A panel is a type of animated container that contains subobjects. It can be expanded or contracted by clicking the button on it's edge. More...

Enumerations

enum  Elm_Panel_Orient {
  ELM_PANEL_ORIENT_TOP,
  ELM_PANEL_ORIENT_BOTTOM,
  ELM_PANEL_ORIENT_LEFT,
  ELM_PANEL_ORIENT_RIGHT
}

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)
 Get the orientation of the panel.
void elm_panel_hidden_set (Evas_Object *obj, Eina_Bool hidden)
 Set the state of the panel.
Eina_Bool elm_panel_hidden_get (const Evas_Object *obj)
 Get the state of the panel.
void elm_panel_toggle (Evas_Object *obj)
 Toggle the hidden state of the panel from code.

Detailed Description

A panel is a type of animated container that contains subobjects. It can be expanded or contracted by clicking the button on it's edge.

preview-00.png

Orientations are as follows:

  • ELM_PANEL_ORIENT_TOP
  • ELM_PANEL_ORIENT_LEFT
  • ELM_PANEL_ORIENT_RIGHT

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

  • "default" - A content of the panel

Supported elm_object common APIs.

Panel example shows one way to use this widget.


Enumeration Type Documentation

Enumerator:
ELM_PANEL_ORIENT_TOP 

Panel (dis)appears from the top.

ELM_PANEL_ORIENT_BOTTOM 

Not implemented.

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.

Parameters:
parentThe parent object
Returns:
The panel object, or NULL on failure

References ELM_PANEL_ORIENT_LEFT.

Eina_Bool elm_panel_hidden_get ( const Evas_Object *  obj)

Get the state of the panel.

Parameters:
objThe panel object
Returns:
EINA_TRUE if it is hidden state
void elm_panel_hidden_set ( Evas_Object *  obj,
Eina_Bool  hidden 
)

Set the state of the panel.

Parameters:
objThe panel object
hiddenIf true, the panel will run the animation to disappear.
Elm_Panel_Orient elm_panel_orient_get ( const Evas_Object *  obj)

Get the orientation of the panel.

Parameters:
objThe panel object
Returns:
The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.

References ELM_PANEL_ORIENT_LEFT.

void elm_panel_orient_set ( Evas_Object *  obj,
Elm_Panel_Orient  orient 
)

Sets the orientation of the panel.

Parameters:
objThe panel object
orientThe panel orientation. Can be one of the following:
  • ELM_PANEL_ORIENT_TOP
  • ELM_PANEL_ORIENT_LEFT
  • ELM_PANEL_ORIENT_RIGHT
Sets from where the panel will (dis)appear.

References ELM_PANEL_ORIENT_BOTTOM, ELM_PANEL_ORIENT_LEFT, ELM_PANEL_ORIENT_RIGHT, and ELM_PANEL_ORIENT_TOP.

void elm_panel_toggle ( Evas_Object *  obj)

Toggle the hidden state of the panel from code.

Parameters:
objThe panel object