summaryrefslogtreecommitdiff
path: root/src/lib/elm_prefs_eo.h
blob: 72ebcc3895b2848634f2982b0db16b327df3fad0 (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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
#define ELM_OBJ_PREFS_CLASS elm_obj_prefs_class_get()

const Eo_Class *elm_obj_prefs_class_get(void) EINA_CONST;

extern EAPI Eo_Op ELM_OBJ_PREFS_BASE_ID;

enum
{
   ELM_OBJ_PREFS_SUB_ID_FILE_SET,
   ELM_OBJ_PREFS_SUB_ID_FILE_GET,
   ELM_OBJ_PREFS_SUB_ID_DATA_SET,
   ELM_OBJ_PREFS_SUB_ID_DATA_GET,
   ELM_OBJ_PREFS_SUB_ID_AUTOSAVE_SET,
   ELM_OBJ_PREFS_SUB_ID_AUTOSAVE_GET,
   ELM_OBJ_PREFS_SUB_ID_RESET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_VALUE_SET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_VALUE_GET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_OBJECT_GET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_VISIBLE_SET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_VISIBLE_GET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_DISABLED_SET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_DISABLED_GET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_EDITABLE_SET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_EDITABLE_GET,
   ELM_OBJ_PREFS_SUB_ID_ITEM_SWALLOW,
   ELM_OBJ_PREFS_SUB_ID_ITEM_UNSWALLOW,
   ELM_OBJ_PREFS_SUB_ID_LAST
};

#define ELM_OBJ_PREFS_ID(sub_id) (ELM_OBJ_PREFS_BASE_ID + sub_id)

/**
 * @def elm_obj_prefs_file_set
 *
 * Set file and page to populate a given prefs widget's interface.
 *
 * @param[in] file
 * @param[in] page
 * @param[out] ret
 *
 * @see elm_prefs_file_set()
 *
 * @since 1.8
 */
#define elm_obj_prefs_file_set(file, page, ret)          \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_FILE_SET), \
        EO_TYPECHECK(const char *, file),                \
        EO_TYPECHECK(const char *, page),                \
        EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_prefs_file_get
 *
 * Retrieve file and page bound to a given prefs widget.
 *
 * @param[out] file
 * @param[out] page
 * @param[out] ret
 *
 * @see elm_prefs_file_get()
 *
 * @since 1.8
 */
#define elm_obj_prefs_file_get(file, page, ret)          \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_FILE_GET), \
        EO_TYPECHECK(const char **, file),               \
        EO_TYPECHECK(const char **, page),               \
        EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_prefs_data_set
 *
 * Set user data for a given prefs widget
 *
 * @param[in] data
 * @param[out] ret
 *
 * @see elm_prefs_data_set()
 *
 * @since 1.8
 */
#define elm_obj_prefs_data_set(data, ret)                \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_DATA_SET), \
        EO_TYPECHECK(Elm_Prefs_Data *, data),            \
        EO_TYPECHECK(Eina_Bool *, ret)
//FIXME: prefs_data == eobject?

/**
 * @def elm_obj_prefs_data_get
 *
 * Retrieve user data for a given prefs widget
 *
 * @param[out] ret
 *
 * @see elm_prefs_data_get()
 *
 * @since 1.8
 */
#define elm_obj_prefs_data_get(ret)                      \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_DATA_GET), \
        EO_TYPECHECK(Elm_Prefs_Data **, ret)

/**
 * @def elm_obj_prefs_autosave_set
 *
 * Set whether a given prefs widget should save its values back (on
 * the user data file, if set) automatically on every UI element
 * changes.
 *
 * @param[in] autosave
 *
 * @see elm_prefs_autosave_get()
 *
 * @since 1.8
 */
#define elm_obj_prefs_autosave_set(autosave)                 \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_AUTOSAVE_SET), \
        EO_TYPECHECK(Eina_Bool, autosave)

/**
 * @def elm_obj_prefs_autosave_get
 *
 * Get whether a given prefs widget is saving its values back
 * automatically on changes.
 *
 * @param[out] ret
 *
 * @see elm_prefs_autosave_set()
 *
 * @since 1.8
 */
#define elm_obj_prefs_autosave_get(ret)                      \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_AUTOSAVE_GET), \
        EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_prefs_reset
 *
 * Reset the values of a given prefs widget to a previous state.
 *
 * @param[in] mode
 *
 * @since 1.8
 */
#define elm_obj_prefs_reset(mode)                     \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_RESET), \
        EO_TYPECHECK(Elm_Prefs_Reset_Mode, mode)

/**
 * @def elm_obj_prefs_item_value_set
 *
 * Set the value on a given prefs widget's item.
 *
 * @param[in] name
 * @param[in] value
 * @param[out] ret
 *
 * @see elm_prefs_item_value_get()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_value_set(name, value, ret)         \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_VALUE_SET), \
        EO_TYPECHECK(const char *, name),                      \
        EO_TYPECHECK(const Eina_Value *, value),               \
        EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_prefs_item_value_get
 *
 * Retrieve the value of a given prefs widget's item.
 *
 * @param[in] name
 * @param[out] value
 * @param[out] ret
 *
 * @see elm_prefs_item_value_set()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_value_get(name, value, ret)         \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_VALUE_GET), \
        EO_TYPECHECK(const char *, name),                      \
        EO_TYPECHECK(Eina_Value *, value),                     \
        EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_prefs_item_object_get
 *
 * Retrieve the Elementary widget bound to a given prefs widget's
 * item.
 *
 * @param[in] name
 * @param[out] ret
 *
 * @see elm_prefs_item_value_get()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_object_get(name, ret)                \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_OBJECT_GET), \
        EO_TYPECHECK(const char *, name),                       \
        EO_TYPECHECK(const Evas_Object **, ret) //FIXME: return EObject?

/**
 * @def elm_obj_prefs_item_visible_set
 *
 * Set whether the widget bound to given prefs widget's item should be
 * visible or not.
 *
 * @param[in] name
 * @param[in] visible
 *
 * @see elm_prefs_item_visible_set()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_visible_set(name, visible)            \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_VISIBLE_SET), \
        EO_TYPECHECK(const char *, name),                        \
        EO_TYPECHECK(Eina_Bool, visible)

/**
 * @def elm_obj_prefs_item_visible_get
 *
 * Retrieve whether the widget bound to a given prefs widget's item is
 * visible or not.
 *
 * @param[in] name
 * @param[out] ret
 *
 * @see elm_prefs_item_visible_get()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_visible_get(name, ret)                \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_VISIBLE_GET), \
        EO_TYPECHECK(const char *,name),                         \
        EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_prefs_item_disabled_set
 *
 * Set whether the widget bound to a given prefs widget's item is
 * disabled or not.
 *
 * @param[in] name
 * @param[in] disabled
 *
 * @see elm_prefs_item_disabled_set()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_disabled_set(name, disabled)           \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_DISABLED_SET), \
        EO_TYPECHECK(const char *, name),                         \
        EO_TYPECHECK(Eina_Bool, disabled)

/**
 * @def elm_obj_prefs_item_disabled_get
 *
 * Retrieve whether the widget bound to a given prefs widget's item is
 * disabled or not.
 *
 * @param[in] name
 * @param[out] ret
 *
 * @see elm_prefs_item_disabled_get()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_disabled_get(name, ret)                \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_DISABLED_GET), \
        EO_TYPECHECK(const char *, name),                         \
        EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_prefs_item_editable_set
 *
 * Set whether the widget bound to a given prefs widget's item is
 * editable or not.
 *
 * @param[in] name
 * @param[in] editable
 *
 * @see elm_prefs_item_editable_set()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_editable_set(name, editable)           \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_EDITABLE_SET), \
        EO_TYPECHECK(const char *, name),                         \
        EO_TYPECHECK(Eina_Bool, editable)

/**
 * @def elm_obj_prefs_item_editable_get
 *
 * Retrieve whether the widget bound to a given prefs widget's item is
 * editable or not.
 *
 * @param[in] name
 * @param[out] ret
 *
 * @see elm_prefs_item_editable_get()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_editable_get(name, ret)                \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_EDITABLE_GET), \
        EO_TYPECHECK(const char *, name),                         \
        EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_prefs_item_swallow
 *
 * "Swallows" an object into a SWALLOW item of a prefs widget.
 *
 * @param[in] name
 * @param[in] child
 * @param[out] ret
 *
 * @see elm_prefs_item_swallow()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_swallow(name, child, ret)         \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_SWALLOW), \
        EO_TYPECHECK(const char *, name),                    \
        EO_TYPECHECK(Evas_Object *, child),                  \
        EO_TYPECHECK(Eina_Bool *, ret)
//FIXME: child == EObject?

/**
 * @def elm_obj_prefs_item_unswallow
 *
 * Unswallow an object from a SWALLOW item of a prefs widget.
 *
 * @param[in] name
 * @param[out] ret
 *
 * @see elm_prefs_item_unswallow()
 *
 * @since 1.8
 */
#define elm_obj_prefs_item_unswallow(name, ret)                \
        ELM_OBJ_PREFS_ID(ELM_OBJ_PREFS_SUB_ID_ITEM_UNSWALLOW), \
        EO_TYPECHECK(const char *,name),                       \
        EO_TYPECHECK(Evas_Object **, ret)
//FIXME: ret == EObject?