[multibuttonentry]Fixed [Nabi S1-539]narrow region about internal entry

[framework/uifw/elementary.git] / src / lib / elm_button.h

diff --git a/src/lib/elm_button.h b/src/lib/elm_button.h
index f5ea8f8..5893898 100644 (file)
--- a/src/lib/elm_button.h
+++ b/src/lib/elm_button.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Button Button
+ * @ingroup Elementary
  *
  * @image html img/widget/button/preview-00.png
  * @image latex img/widget/button/preview-00.eps
@@ -11,12 +12,12 @@
  * This is a push-button. Press it and run some function. It can contain
  * a simple label and icon object and it also has an autorepeat feature.
  *
- * This widgets emits the following signals:
+ * This widget emits the following signals:
  * @li "clicked": the user clicked the button (press/release).
  * @li "repeated": the user pressed the button without releasing it.
  * @li "pressed": button was pressed.
  * @li "unpressed": button was released after being pressed.
- * In all three cases, the @c event parameter of the callback will be
+ * In all cases, the @c event parameter of the callback will be
  * @c NULL.
  *
  * Also, defined in the default theme, the button has the following styles
@@ -27,14 +28,33 @@
  * @li hoversel_vertical: Internally used by @ref Hoversel to give a
  * continuous look across its options.
  * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
+ * @li naviframe: Internally used by @ref Naviframe for its back button.
+ * @li colorselector: Internally used by @ref Colorselector
+ * for its left and right buttons.
  *
- * Default contents parts of the button widget that you can use for are:
+ * Default content parts of the button widget that you can use for are:
  * @li "icon" - An icon of the button
  *
  * Default text parts of the button widget that you can use for are:
  * @li "default" - Label of the button
  *
- * Follow through a complete example @ref button_example_01 "here".
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_part_text_set
+ * @li @ref elm_object_part_text_get
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
+ * @li @ref elm_object_signal_emit
+ * @li @ref elm_object_signal_callback_add
+ * @li @ref elm_object_signal_callback_del
+ *
+ * Here is some sample code using it:
+ * @li @ref button_example_00
+ * @li @ref button_example_01
+ */
+
+/**
+ * @addtogroup Button
  * @{
  */
 
@@ -43,8 +63,10 @@
  *
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Button
  */
-EAPI Evas_Object                 *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+EAPI Evas_Object                 *elm_button_add(Evas_Object *parent);
 
 /**
  * Turn on/off the autorepeat event generated when the button is kept pressed
@@ -60,8 +82,10 @@ EAPI Evas_Object                 *elm_button_add(Evas_Object *parent) EINA_ARG_N
  *
  * @param obj The button object
  * @param on  A bool to turn on/off the event
+ *
+ * @ingroup Button
  */
-EAPI void                         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
+EAPI void                         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on);
 
 /**
  * Get whether the autorepeat feature is enabled
@@ -70,15 +94,17 @@ EAPI void                         elm_button_autorepeat_set(Evas_Object *obj, Ei
  * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
  *
  * @see elm_button_autorepeat_set()
+ *
+ * @ingroup Button
  */
-EAPI Eina_Bool                    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                    elm_button_autorepeat_get(const Evas_Object *obj);
 
 /**
  * Set the initial timeout before the autorepeat event is generated
  *
  * Sets the timeout, in seconds, since the button is pressed until the
  * first @c repeated signal is emitted. If @p t is 0.0 or less, there
- * won't be any delay and the even will be fired the moment the button is
+ * won't be any delay and the event will be fired the moment the button is
  * pressed.
  *
  * @param obj The button object
@@ -86,8 +112,10 @@ EAPI Eina_Bool                    elm_button_autorepeat_get(const Evas_Object *o
  *
  * @see elm_button_autorepeat_set()
  * @see elm_button_autorepeat_gap_timeout_set()
+ *
+ * @ingroup Button
  */
-EAPI void                         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
+EAPI void                         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t);
 
 /**
  * Get the initial timeout before the autorepeat event is generated
@@ -96,8 +124,10 @@ EAPI void                         elm_button_autorepeat_initial_timeout_set(Evas
  * @return Timeout in seconds
  *
  * @see elm_button_autorepeat_initial_timeout_set()
+ *
+ * @ingroup Button
  */
-EAPI double                       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI double                       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj);
 
 /**
  * Set the interval between each generated autorepeat event
@@ -109,16 +139,20 @@ EAPI double                       elm_button_autorepeat_initial_timeout_get(cons
  * @param t   Interval in seconds
  *
  * @see elm_button_autorepeat_initial_timeout_set()
+ *
+ * @ingroup Button
  */
-EAPI void                         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
+EAPI void                         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t);
 
 /**
  * Get the interval between each generated autorepeat event
  *
  * @param obj The button object
  * @return Interval in seconds
+ *
+ * @ingroup Button
  */
-EAPI double                       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI double                       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj);
 
 /**
  * @}