summaryrefslogtreecommitdiff
path: root/src/lib/elm_image_eo.h
blob: 4a5358a8fcb67331f195835f56f1040488247947 (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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
/**
 * @ingroup Image
 *
 * @{
 */
#define ELM_OBJ_IMAGE_CLASS elm_obj_image_class_get()

const Eo_Class *elm_obj_image_class_get(void) EINA_CONST;

extern EAPI Eo_Op ELM_OBJ_IMAGE_BASE_ID;

enum
{
   ELM_OBJ_IMAGE_SUB_ID_ASPECT_FIXED_SET,
   ELM_OBJ_IMAGE_SUB_ID_ASPECT_FIXED_GET,

   ELM_OBJ_IMAGE_SUB_ID_EDITABLE_SET,
   ELM_OBJ_IMAGE_SUB_ID_EDITABLE_GET,

   ELM_OBJ_IMAGE_SUB_ID_FILE_SET,
   ELM_OBJ_IMAGE_SUB_ID_FILE_GET,

   ELM_OBJ_IMAGE_SUB_ID_SIZING_EVAL,

   ELM_OBJ_IMAGE_SUB_ID_SMOOTH_SCALE_SET,
   ELM_OBJ_IMAGE_SUB_ID_SMOOTH_SCALE_GET,

   ELM_OBJ_IMAGE_SUB_ID_FILL_INSIDE_SET,
   ELM_OBJ_IMAGE_SUB_ID_FILL_INSIDE_GET,

   ELM_OBJ_IMAGE_SUB_ID_FILL_OUTSIDE_SET,
   ELM_OBJ_IMAGE_SUB_ID_FILL_OUTSIDE_GET,

   ELM_OBJ_IMAGE_SUB_ID_OBJECT_GET,

   ELM_OBJ_IMAGE_SUB_ID_LOAD_SIZE_SET,
   ELM_OBJ_IMAGE_SUB_ID_LOAD_SIZE_GET,

   ELM_OBJ_IMAGE_SUB_ID_MEMFILE_SET,
   ELM_OBJ_IMAGE_SUB_ID_MMAP_SET,

   ELM_OBJ_IMAGE_SUB_ID_ORIENT_SET,
   ELM_OBJ_IMAGE_SUB_ID_ORIENT_GET,

   ELM_OBJ_IMAGE_SUB_ID_PRELOAD_DISABLED_SET,

   ELM_OBJ_IMAGE_SUB_ID_RESIZE_DOWN_SET,
   ELM_OBJ_IMAGE_SUB_ID_RESIZE_DOWN_GET,

   ELM_OBJ_IMAGE_SUB_ID_RESIZE_UP_SET,
   ELM_OBJ_IMAGE_SUB_ID_RESIZE_UP_GET,

   ELM_OBJ_IMAGE_SUB_ID_SCALE_SET,
   ELM_OBJ_IMAGE_SUB_ID_SCALE_GET,

   ELM_OBJ_IMAGE_SUB_ID_OBJECT_SIZE_GET,

   ELM_OBJ_IMAGE_SUB_ID_SMOOTH_SET,
   ELM_OBJ_IMAGE_SUB_ID_SMOOTH_GET,

   ELM_OBJ_IMAGE_SUB_ID_NO_SCALE_SET,
   ELM_OBJ_IMAGE_SUB_ID_NO_SCALE_GET,

   ELM_OBJ_IMAGE_SUB_ID_RESIZABLE_SET,
   ELM_OBJ_IMAGE_SUB_ID_RESIZABLE_GET,

   ELM_OBJ_IMAGE_SUB_ID_ANIMATED_AVAILABLE_GET,

   ELM_OBJ_IMAGE_SUB_ID_ANIMATED_SET,
   ELM_OBJ_IMAGE_SUB_ID_ANIMATED_GET,

   ELM_OBJ_IMAGE_SUB_ID_ANIMATED_PLAY_SET,
   ELM_OBJ_IMAGE_SUB_ID_ANIMATED_PLAY_GET,

   ELM_OBJ_IMAGE_SUB_ID_LAST
};

#define ELM_OBJ_IMAGE_ID(sub_id) (ELM_OBJ_IMAGE_BASE_ID + sub_id)


/**
 * @def elm_obj_image_memfile_set
 * @since 1.8
 *
 * Set a location in memory to be used as an image object's source
 *
 * @param[in] img
 * @param[in] size
 * @param[in] format
 * @param[in] key
 * @param[out] ret
 *
 * @see elm_image_memfile_set
 */
#define elm_obj_image_memfile_set(img, size, format, key, ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_MEMFILE_SET), EO_TYPECHECK(const void *, img), EO_TYPECHECK(size_t, size), EO_TYPECHECK(const char *, format), EO_TYPECHECK(const char *, key), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_file_set
 * @since 1.8
 *
 * Set the file that will be used as the image's source.
 *
 * @param[in] file
 * @param[in] group
 * @param[out] ret
 *
 * @see elm_image_file_set
 */
#define elm_obj_image_file_set(file, group, ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_FILE_SET), EO_TYPECHECK(const char *, file), EO_TYPECHECK(const char *, group), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_mmap_set
 * @since 1.8
 *
 * Set the file that will be used as the image's source.
 *
 * @param[in] file
 * @param[in] group
 * @param[out] ret
 *
 * @see elm_image_mmap_set
 */
#define elm_obj_image_mmap_set(file, group, ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_MMAP_SET), EO_TYPECHECK(const Eina_File *, file), EO_TYPECHECK(const char *, group), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_file_get
 * @since 1.8
 *
 * Get the file that will be used as image.
 *
 * @param[out] file
 * @param[out] group
 *
 * @see elm_image_file_get
 */
#define elm_obj_image_file_get(file, group) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_FILE_GET), EO_TYPECHECK(const char **, file), EO_TYPECHECK(const char **, group)

/**
 * @def elm_obj_image_smooth_set
 * @since 1.8
 *
 * Set the smooth effect for an image.
 *
 * @param[in] smooth
 *
 * @see elm_image_smooth_set
 */
#define elm_obj_image_smooth_set(smooth) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_SMOOTH_SET), EO_TYPECHECK(Eina_Bool, smooth)

/**
 * @def elm_obj_image_smooth_get
 * @since 1.8
 *
 * Get the smooth effect for an image.
 *
 * @param[out] ret
 *
 * @see elm_image_smooth_get
 */
#define elm_obj_image_smooth_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_SMOOTH_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_size_get
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[out] w
 * @param[out] h
 *
 * @see elm_image_size_get
 */
#define elm_obj_image_size_get(w, h) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_OBJECT_SIZE_GET), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h)

/**
 * @def elm_obj_image_no_scale_set
 * @since 1.8
 *
 * Disable scaling of this object.
 *
 * @param[in] no_scale
 *
 * @see elm_image_no_scale_set
 */
#define elm_obj_image_no_scale_set(no_scale) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_NO_SCALE_SET), EO_TYPECHECK(Eina_Bool, no_scale)

/**
 * @def elm_obj_image_no_scale_get
 * @since 1.8
 *
 * Get whether scaling is disabled on the object.
 *
 * @param[out] ret
 *
 * @see elm_image_no_scale_get
 */
#define elm_obj_image_no_scale_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_NO_SCALE_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_resizable_set
 * @since 1.8
 *
 * Set if the object is (up/down) resizable.
 *
 * @param[in] up
 * @param[in] down
 *
 * @see elm_image_resizable_set
 */
#define elm_obj_image_resizable_set(up, down) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_RESIZABLE_SET), EO_TYPECHECK(Eina_Bool, up), EO_TYPECHECK(Eina_Bool, down)

/**
 * @def elm_obj_image_resizable_get
 * @since 1.8
 *
 * Get if the object is (up/down) resizable.
 *
 * @param[out] size_up
 * @param[out] size_down
 *
 * @see elm_image_resizable_get
 */
#define elm_obj_image_resizable_get(size_up, size_down) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_RESIZABLE_GET), EO_TYPECHECK(Eina_Bool *, size_up), EO_TYPECHECK(Eina_Bool *, size_down)

/**
 * @def elm_obj_image_fill_outside_set
 * @since 1.8
 *
 * Set if the image fills the entire object area, when keeping the aspect ratio.
 *
 * @param[in] fill_outside
 *
 * @see elm_image_fill_outside_set
 */
#define elm_obj_image_fill_outside_set(fill_outside) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_FILL_OUTSIDE_SET), EO_TYPECHECK(Eina_Bool, fill_outside)

/**
 * @def elm_obj_image_fill_outside_get
 * @since 1.8
 *
 * Get if the object is filled outside
 *
 * @param[out] ret
 *
 * @see elm_image_fill_outside_get
 */
#define elm_obj_image_fill_outside_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_FILL_OUTSIDE_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_preload_disabled_set
 * @since 1.8
 *
 * Enable or disable preloading of the image
 *
 * @param[in] disabled
 *
 * @see elm_image_preload_disabled_set
 */
#define elm_obj_image_preload_disabled_set(disabled) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_PRELOAD_DISABLED_SET), EO_TYPECHECK(Eina_Bool, disabled)

/**
 * @def elm_obj_image_orient_set
 * @since 1.8
 *
 * Set the image orientation.
 *
 * @param[in] orient
 *
 * @see elm_image_orient_set
 */
#define elm_obj_image_orient_set(orient) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ORIENT_SET), EO_TYPECHECK(Elm_Image_Orient, orient)

/**
 * @def elm_obj_image_orient_get
 * @since 1.8
 *
 * Get the image orientation.
 *
 * @param[out] ret
 *
 * @see elm_image_orient_get
 */
#define elm_obj_image_orient_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ORIENT_GET), EO_TYPECHECK(Elm_Image_Orient *, ret)

/**
 * @def elm_obj_image_editable_set
 * @since 1.8
 *
 * Make the image 'editable'.
 *
 * @param[in] set
 *
 * @see elm_image_editable_set
 */
#define elm_obj_image_editable_set(set) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_EDITABLE_SET), EO_TYPECHECK(Eina_Bool, set)

/**
 * @def elm_obj_image_editable_get
 * @since 1.8
 *
 * Check if the image is 'editable'.
 *
 * @param[out] ret
 *
 * @see elm_image_editable_get
 */
#define elm_obj_image_editable_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_EDITABLE_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_object_get
 * @since 1.8
 *
 * Get the inlined image object of the image widget.
 *
 * @param[out] ret
 *
 * @see elm_image_object_get
 */
#define elm_obj_image_object_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_OBJECT_GET), EO_TYPECHECK(Evas_Object **, ret)

/**
 * @def elm_obj_image_aspect_fixed_set
 * @since 1.8
 *
 * Set whether the original aspect ratio of the image should be kept on resize.
 *
 * @param[in] fixed
 *
 * @see elm_image_aspect_fixed_set
 */
#define elm_obj_image_aspect_fixed_set(fixed) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ASPECT_FIXED_SET), EO_TYPECHECK(Eina_Bool, fixed)

/**
 * @def elm_obj_image_aspect_fixed_get
 * @since 1.8
 *
 * Get if the object retains the original aspect ratio.
 *
 * @param[out] ret
 *
 * @see elm_image_aspect_fixed_get
 */
#define elm_obj_image_aspect_fixed_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ASPECT_FIXED_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_animated_available_get
 * @since 1.8
 *
 * Get whether an image object supports animation or not.
 *
 * @param[out] ret
 *
 * @see elm_image_animated_available_get
 */
#define elm_obj_image_animated_available_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ANIMATED_AVAILABLE_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_animated_set
 * @since 1.8
 *
 * Set whether an image object (which supports animation) is to
 *
 * @param[in] anim
 *
 * @see elm_image_animated_set
 */
#define elm_obj_image_animated_set(anim) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ANIMATED_SET), EO_TYPECHECK(Eina_Bool, anim)

/**
 * @def elm_obj_image_animated_get
 * @since 1.8
 *
 * Get whether an image object has animation enabled or not.
 *
 * @param[out] ret
 *
 * @see elm_image_animated_get
 */
#define elm_obj_image_animated_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ANIMATED_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_animated_play_set
 * @since 1.8
 *
 * Start or stop an image object's animation.
 *
 * @param[in] play
 *
 * @see elm_image_animated_play_set
 */
#define elm_obj_image_animated_play_set(play) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ANIMATED_PLAY_SET), EO_TYPECHECK(Eina_Bool, play)

/**
 * @def elm_obj_image_animated_play_get
 * @since 1.8
 *
 * Get whether an image object is under animation or not.
 *
 * @param[out] ret
 *
 * @see elm_image_animated_play_get
 */
#define elm_obj_image_animated_play_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_ANIMATED_PLAY_GET), EO_TYPECHECK(Eina_Bool *, ret)

/**
 * @def elm_obj_image_sizing_eval
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 */
#define elm_obj_image_sizing_eval() ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_SIZING_EVAL)

/**
 * @def elm_obj_image_smooth_scale_set
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[in] smooth
 *
 * @see elm_image_smooth_scale_set
 */
#define elm_obj_image_smooth_scale_set(smooth) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_SMOOTH_SCALE_SET), EO_TYPECHECK(Eina_Bool, smooth)

/**
 * @def elm_obj_image_smooth_scale_get
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[out] ret
 *
 * @see elm_image_smooth_scale_get
 */
#define elm_obj_image_smooth_scale_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_SMOOTH_SCALE_GET), EO_TYPECHECK(Eina_Bool *, ret)


/**
 * @def elm_obj_image_fill_inside_set
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[in] fill_inside
 *
 * @see elm_image_fill_inside_set
 */
#define elm_obj_image_fill_inside_set(fill_inside) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_FILL_INSIDE_SET), EO_TYPECHECK(Eina_Bool, fill_inside)

/**
 * @def elm_obj_image_fill_inside_get
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[out] ret
 *
 * @see elm_image_fill_inside_get
 */
#define elm_obj_image_fill_inside_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_FILL_INSIDE_GET), EO_TYPECHECK(Eina_Bool *, ret)


/**
 * @def elm_obj_image_load_size_set
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[in] size
 *
 * @see elm_image_load_size_set
 */
#define elm_obj_image_load_size_set(size) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_LOAD_SIZE_SET), EO_TYPECHECK(int, size)

/**
 * @def elm_obj_image_load_size_get
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[out] ret
 *
 * @see elm_image_load_size_get
 */
#define elm_obj_image_load_size_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_LOAD_SIZE_GET), EO_TYPECHECK(int *, ret)


/**
 * @def elm_obj_image_resize_down_set
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[in] resize_down
 *
 * @see elm_image_resize_down_set
 */
#define elm_obj_image_resize_down_set(resize_down) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_RESIZE_DOWN_SET), EO_TYPECHECK(Eina_Bool, resize_down)

/**
 * @def elm_obj_image_resize_down_get
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[out] ret
 *
 * @see elm_image_resize_down_get
 */
#define elm_obj_image_resize_down_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_RESIZE_DOWN_GET), EO_TYPECHECK(Eina_Bool *, ret)


/**
 * @def elm_obj_image_resize_up_set
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[in] resize_up
 *
 * @see elm_image_resize_up_set
 */
#define elm_obj_image_resize_up_set(resize_up) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_RESIZE_UP_SET), EO_TYPECHECK(Eina_Bool, resize_up)

/**
 * @def elm_obj_image_resize_up_get
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[out] ret
 *
 * @see elm_image_resize_up_get
 */
#define elm_obj_image_resize_up_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_RESIZE_UP_GET), EO_TYPECHECK(Eina_Bool *, ret)


/**
 * @def elm_obj_image_scale_set
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[in] scale
 *
 * @see elm_image_scale_set
 */
#define elm_obj_image_scale_set(scale) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_SCALE_SET), EO_TYPECHECK(double, scale)

/**
 * @def elm_obj_image_scale_get
 * @since 1.8
 *
 * No description supplied by the EAPI.
 *
 * @param[out] ret
 *
 * @see elm_image_scale_get
 */
#define elm_obj_image_scale_get(ret) ELM_OBJ_IMAGE_ID(ELM_OBJ_IMAGE_SUB_ID_SCALE_GET), EO_TYPECHECK(double *, ret)


/**
 * @}
 */