aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/libraries/elementary/src/lib/elm_frame.h
diff options
context:
space:
mode:
authorDavid Walter Seikel2012-04-22 09:20:32 +1000
committerDavid Walter Seikel2012-04-22 09:20:32 +1000
commit3ad3455551be0d7859ecb02290376206d5e66498 (patch)
tree497917e12b4d7f458dff9765d9b53f64c4e03fc3 /libraries/elementary/src/lib/elm_frame.h
parentUpdate EFL to latest beta. (diff)
downloadSledjHamr-3ad3455551be0d7859ecb02290376206d5e66498.zip
SledjHamr-3ad3455551be0d7859ecb02290376206d5e66498.tar.gz
SledjHamr-3ad3455551be0d7859ecb02290376206d5e66498.tar.bz2
SledjHamr-3ad3455551be0d7859ecb02290376206d5e66498.tar.xz
And actually include new files, plus elementary libraries.
Diffstat (limited to 'libraries/elementary/src/lib/elm_frame.h')
-rw-r--r--libraries/elementary/src/lib/elm_frame.h114
1 files changed, 114 insertions, 0 deletions
diff --git a/libraries/elementary/src/lib/elm_frame.h b/libraries/elementary/src/lib/elm_frame.h
new file mode 100644
index 0000000..58c3d93
--- /dev/null
+++ b/libraries/elementary/src/lib/elm_frame.h
@@ -0,0 +1,114 @@
1/**
2 * @defgroup Frame Frame
3 * @ingroup Elementary
4 *
5 * @image html img/widget/frame/preview-00.png
6 * @image latex img/widget/frame/preview-00.eps
7 *
8 * @brief Frame is a widget that holds some content and has a title.
9 *
10 * The default look is a frame with a title, but Frame supports multiple
11 * styles:
12 * @li default
13 * @li pad_small
14 * @li pad_medium
15 * @li pad_large
16 * @li pad_huge
17 * @li outdent_top
18 * @li outdent_bottom
19 *
20 * Of all this styles only default shows the title.
21 *
22 * Smart callbacks one can listen to:
23 * - @c "clicked" - The user has clicked the frame's label
24 *
25 * Default content parts of the frame widget that you can use for are:
26 * @li "default" - A content of the frame
27 *
28 * Default text parts of the frame widget that you can use for are:
29 * @li "default" - Label of the frame
30 *
31 * Supported elm_object common APIs.
32 * @li @ref elm_object_part_text_set
33 * @li @ref elm_object_part_text_get
34 * @li @ref elm_object_part_content_set
35 * @li @ref elm_object_part_content_get
36 * @li @ref elm_object_part_content_unset
37 *
38 * For a detailed example see the @ref tutorial_frame.
39 *
40 * @{
41 */
42
43/**
44 * @brief Add a new frame to the parent
45 *
46 * @param parent The parent object
47 * @return The new object or NULL if it cannot be created
48 *
49 * @ingroup Frame
50 */
51EAPI Evas_Object *elm_frame_add(Evas_Object *parent);
52
53/**
54 * @brief Toggle autocollapsing of a frame
55 * @param obj The frame
56 * @param autocollapse Whether to enable autocollapse
57 *
58 * When @p enable is EINA_TRUE, clicking a frame's label will collapse the frame
59 * vertically, shrinking it to the height of the label.
60 * By default, this is DISABLED.
61 *
62 * @ingroup Frame
63 */
64EAPI void elm_frame_autocollapse_set(Evas_Object *obj, Eina_Bool autocollapse);
65
66/**
67 * @brief Determine autocollapsing of a frame
68 * @param obj The frame
69 * @return Whether autocollapse is enabled
70 *
71 * When this returns EINA_TRUE, clicking a frame's label will collapse the frame
72 * vertically, shrinking it to the height of the label.
73 * By default, this is DISABLED.
74 *
75 * @ingroup Frame
76 */
77EAPI Eina_Bool elm_frame_autocollapse_get(const Evas_Object *obj);
78
79/**
80 * @brief Manually collapse a frame without animations
81 * @param obj The frame
82 * @param collapse true to collapse, false to expand
83 *
84 * Use this to toggle the collapsed state of a frame, bypassing animations.
85 *
86 * @ingroup Frame
87 */
88EAPI void elm_frame_collapse_set(Evas_Object *obj, Eina_Bool collapse);
89
90/**
91 * @brief Determine the collapse state of a frame
92 * @param obj The frame
93 * @return true if collapsed, false otherwise
94 *
95 * Use this to determine the collapse state of a frame.
96 *
97 * @ingroup Frame
98 */
99EAPI Eina_Bool elm_frame_collapse_get(const Evas_Object *obj);
100
101/**
102 * @brief Manually collapse a frame with animations
103 * @param obj The frame
104 * @param collapse true to collapse, false to expand
105 *
106 * Use this to toggle the collapsed state of a frame, triggering animations.
107 *
108 * @ingroup Frame
109 */
110EAPI void elm_frame_collapse_go(Evas_Object *obj, Eina_Bool collapse);
111
112/**
113 * @}
114 */