summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/evas_text.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/evas/canvas/evas_text.eo')
-rw-r--r--src/lib/evas/canvas/evas_text.eo287
1 files changed, 0 insertions, 287 deletions
diff --git a/src/lib/evas/canvas/evas_text.eo b/src/lib/evas/canvas/evas_text.eo
deleted file mode 100644
index 9d9b7cc..0000000
--- a/src/lib/evas/canvas/evas_text.eo
+++ /dev/null
@@ -1,287 +0,0 @@
1type @extern Evas.Text_Style_Type : __undefined_type; [[External text style type]]
2
3class Evas.Text extends Efl.Canvas.Object implements Efl.Text,
4 Efl.Text_Font, Efl.Canvas.Filter.Internal
5{
6 [[Evas text class]]
7 legacy_prefix: evas_object_text;
8 eo_prefix: evas_obj_text;
9 methods {
10 @property shadow_color {
11 [[Controls the shadow color for the given text object.
12
13 Shadow effects are fading colors decorating the text
14 underneath it. They will be shown if the object is set to
15 one of the following styles:
16
17 - $EVAS_TEXT_STYLE_TYPE_SHADOW
18 - $EVAS_TEXT_STYLE_TYPE_OUTLINE_SHADOW
19 - $EVAS_TEXT_STYLE_TYPE_FAR_SHADOW
20 - $EVAS_TEXT_STYLE_TYPE_OUTLINE_SOFT_SHADOW
21 - $EVAS_TEXT_STYLE_TYPE_SOFT_SHADOW
22 - $EVAS_TEXT_STYLE_TYPE_FAR_SOFT_SHADOW
23
24 One can also change the direction where the shadow grows to, with
25 @.style
26
27 See @.shadow_color]]
28 set {
29 }
30 get {
31 [[Note: Use $NULL pointers on the color components you're not
32 interested in: they'll be ignored by the function.]]
33 }
34 values {
35 r: int; [[The red component of the given color.]]
36 g: int; [[The green component of the given color.]]
37 b: int; [[The blue component of the given color.]]
38 a: int; [[The alpha component of the given color.]]
39 }
40 }
41 @property ellipsis {
42 [[Controls the ellipsis that should be used for the text object.
43
44 This is a value between 0.0 and 1.0 indicating the position of the text
45 to be shown. 0.0 means the start will be shown and the end trimmed, 1.0
46 means the beginning will be trimmed and the end will be shown, and any value
47 in between will cause ellipsis to be added in both end of the text and the
48 requested part to be shown.
49 -1.0 means ellipsis is turned off.
50
51 @since 1.8]]
52 set {
53 }
54 get {
55 }
56 values {
57 ellipsis: double(-1.0); [[The ellipsis. Allowed values: -1.0 or 0.0-1.0]]
58 }
59 }
60 @property bidi_delimiters {
61 [[Sets the BiDi delimiters used in the textblock.
62
63 BiDi delimiters are use for in-paragraph separation of bidi segments. This
64 is useful for example in recipients fields of e-mail clients where bidi
65 oddities can occur when mixing RTL and LTR.
66
67 @since 1.1]]
68 set {
69 }
70 get {
71 }
72 values {
73 delim: string; [[A null terminated string of delimiters, e.g ",|".]]
74 }
75 }
76 @property outline_color {
77 [[Controls the outline color for the given text object.
78
79 Outline effects (colored lines around text glyphs) will be
80 shown if the object is set to one of the following styles:
81 - $EVAS_TEXT_STYLE_TYPE_OUTLINE
82 - $EVAS_TEXT_STYLE_TYPE_SOFT_OUTLINE
83 - $EVAS_TEXT_STYLE_TYPE_OUTLINE_SHADOW
84 - $EVAS_TEXT_STYLE_TYPE_OUTLINE_SOFT_SHADOW
85 ]]
86 set {
87 }
88 get {
89 }
90 values {
91 r: int; [[The red component of the given color.]]
92 g: int; [[The green component of the given color.]]
93 b: int; [[The blue component of the given color.]]
94 a: int; [[The alpha component of the given color.]]
95 }
96 }
97 @property glow2_color {
98 [[Sets the 'glow 2' color for the given text object.
99
100 'Glow 2' effects are glowing colors decorating the text's
101 (immediate) surroundings. They will be shown if the object
102 is set to the $EVAS_TEXT_STYLE_TYPE_GLOW style. See also
103 @.glow_color.
104 ]]
105 set {
106 }
107 get {
108 }
109 values {
110 r: int; [[The red component of the given color.]]
111 g: int; [[The green component of the given color.]]
112 b: int; [[The blue component of the given color.]]
113 a: int; [[The alpha component of the given color.]]
114 }
115 }
116 @property style {
117 [[Controls the style to apply on the given text object.
118
119 Text object styles are one of the values in @Evas.Text_Style_Type
120 Some of those values are combinations of more than one style,
121 and some account for the direction of the rendering of shadow effects.
122
123 Note: One may use the helper macros #EVAS_TEXT_STYLE_BASIC_SET and
124 #EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET to assemble a style value.]]
125
126 /* FIXME-doc:
127 The following figure illustrates the text styles:
128
129 @image html text-styles.png
130 @image rtf text-styles.png
131 @image latex text-styles.eps
132
133 @see evas_object_text_style_get()
134 @see evas_object_text_shadow_color_set()
135 @see evas_object_text_outline_color_set()
136 @see evas_object_text_glow_color_set()
137 @see evas_object_text_glow2_color_set() */
138 set {
139 }
140 get {
141 }
142 values {
143 style: Evas.Text_Style_Type; [[Style type]]
144 }
145 }
146 @property glow_color {
147 [[Sets the glow color for the given text object.
148
149 Glow effects are glowing colors decorating the text's
150 surroundings. They will be shown if the object is set to the
151 $EVAS_TEXT_STYLE_TYPE_GLOW style.
152
153 Note: Glow effects are placed from a short distance of the text
154 itself, but not touching it. For glowing effects right on the
155 borders of the glyphs, see 'glow 2' effects.]]
156 set {
157 }
158 get {
159 }
160 values {
161 r: int; [[The red component of the given color.]]
162 g: int; [[The green component of the given color.]]
163 b: int; [[The blue component of the given color.]]
164 a: int; [[The alpha component of the given color.]]
165 }
166 }
167 @property max_descent {
168 [[Maximal descent property]]
169 get {
170 return: int; [[Evas coordinate]]
171 }
172 }
173 @property style_pad {
174 get {
175 [[Gets the text style pad of a text object.]]
176 }
177 values {
178 l: int; [[The left pad (or $NULL).]]
179 r: int; [[The right pad (or $NULL).]]
180 t: int; [[The top pad (or $NULL).]]
181 b: int; [[The bottom pad (or $NULL).]]
182 }
183 }
184 @property direction {
185 get {
186 [[Retrieves the direction of the text currently being displayed in the
187 text object.]]
188
189 return: Efl.Text_Bidirectional_Type; [[Bidirectional type]]
190 }
191 }
192 @property ascent {
193 [[Ascent property]]
194 get {
195 return: int; [[Evas coordinate]]
196 }
197 }
198 @property horiz_advance {
199 [[Horizontal advance property]]
200 get {
201 return: int; [[Evas coordinate]]
202 }
203 }
204 @property inset {
205 [[Inset property]]
206 get {
207 return: int; [[Evas coordinate]]
208 }
209 }
210 @property max_ascent {
211 [[Maximal ascent property]]
212 get {
213 return: int; [[Evas coordinate]]
214 }
215 }
216 @property vert_advance {
217 [[Vertical advance property]]
218 get {
219 return: int; [[Evas coordinate]]
220 }
221 }
222 @property descent {
223 [[descent property]]
224 get {
225 return: int; [[Evas coordinate]]
226 }
227 }
228 last_up_to_pos @const {
229 [[Returns the logical position of the last char in the text up to
230 the pos given.
231
232 This is NOT the position of the last char because of the possibility
233 of RTL in the text.
234 ]]
235 return: int(-1); [[Logical position of the last char]]
236 params {
237 @in x: int; [[X coordinate]]
238 @in y: int; [[Y coordinate]]
239 }
240 }
241 char_coords_get @const {
242 [[Get character coordinates]]
243 return: int; [[Logical position of char]]
244 params {
245 @in x: int; [[X coordinate]]
246 @in y: int; [[Y coordinate]]
247 @out cx: int; [[X coordinate]]
248 @out cy: int; [[Y coordinate]]
249 @out cw: int; [[Width]]
250 @out ch: int; [[Height]]
251 }
252 }
253 char_pos_get @const {
254 [[Retrieve position and dimension information of a character within a text @Efl.Canvas.Object
255
256 This function is used to obtain the X, Y, width and height of the character
257 located at $pos within the @Efl.Canvas.Object $obj. $obj must be a text object
258 Any of the $Evas_Coord parameters ($cx, $cy, $cw, $ch) may be $NULL in which case no value will be assigned to that
259 parameter.]]
260
261 return: bool; [[$false on success, $true otherwise]]
262 params {
263 @in pos: int; [[The character position to request co-ordinates for.]]
264 @out cx: int; [[A pointer to an int to store the X value in (can be NULL).]]
265 @out cy: int; [[A pointer to an int to store the Y value in (can be NULL).]]
266 @out cw: int; [[A pointer to an int to store the Width value in (can be NULL).]]
267 @out ch: int; [[A pointer to an int to store the Height value in (can be NULL).]]
268 }
269 }
270 }
271 implements {
272 Efl.Object.constructor;
273 Efl.Object.destructor;
274 Efl.Gfx.Entity.size { set; }
275 Efl.Gfx.Entity.scale { set; }
276 Efl.Text.text { get; set; }
277 Efl.Text_Font.font { get; set; }
278 Efl.Text_Font.font_source { get; set; }
279 Efl.Text_Font.font_bitmap_scalable { get; set; }
280 Efl.Gfx.Filter.filter_program { set; }
281 Efl.Canvas.Filter.Internal.filter_dirty;
282 Efl.Canvas.Filter.Internal.filter_input_alpha;
283 Efl.Canvas.Filter.Internal.filter_input_render;
284 Efl.Canvas.Filter.Internal.filter_state_prepare;
285 Efl.Canvas.Object.paragraph_direction { set; get; }
286 }
287}