/**
* Line wrapping types.
*/
-typedef enum _Elm_Wrap_Type
+typedef enum
{
ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
ELM_WRAP_LAST
-} Elm_Wrap_Type;
+} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
typedef enum
{
ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
ELM_INPUT_PANEL_LAYOUT_INVALID // XXX: remove this so we can expand
-} Elm_Input_Panel_Layout;
+} Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use */
typedef enum
{
- ELM_AUTOCAPITAL_TYPE_NONE,
- ELM_AUTOCAPITAL_TYPE_WORD,
- ELM_AUTOCAPITAL_TYPE_SENTENCE,
- ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
-} Elm_Autocapital_Type;
+ ELM_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing */
+ ELM_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed */
+ ELM_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence */
+ ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
+} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
/**
* @defgroup Entry Entry
*
* They can also be single line or multi line (the default) and when set
* to multi line mode they support text wrapping in any of the modes
- * indicated by #Elm_Wrap_Type.
+ * indicated by Elm_Wrap_Type.
*
* Other features include password mode, filtering of inserted text with
* elm_entry_text_filter_append() and related functions, inline "items" and
* Set the line wrap type to use on multi-line entries.
*
* Sets the wrap type used by the entry to any of the specified in
- * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
+ * Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
* line (without inserting a line break or paragraph separator) when it
* reaches the far edge of the widget.
*
* to be single line will never wrap.
*
* @param obj The entry object
- * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
+ * @param wrap The wrap mode to use. See Elm_Wrap_Type for details on them
*/
EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
* the end of the contained entry.
*
* @param obj The scrolled entry object
- * @param h The horizontal bounce state
- * @param v The vertical bounce state
+ * @param h_bounce The horizontal bounce state
+ * @param v_bounce The vertical bounce state
*/
EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
*
* @{
*/
-typedef enum _Elm_Flip_Mode
+typedef enum
{
ELM_FLIP_ROTATE_Y_CENTER_AXIS,
ELM_FLIP_ROTATE_X_CENTER_AXIS,
ELM_FLIP_PAGE_UP,
ELM_FLIP_PAGE_DOWN
} Elm_Flip_Mode;
-typedef enum _Elm_Flip_Interaction
+
+typedef enum
{
ELM_FLIP_INTERACTION_NONE,
ELM_FLIP_INTERACTION_ROTATE,
ELM_FLIP_INTERACTION_CUBE,
ELM_FLIP_INTERACTION_PAGE
} Elm_Flip_Interaction;
-typedef enum _Elm_Flip_Direction
+
+typedef enum
{
ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*/
-EAPI Evas_Object *
- elm_flip_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
/**
* @brief Set the front content of the flip widget.
/**
* Set the enable status of the focus highlight
*
- * Set whether to show or not the highlight on focused objects
* @param enable Enable highlight if EINA_TRUE, disable otherwise
+ *
+ * Set whether to show or not the highlight on focused objects
* @ingroup Focus
*/
EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
/**
* Get the enable status of the highlight animation
*
+ * @return The focus hilight mode set
+ *
* Get whether the focus highlight, if enabled, will animate its switch from
* one object to the next
+ *
* @ingroup Focus
*/
EAPI Eina_Bool elm_focus_highlight_animate_get(void);
/**
* Set the enable status of the highlight animation
*
+ * @param animate Enable animation if EINA_TRUE, disable otherwise
+ *
* Set whether the focus highlight, if enabled, will animate its switch from
* one object to the next
- * @param animate Enable animation if EINA_TRUE, disable otherwise
+ *
* @ingroup Focus
*/
EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
*
* @ingroup Focus
*/
-EAPI Eina_Bool
- elm_object_focus_get(const Evas_Object *obj)
-EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
/**
* Set/unset focus to a given Elementary object.