diff options
Diffstat (limited to 'src/lib/elm_mirroring.h')
-rw-r--r-- | src/lib/elm_mirroring.h | 57 |
1 files changed, 29 insertions, 28 deletions
diff --git a/src/lib/elm_mirroring.h b/src/lib/elm_mirroring.h index 815b842d6..df5ed9257 100644 --- a/src/lib/elm_mirroring.h +++ b/src/lib/elm_mirroring.h @@ -1,57 +1,58 @@ /** * @defgroup Mirroring Mirroring - * @ingroup Elementary + * @ingroup elm_infra_group * - * 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. + * @brief These functions allow you to set UI-mirroring on specific + * widgets or the whole interface. Widgets can be in one of the following two + * modes, automatic and manual. Automatic means they are changed + * according to the system mirroring mode and manual means only + * explicit changes matter. You are not supposed to change the + * mirroring state of a widget set to automatic, that mostly works, + * but the behavior is not really defined. * * @{ */ /** - * Get the widget's mirrored mode. + * @brief Gets the widget's mirrored mode. * - * @param obj The widget. - * @return @c EINA_TRUE if mirrored is set, @c EINA_FALSE otherwise + * @since_tizen 2.3 * - * @ingroup Mirroring + * @param[in] obj The widget + * @return @c EINA_TRUE if mirrored is set, otherwise @c EINA_FALSE */ EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj); /** - * Set the widget's mirrored mode. + * @brief Sets the widget's mirrored mode. * - * @param obj The widget. - * @param mirrored @c EINA_TRUE to set mirrored mode, @c EINA_FALSE to unset it. + * @since_tizen 2.3 * - * @ingroup Mirroring + * @param[in] obj The widget + * @param[in] mirrored If @c EINA_TRUE the mirrored mode is set, otherwise @c EINA_FALSE to unset it */ EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored); /** - * Returns the widget's mirrored mode setting. + * @brief Gets the widget's mirrored mode setting. * - * @param obj The widget. - * @return mirrored mode setting of the object. + * @since_tizen 2.3 * - * @ingroup Mirroring + * @param[in] obj The widget + * @return The mirrored mode setting of the object */ 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 Mirroring + * @brief Sets the widget's mirrored mode setting. + * + * @since_tizen 2.3 + * + * @remarks When the widget is in the automatic mode, it follows the system mirrored mode set by + * elm_mirrored_set(). + * + * @param[in] obj The widget + * @param[in] automatic If @c EINA_TRUE the auto mirrored mode is set, otherwise @c EINA_FALSE for manual */ EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic); |