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
15 * Default contents parts of the panel widget that you can use for are:
16 * @li "default" - A content of the panel
18 * @ref tutorial_panel shows one way to use this widget.
23 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
25 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
26 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
30 * @brief Adds a panel object
32 * @param parent The parent object
34 * @return The panel object, or NULL on failure
36 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
39 * @brief Sets the orientation of the panel
41 * @param parent The parent object
42 * @param orient The panel orientation. Can be one of the following:
43 * @li ELM_PANEL_ORIENT_TOP
44 * @li ELM_PANEL_ORIENT_LEFT
45 * @li ELM_PANEL_ORIENT_RIGHT
47 * Sets from where the panel will (dis)appear.
49 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
52 * @brief Get the orientation of the panel.
54 * @param obj The panel object
55 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
57 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
60 * @brief Set the state of the panel.
62 * @param obj The panel object
63 * @param hidden If true, the panel will run the animation to contract
65 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
68 * @brief Get the state of the panel.
70 * @param obj The panel object
71 * @param hidden If true, the panel is in the "hide" state
73 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
76 * @brief Toggle the hidden state of the panel from code
78 * @param obj The panel object
80 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);