Functions | |
Evas_Object * | elm_panes_add (Evas_Object *parent) |
Add a new panes widget to the given parent Elementary (container) object. | |
void | elm_panes_fixed_set (Evas_Object *obj, Eina_Bool fixed) |
Set whether the left and right panes resize homogeneously or not. | |
Eina_Bool | elm_panes_fixed_get (const Evas_Object *obj) |
Retrieve the resize mode for the panes of a given panes widget. | |
double | elm_panes_content_left_size_get (const Evas_Object *obj) |
Get the size proportion of panes widget's left side. | |
void | elm_panes_content_left_size_set (Evas_Object *obj, double size) |
Set the size proportion of panes widget's left side. | |
double | elm_panes_content_right_size_get (const Evas_Object *obj) |
Get the size proportion of panes widget's right side. | |
void | elm_panes_content_right_size_set (Evas_Object *obj, double size) |
Set the size proportion of panes widget's right side. | |
void | elm_panes_horizontal_set (Evas_Object *obj, Eina_Bool horizontal) |
Set the orientation of a given panes widget. | |
Eina_Bool | elm_panes_horizontal_get (const Evas_Object *obj) |
Retrieve the orientation of a given panes widget. |
Detailed Description



The panes widget adds a draggable bar between two contents. When dragged this bar will resize contents' size.
Panes can be displayed vertically or horizontally, and contents size proportion can be customized (homogeneous by default).
This widget inherits from the Layout one, so that all the functions acting on it also work for panes objects.
This widget emits the following signals, besides the ones sent from Layout:
"press"
- The panes has been pressed (button wasn't released yet)."unpressed"
- The panes was released after being pressed."clicked"
- The panes has been clicked>"clicked,double"
- The panes has been double clicked
Available styles for it:
"default"
Default content parts of the panes widget that you can use are:
- "left" - A leftside content of the panes
- "right" - A rightside content of the panes
If panes are displayed vertically, left content will be displayed on top.
Supported elm_object common APIs.
Here is an example on its usage:
Function Documentation
Evas_Object* elm_panes_add | ( | Evas_Object * | parent | ) |
Add a new panes widget to the given parent Elementary (container) object.
- Parameters:
-
parent The parent object.
- Returns:
- a new panes widget handle or
NULL
, on errors.
This function inserts a new panes widget on the canvas.
double elm_panes_content_left_size_get | ( | const Evas_Object * | obj | ) |
Get the size proportion of panes widget's left side.
- Parameters:
-
obj The panes object.
- Returns:
- float value between 0.0 and 1.0 representing size proportion of left side.
- See also:
- elm_panes_content_left_size_set() for more details.
References ELM_WIDGET_DATA.
Referenced by elm_panes_content_right_size_get().
void elm_panes_content_left_size_set | ( | Evas_Object * | obj, |
double | size | ||
) |
Set the size proportion of panes widget's left side.
- Parameters:
-
obj The panes object. size Value between 0.0 and 1.0 representing size proportion of left side.
By default it's homogeneous, i.e., both sides have the same size.
If something different is required, it can be set with this function. For example, if the left content should be displayed over 75% of the panes size, size
should be passed as 0.75
. This way, right content will be resized to 25% of panes size.
If displayed vertically, left content is displayed at top, and right content at bottom.
- Note:
- This proportion will change when user drags the panes bar.
- See also:
- elm_panes_content_left_size_get()
References ELM_WIDGET_DATA.
Referenced by elm_panes_content_right_size_set(), and elm_panes_horizontal_set().
double elm_panes_content_right_size_get | ( | const Evas_Object * | obj | ) |
Get the size proportion of panes widget's right side.
- Parameters:
-
obj The panes object.
- Returns:
- float value between 0.0 and 1.0 representing size proportion of right side.
- See also:
- elm_panes_content_right_size_set() for more details.
References elm_panes_content_left_size_get().
void elm_panes_content_right_size_set | ( | Evas_Object * | obj, |
double | size | ||
) |
Set the size proportion of panes widget's right side.
- Parameters:
-
obj The panes object. size Value between 0.0 and 1.0 representing size proportion of right side.
By default it's homogeneous, i.e., both sides have the same size.
If something different is required, it can be set with this function. For example, if the right content should be displayed over 75% of the panes size, size
should be passed as 0.75
. This way, left content will be resized to 25% of panes size.
If displayed vertically, left content is displayed at top, and right content at bottom.
- Note:
- This proportion will change when user drags the panes bar.
- See also:
- elm_panes_content_right_size_get()
References elm_panes_content_left_size_set().
Eina_Bool elm_panes_fixed_get | ( | const Evas_Object * | obj | ) |
Retrieve the resize mode for the panes of a given panes widget.
- Parameters:
-
obj The panes object.
- Returns:
EINA_TRUE
, ifobj
is set to be resized homogeneously,
- See also:
- elm_panes_fixed_set() for more details.
- elm_panes_content_left_size_get()
- elm_panes_content_right_size_get()
void elm_panes_fixed_set | ( | Evas_Object * | obj, |
Eina_Bool | fixed | ||
) |
Set whether the left and right panes resize homogeneously or not.
- Parameters:
-
obj The panes object. fixed Use EINA_TRUE
to makeobj
to be resize the left and right panes homogeneously. UseEINA_FALSE
to make use of the values specified in elm_panes_content_left_size_set() and elm_panes_content_right_size_set() to resize the left and right panes.
By default panes are resized homogeneously.
References elm_layout_signal_emit().
Eina_Bool elm_panes_horizontal_get | ( | const Evas_Object * | obj | ) |
Retrieve the orientation of a given panes widget.
- Parameters:
-
obj The panes object.
- Returns:
EINA_TRUE
, ifobj
is set to be horizontal,EINA_FALSE
if it's vertical (and on errors).
- See also:
- elm_panes_horizontal_set() for more details.
void elm_panes_horizontal_set | ( | Evas_Object * | obj, |
Eina_Bool | horizontal | ||
) |
Set the orientation of a given panes widget.
- Parameters:
-
obj The panes object. horizontal Use EINA_TRUE
to makeobj
to be horizontal,EINA_FALSE
to make it vertical.
Use this function to change how your panes is to be disposed: vertically or horizontally.
By default it's displayed horizontally.
- See also:
- elm_panes_horizontal_get()
References elm_panes_content_left_size_set().