Frame

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

Functions
void	elm_frame::collapse_go (bool collapse_) const
	Manually collapse a frame with animations Use this to toggle the collapsed state of a frame, triggering animations. More...
bool	elm_frame::collapse_get () const
	Determine the collapse state of a frame. More...
void	elm_frame::collapse_set (bool collapse_) const
	Determine the collapse state of a frame. More...
bool	elm_frame::autocollapse_get () const
	Determine autocollapsing of a frame. More...
void	elm_frame::autocollapse_set (bool autocollapse_) const
	Determine autocollapsing of a frame. More...
Evas_Object *	elm_frame_add (Evas_Object *parent)
	Add a new frame to the parent. More...

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
• "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.

• 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

bool elm_frame::autocollapse_get ( ) const

inline

Determine autocollapsing of a 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.

Parameters

autocollapse

Whether to enable autocollapse

void elm_frame::autocollapse_set ( bool  autocollapse_ ) const

inline

Determine autocollapsing of a 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.

Parameters

autocollapse

Whether to enable autocollapse

bool elm_frame::collapse_get ( ) const

inline

Determine the collapse state of a frame.

Returns

true if collapsed, false otherwise

Use this to determine the collapse state of a frame.

Parameters

collapse

true to collapse, false to expand

void elm_frame::collapse_go ( bool  collapse_ ) const

inline

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

Parameters

collapse

true to collapse, false to expand

void elm_frame::collapse_set ( bool  collapse_ ) const

inline

Determine the collapse state of a frame.

Returns

true if collapsed, false otherwise

Use this to determine the collapse state of a frame.

Parameters

collapse

true to collapse, false to expand

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