aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/libraries/elementary/src/lib/elm_mirroring.h
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/elementary/src/lib/elm_mirroring.h')
-rw-r--r--libraries/elementary/src/lib/elm_mirroring.h59
1 files changed, 59 insertions, 0 deletions
diff --git a/libraries/elementary/src/lib/elm_mirroring.h b/libraries/elementary/src/lib/elm_mirroring.h
new file mode 100644
index 0000000..24baa48
--- /dev/null
+++ b/libraries/elementary/src/lib/elm_mirroring.h
@@ -0,0 +1,59 @@
1/**
2 * @defgroup Mirroring Mirroring
3 * @ingroup Elementary
4 *
5 * These functions allow you to set ui-mirroring on specific
6 * widgets or the whole interface. Widgets can be in one of two
7 * modes, automatic and manual. Automatic means they'll be changed
8 * according to the system mirroring mode and manual means only
9 * explicit changes will matter. You are not supposed to change
10 * mirroring state of a widget set to automatic, will mostly work,
11 * but the behavior is not really defined.
12 *
13 * @{
14 */
15
16/**
17 * Get the widget's mirrored mode.
18 *
19 * @param obj The widget.
20 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
21 *
22 * @ingroup Mirroring
23 */
24EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj);
25
26/**
27 * Set the widget's mirrored mode.
28 *
29 * @param obj The widget.
30 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
31 *
32 * @ingroup Mirroring
33 */
34EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
35
36/**
37 * Returns the widget's mirrored mode setting.
38 *
39 * @param obj The widget.
40 * @return mirrored mode setting of the object.
41 *
42 * @ingroup Mirroring
43 */
44EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj);
45
46/**
47 * Sets the widget's mirrored mode setting.
48 * When widget in automatic mode, it follows the system mirrored mode set by
49 * elm_mirrored_set().
50 * @param obj The widget.
51 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
52 *
53 * @ingroup Mirroring
54 */
55EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic);
56
57/**
58 * @}
59 */