src/lib/elm_panel.h

   1 /**
   2  * @defgroup Panel Panel
   3  *
   4  * @image html img/widget/panel/preview-00.png
   5  * @image latex img/widget/panel/preview-00.eps
   6  *
   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.
   9  *
  10  * Orientations are as follows:
  11  * @li ELM_PANEL_ORIENT_TOP
  12  * @li ELM_PANEL_ORIENT_LEFT
  13  * @li ELM_PANEL_ORIENT_RIGHT
  14  *
  15  * Default contents parts of the panel widget that you can use for are:
  16  * @li "default" - A content of the panel
  17  *
  18  * @ref tutorial_panel shows one way to use this widget.
  19  * @{
  20  */
  21 typedef enum
  22 {
  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 */
  27 } Elm_Panel_Orient;
  28
  29 /**
  30  * @brief Adds a panel object
  31  *
  32  * @param parent The parent object
  33  *
  34  * @return The panel object, or NULL on failure
  35  */
  36 EAPI Evas_Object                 *elm_panel_add(Evas_Object *parent);
  37
  38 /**
  39  * @brief Sets the orientation of the panel
  40  *
  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
  46  *
  47  * Sets from where the panel will (dis)appear.
  48  */
  49 EAPI void                         elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient);
  50
  51 /**
  52  * @brief Get the orientation of the panel.
  53  *
  54  * @param obj The panel object
  55  * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
  56  */
  57 EAPI Elm_Panel_Orient             elm_panel_orient_get(const Evas_Object *obj);
  58
  59 /**
  60  * @brief Set the state of the panel.
  61  *
  62  * @param obj The panel object
  63  * @param hidden If true, the panel will run the animation to contract
  64  */
  65 EAPI void                         elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden);
  66
  67 /**
  68  * @brief Get the state of the panel.
  69  *
  70  * @param obj The panel object
  71  * @param hidden If true, the panel is in the "hide" state
  72  */
  73 EAPI Eina_Bool                    elm_panel_hidden_get(const Evas_Object *obj);
  74
  75 /**
  76  * @brief Toggle the hidden state of the panel from code
  77  *
  78  * @param obj The panel object
  79  */
  80 EAPI void                         elm_panel_toggle(Evas_Object *obj);
  81
  82 /**
  83  * @}
  84  */