summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYoungbok Shin <youngb.shin@samsung.com>2016-05-23 21:08:13 +0900
committerYoungbok Shin <youngb.shin@samsung.com>2016-05-23 21:09:02 +0900
commit2a06e638fe8d7b7d21978a447795bab7b180ad6b (patch)
tree8f4e869ebc3757d2253339f76f4f5b93b0a3c2c9
parenta2540ac9e6652eb37de6f0005a3fb83560d363c9 (diff)
Add docs from existing APIs.devs/youngbok/elm_interface_next
It also add an interface: efl_input_panel.eo
-rw-r--r--src/lib/efl/interfaces/efl_cnp.eo23
-rw-r--r--src/lib/efl/interfaces/efl_input_panel.eo136
-rw-r--r--src/lib/efl/interfaces/efl_text_cursor.eo74
-rw-r--r--src/lib/efl/interfaces/efl_text_properties.eo48
-rw-r--r--src/lib/efl/interfaces/efl_text_selection.eo41
5 files changed, 232 insertions, 90 deletions
diff --git a/src/lib/efl/interfaces/efl_cnp.eo b/src/lib/efl/interfaces/efl_cnp.eo
index 709491cc5b..7089648072 100644
--- a/src/lib/efl/interfaces/efl_cnp.eo
+++ b/src/lib/efl/interfaces/efl_cnp.eo
@@ -8,26 +8,33 @@ enum Efl.Cnp.Mode
8interface Efl.Cnp { 8interface Efl.Cnp {
9 methods { 9 methods {
10 @property mode { 10 @property mode {
11 set { 11 [[Control pasting of text and images for the widget.
12 [[TODO 12
13 Normally the entry allows both text and images to be pasted.
14 By setting cnp_mode to be #EFL_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
15 By setting cnp_mode to be #EFL_CNP_MODE_PLAINTEXT, this remove all tags in text .
16
17 Note: This only changes the behaviour of text.
13 ]] 18 ]]
19 set {
14 } 20 }
15 get { 21 get {
16 [[TODO
17 ]]
18 } 22 }
19 values { 23 values {
20 mode: Efl.Cnp.Mode; [[TODO]] 24 mode: Efl.Cnp.Mode; [[One of #Efl_Cnp_Mode: #EFL_CNP_MODE_MARKUP, #EFL_CNP_MODE_NO_IMAGE, #EFL_CNP_MODE_PLAINTEXT.]]
21 } 25 }
22 } 26 }
23 copy { 27 copy {
24 return: const (char)*; [[TODO]] 28 [[This executes a "copy" action on the text of the object.]]
29 return: const (char)*; [[Returns copied text]]
25 } 30 }
26 cut { 31 cut {
27 return: const (char)*; [[TODO]] 32 [[This executes a "cut" action on the text of the object.]]
33 return: const (char)*; [[Returns cutted text]]
28 } 34 }
29 paste { 35 paste {
30 return: const (char)*; [[TODO]] 36 [[This executes a "paste" action on the text of the object.]]
37 return: const (char)*; [[Returns pasted text]]
31 } 38 }
32 } 39 }
33} 40}
diff --git a/src/lib/efl/interfaces/efl_input_panel.eo b/src/lib/efl/interfaces/efl_input_panel.eo
new file mode 100644
index 0000000000..abacfb54c2
--- /dev/null
+++ b/src/lib/efl/interfaces/efl_input_panel.eo
@@ -0,0 +1,136 @@
1enum Efl.Input_Panel.Layout
2{
3 normal = 0,
4 number,
5 email,
6 url,
7 phonenumber,
8 ip,
9 month,
10 numberonly,
11 invalid,
12 hex,
13 terminal,
14 password,
15 datetime,
16 emoticon
17}
18
19enum Efl.Input_Panel.Lang
20{
21 automatic = 0,
22 alphabet
23}
24
25enum Efl.Input_Panel.Return.Key.Type
26{
27 default = 0,
28 done,
29 go,
30 join,
31 login,
32 next,
33 search,
34 send,
35 signin
36}
37
38interface Efl.Input_Panel {
39 methods {
40 @property layout {
41 set {
42 [[Set the input panel layout.]]
43 }
44 get {
45 [[Get the input panel layout.]]
46 }
47 values {
48 layout: Efl.Input_Panel.Layout(Efl.Input_Panel.Layout.invalid); [[layout type.]]
49 }
50 }
51 @property visible {
52 [[Controls visiblity of the input panel.
53 ]]
54 set {
55 }
56 get {
57 }
58 values {
59 visible: bool; [[If visible is true, the input panel will be shown. If visible is false, the input panel will be hidden.]]
60 }
61 }
62 @property language {
63 set {
64 [[Set the language mode of the input panel.
65
66 This API can be used if you want to show the alphabet keyboard mode.
67 ]]
68 }
69 get {
70 [[Get the language mode of the input panel.
71 ]]
72 }
73 values {
74 language: Efl.Input_Panel.Lang; [[language to be set to the input panel.]]
75 }
76 }
77 @property return_key_type {
78 set {
79 [[Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
80
81 An input panel displays the string or icon associated with this type.
82 ]]
83 }
84 get {
85 [[Get the "return" key type.
86 ]]
87 }
88 values {
89 type: Efl.Input_Panel.Return.Key.Type; [[The type of "return" key on the input panel.]]
90 }
91 }
92 @property return_key_disabled {
93 set {
94 [[Set the return key on the input panel to be disabled.
95 ]]
96 }
97 get {
98 [[Get whether the return key on the input panel should be disabled or not.
99 ]]
100 }
101 values {
102 disabled: bool; [[The state to put in in: $true for
103 disabled, $false for enabled.]]
104 }
105 }
106 @property return_key_autoenabled {
107 [[Set whether the return key on the input panel is disabled automatically when there is no text.
108
109 If $enabled is $true, The return key on input panel is disabled when there is no text.
110 The return key on the input panel is automatically enabled when there is text.
111 The default value is $false.
112 ]]
113 set {
114 }
115 get {
116 }
117 values {
118 enabled: bool; [[If $enabled is true, the return key is automatically disabled when there is no text.]]
119 }
120 }
121 @property show_on_demand {
122 set {
123 [[Set the attribute to show the input panel in case of only an user's explicit Mouse Up event.
124 It doesn't request to show the input panel even though it has focus.
125 ]]
126 }
127 get {
128 [[Get the attribute to show the input panel in case of only an user's explicit Mouse Up event.
129 ]]
130 }
131 values {
132 on_demand: bool; [[If true, the input panel will be shown in case of only Mouse up event.]]
133 }
134 }
135 }
136}
diff --git a/src/lib/efl/interfaces/efl_text_cursor.eo b/src/lib/efl/interfaces/efl_text_cursor.eo
index 1b6bd6f17a..82aca87888 100644
--- a/src/lib/efl/interfaces/efl_text_cursor.eo
+++ b/src/lib/efl/interfaces/efl_text_cursor.eo
@@ -1,68 +1,86 @@
1enum Efl.Text.Cursor.Type
2{
3 under = 0,
4 before
5}
6
1interface Efl.Text.Cursor { 7interface Efl.Text.Cursor {
2 methods { 8 methods {
9 @property type {
10 [[Contols cursor type. It may change the cursor's geometry
11 according to cursor type.
12 ]]
13 set {
14 }
15 get {
16 }
17 values {
18 type: Efl.Text.Cursor.Type; [[The cursor's type]]
19 }
20 }
3 @property position { 21 @property position {
4 set { 22 set {
5 [[TODO 23 [[Set the cursor pos.
6 ]] 24 ]]
7 } 25 }
8 get { 26 get {
9 [[TODO 27 [[Return the current cursor pos.
10 ]] 28 ]]
11 } 29 }
12 values { 30 values {
13 position: int; [[TODO]] 31 position: int; [[The cursor's position]]
14 } 32 }
15 } 33 }
16 @property geometry { 34 @property geometry {
17 get { 35 get {
18 [[TODO 36 [[Returns the geometry of the cursor.
19 ]] 37 ]]
20 } 38 }
21 values { 39 values {
22 x: int; [[TODO]] 40 x: int; [[Cursor X position]]
23 y: int; [[TODO]] 41 y: int; [[Cursor Y position]]
24 w: int; [[TODO]] 42 w: int; [[Cursor width]]
25 h: int; [[TODO]] 43 h: int; [[Cursor height]]
26 } 44 }
27 } 45 }
28 @property bidi { 46 @property bidi {
29 get { 47 get {
30 [[TODO 48 [[Returns the direction of the cursor.
31 ]] 49 ]]
32 } 50 }
33 values { 51 values {
34 bidi: int; [[TODO]] 52 bidi: Efl.BiDi.Direction; [[the diretion of the cursor]]
35 } 53 }
36 } 54 }
37 first { 55 move_begin {
38 [[TODO 56 [[Move the cursor to the beginning of text.
39 ]] 57 ]]
40 return: bool; [[TODO]] 58 return: bool; [[If the cursor is moved to the beginning of text, it returns true]]
41 } 59 }
42 last { 60 move_end {
43 [[TODO 61 [[Move the cursor to the end of text.
44 ]] 62 ]]
45 return: bool; [[TODO]] 63 return: bool; [[If the cursor is moved to the end of text, it returns true]]
46 } 64 }
47 next { 65 move_next {
48 [[TODO 66 [[Move the cursor to the next position of text.
49 ]] 67 ]]
50 return: bool; [[TODO]] 68 return: bool; [[If the cursor is moved to the next position of text, it returns true]]
51 } 69 }
52 prev { 70 move_prev {
53 [[TODO 71 [[Move the cursor to the previous position of text.
54 ]] 72 ]]
55 return: bool; [[TODO]] 73 return: bool; [[If the cursor is moved to the previous position of text, it returns true]]
56 } 74 }
57 up { 75 move_up {
58 [[TODO 76 [[Move the cursor to the above line of text.
59 ]] 77 ]]
60 return: bool; [[TODO]] 78 return: bool; [[If the cursor is moved to the above line of text, it returns true]]
61 } 79 }
62 down { 80 move_down {
63 [[TODO 81 [[Move the cursor to the below line of text.
64 ]] 82 ]]
65 return: bool; [[TODO]] 83 return: bool; [[If the cursor is moved to the below line of text, it returns true]]]
66 } 84 }
67 } 85 }
68} 86}
diff --git a/src/lib/efl/interfaces/efl_text_properties.eo b/src/lib/efl/interfaces/efl_text_properties.eo
index abe1151451..9424ed5003 100644
--- a/src/lib/efl/interfaces/efl_text_properties.eo
+++ b/src/lib/efl/interfaces/efl_text_properties.eo
@@ -8,7 +8,7 @@ enum Efl.Text.Properties.Ellipsis
8 end 8 end
9} 9}
10 10
11enum Efl.Text.Properties.Horizontal.Alignment 11enum Efl.Text.Properties.Horizontal_Alignment
12{ 12{
13 default = 0, 13 default = 0,
14 left, 14 left,
@@ -16,7 +16,7 @@ enum Efl.Text.Properties.Horizontal.Alignment
16 right 16 right
17} 17}
18 18
19enum Efl.Text.Properties.Vertical.Alignment 19enum Efl.Text.Properties.Vertical_Alignment
20{ 20{
21 default = 0, 21 default = 0,
22 top, 22 top,
@@ -24,7 +24,7 @@ enum Efl.Text.Properties.Vertical.Alignment
24 bottom 24 bottom
25} 25}
26 26
27enum Efl.Text.Properties.Wrap.Mode 27enum Efl.Text.Properties.Wrap_Mode
28{ 28{
29 none = 0, 29 none = 0,
30 char, 30 char,
@@ -87,64 +87,48 @@ interface Efl.Text.Properties {
87 } 87 }
88 } 88 }
89 @property ellipsis { 89 @property ellipsis {
90 [[Controls the ellipsis for the text object.]]
90 set { 91 set {
91 [[TODO
92 ]]
93 } 92 }
94 get { 93 get {
95 [[TODO
96 ]]
97 } 94 }
98 values { 95 values {
99 ellipsis: Efl.Text.Properties.Ellipsis; [[TODO]] 96 ellipsis: Efl.Text.Properties.Ellipsis; [[The ellipsis. See @Efl.Text.Properties.Ellipsis]]
100 } 97 }
101 } 98 }
102 @property horizontal_alignment { 99 @property horizontal_alignment {
100 [[Controls horizontal alignment for text.]]
103 set { 101 set {
104 [[TODO
105 ]]
106 } 102 }
107 get { 103 get {
108 [[TODO
109 ]]
110 } 104 }
111 values { 105 values {
112 align: Efl.Text.Properties.Horizontal.Alignment; [[TODO]] 106 align: Efl.Text.Properties.Horizontal_Alignment; [[The horizontal alignment. See @Efl.Text.Properties.Horizontal_Alignment]]
113 } 107 }
114 } 108 }
115 @property vertical_alignment { 109 @property vertical_alignment {
110 [[Controls vertical alignment for text.]]
116 set { 111 set {
117 [[TODO
118 ]]
119 } 112 }
120 get { 113 get {
121 [[TODO
122 ]]
123 } 114 }
124 values { 115 values {
125 align: Efl.Text.Properties.Vertical.Alignment; [[TODO]] 116 align: Efl.Text.Properties.Vertical_Alignment; [[The vertical alignment. See @Efl.Text.Properties.Vertical_Alignment]]
126 } 117 }
127 } 118 }
128 @property wrap_mode { 119 @property wrap_mode {
120 [[Controls wrap mode. This tells how the text will be implicitly cut
121 into a new line (without inserting a line break or paragraph separator)
122 when it reaches the far edge of the object.
123
124 Note that #EFL_TEXT_PROPERTIES_WRAP_MODE_NONE indicates single-line mode.
125 ]]
129 set { 126 set {
130 [[TODO
131 ]]
132 } 127 }
133 get { 128 get {
134 [[TODO
135 ]]
136 }
137 values {
138 ellipsis: Efl.Text.Properties.Ellipsis; [[TODO]]
139 }
140 }
141 @property BiDi {
142 get {
143 [[TODO
144 ]]
145 } 129 }
146 values { 130 values {
147 bidi: Efl.BiDi.Direction; [[TODO]] 131 ellipsis: Efl.Text.Properties.Wrap_Mode; [[The wrap mode to use. See @Efl.Text.Properties.Wrap_Mode for details on them.]]
148 } 132 }
149 } 133 }
150 } 134 }
diff --git a/src/lib/efl/interfaces/efl_text_selection.eo b/src/lib/efl/interfaces/efl_text_selection.eo
index 1de9d793d1..87a70c5924 100644
--- a/src/lib/efl/interfaces/efl_text_selection.eo
+++ b/src/lib/efl/interfaces/efl_text_selection.eo
@@ -1,61 +1,58 @@
1interface Efl.Text.Selection { 1interface Efl.Text.Selection {
2 methods { 2 methods {
3 @property enable { 3 @property enable {
4 [[Enable or disable selection feature.]]
4 set { 5 set {
5 [[TODO
6 ]]
7 } 6 }
8 get { 7 get {
9 [[TODO
10 ]]
11 } 8 }
12 values { 9 values {
13 enable: bool; [[TODO]] 10 enable: bool; [[If $enable is true, the text selection is enabled.]]
14 } 11 }
15 } 12 }
16 @property region { 13 @property region {
14 [[This selects a region of text within the object.
17 set { 15 set {
18 [[TODO
19 ]]
20 } 16 }
21 get { 17 get {
22 [[TODO
23 ]]
24 } 18 }
25 values { 19 values {
26 start: int; [[TODO]] 20 start: int; [[The starting position.]]
27 end: int; [[TODO]] 21 end: int; [[The end position.]]
28 } 22 }
29 } 23 }
30 @property handler_disabled { 24 @property handler_disabled {
25 [[This disabled the selection handlers.]]
31 set { 26 set {
32 [[TODO
33 ]]
34 } 27 }
35 get { 28 get {
36 [[TODO
37 ]]
38 } 29 }
39 values { 30 values {
40 disabled: bool; [[TODO]] 31 disabled: bool; [[If $true, the selection handlers are disabled.]]
41 } 32 }
42 } 33 }
43 @property text { 34 @property text {
44 get { 35 get {
45 [[TODO 36 [[Get any selected text within the object.
37
38 If there's any selected text in the object, this function returns it as
39 a string in markup format. $null is returned if no selection exists or
40 if an error occurred.
41
42 The returned value points to an internal string and should not be freed
43 or modified in any way. If the object is deleted or its
44 contents are changed, the returned pointer should be considered invalid.
46 ]] 45 ]]
47 } 46 }
48 values { 47 values {
49 text: const(char)*; [[TODO]] 48 text: const(char)*;
50 } 49 }
51 } 50 }
52 all { 51 all {
53 [[TODO 52 [[This selects all text within the object.]]
54 ]]
55 } 53 }
56 none { 54 none {
57 [[TODO 55 [[This drops any existing text selection within the object.]]
58 ]]
59 } 56 }
60 } 57 }
61} 58}