summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_widget_item.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_widget_item.eo')
-rw-r--r--src/lib/elementary/elm_widget_item.eo547
1 files changed, 0 insertions, 547 deletions
diff --git a/src/lib/elementary/elm_widget_item.eo b/src/lib/elementary/elm_widget_item.eo
deleted file mode 100644
index 7f221e2..0000000
--- a/src/lib/elementary/elm_widget_item.eo
+++ /dev/null
@@ -1,547 +0,0 @@
1import elm_general;
2import efl_ui;
3
4type Elm_Tooltip_Item_Content_Cb: __undefined_type; [[Elementary tooltip item content callback type]]
5type Elm_Object_Item_Signal_Cb: __undefined_type; [[Elementary object item signal callback type]]
6
7class Elm.Widget.Item extends Efl.Object implements Efl.Access.Object,
8 Efl.Access.Component
9{
10 [[Elementary widget item class]]
11 eo_prefix: elm_wdg_item;
12 legacy_prefix: elm_object_item;
13 methods {
14 @property tooltip_window_mode {
15 [[Control size restriction state of an object's tooltip
16
17 This function returns whether a tooltip is allowed to expand beyond
18 its parent window's canvas.
19 It will instead be limited only by the size of the display.]]
20 get {
21 }
22 set {
23 return: bool; [[$false on failure, $true on success]]
24 }
25 values {
26 disable: bool; [[If $true, size restrictions are disabled]]
27 }
28 }
29 @property tooltip_style {
30 [[Control a different style for this item tooltip.
31
32 Note: before you set a style you should define a tooltip with
33 @.tooltip_content_cb_set or
34 @.tooltip_text_set
35
36 See: elm_object_tooltip_style_set() for more details.]]
37 get {
38 }
39 set {
40 }
41 values {
42 style: string; [[The theme style used/to use (default, transparent, ...)]]
43 }
44 }
45 @property cursor {
46 [[Control the type of mouse pointer/cursor decoration to be shown,
47 when the mouse pointer is over the given item
48
49 This function works analogously as elm_object_cursor_set(), but
50 here the cursor's changing area is restricted to the item's
51 area, and not the whole widget's. Note that that item cursors
52 have precedence over widget cursors, so that a mouse over an
53 item with custom cursor set will always show that cursor.
54
55 If this function is called twice for an object, a previously set
56 cursor will be unset on the second call.]]
57 get {
58 }
59 set {
60 }
61 values {
62 cursor: string; [[The cursor type's name]]
63 }
64 }
65 @property cursor_style {
66 [[Control a different $style for a given custom cursor set for an item.
67
68 This function only makes sense when one is using custom mouse
69 cursor decorations defined in a theme file, which can have,
70 given a cursor name/type, alternate styles on it. It
71 works analogously as elm_object_cursor_style_set(), but here
72 applies only to item objects.
73
74 Warning: Before you set a cursor style you should have defined a
75 custom cursor previously on the item, with @.cursor.set]]
76 get {
77 }
78 set {
79 }
80 values {
81 style: string; [[The theme style to use/in use (e.g. $"default", $"transparent", etc)]]
82 }
83 }
84 @property cursor_engine_only {
85 [[Control if the (custom)cursor for a given item should be
86 searched in its theme, also, or should only rely on the
87 rendering engine.
88
89 Note: This call is of use only if you've set a custom cursor
90 for items, with @.cursor.set.
91
92 Note: By default, cursors will only be looked for between those
93 provided by the rendering engine.]]
94 get {
95 }
96 set {
97 }
98 values {
99 engine_only: bool; [[Use $true to have cursors looked for only on those provided by the rendering engine, $false to have them searched on the widget's theme, as well.]]
100 }
101 }
102 @property part_content {
103 [[Control a content of an object item
104
105 This sets a new object to an item as a content object. If any object was
106 already set as a content object in the same part, previous object will be
107 deleted automatically.]]
108 get {
109 }
110 set {
111 }
112 keys {
113 part: string @nullable; [[The content part name (NULL for the default content)]]
114 }
115 values {
116 content: Efl.Canvas.Object; [[The content of the object item]]
117 }
118 }
119 @property part_text {
120 [[Control a label of an object item
121
122 Note: Elementary object items may have many labels]]
123 get {
124 }
125 set {
126 }
127 keys {
128 part: string @nullable; [[The text part name (NULL for the default label)]]
129 }
130 values {
131 label: string; [[Text of the label]]
132 }
133 }
134 @property part_text_custom @protected {
135 get {
136 [[Get additional text part content]]
137 legacy: null;
138 }
139 set {
140 [[Save additional text part content]]
141 legacy: null;
142 }
143 keys {
144 part: string; [[Part name]]
145 }
146 values {
147 label: string; [[Label name]]
148 }
149 }
150 @property item_focus {
151 [[Control the object item focused
152
153 @since 1.10]]
154 get {
155 legacy: elm_object_item_focus_get;
156 }
157 set {
158 legacy: elm_object_item_focus_set;
159 }
160 values {
161 focused: bool; [[The focused state]]
162 }
163 }
164 @property style {
165 [[Control the style of an object item
166
167 @since 1.9]]
168 get {
169 }
170 set {
171 }
172 values {
173 style: string; [[The style of object item]]
174 }
175 }
176 @property disabled {
177 [[Control the disabled state of a widget item.
178
179 Elementary object item can be disabled, in which state they won't
180 receive input and, in general, will be themed differently from
181 their normal state, usually greyed out. Useful for contexts
182 where you don't want your users to interact with some of the
183 parts of you interface.
184
185 This sets the state for the widget item, either disabling it or
186 enabling it back.]]
187 get {
188 }
189 set {
190 }
191 values {
192 disable: bool; [[$true, if the widget item is disabled, $false if it's enabled (or on errors)]]
193 }
194 }
195 access_order_get {
196 [[Get highlight order
197
198 @since 1.8]]
199 return: const(list<Efl.Canvas.Object>); [[List of evas canvas objects]]
200 }
201 access_order_set {
202 [[Set highlight order
203
204 @since 1.8]]
205 params {
206 @in objs: list<Efl.Canvas.Object> @owned; [[Order of objects to pass highlight]]
207 }
208 }
209 widget_get @const {
210 [[Get the widget object's handle which contains a given item
211
212 Note: This returns the widget object itself that an item belongs to.
213 Note: Every elm_object_item supports this API]]
214 return: Efl.Canvas.Object; [[The widget object]]
215 }
216 pre_notify_del @protected {
217 [[notify deletion of widget item]]
218 legacy: null;
219 }
220 tooltip_text_set {
221 [[Set the text to be shown in a given object item's tooltips.
222
223 Setup the text as tooltip to object. The item can have only one tooltip,
224 so any previous tooltip data - set with this function or
225 @.tooltip_content_cb_set - is removed.
226
227 See: elm_object_tooltip_text_set() for more details.]]
228 params {
229 text: string; [[The text to set in the content.]]
230 }
231 }
232 tooltip_translatable_text_set @protected {
233 [[Set widget item tooltip as a text string]]
234 legacy: null;
235 params {
236 text: string; [[Tooltip text]]
237 }
238 }
239 tooltip_unset {
240 [[Unset tooltip from item.
241
242 Remove tooltip from item. The callback provided as del_cb to
243 @.tooltip_content_cb_set will be called to notify
244 it is not used anymore.
245
246 See: elm_object_tooltip_unset() for more details.
247 See: @.tooltip_content_cb_set]]
248 }
249 cursor_unset {
250 [[Unset any custom mouse pointer/cursor decoration set to be
251 shown, when the mouse pointer is over the given
252 item, thus making it show the default cursor again.
253
254 Use this call to undo any custom settings on this item's cursor
255 decoration, bringing it back to defaults (no custom style set).
256
257 See: elm_object_cursor_unset()
258 See: @.cursor.set]]
259 }
260 part_content_unset {
261 [[Unset a content of an object item
262
263 Note: Elementary object items may have many contents]]
264 params {
265 part: string; [[The content part name to unset (NULL for the default content)]]
266 }
267 return: Efl.Canvas.Object; [[Content object]]
268 }
269 part_text_custom_update @protected {
270 [[Update additional text part content]]
271 legacy: null;
272 }
273 signal_callback_add {
274 [[Add a callback for a signal emitted by object item edje.
275
276 This function connects a callback function to a signal emitted by the
277 edje object of the object item.
278 Globs can occur in either the emission or source name.
279
280 @since 1.8]]
281 params {
282 emission: string; [[The signal's name.]]
283 source: string; [[The signal's source.]]
284 func: Elm_Object_Item_Signal_Cb; [[The callback function to be executed when the signal is emitted.]]
285 data: void_ptr; [[A pointer to data to pass to the callback function.]]
286 }
287 }
288 signal_callback_del {
289 [[Remove a signal-triggered callback from a object item edje object.
290
291 This function removes the last callback, previously attached to
292 a signal emitted by an underlying Edje object of $it, whose
293 parameters $emission, $source and $func match exactly with
294 those passed to a previous call to
295 @.signal_callback_add. The data pointer that was passed
296 to this call will be returned.
297
298 See: @.signal_callback_add
299
300 @since 1.8]]
301 params {
302 emission: string; [[The signal's name.]]
303 source: string; [[The signal's source.]]
304 func: Elm_Object_Item_Signal_Cb; [[The callback function to be executed when the signal is emitted.]]
305 }
306 return: void_ptr; [[The data pointer of the signal callback or $NULL, on errors.]]
307 }
308 signal_emit {
309 [[Send a signal to the edje object of the widget item.
310
311 This function sends a signal to the edje object of the obj item. An
312 edje program can respond to a signal by specifying matching
313 'signal' and 'source' fields.
314 Don't use this unless you want to also handle resetting of part states to default on
315 every unrealize in case of genlist/gengrid.]]
316 params {
317 emission: string; [[The signal's name.]]
318 source: string; [[The signal's source.]]
319 }
320 }
321 access_info_set {
322 [[Set the text to read out when in accessibility mode]]
323 params {
324 txt: string; [[The text that describes the widget to people with poor or no vision]]
325 }
326 }
327 access_object_get @const {
328 [[Get an accessible object of the object item.
329
330 @since 1.8]]
331 return: Efl.Canvas.Object; [[Accessible object of the object item or NULL for any error]]
332 }
333 domain_translatable_part_text_set {
334 [[Set the text for an object item's part, marking it as translatable.
335
336 The string to set as $text must be the original one. Do not pass the
337 return of $gettext() here. Elementary will translate the string
338 internally and set it on the object item using
339 @.part_text.set, also storing the original string so that it
340 can be automatically translated when the language is changed with
341 elm_language_set(). The $domain will be stored along to find the
342 translation in the correct catalog. It can be NULL, in which case it will use
343 whatever domain was set by the application with $textdomain(). This is
344 useful in case you are building a library on top of Elementary that will have
345 its own translatable strings, that should not be mixed with those of programs
346 using the library.
347
348 @since 1.8]]
349 params {
350 part: string; [[The name of the part to set]]
351 domain: string; [[The translation domain to use]]
352 label: string; [[The original, non-translated text to set]]
353 }
354 }
355 translatable_part_text_get @const {
356 [[Get the original string set as translatable for an object item.
357
358 When setting translated strings, the function @.part_text.get
359 will return the translation returned by $gettext(). To get the original
360 string use this function.
361
362 @since 1.8]]
363 params {
364 part: string; [[The name of the part that was set]]
365 }
366 return: string; [[The original, untranslated string]]
367 }
368 translate @protected {
369 [[Query translate]]
370 legacy: null;
371 }
372 domain_part_text_translatable_set {
373 [[Mark the part text to be translatable or not.
374
375 Once you mark the part text to be translatable, the text will be translated
376 internally regardless of @.part_text.set and
377 @.domain_translatable_part_text_set. In other case, if you
378 set the Elementary policy that all text will be translatable in default, you
379 can set the part text to not be translated by calling this API.
380
381 See: @.domain_translatable_part_text_set
382 See: @.part_text.set
383 See: elm_policy()
384
385 @since 1.8]]
386 params {
387 part: string; [[The part name of the translatable text]]
388 domain: string; [[The translation domain to use]]
389 translatable: bool; [[$true, the part text will be translated internally. $false, otherwise.]]
390 }
391 }
392 track {
393 [[This returns track object of the item.
394
395 Note: This gets a rectangle object that represents the object item's internal
396 object. If you want to check the geometry, visibility of the item, you
397 can call the evas apis such as evas_object_geometry_get(),
398 evas_object_visible_get() to the track object. Note that all of the
399 widget items may/may not have the internal object so this api may
400 return $NULL if the widget item doesn't have it. Additionally, the
401 widget item is managed/controlled by the widget, the widget item could
402 be changed(moved, resized even deleted) anytime by it's own widget's
403 decision. So please dont' change the track object as well as don't
404 keep the track object in your side as possible but get the track object
405 at the moment you need to refer. Otherwise, you need to add some
406 callbacks to the track object to track it's attributes changes.
407
408 Warning: After use the track object, please call the
409 @.untrack() paired to elm_object_item_track
410 definitely to free the track object properly. Don't delete the
411 track object.
412
413 See: @.untrack
414 See: @.track_get
415
416 @since 1.8]]
417 return: Efl.Canvas.Object; [[The track object]]
418 }
419 untrack {
420 [[This retrieve the track object of the item.
421
422 Note: This retrieves the track object that was returned from
423 @.track.
424
425 See: @.track
426 See: @.track_get
427
428 @since 1.8]]
429 }
430 track_get @const {
431 [[Get the track object reference count.
432
433 Note: This gets the reference count for the track object. Whenever you call
434 the @.track, the reference count will be increased by
435 one. Likely the reference count will be decreased again when you call
436 the @.untrack. Unless the reference count reaches to
437 zero, the track object won't be deleted. So please be sure to call
438 @.untrack() paired to the elm_object_item_track call
439 count.
440
441 See: @.track
442 See: @.track_get
443
444 @since 1.8]]
445 return: int; [[Track object reference count]]
446 }
447 track_cancel @protected {
448 [[Query track_cancel]]
449 legacy: null;
450 }
451 del_cb_set {
452 [[Set the function to be called when an item from the widget is
453 freed.
454
455 Note: Every elm_object_item supports this API]]
456 params {
457 del_cb: Evas_Smart_Cb @nullable; [[The function called]]
458 }
459 }
460 tooltip_content_cb_set {
461 [[Set the content to be shown in the tooltip item.
462
463 Setup the tooltip to item. The item can have only one tooltip,
464 so any previous tooltip data is removed. $func(with $data) will
465 be called every time that need show the tooltip and it should
466 return a valid Evas_Object. This object is then managed fully by
467 tooltip system and is deleted when the tooltip is gone.
468
469 See: elm_object_tooltip_content_cb_set() for more details.]]
470 params {
471 func: Elm_Tooltip_Item_Content_Cb @nullable; [[The function used to create the tooltip contents.]]
472 data: const(void_ptr) @optional; [[What to provide to $func as callback data/context.]]
473 del_cb: Evas_Smart_Cb @optional; [[Called when data is not needed anymore, either when another callback replaces $func, the tooltip is unset with @.tooltip_unset or the owner $item dies. This callback receives as the first parameter the given $data, and $event_info is the item.]]
474
475 }
476 }
477 access_register {
478 [[Register object item as an accessible object.
479
480 @since 1.8]]
481 return: Efl.Canvas.Object; [[Accessible object of the object item or NULL for any error]]
482 }
483 access_unregister {
484 [[Unregister accessible object of the object item.
485
486 @since 1.8]]
487 }
488 access_order_unset {
489 [[Unset highlight order
490
491 @since 1.8]]
492 }
493 disable @protected {
494 [[Disable widget item]]
495 legacy: null;
496 }
497 del_pre @protected {
498 [[Delete pre widget item]]
499 legacy: null;
500 }
501 focus_next_object_get @const {
502 [[Get the next object with specific focus direction.
503
504 @since 1.16]]
505 params {
506 dir: Efl.Ui.Focus.Direction; [[Focus direction]]
507 }
508 return: Efl.Canvas.Object; [[Focus next object]]
509 }
510 focus_next_object_set {
511 [[Set the next object with specific focus direction.
512
513 @since 1.16]]
514 params {
515 next: Efl.Canvas.Object @nullable; [[Focus next object]]
516 dir: Efl.Ui.Focus.Direction; [[Focus direction]]
517 }
518 }
519 focus_next_item_get @const {
520 [[Get the next object item with specific focus direction.
521
522 @since 1.16]]
523 params {
524 dir: Efl.Ui.Focus.Direction; [[Focus direction]]
525 }
526 return: Elm.Widget.Item; [[Focus next object item]]
527 }
528 focus_next_item_set {
529 [[Set the next object item with specific focus direction.
530
531 @since 1.16]]
532 params {
533 next_item: Elm.Widget.Item @nullable; [[Focus next object item]]
534 dir: Efl.Ui.Focus.Direction; [[Focus direction]]
535 }
536 }
537 }
538 implements {
539 Efl.Object.constructor;
540 Efl.Object.destructor;
541 Efl.Object.invalidate;
542 Efl.Access.Object.state_set { get; }
543 Efl.Access.Object.attributes { get; }
544 Efl.Access.Component.extents { get; set; }
545 Efl.Access.Component.focus_grab;
546 }
547}
Copyright © Enlightenment.org