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 _Elm_Panel_Orient
  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 *
  37                                   elm_panel_add(Evas_Object *parent)
  38 EINA_ARG_NONNULL(1);
  39
  40 /**
  41  * @brief Sets the orientation of the panel
  42  *
  43  * @param parent The parent object
  44  * @param orient The panel orientation. Can be one of the following:
  45  * @li ELM_PANEL_ORIENT_TOP
  46  * @li ELM_PANEL_ORIENT_LEFT
  47  * @li ELM_PANEL_ORIENT_RIGHT
  48  *
  49  * Sets from where the panel will (dis)appear.
  50  */
  51 EAPI void                         elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
  52
  53 /**
  54  * @brief Get the orientation of the panel.
  55  *
  56  * @param obj The panel object
  57  * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
  58  */
  59 EAPI Elm_Panel_Orient             elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  60
  61 /**
  62  * @brief Set the content of the panel.
  63  *
  64  * @param obj The panel object
  65  * @param content The panel content
  66  *
  67  * Once the content object is set, a previously set one will be deleted.
  68  * If you want to keep that old content object, use the
  69  * elm_panel_content_unset() function.
  70  *
  71  * @deprecated use elm_object_content_set() instead
  72  *
  73  */
  74 EINA_DEPRECATED EAPI void         elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
  75
  76 /**
  77  * @brief Get the content of the panel.
  78  *
  79  * @param obj The panel object
  80  * @return The content that is being used
  81  *
  82  * Return the content object which is set for this widget.
  83  *
  84  * @see elm_panel_content_set()
  85  *
  86  * @deprecated use elm_object_content_get() instead
  87  *
  88  */
  89 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
  90
  91 /**
  92  * @brief Unset the content of the panel.
  93  *
  94  * @param obj The panel object
  95  * @return The content that was being used
  96  *
  97  * Unparent and return the content object which was set for this widget.
  98  *
  99  * @see elm_panel_content_set()
 100  *
 101  * @deprecated use elm_object_content_unset() instead
 102  *
 103  */
 104 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
 105
 106 /**
 107  * @brief Set the state of the panel.
 108  *
 109  * @param obj The panel object
 110  * @param hidden If true, the panel will run the animation to contract
 111  */
 112 EAPI void                         elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
 113
 114 /**
 115  * @brief Get the state of the panel.
 116  *
 117  * @param obj The panel object
 118  * @param hidden If true, the panel is in the "hide" state
 119  */
 120 EAPI Eina_Bool                    elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
 121
 122 /**
 123  * @brief Toggle the hidden state of the panel from code
 124  *
 125  * @param obj The panel object
 126  */
 127 EAPI void                         elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
 128
 129 /**
 130  * @}
 131  */