Tizen Native API
Functions | Typedefs
Panel
Elementary Widgets

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 (EFL) :
1.8).

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

  • "default" - Content of the panel.

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

  • "scroll" - The content has been scrolled (moved).

Functions

Evas_Object * elm_panel_add (Evas_Object *parent)
 Adds a panel object.
void elm_panel_orient_set (Evas_Object *obj, Elm_Panel_Orient orient)
 Sets the orientation of the panel.
Elm_Panel_Orient elm_panel_orient_get (const Evas_Object *obj)
 Gets the orientation of the panel.
void elm_panel_hidden_set (Evas_Object *obj, Eina_Bool hidden)
 Sets the state of the panel.
Eina_Bool elm_panel_hidden_get (const Evas_Object *obj)
 Gets the state of the panel.
void elm_panel_toggle (Evas_Object *obj)
 Toggles the hidden state of the panel from the code.
void elm_panel_scrollable_set (Evas_Object *obj, Eina_Bool scrollable)
 Enables or disables scrolling in the panel.

Typedefs

typedef struct
_Elm_Panel_Scroll_Info 		Elm_Panel_Scroll_Info
 The structure type when the panel content is scrolled, if the panel object is scrollable, this information is passed by the event_info argument in the "scroll" smart callback function.

Enumeration Type Documentation

enum Elm_Panel_Orient

Enumeration of Elm Panel Orient type.

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.1
Parameters:
[in]parentThe parent object
Returns:
The panel object, otherwise NULL on failure
Eina_Bool elm_panel_hidden_get ( const Evas_Object *  obj)

Gets the state of the panel.

Since :
2.3.1
Parameters:
[in]objThe panel object
Returns:
EINA_TRUE if it is the hidden state, otherwise EINA_FALSE
void elm_panel_hidden_set ( Evas_Object *  obj,
Eina_Bool  hidden 
)

Sets the state of the panel.

Since :
2.3.1
Parameters:
[in]objThe panel object
[in]hiddenIf true the panel runs the animation to disappear, otherwise false
Elm_Panel_Orient elm_panel_orient_get ( const Evas_Object *  obj)

Gets the orientation of the panel.

Since :
2.3.1
Parameters:
[in]objThe panel object
Returns:
The Elm_Panel_Orient, otherwise ELM_PANEL_ORIENT_LEFT on failure
void elm_panel_orient_set ( Evas_Object *  obj,
Elm_Panel_Orient  orient 
)

Sets the orientation of the panel.

This sets the location from where the panel (dis)appears.

Since :
2.3.1
Parameters:
[in]objThe panel object
[in]orientThe panel orientation, can be one of the following:
  • ELM_PANEL_ORIENT_TOP
  • ELM_PANEL_ORIENT_LEFT
  • ELM_PANEL_ORIENT_RIGHT
void elm_panel_scrollable_set ( Evas_Object *  obj,
Eina_Bool  scrollable 
)

Enables or disables scrolling in the panel.

Remarks:
Tizen only feature but not internal (will be patched into upstream)
Since :
2.3.1
Remarks:
Normally the panel is not scrollable unless you enable it with this call.
Parameters:
[in]objThe panel object
[in]scrollableIf EINA_TRUE it is scrollable, otherwise EINA_FALSE
void elm_panel_toggle ( Evas_Object *  obj)

Toggles the hidden state of the panel from the code.

Since :
2.3.1
Parameters:
[in]objThe panel object