2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @defgroup Panel Panel
|
2012-04-16 18:35:46 -07:00
|
|
|
* @ingroup Elementary
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-08-30 09:46:40 -07:00
|
|
|
* @image html panel_inheritance_tree.png
|
|
|
|
* @image latex panel_inheritance_tree.eps
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @image html img/widget/panel/preview-00.png
|
|
|
|
* @image latex img/widget/panel/preview-00.eps
|
|
|
|
*
|
2012-08-30 09:46:40 -07:00
|
|
|
* @brief A panel is an animated side-panel that contains a
|
|
|
|
* sub-object. It can be expanded or contracted by clicking the
|
|
|
|
* button on its edge.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Orientations are as follows:
|
2012-08-30 09:46:40 -07:00
|
|
|
* @li @c ELM_PANEL_ORIENT_TOP
|
|
|
|
* @li @c ELM_PANEL_ORIENT_LEFT
|
|
|
|
* @li @c ELM_PANEL_ORIENT_RIGHT
|
|
|
|
* @li @c ELM_PANEL_ORIENT_BOTTOM
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-08-30 09:46:40 -07:00
|
|
|
* This widget inherits from the @ref Layout one, so that all the
|
|
|
|
* functions acting on it also work for panel objects.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-08-30 09:46:40 -07:00
|
|
|
* Default content parts of the panel widget that you can use are:
|
|
|
|
* @li @c "default" - A content of the panel
|
2012-01-08 22:55:51 -08:00
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @ref tutorial_panel shows one way to use this widget.
|
|
|
|
* @{
|
|
|
|
*/
|
2011-12-30 01:41:11 -08:00
|
|
|
typedef enum
|
2011-12-29 23:20:48 -08:00
|
|
|
{
|
|
|
|
ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
|
2012-08-30 09:46:40 -07:00
|
|
|
ELM_PANEL_ORIENT_BOTTOM, /**< Panel (dis)appears from the bottom */
|
2011-12-29 23:20:48 -08:00
|
|
|
ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
|
|
|
|
ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
|
|
|
|
} Elm_Panel_Orient;
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @brief Adds a panel object
|
|
|
|
*
|
|
|
|
* @param parent The parent object
|
|
|
|
*
|
|
|
|
* @return The panel object, or NULL on failure
|
2012-04-16 18:35:46 -07:00
|
|
|
*
|
|
|
|
* @ingroup Panel
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Evas_Object *elm_panel_add(Evas_Object *parent);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @brief Sets the orientation of the panel
|
|
|
|
*
|
2012-02-18 07:40:39 -08:00
|
|
|
* @param obj The panel object
|
2011-12-29 23:20:48 -08:00
|
|
|
* @param orient The panel orientation. Can be one of the following:
|
|
|
|
* @li ELM_PANEL_ORIENT_TOP
|
|
|
|
* @li ELM_PANEL_ORIENT_LEFT
|
|
|
|
* @li ELM_PANEL_ORIENT_RIGHT
|
|
|
|
*
|
|
|
|
* Sets from where the panel will (dis)appear.
|
2012-04-16 18:35:46 -07:00
|
|
|
*
|
|
|
|
* @ingroup Panel
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @brief Get the orientation of the panel.
|
|
|
|
*
|
|
|
|
* @param obj The panel object
|
|
|
|
* @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
|
2012-04-16 18:35:46 -07:00
|
|
|
*
|
|
|
|
* @ingroup Panel
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @brief Set the state of the panel.
|
|
|
|
*
|
|
|
|
* @param obj The panel object
|
2012-02-14 20:48:21 -08:00
|
|
|
* @param hidden If true, the panel will run the animation to disappear.
|
2012-04-16 18:35:46 -07:00
|
|
|
*
|
|
|
|
* @ingroup Panel
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @brief Get the state of the panel.
|
|
|
|
*
|
|
|
|
* @param obj The panel object
|
2012-02-18 07:40:39 -08:00
|
|
|
* @return EINA_TRUE if it is hidden state
|
2012-04-16 18:35:46 -07:00
|
|
|
*
|
|
|
|
* @ingroup Panel
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @brief Toggle the hidden state of the panel from code
|
|
|
|
*
|
|
|
|
* @param obj The panel object
|
2012-04-16 18:35:46 -07:00
|
|
|
*
|
|
|
|
* @ingroup Panel
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_panel_toggle(Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|