summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_gengrid_item.eo
blob: 32975723f428b92ac097a352fd55bbedeca359ff (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
import elm_general;

type @extern Elm.Gengrid.Item.Class: __undefined_type; [[External elm gengrid item class]]

enum Elm.Gengrid.Item.Scrollto_Type
{
   [[Defines where to position the item in the genlist.]]
   legacy: elm_gengrid_item_scrollto;
   none = 0,   [[No scrollto.]]
   in = (1 << 0),   [[To the nearest viewport.]]
   top = (1 << 1),   [[To the top of viewport.]]
   middle = (1 << 2),   [[To the middle of viewport.]]
   bottom = (1 << 3)   [[To the bottom of viewport.]]
}

enum Elm.Gengrid.Item.Field_Type
{
   [[Defines the type of the item part Used while updating item's parts.
     It can be used at updating multi fields.]]
   legacy: elm_gengrid_item_field;
   all = 0, [[Type all]]
   text = (1 << 0), [[Type text]]
   content = (1 << 1), [[Type content]]
   state = (1 << 2) [[Type state]]
}


class Elm.Gengrid.Item(Elm.Widget.Item.Static_Focus, Efl.Ui.Focus.Object, Efl.Ui.Legacy)
{
      [[Elementary gengrid item class]]
      legacy_prefix: elm_gengrid_item;
      eo_prefix: elm_obj_gengrid_item;
      data: Elm_Gen_Item;
      methods {
           @property prev {
                get {
                     [[Get the previous item in a gengrid widget's internal list of items, given a handle to one of those items.

                       This returns the item placed before the $item, on the container
                       gengrid.]]
                }
                values {
                     item: Elm.Widget.Item; [[The item before $item, or $NULL if there's none (and on errors)]]
                }
           }
           @property next {
                get {
                     [[Get the next item in a gengrid widget's internal list of items,
                       given a handle to one of those items.

                       This returns the item placed after the $item, on the container
                       gengrid.]]
                }
                values {
                     item: Elm.Widget.Item; [[The item after $item, or $NULL if there's none (and on errors)]]
                }
           }
           @property selected {
                [[Control whether a given gengrid item is selected or not

                  This API returns true for all the items selected in multi-select mode as well.

                  This sets the selected state of an item. If multi-selection is
                  not enabled on the containing gengrid and $selected is
                  true, any other previously selected items will get
                  unselected in favor of this new one.]]
                get {
                }
                set {
                }
                values {
                     selected: bool; [[The selected state ($true selected, $false not selected)]]
                }
           }
           @property item_class {
                get {
                     [[Get the Gengrid Item class for the given Gengrid Item.

                       This returns the Gengrid_Item_Class for the given item. It can be used to examine
                       the function pointers and item_style.]]
                }
                values {
                     @cref itc: Elm.Gengrid.Item.Class; [[Gengrid Item class for the given item]]
                }
           }
           @property index {
                get {
                     [[Get the index of the item. It is only valid once displayed.]]
                }
                values {
                     index: int(-1); [[The position inside the list of item.]]
                }
           }
           @property pos {
                get {
                     [[Get a given gengrid item's position, relative to the whole gengrid's grid area.

                       This returns the "logical" position of the item within the
                       gengrid. For example, $(0, 1) would stand for first row,
                       second column.]]
                }
                values {
                     x: uint; [[Pointer to variable to store the item's <b>row number</b>.]]
                     y: uint; [[Pointer to variable to store the item's <b>column number</b>.]]
                }
           }
           @property select_mode {
                [[Control the gengrid item's select mode.

                  (If getting mode fails, it returns ELM_OBJECT_SELECT_MODE_MAX)

                  elm_gengrid_select_mode_set() changes item's select mode.
                  - ELM_OBJECT_SELECT_MODE_DEFAULT : The item will only call their selection func and
                       callback when first becoming selected. Any further clicks will
                       do nothing, unless you set always select mode.
                  - ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
                       every click will make the selected callbacks be called.
                  - ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select the item
                       entirely and they will neither appear selected nor call selected
                       callback functions.
                  - ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY : This will apply no-finger-size rule
                       with ELM_OBJECT_SELECT_MODE_NONE. No-finger-size rule makes an item can be
                       smaller than lower limit. Clickable objects should be bigger than
                       human touch point device (your finger) for some touch or
                       small screen devices. So it is enabled, the item can be shrink than
                       predefined finger-size value. And the item will be updated.]]
                get {
                }
                set {
                }
                values {
                     mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The selected mode]]
                }
           }
           @property custom_size {
                [[Custom size mode for non-homogeneous gengrid. ]]
                get {
                     [[Get the dimensions of a gengrid item.

                       Gives the dimensions set with elm_gengrid_item_custom_size_set(). If the item
                       has not been modified values set with elm_gengrid_item_size_set() are obtained.

                       @since 1.19]]
                }
                set {
                     [[Resize dimensions of a gengrid item.

                       In case of a horizontal grid, only the widths only be resized and
                       in case of vertical only the heights can be resized. Item size
                       should be set by elm_gengrid_item_size_set() beforehand.

                       The values set by elm_gengrid_item_size_set() will be used for the
                       dimension that remains fixed.

                       @since 1.19]]
                }
                values {
                     w : int; [[The item's width.]]
                     h : int; [[The item's height.]]
                }
           }
           /*      init { FIXME
                   params {
                   Evas_Smart_Cb func;
                   const(void_ptr) data;
                   }
                   }*/
           show {
                [[Show the portion of a gengrid's internal grid containing a given
                  item, immediately.

                  This causes gengrid to redraw its viewport's contents to the
                  region containing the given $item item, if it is not fully
                  visible.]]
                params {
                     @in type: Elm.Gengrid.Item.Scrollto_Type; [[Where to position the item in the viewport.]]
                }
           }
           bring_in {
                [[Animatedly bring in, to the visible area of a gengrid, a given item on it.

                  This causes gengrid to jump to the given $item and show
                  it (by scrolling), if it is not fully visible. This will use
                  animation to do so and take a period of time to complete.]]
                params {
                     @in type: Elm.Gengrid.Item.Scrollto_Type; [[Where to position the item in the viewport.]]
                }
           }
           update {
                [[Update the contents of a given gengrid item

                  This updates an item by calling all the item class functions
                  again to get the contents, texts and states. Use this when the
                  original item data has changed and you want the changes to be
                  reflected.]]
           }
           fields_update {
                [[Update the part of an item

                  This updates an item's part by calling item's fetching functions again
                  to get the contents, texts and states. Use this when the original
                  item data has changed and the changes are desired to be reflected.
                  Second parts argument is used for globbing to match '*', '?', and '.'
                  It can be used at updating multi fields.

                  Use elm_gengrid_realized_items_update() to update an item's all
                  property.

                  @since 1.15]]
                params {
                     @in parts: string; [[The name of item's part]]
                     @in itf: Elm.Gengrid.Item.Field_Type; [[The type of item's part type]]
                }
           }
           item_class_update {
                [[Update the item class of a gengrid item.

                  This sets another class of the item, changing the way that it is
                  displayed. After changing the item class, elm_gengrid_item_update() is
                  called on the item $it.]]
                params {
                     @cref itc: Elm.Gengrid.Item.Class; [[The gengrid item class describing the function pointers and the item style.]]
                }
           }
           all_contents_unset{

                 [[Unset all contents fetched by the item class

                 This instructs gengrid to release references to contents in the item,
                 meaning that they will no longer be managed by gengrid and are
                 floating "orphans" that can be re-used elsewhere if the user wants
                 to.

                 @since 1.18
                 ]]
                params {
                     @out l: list<Efl.Canvas.Object> @owned; [[The contents list to return.]]
                }
           }
      }
      implements {
           Efl.Object.constructor;
           Elm.Widget.Item.del_pre;
           Elm.Widget.Item.disable;
           Elm.Widget.Item.signal_emit;
           Elm.Widget.Item.focus { get; set; }
           Elm.Widget.Item.part_text { get; }
           Elm.Widget.Item.part_content { get; }
           Elm.Widget.Item.tooltip_text_set;
           Elm.Widget.Item.tooltip_style { get; set; }
           Elm.Widget.Item.tooltip_window_mode { get; set; }
           Elm.Widget.Item.tooltip_content_cb_set;
           Elm.Widget.Item.tooltip_unset;
           Elm.Widget.Item.cursor { set; }
           Elm.Widget.Item.cursor_unset;
           Efl.Access.name { get; }
           Efl.Access.state_set { get; }
           Efl.Ui.Focus.Object.prepare_logical;
      }
}