Tizen Native API  5.5

A panel is an animated side-panel that contains a sub-object. It can be expanded or contracted by clicking the button on its edge.

panel_inheritance_tree.png

Orientations are as follows:

  • #ELM_PANEL_ORIENT_TOP
  • #ELM_PANEL_ORIENT_LEFT
  • #ELM_PANEL_ORIENT_RIGHT
  • #ELM_PANEL_ORIENT_BOTTOM

This widget inherits from the Layout one, so that all the functions acting on it also work for panel objects (since 1.8).

This widget emits the following signals, besides the ones sent from Layout:

  • "toggled" : When the panel has been toggled. (since 1.18)
  • "scroll" : When the content has been scrolled (moved). (since 1.10) This signal is emitted only when the panel is scrollable. Elm_Panel_Scroll_Info will be passed by event_info argument.
  • "focused" : When the panel has received focus. (since 1.8)
  • "unfocused" : When the panel has lost focus. (since 1.8)

Default content parts of the panel widget that you can use are:

  • "default" - A content of the panel

Panel example shows one way to use this widget.

Functions

void elm_panel_orient_set (Elm_Panel *obj, Elm_Panel_Orient orient)
 Set the orientation of the panel.
Elm_Panel_Orient elm_panel_orient_get (const Elm_Panel *obj)
 Get the orientation of the panel.
void elm_panel_hidden_set (Elm_Panel *obj, Eina_Bool hidden)
 Set the state of the panel.
Eina_Bool elm_panel_hidden_get (const Elm_Panel *obj)
 Get the state of the panel.
void elm_panel_scrollable_set (Elm_Panel *obj, Eina_Bool scrollable)
 Set the scrollability of the panel.
Eina_Bool elm_panel_scrollable_get (const Elm_Panel *obj)
 Get the state of the scrollability.
void elm_panel_scrollable_content_size_set (Elm_Panel *obj, double ratio)
 Set the size of the scrollable panel.
void elm_panel_toggle (Elm_Panel *obj)
 Get the size of the scrollable panel.
Evas_Objectelm_panel_add (Evas_Object *parent)
 Adds a panel object.

Typedefs

typedef struct
_Elm_Panel_Scroll_Info 
Elm_Panel_Scroll_Info

Typedef Documentation

Panel scroll information

Since (EFL) :
1.11

Function Documentation

Adds a panel object.

Parameters:
parentThe parent object
Returns:
The panel object, or NULL on failure
Since :
2.3
Examples:
panel_example_01.c.
Eina_Bool elm_panel_hidden_get ( const Elm_Panel *  obj)

Get the state of the panel.

Parameters:
[in]objThe object.
Returns:
If true, the panel will run the animation to disappear.
Since :
2.3
void elm_panel_hidden_set ( Elm_Panel *  obj,
Eina_Bool  hidden 
)

Set the state of the panel.

Parameters:
[in]objThe object.
[in]hiddenIf true, the panel will run the animation to disappear.
Since :
2.3
Examples:
panel_example_01.c.
Elm_Panel_Orient elm_panel_orient_get ( const Elm_Panel *  obj)

Get the orientation of the panel.

Parameters:
[in]objThe object.
Returns:
The panel orientation.
Since :
2.3
void elm_panel_orient_set ( Elm_Panel *  obj,
Elm_Panel_Orient  orient 
)

Set the orientation of the panel.

Set from where the panel will (dis)appear.

Parameters:
[in]objThe object.
[in]orientThe panel orientation.
Since :
2.3
Examples:
panel_example_01.c.
void elm_panel_scrollable_content_size_set ( Elm_Panel *  obj,
double  ratio 
)

Set the size of the scrollable panel.

Parameters:
[in]objThe object.
[in]ratioSize ratio
Since :
3.0f(2.3.1)
Eina_Bool elm_panel_scrollable_get ( const Elm_Panel *  obj)

Get the state of the scrollability.

Parameters:
[in]objThe object.
Returns:
The scrollable state.
Since (EFL) :
1.12
Since :
3.0f(2.3.1)
void elm_panel_scrollable_set ( Elm_Panel *  obj,
Eina_Bool  scrollable 
)

Set the scrollability of the panel.

Parameters:
[in]objThe object.
[in]scrollableThe scrollable state.
Since :
2.3
void elm_panel_toggle ( Elm_Panel *  obj)

Get the size of the scrollable panel.

Parameters:
[in]objThe object.
Returns:
Size ratio
Since (EFL) :
1.19 Toggle the hidden state of the panel from code
Since :
2.3
Examples:
panel_example_01.c.