summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_panel.h
blob: c94d9fc5841461d420e07c39afefdf9383edbb72 (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
/**
 * @defgroup Elm_Panel Panel
 * @ingroup Elementary
 *
 * @image html panel_inheritance_tree.png
 * @image latex panel_inheritance_tree.eps
 *
 * @image html img/widget/panel/preview-00.png
 * @image latex img/widget/panel/preview-00.eps
 *
 * @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.
 *
 * Orientations are as follows:
 * @li #ELM_PANEL_ORIENT_TOP
 * @li #ELM_PANEL_ORIENT_LEFT
 * @li #ELM_PANEL_ORIENT_RIGHT
 * @li #ELM_PANEL_ORIENT_BOTTOM
 *
 * This widget inherits from the @ref Layout one, so that all the
 * functions acting on it also work for panel objects (since 1.8).
 *
 * This widget emits the following signals, besides the ones sent from
 * @ref Layout:
 * @li @c "toggled" : When the panel has been toggled. (since 1.18)
 * @li @c "scroll" : When the content has been scrolled (moved). (since 1.10)
 *        This signal is emitted only when the panel is scrollable.
 *        Elm_Panel_Scroll_Info will be passed by @p event_info argument.
 * @li @c "focused" : When the panel has received focus. (since 1.8)
 * @li @c "unfocused" : When the panel has lost focus. (since 1.8)
 *
 * Default content parts of the panel widget that you can use are:
 * @li @c "default" - A content of the panel
 *
 * @ref tutorial_panel shows one way to use this widget.
 * @{
 */

#include "elm_panel_common.h"
#ifndef EFL_NOLEGACY_API_SUPPORT
#include "elm_panel_legacy.h"
#endif
/**
 * @}
 */