blob: fabbcc0aee32338a715257f998ed053be90e9fdc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/**
* @defgroup Panel Panel
* @ingroup Elementary
*
* @image html img/widget/panel/preview-00.png
* @image latex img/widget/panel/preview-00.eps
*
* @brief A panel is a type of animated container that contains subobjects.
* It can be expanded or contracted by clicking the button on it's edge.
*
* Orientations are as follows:
* @li ELM_PANEL_ORIENT_TOP
* @li ELM_PANEL_ORIENT_LEFT
* @li ELM_PANEL_ORIENT_RIGHT
*
* Default content parts of the panel widget that you can use for are:
* @li "default" - A content of the panel
*
* Supported elm_object common APIs.
* @li @ref elm_object_signal_emit
* @li @ref elm_object_signal_callback_add
* @li @ref elm_object_signal_callback_del
* @li @ref elm_object_part_content_set
* @li @ref elm_object_part_content_get
* @li @ref elm_object_part_content_unset
*
* @ref tutorial_panel shows one way to use this widget.
* @{
*/
typedef enum
{
ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
} Elm_Panel_Orient;
/**
* @brief Adds a panel object
*
* @param parent The parent object
*
* @return The panel object, or NULL on failure
*
* @ingroup Panel
*/
EAPI Evas_Object *elm_panel_add(Evas_Object *parent);
/**
* @brief Sets the orientation of the panel
*
* @param obj The panel object
* @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.
*
* @ingroup Panel
*/
EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient);
/**
* @brief Get the orientation of the panel.
*
* @param obj The panel object
* @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
*
* @ingroup Panel
*/
EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj);
/**
* @brief Set the state of the panel.
*
* @param obj The panel object
* @param hidden If true, the panel will run the animation to disappear.
*
* @ingroup Panel
*/
EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden);
/**
* @brief Get the state of the panel.
*
* @param obj The panel object
* @return EINA_TRUE if it is hidden state
*
* @ingroup Panel
*/
EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj);
/**
* @brief Toggle the hidden state of the panel from code
*
* @param obj The panel object
*
* @ingroup Panel
*/
EAPI void elm_panel_toggle(Evas_Object *obj);
/**
* @}
*/
|