elementary merging.
[framework/uifw/elementary.git] / src / lib / elm_panel.h
index 0c27212..088168e 100644 (file)
@@ -12,7 +12,7 @@
  * @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.
@@ -46,7 +46,7 @@ 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
@@ -68,7 +68,7 @@ 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.
  */
 EAPI void                         elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden);
 
@@ -76,7 +76,7 @@ EAPI void                         elm_panel_hidden_set(Evas_Object *obj, Eina_Bo
  * @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
  */
 EAPI Eina_Bool                    elm_panel_hidden_get(const Evas_Object *obj);
 
@@ -88,5 +88,31 @@ EAPI Eina_Bool                    elm_panel_hidden_get(const Evas_Object *obj);
 EAPI void                         elm_panel_toggle(Evas_Object *obj);
 
 /**
+ * @brief Set the content of the panel.
+ *
+ * @param obj The panel object
+ * @param content The content object
+ */
+EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content);
+
+/**
+ * @brief Get the content of the panel.
+ *
+ * @param obj The panel object
+ * @return The content object of the panel or NULL if none is set.
+ *
+ * @see elm_panel_content_set()
+ */
+EAPI Evas_Object * elm_panel_content_get(const Evas_Object *obj);
+
+/**
+ * @brief Remove and return the content from the panel.
+ *
+ * @param obj The panel object
+ * @return The content object of the panel or NULL if none is set.
+ */
+EAPI Evas_Object * elm_panel_content_unset(Evas_Object *obj);
+
+/**
  * @}
  */