2 * @defgroup Panel Panel
5 * @image html img/widget/panel/preview-00.png
6 * @image latex img/widget/panel/preview-00.eps
8 * @brief A panel is a type of animated container that contains subobjects.
9 * It can be expanded or contracted by clicking the button on it's edge.
11 * Orientations are as follows:
12 * @li ELM_PANEL_ORIENT_TOP
13 * @li ELM_PANEL_ORIENT_LEFT
14 * @li ELM_PANEL_ORIENT_RIGHT
16 * Default content parts of the panel widget that you can use for are:
17 * @li "default" - A content of the panel
19 * Supported elm_object common APIs.
20 * @li @ref elm_object_signal_emit
21 * @li @ref elm_object_signal_callback_add
22 * @li @ref elm_object_signal_callback_del
23 * @li @ref elm_object_part_content_set
24 * @li @ref elm_object_part_content_get
25 * @li @ref elm_object_part_content_unset
27 * @ref tutorial_panel shows one way to use this widget.
32 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
33 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
34 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
35 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
39 * @brief Adds a panel object
41 * @param parent The parent object
43 * @return The panel object, or NULL on failure
47 EAPI Evas_Object *elm_panel_add(Evas_Object *parent);
50 * @brief Sets the orientation of the panel
52 * @param obj The panel object
53 * @param orient The panel orientation. Can be one of the following:
54 * @li ELM_PANEL_ORIENT_TOP
55 * @li ELM_PANEL_ORIENT_LEFT
56 * @li ELM_PANEL_ORIENT_RIGHT
58 * Sets from where the panel will (dis)appear.
62 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient);
65 * @brief Get the orientation of the panel.
67 * @param obj The panel object
68 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
72 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj);
75 * @brief Set the state of the panel.
77 * @param obj The panel object
78 * @param hidden If true, the panel will run the animation to disappear.
82 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden);
85 * @brief Get the state of the panel.
87 * @param obj The panel object
88 * @return EINA_TRUE if it is hidden state
92 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj);
95 * @brief Toggle the hidden state of the panel from code
97 * @param obj The panel object
101 EAPI void elm_panel_toggle(Evas_Object *obj);