Tizen Native API
Functions | Typedefs
Panel
Elementary Widgets

Functions

void elm_panel_orient_set (Elm_Panel *obj, Elm_Panel_Orient orient)
 Sets 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.
void elm_panel_toggle (Elm_Panel *obj)
 Toggle the hidden state of the panel from code.
Evas_Object * elm_panel_add (Evas_Object *parent)
 Adds a panel object.

Typedefs

typedef struct
_Elm_Panel_Scroll_Info 		Elm_Panel_Scroll_Info

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:

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:

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

Typedef Documentation

typedef struct _Elm_Panel_Scroll_Info Elm_Panel_Scroll_Info

Panel scroll information

Since (EFL) :
1.11

Enumeration Type Documentation

enum Elm_Panel_Orient

Panel orientation mode

Enumerator:
ELM_PANEL_ORIENT_TOP 

Panel (dis)appears from the top

ELM_PANEL_ORIENT_BOTTOM 

Panel (dis)appears from the bottom

ELM_PANEL_ORIENT_LEFT 

Panel (dis)appears from the left

ELM_PANEL_ORIENT_RIGHT 

Panel (dis)appears from the right

Function Documentation

Evas_Object* elm_panel_add ( Evas_Object *  parent)

Adds a panel object.

Since :
2.3
Parameters:
[in]parentThe parent object
Returns:
The panel object, or NULL on failure
Eina_Bool elm_panel_hidden_get ( const Elm_Panel *  obj)

Get the state of the panel.

Since :
2.3
Returns:
EINA_TRUE if it is hidden state
Parameters:
[in]objThe elm panel object
void elm_panel_hidden_set ( Elm_Panel *  obj,
Eina_Bool  hidden 
)

Set the state of the panel.

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

Get the orientation of the panel.

Since :
2.3
Returns:
The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
Parameters:
[in]objThe elm panel object
void elm_panel_orient_set ( Elm_Panel *  obj,
Elm_Panel_Orient  orient 
)

Sets the orientation of the panel.

Since :
2.3
Remarks:
Sets from where the panel will (dis)appear.
Parameters:
[in]objThe elm panel object
[in]orientThe panel orientation. Can be one of the following:
void elm_panel_scrollable_set ( Elm_Panel *  obj,
Eina_Bool  scrollable 
)

Set the scrollability of the panel.

Since :
2.3
Parameters:
[in]objThe elm panel object
[in]scrollableNo description supplied.
void elm_panel_toggle ( Elm_Panel *  obj)

Toggle the hidden state of the panel from code.

Since :
2.3
Parameters:
[in]objThe elm panel object