Tizen Native API
Functions
Panes
Elementary Widgets

Functions

Evas_Objectelm_panes_add (Evas_Object *parent)
 Adds a new panes widget to the given parent Elementary (container) object.
void elm_panes_fixed_set (Evas_Object *obj, Eina_Bool fixed)
 Sets whether the left and right panes resize homogeneously.
Eina_Bool elm_panes_fixed_get (const Evas_Object *obj)
 Gets the resize mode for the panes of a given panes widget.
double elm_panes_content_left_size_get (const Evas_Object *obj)
 Gets the size proportion of panes widget's left side.
void elm_panes_content_left_size_set (Evas_Object *obj, double size)
 Sets the size proportion of the panes widget's left side.
double elm_panes_content_right_size_get (const Evas_Object *obj)
 Gets the size proportion of the panes widget's right side.
void elm_panes_content_right_size_set (Evas_Object *obj, double size)
 Sets the size proportion of the panes widget's right side.
void elm_panes_horizontal_set (Evas_Object *obj, Eina_Bool horizontal)
 Sets the orientation of a given panes widget.
Eina_Bool elm_panes_horizontal_get (const Evas_Object *obj)
 Gets the orientation of a given panes widget.

The panes widget adds a draggable bar between two contents. When dragged this bar resizes contents' size.

panes_inheritance_tree.png
panes.png

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 :

Available styles for it:

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

If panes are displayed vertically, left content is displayed on top.

Supported common elm_object APIs.


Function Documentation

Adds a new panes widget to the given parent Elementary (container) object.

This function inserts a new panes widget on the canvas.

Since :
2.3
Parameters:
[in]parentThe parent object
Returns:
A new panes widget handle, otherwise NULL in case of an error

Gets the size proportion of panes widget's left side.

Since :
2.3
Parameters:
[in]objThe panes object
Returns:
The float value between 0.0 and 1.0 representing the size proportion of the left side
See also:
elm_panes_content_left_size_set()
void elm_panes_content_left_size_set ( Evas_Object obj,
double  size 
)

Sets the size proportion of the panes widget's left side.

Since :
2.3
Remarks:
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, the right content is resized to 25% of the panes size.
If displayed vertically, left content is displayed at the top, and right content at the bottom.
This proportion changes when the user drags the panes bar.
Parameters:
[in]objThe panes object
[in]sizeThe value between 0.0 and 1.0 representing the size proportion of the left side
See also:
elm_panes_content_left_size_get()

Gets the size proportion of the panes widget's right side.

Since :
2.3
Parameters:
[in]objThe panes object
Returns:
The float value between 0.0 and 1.0 representing the size proportion of the right side
See also:
elm_panes_content_right_size_set()
void elm_panes_content_right_size_set ( Evas_Object obj,
double  size 
)

Sets the size proportion of the panes widget's right side.

Since :
2.3
Remarks:
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, the left content is resized to 25% of the panes size.
If displayed vertically, the left content is displayed at the top, and the right content at the bottom.
This proportion changes when the user drags the panes bar.
Parameters:
[in]objThe panes object
[in]sizeThe values between 0.0 and 1.0 representing the size proportion of the right side
See also:
elm_panes_content_right_size_get()

Gets the resize mode for the panes of a given panes widget.

Since :
2.3
Parameters:
[in]objThe panes object
Returns:
EINA_TRUE if obj is set to be resized homogeneously, otherwise EINA_FALSE
See also:
elm_panes_fixed_set()
elm_panes_content_left_size_get()
elm_panes_content_right_size_get()
void elm_panes_fixed_set ( Evas_Object obj,
Eina_Bool  fixed 
)

Sets whether the left and right panes resize homogeneously.

Since :
2.3
Remarks:
By default panes are resized homogeneously.
Parameters:
[in]objThe panes object
[in]fixedIf EINA_TRUE obj resizes the left and right panes homogeneously, otherwise EINA_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
See also:
elm_panes_fixed_get()
elm_panes_content_left_size_set()
elm_panes_content_right_size_set()

Gets the orientation of a given panes widget.

Since :
2.3
Parameters:
[in]objThe panes object
Returns:
EINA_TRUE, if obj is set to be horizontal, otherwise EINA_FALSE if it's vertical (and on errors)
See also:
elm_panes_horizontal_set()
void elm_panes_horizontal_set ( Evas_Object obj,
Eina_Bool  horizontal 
)

Sets the orientation of a given panes widget.

Since :
2.3
Remarks:
Use this function to change how your panes are to be disposed: vertically or horizontally.

By default it's displayed horizontally.

Parameters:
[in]objThe panes object
[in]horizontalIf EINA_TRUE obj is horizontal, otherwise EINA_FALSE to make it vertical
See also:
elm_panes_horizontal_get()

Except as noted, this content - excluding the Code Examples - is licensed under Creative Commons Attribution 3.0 and all of the Code Examples contained herein are licensed under BSD-3-Clause.
For details, see the Content License