Add APIs for floating mode (app-in-app)

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

diff --git a/src/lib/elm_panel.h b/src/lib/elm_panel.h
index 2381416..fabbcc0 100644 (file)
--- a/src/lib/elm_panel.h
+++ b/src/lib/elm_panel.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Panel Panel
+ * @ingroup Elementary
  *
  * @image html img/widget/panel/preview-00.png
  * @image latex img/widget/panel/preview-00.eps
@@ -12,9 +13,17 @@
  * @li ELM_PANEL_ORIENT_LEFT
  * @li ELM_PANEL_ORIENT_RIGHT
  *
- * Default contents parts of the panel widget that you can use for are:
+ * Default content parts of the panel widget that you can use for are:
  * @li "default" - A content of the panel
  *
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_signal_emit
+ * @li @ref elm_object_signal_callback_add
+ * @li @ref elm_object_signal_callback_del
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
+ *
  * @ref tutorial_panel shows one way to use this widget.
  * @{
  */
@@ -32,52 +41,64 @@ typedef enum
  * @param parent The parent object
  *
  * @return The panel object, or NULL on failure
+ *
+ * @ingroup Panel
  */
-EAPI Evas_Object                 *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+EAPI Evas_Object                 *elm_panel_add(Evas_Object *parent);
 
 /**
  * @brief Sets the orientation of the panel
  *
- * @param parent The parent object
+ * @param obj The panel object
  * @param orient The panel orientation. Can be one of the following:
  * @li ELM_PANEL_ORIENT_TOP
  * @li ELM_PANEL_ORIENT_LEFT
  * @li ELM_PANEL_ORIENT_RIGHT
  *
  * Sets from where the panel will (dis)appear.
+ *
+ * @ingroup Panel
  */
-EAPI void                         elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
+EAPI void                         elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient);
 
 /**
  * @brief Get the orientation of the panel.
  *
  * @param obj The panel object
  * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
+ *
+ * @ingroup Panel
  */
-EAPI Elm_Panel_Orient             elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Panel_Orient             elm_panel_orient_get(const Evas_Object *obj);
 
 /**
  * @brief Set the state of the panel.
  *
  * @param obj The panel object
- * @param hidden If true, the panel will run the animation to contract
+ * @param hidden If true, the panel will run the animation to disappear.
+ *
+ * @ingroup Panel
  */
-EAPI void                         elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
+EAPI void                         elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden);
 
 /**
  * @brief Get the state of the panel.
  *
  * @param obj The panel object
- * @param hidden If true, the panel is in the "hide" state
+ * @return EINA_TRUE if it is hidden state
+ *
+ * @ingroup Panel
  */
-EAPI Eina_Bool                    elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                    elm_panel_hidden_get(const Evas_Object *obj);
 
 /**
  * @brief Toggle the hidden state of the panel from code
  *
  * @param obj The panel object
+ *
+ * @ingroup Panel
  */
-EAPI void                         elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void                         elm_panel_toggle(Evas_Object *obj);
 
 /**
  * @}