Frame is a widget that holds some content and has a title. More...
Functions | |
Evas_Object * | elm_frame_add (Evas_Object *parent) |
Add a new frame to the parent. | |
void | elm_frame_autocollapse_set (Evas_Object *obj, Eina_Bool autocollapse) |
Toggle autocollapsing of a frame. | |
Eina_Bool | elm_frame_autocollapse_get (const Evas_Object *obj) |
Determine autocollapsing of a frame. | |
void | elm_frame_collapse_set (Evas_Object *obj, Eina_Bool collapse) |
Manually collapse a frame without animations. | |
Eina_Bool | elm_frame_collapse_get (const Evas_Object *obj) |
Determine the collapse state of a frame. | |
void | elm_frame_collapse_go (Evas_Object *obj, Eina_Bool collapse) |
Manually collapse a frame with animations. |
Detailed Description
Frame is a widget that holds some content and has a title.


The default look is a frame with a title, but Frame supports multiple styles:
- default
- pad_small
- pad_medium
- pad_large
- pad_huge
- outdent_top
- outdent_bottom
Of all this styles only default shows the title.
This widget inherits from the Layout one, so that all the functions acting on it also work for frame objects.
This widget emits the following signals, besides the ones sent from Layout:
"clicked"
- The user has clicked the frame's label
Default content parts of the frame widget that you can use for are:
- "default" - A content of the frame
Default text parts of the frame widget that you can use for are:
- "default" - Label of the frame
Supported elm_object common APIs.
- elm_object_part_text_set
- elm_object_part_text_get
- elm_object_part_content_set
- elm_object_part_content_get
- elm_object_part_content_unset
For a detailed example see the Frame example.
Function Documentation
Evas_Object* elm_frame_add | ( | Evas_Object * | parent | ) |
Add a new frame to the parent.
- Parameters:
-
parent The parent object
- Returns:
- The new object or NULL if it cannot be created
Eina_Bool elm_frame_autocollapse_get | ( | const Evas_Object * | obj | ) |
Determine autocollapsing of a frame.
- Parameters:
-
obj The frame
- Returns:
- Whether autocollapse is enabled
When this returns EINA_TRUE, clicking a frame's label will collapse the frame vertically, shrinking it to the height of the label. By default, this is DISABLED.
void elm_frame_autocollapse_set | ( | Evas_Object * | obj, |
Eina_Bool | autocollapse | ||
) |
Toggle autocollapsing of a frame.
- Parameters:
-
obj The frame autocollapse Whether to enable autocollapse
When enable
is EINA_TRUE, clicking a frame's label will collapse the frame vertically, shrinking it to the height of the label. By default, this is DISABLED.
Eina_Bool elm_frame_collapse_get | ( | const Evas_Object * | obj | ) |
Determine the collapse state of a frame.
- Parameters:
-
obj The frame
- Returns:
- true if collapsed, false otherwise
Use this to determine the collapse state of a frame.
void elm_frame_collapse_go | ( | Evas_Object * | obj, |
Eina_Bool | collapse | ||
) |
Manually collapse a frame with animations.
- Parameters:
-
obj The frame collapse true to collapse, false to expand
Use this to toggle the collapsed state of a frame, triggering animations.
References elm_layout_signal_emit(), and ELM_WIDGET_DATA.
void elm_frame_collapse_set | ( | Evas_Object * | obj, |
Eina_Bool | collapse | ||
) |
Manually collapse a frame without animations.
- Parameters:
-
obj The frame collapse true to collapse, false to expand
Use this to toggle the collapsed state of a frame, bypassing animations.
References elm_layout_signal_emit(), and ELM_WIDGET_DATA.