summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/efl_canvas_text.eo
blob: 78dc931aff22441f96cd333539e3c848ed6342de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
struct Efl.Canvas.Text.Style;

class Efl.Canvas.Text (Efl.Canvas.Object, Efl.Text)
{
   legacy_prefix: evas_object_textblock;
   methods {
      @property bidi_delimiters {
         [[BiDi delimiters are used for in-paragraph separation of bidi
           segments. This is useful for example in recipients fields of
           e-mail clients where bidi oddities can occur when mixing RTL
           and LTR.

           @since 1.1
         ]]
         set {}
         get {}
         values {
            delim: string; [[A null terminated string of delimiters, e.g ",|" or $null if empty.]]
         }
      }
      @property legacy_newline {
         [[When true, newline character will behave as a paragraph separator.

           @since 1.1
         ]]
         set {}
         get {}
         values {
            mode: bool; [[$true for legacy mode, $false otherwise.]]
         }
      }
      @property style {
         [[The text style of the object.

           $key is how you reference the style (for deletion or fetching). $NULL
           as key indicates the style has the highest priority (default style).
           The style priority is the order of creation, styles created first
           are applied first with the exception of $NULL which is implicitly
           first.

           Set $style to $NULL to delete it.
         ]]
         set {
            legacy: null;
         }
         get {
            legacy: null;
         }
         keys {
            key: string; [[The name to the style. $NULL is the default style]]
         }
         values {
            style: string; [[The style.]]
         }
      }
      @property size_formatted {
         [[The formatted width and height.

           This calculates the actual size after restricting the
           textblock to the current size of the object.

           The main difference between this and @.size_native.get
           is that the "native" function does not wrapping into account
           it just calculates the real width of the object if it was
           placed on an infinite canvas, while this function gives the
           size after wrapping according to the size restrictions of the
           object.

           For example for a textblock containing the text:
           "You shall not pass!" with no margins or padding and assuming
           a monospace font and a size of 7x10 char widths (for simplicity)
           has a native size of 19x1 and a formatted size of 5x4.
         ]]
         get {}
         values {
            w: Evas.Coord; [[The width of the object.]]
            h: Evas.Coord; [[The height of the object.]]
         }
      }
      @property cursor {
         [[The object's main cursor.]]
         get {
            return: Efl.Canvas.Text.Cursor;
         }
      }
      @property size_native {
         [[The native width and height.

           This calculates the actual size without taking account the
           current size of the object.

           The main difference between this and @.size_formatted.get
           is that the "native" function does not take wrapping into
           account it just calculates the real width of the object if
           it was placed on an infinite canvas, while the "formatted"
           function gives the size after  wrapping text according to
           the size restrictions of the object.

           For example for a textblock containing the text:
           "You shall not pass!" with no margins or padding and assuming
           a monospace font and a size of 7x10 char widths (for simplicity)
           has a native size of 19x1 and a formatted size of 5x4.
         ]]
         get {}
         values {
            w: Evas.Coord; [[The width returned.]]
            h: Evas.Coord; [[The height returned.]]
         }
      }
      @property style_insets {
         get {}
         values {
            l: Evas.Coord;
            r: Evas.Coord;
            t: Evas.Coord;
            b: Evas.Coord;
         }
      }
      @property is_empty {
         [[Whether the object is empty (no text) or not]]
         get {
            legacy: null;
         }
         values {
            is_empty: bool; [[$true if empty]]
         }
      }
      obstacle_add {
         [[Add obstacle evas object $eo_obs to be observed during layout
           of text.

           The textblock does the layout of the text according to the
           position of the obstacle.

           @since 1.15
         ]]
         params {
            @in eo_obs: Efl.Canvas.Object;
         }
         return: bool; [[$true on success, $false otherwise.]]
      }
      obstacle_del {
         [[Removes $eo_obs from observation during text layout.

           @since 1.15
         ]]
         params {
            @in eo_obs: Efl.Canvas.Object;
         }
         return: bool; [[$true on success, $false otherwise.]]
      }
      obstacles_update {
         [[Triggers for relayout due to obstacles' state change.

           The obstacles alone don't affect the layout, until this is
           called. Use this after doing changes (moving, positioning etc.)
           in the obstacles that you  would like to be considered in the
           layout.

           For example: if you have just repositioned the obstacles to
           differrent coordinates relative to the textblock, you need to
           call this so it will consider this new state and will relayout
           the text.

           @since 1.15
         ]]
      }
      @property annotation {
         [[A new format for $annotation.

           This will replace the format applied by $annotation with $format.
           Assumes that $annotation is a handle for an existing annotation,
           i.e. one that was added using @.annotation_insert to this object.
           Otherwise, this will fail and return $false.

           @since 1.18
         ]]
         set {
            legacy: null;
            return: bool; [[$true on success, $false otherwise.]]
         }
         get {
            legacy: null;
         }
         keys {
            annotation: Efl.Canvas.Text.Annotation *;
         }
         values {
            format: string;
         }
      }
      range_annotations_get {
         [[Returns an iterator of all the handles in a range.

           @since 1.18
         ]]
         legacy: null;
         params {
              @in start: const(Efl.Canvas.Text.Cursor);
              @in end:   const(Efl.Canvas.Text.Cursor);
         }
         return: free(own(iterator<Efl.Canvas.Text.Annotation *>),
                 eina_iterator_free); [[Handle of the Annotation]]
      }
      annotation_del {
         [[Deletes $annotation.

           All formats applied by $annotations will be removed and it will be
           deleted.
         ]]
         legacy: null;
         params {
            @in annotation: Efl.Canvas.Text.Annotation *;
         }
         return: bool; [[$true on success, $false otherwise.]]
      }
      annotation_insert {
         [[Inserts an annotation format in a specified range [$start, $end - 1].

           This will add both opening and closing formats for the given
           $format.
           Returns a handle to manipulate the inserted annotation.

           @since 1.18
         ]]
         legacy: null;
         params {
              @in start: Efl.Canvas.Text.Cursor;
              @in end:   Efl.Canvas.Text.Cursor;
              @in format: string;
         }
         return: Efl.Canvas.Text.Annotation *;
      }
      range_geometry_get {
         [[Get the geometry of a range.  The geometry is the geometry in
           which rectangles in middle lines of range are merged into one big
           rectangle.

           @since 1.13
         ]]
         legacy: null;
         params {
             @in cur1: const(Efl.Canvas.Text.Cursor);
             @in cur2: const(Efl.Canvas.Text.Cursor);
         }
         return: free(own(iterator<Eina.Rectangle>),
                         eina_iterator_free);
      }
      range_delete {
         [[Deletes the range between given cursors.]]
         legacy: null;
         params {
            @in cur1: Efl.Canvas.Text.Cursor; [[Range start position.]]
            @in cur2: Efl.Canvas.Text.Cursor; [[Range end position.]]
         }
      }
      visible_range_get {
         [[Returns the currently visible range.

           The given $start and $end cursor act like an out-variables here,
           as these are set to the positions of the start and the end of the
           visible range in the text, respectively.

           @since 1.1.
         ]]
         return: bool; [[$true on success, $false otherwise.]]
         params {
            @in start: Efl.Canvas.Text.Cursor; [[Range start position.]]
            @in end: Efl.Canvas.Text.Cursor; [[Range end position.]]
         }
      }
      range_text_get {
         [[Returns the text in the range between $cur1 and $cur2.]]
         legacy: null;
         return: own(char*); [[The text in the given range.]]
         params {
            @in cur1: const(Efl.Canvas.Text.Cursor); [[Range start position.]]
            @in cur2: const(Efl.Canvas.Text.Cursor); [[Range end position.]]
         }
      }
      object_item_geometry_get {
         [[Queries a given object item for its geometry

           Note that the provided annotation should be an object item type.
         ]]
         legacy: null;
         params {
            @in an: const(Efl.Canvas.Text.Annotation)*; [[Given annotation to query]]
            @out x: Evas.Coord;
            @out y: Evas.Coord;
            @out w: Evas.Coord;
            @out h: Evas.Coord;
         }
         return: bool; [[$true if given annotation is an object item, $false otherwise]]
      }
   }
   implements {
      Efl.Object.constructor;
      Efl.Object.destructor;
      Efl.Object.dbg_info_get;
      Efl.Canvas.Object.paragraph_direction.set;
      Efl.Canvas.Object.paragraph_direction.get;
      Efl.Text.text.set;
      Efl.Text.text.get;
   }
   events {
      changed; [[The content (text or annotations) have changed.]]
   }
}