summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-07-31 16:00:08 +0100
committerTom Hacohen <tom@stosb.com>2015-07-31 16:00:23 +0100
commit7ffa4d13670d515795e0d12cdaf9822daa190cf7 (patch)
tree66c0f82073a395408399eb97aa8c99ed3941ca7a
parentb2bfd64f2687e17aebdb998f9f26bfcd79f645b5 (diff)
Evas text: Migrate docs to new Eolian format.
-rw-r--r--src/lib/evas/canvas/evas_text.eo280
1 files changed, 107 insertions, 173 deletions
diff --git a/src/lib/evas/canvas/evas_text.eo b/src/lib/evas/canvas/evas_text.eo
index 8cdb2041f5..b063d6b435 100644
--- a/src/lib/evas/canvas/evas_text.eo
+++ b/src/lib/evas/canvas/evas_text.eo
@@ -4,165 +4,120 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter)
4 eo_prefix: evas_obj_text; 4 eo_prefix: evas_obj_text;
5 methods { 5 methods {
6 @property shadow_color { 6 @property shadow_color {
7 set { 7 [[Controls the shadow color for the given text object.
8 /*@
9 Sets the shadow color for the given text object.
10 8
11 Shadow effects, which are fading colors decorating the text 9 Shadow effects, which are fading colors decorating the text
12 underneath it, will just be shown if the object is set to one of 10 underneath it, will just be shown if the object is set to one of
13 the following styles: 11 the following styles:
14 12
15 - #EVAS_TEXT_STYLE_SHADOW 13 - @Evas.Text_Style_Type.shadow
16 - #EVAS_TEXT_STYLE_OUTLINE_SHADOW 14 - @Evas.Text_Style_Type.outline_shadow
17 - #EVAS_TEXT_STYLE_FAR_SHADOW 15 - @Evas.Text_Style_Type.far_shadow
18 - #EVAS_TEXT_STYLE_OUTLINE_SOFT_SHADOW 16 - @Evas.Text_Style_Type.outline_soft_shadow
19 - #EVAS_TEXT_STYLE_SOFT_SHADOW 17 - @Evas.Text_Style_Type.soft_shadow
20 - #EVAS_TEXT_STYLE_FAR_SOFT_SHADOW 18 - @Evas.Text_Style_Type.far_soft_shadow
21 19
22 One can also change the direction where the shadow grows to, with 20 One can also change the direction where the shadow grows to, with
23 evas_object_text_style_set(). 21 @.style
24 22
25 @see evas_object_text_shadow_color_get() */ 23 See @.shadow_color]]
24 set {
26 } 25 }
27 get { 26 get {
28 /*@ 27 [[Note: Use $NULL pointers on the color components you're not
29 Retrieves the shadow color for the given text object. 28 interested in: they'll be ignored by the function.]]
30
31 @note Use @c NULL pointers on the color components you're not
32 interested in: they'll be ignored by the function.
33
34 @see evas_object_text_shadow_color_set() for more details. */
35 } 29 }
36 values { 30 values {
37 r: int; /*@ The red component of the given color. */ 31 r: int; [[The red component of the given color.]]
38 g: int; /*@ The green component of the given color. */ 32 g: int; [[The green component of the given color.]]
39 b: int; /*@ The blue component of the given color. */ 33 b: int; [[The blue component of the given color.]]
40 a: int; /*@ The alpha component of the given color. */ 34 a: int; [[The alpha component of the given color.]]
41 } 35 }
42 } 36 }
43 @property ellipsis { 37 @property ellipsis {
44 set { 38 [[Conttrols the ellipsis that should be used for the text object.
45 /*@
46 @brief Sets the ellipsis that should be used for the text object.
47 39
48 This is a value between 0.0 and 1.0 indicating the position of the text 40 This is a value between 0.0 and 1.0 indicating the position of the text
49 to be shown. 0.0 means the start will be shown and the end trimmed, 1.0 41 to be shown. 0.0 means the start will be shown and the end trimmed, 1.0
50 means the beginning will be trimmed and the end will be shown, and any value 42 means the beginning will be trimmed and the end will be shown, and any value
51 in between will cause ellipsis to be added in both end of the text and the 43 in between will cause ellipsis to be added in both end of the text and the
52 requested part to be shown. 44 requested part to be shown.
53 -1.0 means ellipsis is turned off. 45 -1.0 means ellipsis is turned off.
54 46
55 @since 1.8 */ 47 @since 1.8]]
48 set {
56 } 49 }
57 get { 50 get {
58 /*@
59 @brief Gets the ellipsis currently set on the text object.
60
61 @return The ellipsis set on the text object. The ellipsis is -1.0.
62 @see evas_object_text_ellipsis_set.
63 @since 1.8 */
64 } 51 }
65 values { 52 values {
66 ellipsis: double(-1); /*@ the ellipsis. */ 53 ellipsis: double(-1); [[the ellipsis. Allowed values: -1.0 or 0.0-1.0]]
67 } 54 }
68 } 55 }
69 @property bidi_delimiters { 56 @property bidi_delimiters {
70 set { 57 [[Sets the BiDi delimiters used in the textblock.
71 /*@
72 @brief Sets the BiDi delimiters used in the textblock.
73 58
74 BiDi delimiters are use for in-paragraph separation of bidi segments. This 59 BiDi delimiters are use for in-paragraph separation of bidi segments. This
75 is useful for example in recipients fields of e-mail clients where bidi 60 is useful for example in recipients fields of e-mail clients where bidi
76 oddities can occur when mixing RTL and LTR. 61 oddities can occur when mixing RTL and LTR.
77 62
78 @since 1.1 */ 63 @since 1.1]]
64 set {
79 } 65 }
80 get { 66 get {
81 /*@
82 @brief Gets the BiDi delimiters used in the textblock.
83
84 BiDi delimiters are use for in-paragraph separation of bidi segments. This
85 is useful for example in recipients fields of e-mail clients where bidi
86 oddities can occur when mixing RTL and LTR.
87
88 @return A null terminated string of delimiters, e.g ",|". If empty, returns NULL.
89 @since 1.1 */
90 } 67 }
91 values { 68 values {
92 delim: const(char)*; /*@ A null terminated string of delimiters, e.g ",|". */ 69 delim: const(char)*; [[A null terminated string of delimiters, e.g ",|".]]
93 } 70 }
94 } 71 }
95 @property outline_color { 72 @property outline_color {
73 [[Controlss the outline color for the given text object.
74
75 Outline effects (colored lines around text glyphs) will just be
76 shown if the object is set to one of the following styles:
77 - @Evas.Text_Style_Type.outline
78 - @Evas.Text_Style_Type.soft_outline
79 - @Evas.Text_Style_Type.outline_shadow
80 - @Evas.Text_Style_Type.outline_soft_shadow]]
96 set { 81 set {
97 /*@
98 Sets the outline color for the given text object.
99
100 Outline effects (colored lines around text glyphs) will just be
101 shown if the object is set to one of the following styles:
102 - #EVAS_TEXT_STYLE_OUTLINE
103 - #EVAS_TEXT_STYLE_SOFT_OUTLINE
104 - #EVAS_TEXT_STYLE_OUTLINE_SHADOW
105 - #EVAS_TEXT_STYLE_OUTLINE_SOFT_SHADOW
106
107 @see evas_object_text_outline_color_get() */
108 } 82 }
109 get { 83 get {
110 /*@
111 Retrieves the outline color for the given text object.
112
113 @note Use @c NULL pointers on the color components you're not
114 interested in: they'll be ignored by the function.
115
116 @see evas_object_text_outline_color_set() for more details. */
117 } 84 }
118 values { 85 values {
119 r: int; /*@ The red component of the given color. */ 86 r: int; [[The red component of the given color.]]
120 g: int; /*@ The green component of the given color. */ 87 g: int; [[The green component of the given color.]]
121 b: int; /*@ The blue component of the given color. */ 88 b: int; [[The blue component of the given color.]]
122 a: int; /*@ The alpha component of the given color. */ 89 a: int; [[The alpha component of the given color.]]
123 } 90 }
124 } 91 }
125 @property glow2_color { 92 @property glow2_color {
126 set { 93 [[Sets the 'glow 2' color for the given text object.
127 /*@
128 Sets the 'glow 2' color for the given text object.
129
130 'Glow 2' effects, which are glowing colors decorating the text's
131 (immediate) surroundings, will just be shown if the object is set
132 to the #EVAS_TEXT_STYLE_GLOW style. See also
133 evas_object_text_glow_color_set().
134 94
135 @see evas_object_text_glow2_color_get() */ 95 'Glow 2' effects, which are glowing colors decorating the text's
96 (immediate) surroundings, will just be shown if the object is set
97 to the @Evas.Text_Style_Type.glow style. See also
98 @.glow_color.]]
99 set {
136 } 100 }
137 get { 101 get {
138 /*@
139 Retrieves the 'glow 2' color for the given text object.
140
141 @note Use @c NULL pointers on the color components you're not
142 interested in: they'll be ignored by the function.
143
144 @see evas_object_text_glow2_color_set() for more details. */
145 } 102 }
146 values { 103 values {
147 r: int; /*@ The red component of the given color. */ 104 r: int; [[The red component of the given color.]]
148 g: int; /*@ The green component of the given color. */ 105 g: int; [[The green component of the given color.]]
149 b: int; /*@ The blue component of the given color. */ 106 b: int; [[The blue component of the given color.]]
150 a: int; /*@ The alpha component of the given color. */ 107 a: int; [[The alpha component of the given color.]]
151 } 108 }
152 } 109 }
153 @property style { 110 @property style {
154 set { 111 [[Controls the style to apply on the given text object.
155 /*@
156 Sets the style to apply on the given text object.
157 112
158 Text object styles are one of the values in 113 Text object styles are one of the values in @Evas.Text_Style_Type
159 #Evas_Text_Style_Type. Some of those values are combinations of 114 Some of those values are combinations of more than one style,
160 more than one style, and some account for the direction of the 115 and some account for the direction of the rendering of shadow effects.
161 rendering of shadow effects.
162 116
163 @note One may use the helper macros #EVAS_TEXT_STYLE_BASIC_SET and 117 Note: One may use the helper macros #EVAS_TEXT_STYLE_BASIC_SET and
164 #EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET to assemble a style value. 118 #EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET to assemble a style value.]]
165 119
120 /* FIXME-doc:
166 The following figure illustrates the text styles: 121 The following figure illustrates the text styles:
167 122
168 @image html text-styles.png 123 @image html text-styles.png
@@ -174,49 +129,33 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter)
174 @see evas_object_text_outline_color_set() 129 @see evas_object_text_outline_color_set()
175 @see evas_object_text_glow_color_set() 130 @see evas_object_text_glow_color_set()
176 @see evas_object_text_glow2_color_set() */ 131 @see evas_object_text_glow2_color_set() */
132 set {
177 } 133 }
178 get { 134 get {
179 /*@
180 Retrieves the style on use on the given text object.
181
182 @return the style type in use.
183
184 @see evas_object_text_style_set() for more details. */
185 } 135 }
186 values { 136 values {
187 style: Evas.Text_Style_Type; /*@ a style type. */ 137 style: Evas.Text_Style_Type; [[a style type.]]
188 } 138 }
189 } 139 }
190 @property glow_color { 140 @property glow_color {
191 set { 141 [[Sets the glow color for the given text object.
192 /*@
193 Sets the glow color for the given text object.
194 142
195 Glow effects, which are glowing colors decorating the text's 143 Glow effects, which are glowing colors decorating the text's
196 surroundings, will just be shown if the object is set to the 144 surroundings, will just be shown if the object is set to the
197 #EVAS_TEXT_STYLE_GLOW style. 145 @Evas.Text_Style_Type.glow style.
198 146
199 @note Glow effects are placed from a short distance of the text 147 Note: Glow effects are placed from a short distance of the text
200 itself, but no touching it. For glowing effects right on the 148 itself, but no touching it. For glowing effects right on the
201 borders of the glyphs, see 'glow 2' effects 149 borders of the glyphs, see 'glow 2' effects.]]
202 (evas_object_text_glow2_color_set()). 150 set {
203
204 @see evas_object_text_glow_color_get() */
205 } 151 }
206 get { 152 get {
207 /*@
208 Retrieves the glow color for the given text object.
209
210 @note Use @c NULL pointers on the color components you're not
211 interested in: they'll be ignored by the function.
212
213 @see evas_object_text_glow_color_set() for more details. */
214 } 153 }
215 values { 154 values {
216 r: int; /*@ The red component of the given color. */ 155 r: int; [[The red component of the given color.]]
217 g: int; /*@ The green component of the given color. */ 156 g: int; [[The green component of the given color.]]
218 b: int; /*@ The blue component of the given color. */ 157 b: int; [[The blue component of the given color.]]
219 a: int; /*@ The alpha component of the given color. */ 158 a: int; [[The alpha component of the given color.]]
220 } 159 }
221 } 160 }
222 @property max_descent { 161 @property max_descent {
@@ -226,22 +165,20 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter)
226 } 165 }
227 @property style_pad { 166 @property style_pad {
228 get { 167 get {
229 /*@ 168 [[Gets the text style pad of a text object.]]
230 Gets the text style pad of a text object. */
231 } 169 }
232 values { 170 values {
233 l: int; /*@ The left pad (or @c NULL). */ 171 l: int; [[The left pad (or $NULL).]]
234 r: int; /*@ The right pad (or @c NULL). */ 172 r: int; [[The right pad (or $NULL).]]
235 t: int; /*@ The top pad (or @c NULL). */ 173 t: int; [[The top pad (or $NULL).]]
236 b: int; /*@ The bottom pad (or @c NULL). */ 174 b: int; [[The bottom pad (or $NULL).]]
237 } 175 }
238 } 176 }
239 @property direction { 177 @property direction {
240 get { 178 get {
241 /*@ 179 [[Retrieves the direction of the text currently being displayed in the
242 Retrieves the direction of the text currently being displayed in the 180 text object.]]
243 text object. 181
244 @return the direction of the text */
245 return: Evas.BiDi_Direction; 182 return: Evas.BiDi_Direction;
246 } 183 }
247 } 184 }
@@ -276,42 +213,39 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter)
276 } 213 }
277 } 214 }
278 last_up_to_pos @const { 215 last_up_to_pos @const {
279 /*@ Returns the logical position of the last char in the text up to the pos given. this is NOT the position of the last char because of the possibility of RTL in the text. */ 216 [[Returns the logical position of the last char in the text up to the pos given. this is NOT the position of the last char because of the possibility of RTL in the text.]]
280 return: int(-1); 217 return: int(-1);
281 params { 218 params {
282 @in x: Evas.Coord; /*@ in */ 219 @in x: Evas.Coord;
283 @in y: Evas.Coord; /*@ in */ 220 @in y: Evas.Coord;
284 } 221 }
285 } 222 }
286 char_coords_get @const { 223 char_coords_get @const {
287 return: int; 224 return: int;
288 params { 225 params {
289 @in x: Evas.Coord; /*@ in */ 226 @in x: Evas.Coord;
290 @in y: Evas.Coord; /*@ in */ 227 @in y: Evas.Coord;
291 @out cx: Evas.Coord; /*@ out */ 228 @out cx: Evas.Coord;
292 @out cy: Evas.Coord; /*@ out */ 229 @out cy: Evas.Coord;
293 @out cw: Evas.Coord; /*@ out */ 230 @out cw: Evas.Coord;
294 @out ch: Evas.Coord; /*@ out */ 231 @out ch: Evas.Coord;
295 } 232 }
296 } 233 }
297 char_pos_get @const { 234 char_pos_get @const {
298 /*@ 235 [[Retrieve position and dimension information of a character within a text @Evas.Object
299 Retrieve position and dimension information of a character within a text @c Evas_Object.
300 236
301 This function is used to obtain the X, Y, width and height of the character 237 This function is used to obtain the X, Y, width and height of the character
302 located at @p pos within the @c Evas_Object @p obj. @p obj must be a text object 238 located at $pos within the @Evas.Object $obj. $obj must be a text object
303 as created with evas_object_text_add(). Any of the @c Evas_Coord parameters (@p cx, 239 Any of the $Evas_Coord parameters ($cx, $cy, $cw, $ch) may be $NULL in which case no value will be assigned to that
304 @p cy, @p cw, @p ch) may be @c NULL in which case no value will be assigned to that 240 parameter.]]
305 parameter.
306 241
307 @return @c EINA_FALSE on success, @c EINA_TRUE on error. */ 242 return: bool; [[$false on success, $true otherwise]]
308 return: bool;
309 params { 243 params {
310 @in pos: int; /*@ The character position to request co-ordinates for. */ 244 @in pos: int; [[The character position to request co-ordinates for.]]
311 @out cx: Evas.Coord; /*@ A pointer to an @c Evas_Coord to store the X value in (can be NULL). */ 245 @out cx: Evas.Coord; [[A pointer to an @Evas.Coord to store the X value in (can be NULL).]]
312 @out cy: Evas.Coord; /*@ A pointer to an @c Evas_Coord to store the Y value in (can be NULL). */ 246 @out cy: Evas.Coord; [[A pointer to an @Evas.Coord to store the Y value in (can be NULL).]]
313 @out cw: Evas.Coord; /*@ A pointer to an @c Evas_Coord to store the Width value in (can be NULL). */ 247 @out cw: Evas.Coord; [[A pointer to an @Evas.Coord to store the Width value in (can be NULL).]]
314 @out ch: Evas.Coord; /*@ A pointer to an @c Evas_Coord to store the Height value in (can be NULL). */ 248 @out ch: Evas.Coord; [[A pointer to an @Evas.Coord to store the Height value in (can be NULL).]]
315 } 249 }
316 } 250 }
317 } 251 }