2 * @defgroup Frame Frame
5 * @image html frame_inheritance_tree.png
6 * @image latex frame_inheritance_tree.eps
8 * @image html img/widget/frame/preview-00.png
9 * @image latex img/widget/frame/preview-00.eps
11 * @brief Frame is a widget that holds some content and has a title.
13 * The default look is a frame with a title, but Frame supports multiple
23 * Of all this styles only default shows the title.
25 * This widget inherits from the @ref Layout one, so that all the
26 * functions acting on it also work for frame objects.
28 * This widget emits the following signals, besides the ones sent from
30 * - @c "clicked" - The user has clicked the frame's label
32 * Default content parts of the frame widget that you can use for are:
33 * @li "default" - A content of the frame
35 * Default text parts of the frame widget that you can use for are:
36 * @li "default" - Label of the frame
38 * Supported elm_object common APIs.
39 * @li @ref elm_object_part_text_set
40 * @li @ref elm_object_part_text_get
41 * @li @ref elm_object_part_content_set
42 * @li @ref elm_object_part_content_get
43 * @li @ref elm_object_part_content_unset
45 * For a detailed example see the @ref tutorial_frame.
51 * @brief Add a new frame to the parent
53 * @param parent The parent object
54 * @return The new object or NULL if it cannot be created
58 EAPI Evas_Object *elm_frame_add(Evas_Object *parent);
61 * @brief Toggle autocollapsing of a frame
62 * @param obj The frame
63 * @param autocollapse Whether to enable autocollapse
65 * When @p enable is EINA_TRUE, clicking a frame's label will collapse the frame
66 * vertically, shrinking it to the height of the label.
67 * By default, this is DISABLED.
71 EAPI void elm_frame_autocollapse_set(Evas_Object *obj, Eina_Bool autocollapse);
74 * @brief Determine autocollapsing of a frame
75 * @param obj The frame
76 * @return Whether autocollapse is enabled
78 * When this returns EINA_TRUE, clicking a frame's label will collapse the frame
79 * vertically, shrinking it to the height of the label.
80 * By default, this is DISABLED.
84 EAPI Eina_Bool elm_frame_autocollapse_get(const Evas_Object *obj);
87 * @brief Manually collapse a frame without animations
88 * @param obj The frame
89 * @param collapse true to collapse, false to expand
91 * Use this to toggle the collapsed state of a frame, bypassing animations.
95 EAPI void elm_frame_collapse_set(Evas_Object *obj, Eina_Bool collapse);
98 * @brief Determine the collapse state of a frame
99 * @param obj The frame
100 * @return true if collapsed, false otherwise
102 * Use this to determine the collapse state of a frame.
106 EAPI Eina_Bool elm_frame_collapse_get(const Evas_Object *obj);
109 * @brief Manually collapse a frame with animations
110 * @param obj The frame
111 * @param collapse true to collapse, false to expand
113 * Use this to toggle the collapsed state of a frame, triggering animations.
117 EAPI void elm_frame_collapse_go(Evas_Object *obj, Eina_Bool collapse);