Tizen Native API  5.5

Frame is a widget that holds some content and has a title.

frame_inheritance_tree.png

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
  • "language,changed" - the program's language changed (since 1.9)

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" - A label of the frame

Supported elm_object common APIs.

For a detailed example see the Frame example.

Functions

void elm_frame_collapse_set (Efl_Ui_Frame *obj, Eina_Bool collapse)
 Manually collapse a frame without animations Use this to toggle the collapsed state of a frame, bypassing animations.
Eina_Bool elm_frame_collapse_get (const Efl_Ui_Frame *obj)
 Determine the collapse state of a frame Use this to determine the collapse state of a frame.
void elm_frame_autocollapse_set (Efl_Ui_Frame *obj, Eina_Bool autocollapse)
 Toggle autocollapsing of a frame When enable is 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_autocollapse_get (const Efl_Ui_Frame *obj)
 Determine autocollapsing of a frame.
void elm_frame_collapse_go (Efl_Ui_Frame *obj, Eina_Bool collapse)
 Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations.
Evas_Objectelm_frame_add (Evas_Object *parent)
 Add a new frame to the parent.

Function Documentation

Add a new frame to the parent.

Parameters:
parentThe parent object
Returns:
The new object or NULL if it cannot be created
Since :
3.0f(2.3.1)
Examples:
colorselector_example_01.c, entry_example.c, frame_example_01.c, and general_funcs_example.c.
Eina_Bool elm_frame_autocollapse_get ( const Efl_Ui_Frame *  obj)

Determine autocollapsing of a frame.

When this returns true, clicking a frame's label will collapse the frame vertically, shrinking it to the height of the label. By default, this is DISABLED.

Parameters:
[in]objThe object.
Returns:
Whether to enable autocollapse.
Since :
3.0f(2.3.1)
void elm_frame_autocollapse_set ( Efl_Ui_Frame *  obj,
Eina_Bool  autocollapse 
)

Toggle autocollapsing of a frame When enable is true, clicking a frame's label will collapse the frame vertically, shrinking it to the height of the label. By default, this is DISABLED.

Parameters:
[in]objThe object.
[in]autocollapseWhether to enable autocollapse.
Since :
3.0f(2.3.1)
Eina_Bool elm_frame_collapse_get ( const Efl_Ui_Frame *  obj)

Determine the collapse state of a frame Use this to determine the collapse state of a frame.

Parameters:
[in]objThe object.
Returns:
true to collapse, false to expand.
Since :
3.0f(2.3.1)
void elm_frame_collapse_go ( Efl_Ui_Frame *  obj,
Eina_Bool  collapse 
)

Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations.

Parameters:
[in]objThe object.
[in]collapsetrue to collapse, false to expand.
Since :
3.0f(2.3.1)
void elm_frame_collapse_set ( Efl_Ui_Frame *  obj,
Eina_Bool  collapse 
)

Manually collapse a frame without animations Use this to toggle the collapsed state of a frame, bypassing animations.

Parameters:
[in]objThe object.
[in]collapsetrue to collapse, false to expand.
Since :
3.0f(2.3.1)