53ef96785ea5c6c4a156091507672008fa28dbc6
[framework/uifw/elementary.git] / src / lib / elm_mirroring.h
1 /**
2 <<<<<<< HEAD
3  * @defgroup UI-Mirroring Selective Widget mirroring
4 =======
5  * @defgroup Mirroring Mirroring
6 >>>>>>> remotes/origin/upstream
7  *
8  * These functions allow you to set ui-mirroring on specific
9  * widgets or the whole interface. Widgets can be in one of two
10  * modes, automatic and manual.  Automatic means they'll be changed
11  * according to the system mirroring mode and manual means only
12  * explicit changes will matter. You are not supposed to change
13  * mirroring state of a widget set to automatic, will mostly work,
14  * but the behavior is not really defined.
15  *
16  * @{
17  */
18
19 <<<<<<< HEAD
20 EAPI Eina_Bool elm_mirrored_get(void);
21 EAPI void      elm_mirrored_set(Eina_Bool mirrored);
22
23 /**
24  * Get the system mirrored mode. This determines the default mirrored mode
25  * of widgets.
26  *
27 =======
28 /**
29  * Get the widget's mirrored mode.
30  *
31  * @param obj The widget.
32 >>>>>>> remotes/origin/upstream
33  * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
34  */
35 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj);
36
37 /**
38 <<<<<<< HEAD
39  * Set the system mirrored mode. This determines the default mirrored mode
40  * of widgets.
41  *
42 =======
43  * Set the widget's mirrored mode.
44  *
45  * @param obj The widget.
46 >>>>>>> remotes/origin/upstream
47  * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
48  */
49 EAPI void      elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
50
51 /**
52  * Returns the widget's mirrored mode setting.
53  *
54  * @param obj The widget.
55  * @return mirrored mode setting of the object.
56  *
57  **/
58 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj);
59
60 /**
61  * Sets the widget's mirrored mode setting.
62  * When widget in automatic mode, it follows the system mirrored mode set by
63  * elm_mirrored_set().
64  * @param obj The widget.
65  * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
66  */
67 EAPI void      elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic);
68
69 /**
70  * @}
71  */