2 * @defgroup Panel Panel
4 * @image html img/widget/panel/preview-00.png
5 * @image latex img/widget/panel/preview-00.eps
7 * @brief A panel is a type of animated container that contains subobjects.
8 * It can be expanded or contracted by clicking the button on it's edge.
10 * Orientations are as follows:
11 * @li ELM_PANEL_ORIENT_TOP
12 * @li ELM_PANEL_ORIENT_LEFT
13 * @li ELM_PANEL_ORIENT_RIGHT
16 * Default contents parts of the panel widget that you can use for are:
18 * Default content parts of the panel widget that you can use for are:
19 >>>>>>> remotes/origin/upstream
20 * @li "default" - A content of the panel
22 * Supported elm_object common APIs.
23 * @li elm_object_signal_emit
24 * @li elm_object_signal_callback_add
25 * @li elm_object_signal_callback_del
26 * @li elm_object_part_content_set
27 * @li elm_object_part_content_get
28 * @li elm_object_part_content_unset
30 * @ref tutorial_panel shows one way to use this widget.
35 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
36 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
37 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
38 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
42 * @brief Adds a panel object
44 * @param parent The parent object
46 * @return The panel object, or NULL on failure
48 EAPI Evas_Object *elm_panel_add(Evas_Object *parent);
51 * @brief Sets the orientation of the panel
54 * @param parent The parent object
56 * @param obj The panel object
57 >>>>>>> remotes/origin/upstream
58 * @param orient The panel orientation. Can be one of the following:
59 * @li ELM_PANEL_ORIENT_TOP
60 * @li ELM_PANEL_ORIENT_LEFT
61 * @li ELM_PANEL_ORIENT_RIGHT
63 * Sets from where the panel will (dis)appear.
65 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient);
68 * @brief Get the orientation of the panel.
70 * @param obj The panel object
71 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
73 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj);
76 * @brief Set the state of the panel.
78 * @param obj The panel object
80 * @param hidden If true, the panel will run the animation to contract
82 * @param hidden If true, the panel will run the animation to disappear.
83 >>>>>>> remotes/origin/upstream
85 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden);
88 * @brief Get the state of the panel.
90 * @param obj The panel object
92 * @param hidden If true, the panel is in the "hide" state
94 * @return EINA_TRUE if it is hidden state
95 >>>>>>> remotes/origin/upstream
97 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj);
100 * @brief Toggle the hidden state of the panel from code
102 * @param obj The panel object
104 EAPI void elm_panel_toggle(Evas_Object *obj);
109 * @brief Set the content of the panel.
111 * @param obj The panel object
112 * @param content The content object
114 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content);
117 * @brief Get the content of the panel.
119 * @param obj The panel object
120 * @return The content object of the panel or NULL if none is set.
122 * @see elm_panel_content_set()
124 EAPI Evas_Object * elm_panel_content_get(const Evas_Object *obj);
127 * @brief Remove and return the content from the panel.
129 * @param obj The panel object
130 * @return The content object of the panel or NULL if none is set.
132 EAPI Evas_Object * elm_panel_content_unset(Evas_Object *obj);
135 >>>>>>> remotes/origin/upstream