summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_general.eot
blob: 5e2fb0dbc810adcd5c45ad9e852d5c5df7b158a6 (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
struct Elm.Event.Policy_Changed
{
   [[Data on the event when an Elementary policy has changed]]
   policy: uint; [[the policy identifier]]
   new_value: int; [[value the policy had before the change]]
   old_value: int; [[new value the policy got]]
}

/* FIXME: These shouldn't be here, we don't do functions in eolian!!! */
type Elm_Gen_Item_Text_Get_Cb: __undefined_type;
type Elm_Gen_Item_Content_Get_Cb: __undefined_type;
type Elm_Gen_Item_State_Get_Cb: __undefined_type;
type Elm_Gen_Item_Del_Cb: __undefined_type;
type Elm_Gen_Item_Filter_Get_Cb: __undefined_type;
type Elm_Gen_Item_Reusable_Content_Get_Cb: __undefined_type;
type Elm_Tooltip_Item_Content_Cb: __undefined_type;
type Elm_Object_Item_Signal_Cb: __undefined_type;
type Elm_Event_Cb: __undefined_type;
type Evas_Smart_Cb: __undefined_type;
type Eina_Compare_Cb: __undefined_type;

/* FIXME: This shouldn't be here, we don't do functions in eolian!!! */
struct Elm.Gen.Item.Class.Functions
{
   [[Elementary genlist/gengrid callback functions data structure]]
   text_get: Elm_Gen_Item_Text_Get_Cb; [[ Text fetching class function for
                                          genlist/gengrid item classes. ]]
   content_get: Elm_Gen_Item_Content_Get_Cb; [[ Content fetching class function
                                                for genlist/gengrid item classes. ]]
   state_get: Elm_Gen_Item_State_Get_Cb; [[ State fetching class function for
                                            genlist/gengrid item classes. ]]
   del: Elm_Gen_Item_Del_Cb; [[ Deletion class function for genlist/gengrid
                                item classes. ]]
   filter_get: Elm_Gen_Item_Filter_Get_Cb;  [[ Filter seeking class function for
                                               genlist/gengrid item classes. ]]
   reusable_content_get: Elm_Gen_Item_Reusable_Content_Get_Cb; [[ Reusable content get class
                                                                  function for gen item classes. ]]

}

struct Elm.Gen.Item.Class
{
   [[ Gengrid or Genlist item class definition. ]]
   version: int; [[Set by elementary if you alloc an item class using
                   elm_genlist/gengrid_item_class_new(), or if you set your own
                   class (must be const) then set it to
                   ELM_GENLIST/GENGRID_ITEM_CLASS_VERSION. ]]
   refcount: uint; [[ Set it to 0 if you use your own const class, or
                              its managed for you by class ref/unref calls. ]]
   delete_me: bool; [[ Leave this alone - set it to 0 if you have a
                               const class of your own. ]]
   item_style: const(char) *; [[ Name of the visual style to use for this item.
                                If you don't know use "default". ]]
   decorate_item_style: const(char) *; [[ Style used if item is set to a decorate
                                         mode. see elm_genlist_item_decorate_mode_set()
                                         or NULL if you don't care. currently
                                         it's used only in genlist. ]]
   decorate_all_item_style: const(char) *; [[ Style to use when in edit mode, or
                                             NULL if you don't care. Currently
                                             it's used only in genlist. ]]
   func: Elm.Gen.Item.Class.Functions; [[ Set of callbacks ]]
}

type Elm.Gengrid.Item.Class: Elm.Gen.Item.Class; [[ See @Elm.Gen.Item.Class. ]]

type Elm.Genlist.Item.Class: Elm.Gen.Item.Class; [[ See @Elm.Gen.Item.Class. ]]

enum Elm.Glob.Match_Flags
{
   [[Glob matching bitfiled flags. @since 1.11]]
   legacy: elm_glob_match;
   no_escape = (1 << 0), [[Treat backslash as an ordinary character instead of escape]]
   path = (1 << 1), [[Match a slash in string only with a slash in pattern and not by
                      an asterisk (*) or a question mark (?) metacharacter, nor by a
                      bracket expression ([]) containing a slash.]]
   period = (1 << 2), [[Leading  period in string has to be matched exactly by a period
                        in pattern. A period is considered to be leading if it is the
                        first character in string, or if both ELM_GLOB_MATCH_PATH is
                        set and the period immediately follows a slash.]]
   nocase = (1 << 3), [[The pattern is matched case-insensitively.]]
}

enum Elm.Policy
{
   [[Policy identifiers.]]
   quit, [[under which circumstances the application should quit automatically.
           See also @Elm.Policy.quit.]]
   exit, [[defines elm_exit() behaviour. See also @Elm.Policy.exit.

           @since 1.8
         ]]
   throttle, [[defines how throttling should work. See also @Elm.Policy.throttle

               @since 1.8
             ]]
   last [[Sentinel value to indicate last enum field during iteration]]
}

enum Elm.Policy.Quit
{
   [[Possible values for the #ELM_POLICY_QUIT policy]]
   none = 0, [[never quit the application automatically]]
   last_window_closed, [[quit when the application's last window is closed]]
   last_window_hidden [[quit when the application's last window is hidden

                        @since 1.14]]
}

enum Elm.Policy.Exit
{
   [[Possible values for the #ELM_POLICY_EXIT policy.

     @since 1.8
   ]]
   none = 0, [[just quit the main loop on elm_exit()]]
   windows_del [[delete all the windows after quitting the main loop]]
}

enum Elm.Policy.Throttle
{
   [[Possible values for the #ELM_POLICY_THROTTLE policy.

     @since 1.8
   ]]
   config = 0, [[do whatever elementary config is configured to do]]
   hidden_always, [[always throttle when all windows are no longer visible]]
   never [[never throttle when windows are all hidden, regardless of config
           settings]]
}

enum Elm.Object.Select_Mode
{
   [[Possible values for the #ELM_OBJECT_SELECT_MODE policy.

     @since 1.7
   ]]
   default = 0, [[default select mode. Once an item is selected, it would stay
                  highlighted and not going to call selected callback again
                  even it was clicked. Items can get focus.]]
   always, [[always select mode. Item selected callbacks will be called every
             time for click events, even after the item was already selected.
             Items can get focus.]]
   none, [[no select mode. Items will never be highlighted and selected but
           the size will be adjusted by the finger size configuration. Items
           can't get focus.]]
   display_only, [[no select mode with no finger size rule. Items will never
                   be highlighted and selected and ignore the finger size. So
                   the item size can be reduced below than the finger size
                   configuration. Items can't get focus.]]
   max [[canary value: any value greater or equal to ELM_OBJECT_SELECT_MODE_MAX
         is forbidden.]]
}

enum Elm.Object.Multi_Select_Mode
{
   [[Possible values for the #ELM_OBJECT_MULTI_SELECT_MODE policy.

     @since 1.8
   ]]
   default = 0, [[default multiple select mode]]
   with_control, [[disallow mutiple selection when clicked without control key
                   pressed]]
   max [[canary value: any value greater or equal to
         ELM_OBJECT_MULTI_SELECT_MODE_MAX is forbidden.]]
}

enum Elm.Wrap.Type
{
   [[Line wrapping types.
     Type of word or character wrapping to use.

     See also \@ref elm_entry_line_wrap_set, \@ref
     elm_popup_content_text_wrap_type_set, \@ref elm_label_line_wrap_set.
   ]]

   legacy: elm_wrap;
   none = 0, [[No wrap - value is zero.]]
   char,     [[Char wrap - wrap between characters.]]
   word,     [[Word wrap - wrap in allowed wrapping points (as defined in the unicode standard).]]
   mixed,    [[Mixed wrap - Word wrap, and if that fails, char wrap.]]
   last      [[Sentinel value to indicate last enum field during iteration]]
}

enum Elm.Focus_Direction
{
   [[ Focus directions. ]]
   legacy: elm_focus;
   previous, [[ previous direction ]]
   next,     [[ next direction ]]
   up,       [[ up direction ]]
   down,     [[ down direction ]]
   right,    [[ right direction ]]
   left,     [[ left direction ]]
}

enum Elm.Focus.Region.Show_Mode
{
   [[Focus region show mode.]]
   legacy: elm_focus_region_show;
   widget, [[As a widget.]]
   item, [[As an item.]]
}

enum Efl.Ui.Focus.Move_Policy
{
   [[Focus Movement Policy.
     @since 1.10]]
   click, [[Move focus by mouse click or touch. Elementary focus is set on mouse
            click and this is checked at mouse up time. (default)]]
   in, [[Move focus by mouse in. Elementary focus is set on mouse move when the
         mouse pointer is moved into an object.]]
   key_only, [[Move focus by key. Elementary focus is set on key input like
               Left, Right, Up, Down, Tab, or Shift+Tab.]]
}

enum Elm.Prefs.Reset_Mode
{
   [[Modes of resetting a prefs widget.
     see elm_prefs_reset()
     @since 1.8]]
   legacy: elm_prefs_reset;
   defaults, [[reset to default values, declared in its <b>.epb</b> file]]
   last [[prefs will keep a small history of changes, so this  resets back to last batch of changes on the UI elements. it does <b>not</b> work on autosave mode]]
}

enum Elm.Prefs.Item_Type
{
   [[Elm Prefs item types.
     @since 1.8]]
   legacy: elm_prefs_type;
   unknown = 0, [[Unknown type]]
   action, [[action type, bound to button-like UI elements]]
   bool, [[boolean type, bound to checkbox-like UI elements]]
   int, [[integer type, bound to spinner-like UI elements]]
   float, [[floating point type, bound to spinner-like UI elements]]
   label, [[label type, bound to read-only, label UI elements]]
   date, [[date type, bound to date selection UI elements]]
   text, [[text type, bound to single-line, text entry UI elements]]
   textarea, [[text area type, bound to multi-line, text entry UI elements]]
   page, [[page type, used to nest pages]]
   reset, [[values resetting trigger type, bound to button-like UI elements]]
   save, [[saving trigger type, bound to button-like UI elements]]
   separator, [[separator type, bound to separator-like UI elements]]
   swallow [[swallow type, bound to an empty 'spot' on the UI meant to receive and display external content]]
}

enum Efl.Ui.Slider.Indicator_Visible_Mode
{
   [[Slider's indicator visiblity mode.

     @since 1.13
   ]]
   default,   [[show indicator on mouse down or change in slider value]]
   always,    [[Always show the indicator.]]
   on_focus,  [[Show the indicator on focus]]
   none       [[Never show the indicator ]]
}

enum Efl.Ui.Focus.Autoscroll_Mode
{
   [[Focus Autoscroll Mode

     @since 1.10
   ]]
   show,    [[Directly show the focused region or item automatically.]]
   none,    [[Do not show the focused region or item automatically.]]
   bring_in [[Bring in the focused region or item automatically which might invole the scrolling.]]
}

enum Efl.Ui.Softcursor_Mode
{
   [[Software cursor mode.

     @since 1.7
   ]]
   auto, [[Auto-detect if a software cursor should be used (default).]]
   on,   [[Always use a softcursor.]]
   off   [[Never use a softcursor.]]
}