efl/legacy/elementary/src/lib/elm_mirroring.h

61 lines
1.6 KiB
C

/**
* @defgroup Elm_Mirroring Mirroring
* @ingroup Elementary
*
* These functions allow you to set ui-mirroring on specific
* widgets or the whole interface. Widgets can be in one of two
* modes, automatic and manual. Automatic means they'll be changed
* according to the system mirroring mode and manual means only
* explicit changes will matter. You are not supposed to change
* mirroring state of a widget set to automatic, will mostly work,
* but the behavior is not really defined.
*
* @{
*/
/**
* Get the widget's mirrored mode.
*
* @param obj The widget.
* @return @c EINA_TRUE if mirrored is set, @c EINA_FALSE otherwise
*
* @ingroup Elm_Mirroring
*/
EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj);
/**
* Set the widget's mirrored mode.
*
* @param obj The widget.
* @param mirrored @c EINA_TRUE to set mirrored mode, @c EINA_FALSE to unset it.
*
* @ingroup Elm_Mirroring
*/
EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
/**
* Returns the widget's mirrored mode setting.
*
* @param obj The widget.
* @return mirrored mode setting of the object.
*
* @ingroup Elm_Mirroring
*/
EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj);
/**
* Sets the widget's mirrored mode setting.
* When widget in automatic mode, it follows the system mirrored mode set by
* elm_mirrored_set().
* @param obj The widget.
* @param automatic @c EINA_TRUE for auto mirrored mode. @c EINA_FALSE for
* manual.
*
* @ingroup Elm_Mirroring
*/
EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic);
/**
* @}
*/