summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_gengrid_item.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_gengrid_item.eo')
-rw-r--r--src/lib/elementary/elm_gengrid_item.eo236
1 files changed, 0 insertions, 236 deletions
diff --git a/src/lib/elementary/elm_gengrid_item.eo b/src/lib/elementary/elm_gengrid_item.eo
deleted file mode 100644
index 87ddbbc..0000000
--- a/src/lib/elementary/elm_gengrid_item.eo
+++ /dev/null
@@ -1,236 +0,0 @@
1import elm_general;
2
3class Elm.Gengrid.Item extends Elm.Widget.Item.Static_Focus implements Efl.Ui.Focus.Object, Efl.Ui.Legacy
4{
5 [[Elementary gengrid item class]]
6 legacy_prefix: elm_gengrid_item;
7 eo_prefix: elm_obj_gengrid_item;
8 data: Elm_Gen_Item;
9 methods {
10 @property prev {
11 get {
12 [[Get the previous item in a gengrid widget's internal list of items, given a handle to one of those items.
13
14 This returns the item placed before the $item, on the container
15 gengrid.]]
16 }
17 values {
18 item: Elm.Widget.Item; [[The item before $item, or $NULL if there's none (and on errors)]]
19 }
20 }
21 @property next {
22 get {
23 [[Get the next item in a gengrid widget's internal list of items,
24 given a handle to one of those items.
25
26 This returns the item placed after the $item, on the container
27 gengrid.]]
28 }
29 values {
30 item: Elm.Widget.Item; [[The item after $item, or $NULL if there's none (and on errors)]]
31 }
32 }
33 @property selected {
34 [[Control whether a given gengrid item is selected or not
35
36 This API returns true for all the items selected in multi-select mode as well.
37
38 This sets the selected state of an item. If multi-selection is
39 not enabled on the containing gengrid and $selected is
40 true, any other previously selected items will get
41 unselected in favor of this new one.]]
42 get {
43 }
44 set {
45 }
46 values {
47 selected: bool; [[The selected state ($true selected, $false not selected)]]
48 }
49 }
50 @property item_class {
51 get {
52 [[Get the Gengrid Item class for the given Gengrid Item.
53
54 This returns the Gengrid_Item_Class for the given item. It can be used to examine
55 the function pointers and item_style.]]
56 }
57 values {
58 @cref itc: Elm.Gengrid.Item.Class; [[Gengrid Item class for the given item]]
59 }
60 }
61 @property index {
62 get {
63 [[Get the index of the item. It is only valid once displayed.]]
64 }
65 values {
66 index: int(-1); [[The position inside the list of item.]]
67 }
68 }
69 @property pos {
70 get {
71 [[Get a given gengrid item's position, relative to the whole gengrid's grid area.
72
73 This returns the "logical" position of the item within the
74 gengrid. For example, $(0, 1) would stand for first row,
75 second column.]]
76 }
77 values {
78 x: uint; [[Pointer to variable to store the item's <b>row number</b>.]]
79 y: uint; [[Pointer to variable to store the item's <b>column number</b>.]]
80 }
81 }
82 @property select_mode {
83 [[Control the gengrid item's select mode.
84
85 (If getting mode fails, it returns ELM_OBJECT_SELECT_MODE_MAX)
86
87 elm_gengrid_select_mode_set() changes item's select mode.
88 - ELM_OBJECT_SELECT_MODE_DEFAULT : The item will only call their selection func and
89 callback when first becoming selected. Any further clicks will
90 do nothing, unless you set always select mode.
91 - ELM_OBJECT_SELECT_MODE_ALWAYS : This means that, even if selected,
92 every click will make the selected callbacks be called.
93 - ELM_OBJECT_SELECT_MODE_NONE : This will turn off the ability to select the item
94 entirely and they will neither appear selected nor call selected
95 callback functions.
96 - ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY : This will apply no-finger-size rule
97 with ELM_OBJECT_SELECT_MODE_NONE. No-finger-size rule makes an item can be
98 smaller than lower limit. Clickable objects should be bigger than
99 human touch point device (your finger) for some touch or
100 small screen devices. So it is enabled, the item can be shrink than
101 predefined finger-size value. And the item will be updated.]]
102 get {
103 }
104 set {
105 }
106 values {
107 mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The selected mode]]
108 }
109 }
110 @property custom_size {
111 [[Custom size mode for non-homogeneous gengrid. ]]
112 get {
113 [[Get the dimensions of a gengrid item.
114
115 Gives the dimensions set with elm_gengrid_item_custom_size_set(). If the item
116 has not been modified values set with elm_gengrid_item_size_set() are obtained.
117
118 @since 1.19]]
119 }
120 set {
121 [[Resize dimensions of a gengrid item.
122
123 In case of a horizontal grid, only the widths only be resized and
124 in case of vertical only the heights can be resized. Item size
125 should be set by elm_gengrid_item_size_set() beforehand.
126
127 The values set by elm_gengrid_item_size_set() will be used for the
128 dimension that remains fixed.
129
130 @since 1.19]]
131 }
132 values {
133 w : int; [[The item's width.]]
134 h : int; [[The item's height.]]
135 }
136 }
137 /* init { FIXME
138 params {
139 Evas_Smart_Cb func;
140 const(void_ptr) data;
141 }
142 }*/
143 show {
144 [[Show the portion of a gengrid's internal grid containing a given
145 item, immediately.
146
147 This causes gengrid to redraw its viewport's contents to the
148 region containing the given $item item, if it is not fully
149 visible.]]
150 params {
151 @in type: Elm.Gengrid.Item.Scrollto_Type; [[Where to position the item in the viewport.]]
152 }
153 }
154 bring_in {
155 [[Animatedly bring in, to the visible area of a gengrid, a given item on it.
156
157 This causes gengrid to jump to the given $item and show
158 it (by scrolling), if it is not fully visible. This will use
159 animation to do so and take a period of time to complete.]]
160 params {
161 @in type: Elm.Gengrid.Item.Scrollto_Type; [[Where to position the item in the viewport.]]
162 }
163 }
164 update {
165 [[Update the contents of a given gengrid item
166
167 This updates an item by calling all the item class functions
168 again to get the contents, texts and states. Use this when the
169 original item data has changed and you want the changes to be
170 reflected.]]
171 }
172 fields_update {
173 [[Update the part of an item
174
175 This updates an item's part by calling item's fetching functions again
176 to get the contents, texts and states. Use this when the original
177 item data has changed and the changes are desired to be reflected.
178 Second parts argument is used for globbing to match '*', '?', and '.'
179 It can be used at updating multi fields.
180
181 Use elm_gengrid_realized_items_update() to update an item's all
182 property.
183
184 @since 1.15]]
185 params {
186 @in parts: string; [[The name of item's part]]
187 @in itf: Elm.Gengrid.Item.Field_Type; [[The type of item's part type]]
188 }
189 }
190 item_class_update {
191 [[Update the item class of a gengrid item.
192
193 This sets another class of the item, changing the way that it is
194 displayed. After changing the item class, elm_gengrid_item_update() is
195 called on the item $it.]]
196 params {
197 @cref itc: Elm.Gengrid.Item.Class; [[The gengrid item class describing the function pointers and the item style.]]
198 }
199 }
200 all_contents_unset{
201
202 [[Unset all contents fetched by the item class
203
204 This instructs gengrid to release references to contents in the item,
205 meaning that they will no longer be managed by gengrid and are
206 floating "orphans" that can be re-used elsewhere if the user wants
207 to.
208
209 @since 1.18
210 ]]
211 params {
212 @out l: list<Efl.Canvas.Object> @owned; [[The contents list to return.]]
213 }
214 }
215 }
216 implements {
217 Efl.Object.constructor;
218 Elm.Widget.Item.del_pre;
219 Elm.Widget.Item.disable;
220 Elm.Widget.Item.signal_emit;
221 Elm.Widget.Item.item_focus { get; set; }
222 Elm.Widget.Item.part_text { get; }
223 Elm.Widget.Item.part_content { get; }
224 Elm.Widget.Item.tooltip_text_set;
225 Elm.Widget.Item.tooltip_style { get; set; }
226 Elm.Widget.Item.tooltip_window_mode { get; set; }
227 Elm.Widget.Item.tooltip_content_cb_set;
228 Elm.Widget.Item.tooltip_unset;
229 Elm.Widget.Item.cursor { set; }
230 Elm.Widget.Item.cursor_unset;
231 Efl.Access.Object.i18n_name { get; }
232 Efl.Access.Object.state_set { get; }
233 Efl.Ui.Focus.Object.setup_order_non_recursive;
234 Efl.Ui.Focus.Object.focus_parent { get; }
235 }
236}