Functions
Panes

Functions

double elm_panes::content_left_size_get () const
 Get the size proportion of panes widget's left side. More...
 
void elm_panes::content_left_size_set (double size_) const
 Get the size proportion of panes widget's left side. More...
 
bool elm_panes::horizontal_get () const
 Retrieve the split direction of a given panes widget. More...
 
void elm_panes::horizontal_set (bool horizontal_) const
 Retrieve the split direction of a given panes widget. More...
 
bool elm_panes::fixed_get () const
 Retrieve the resize mode for the panes of a given panes widget. More...
 
void elm_panes::fixed_set (bool fixed_) const
 Retrieve the resize mode for the panes of a given panes widget. More...
 
double elm_panes::content_right_size_get () const
 Get the size proportion of panes widget's right side. More...
 
void elm_panes::content_right_size_set (double size_) const
 Get the size proportion of panes widget's right side. More...
 
double elm_panes::content_left_min_relative_size_get () const
 Get the relative minimum size of panes widget's left side. More...
 
void elm_panes::content_left_min_relative_size_set (double size_) const
 Get the relative minimum size of panes widget's left side. More...
 
double elm_panes::content_right_min_relative_size_get () const
 Get the relative minimum size of panes widget's right side. More...
 
void elm_panes::content_right_min_relative_size_set (double size_) const
 Get the relative minimum size of panes widget's right side. More...
 
Evas_Coord elm_panes::content_left_min_size_get () const
 Get the absolute minimum size of panes widget's left side. More...
 
void elm_panes::content_left_min_size_set (Evas_Coord size_) const
 Get the absolute minimum size of panes widget's left side. More...
 
Evas_Coord elm_panes::content_right_min_size_get () const
 Get the absolute minimum size of panes widget's right side. More...
 
void elm_panes::content_right_min_size_set (Evas_Coord size_) const
 Get the absolute minimum size of panes widget's right side. More...
 
Evas_Object * elm_panes_add (Evas_Object *parent)
 Add a new panes widget to the given parent Elementary (container) object. More...
 

Detailed Description

panes_inheritance_tree.png
preview-00.png
panes.png

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

Panes can be split 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:

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

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

double elm_panes::content_left_min_relative_size_get ( ) const
inline

Get the relative minimum size of panes widget's left side.

Parameters
objThe panes object.
Returns
double value between 0.0 and 1.0 representing size proportion of minimum size of left side.
See also
elm_panes_content_left_min_relative_size_set() for more details.
Parameters
sizevalue between 0.0 and 1.0 representing size proportion of minimum size of left side.
void elm_panes::content_left_min_relative_size_set ( double  size_) const
inline

Get the relative minimum size of panes widget's left side.

Parameters
objThe panes object.
Returns
double value between 0.0 and 1.0 representing size proportion of minimum size of left side.
See also
elm_panes_content_left_min_relative_size_set() for more details.
Parameters
sizevalue between 0.0 and 1.0 representing size proportion of minimum size of left side.
Evas_Coord elm_panes::content_left_min_size_get ( ) const
inline

Get the absolute minimum size of panes widget's left side.

Parameters
objThe panes object. int value representing minimum size of left side in pixels.
See also
elm_panes_content_left_min_size_set() for more details.
Parameters
sizevalue representing minimum size of left side in pixels.
void elm_panes::content_left_min_size_set ( Evas_Coord  size_) const
inline

Get the absolute minimum size of panes widget's left side.

Parameters
objThe panes object. int value representing minimum size of left side in pixels.
See also
elm_panes_content_left_min_size_set() for more details.
Parameters
sizevalue representing minimum size of left side in pixels.
double elm_panes::content_left_size_get ( ) const
inline

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

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.
Parameters
sizeValue between 0.0 and 1.0 representing size proportion of left side.
void elm_panes::content_left_size_set ( double  size_) const
inline

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

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.
Parameters
sizeValue between 0.0 and 1.0 representing size proportion of left side.
double elm_panes::content_right_min_relative_size_get ( ) const
inline

Get the relative minimum size of panes widget's right side.

Parameters
objThe panes object.
Returns
double value between 0.0 and 1.0 representing size proportion of minimum size of right side.
See also
elm_panes_content_right_min_size_set() for more details.
Parameters
sizevalue between 0.0 and 1.0 representing size proportion of minimum size of right side.
void elm_panes::content_right_min_relative_size_set ( double  size_) const
inline

Get the relative minimum size of panes widget's right side.

Parameters
objThe panes object.
Returns
double value between 0.0 and 1.0 representing size proportion of minimum size of right side.
See also
elm_panes_content_right_min_size_set() for more details.
Parameters
sizevalue between 0.0 and 1.0 representing size proportion of minimum size of right side.
Evas_Coord elm_panes::content_right_min_size_get ( ) const
inline

Get the absolute minimum size of panes widget's right side.

Parameters
objThe panes object. int value representing minimum size of right side in pixels.
See also
elm_panes_content_right_min_size_set() for more details.
Parameters
sizevalue representing minimum size of right side in pixels.
void elm_panes::content_right_min_size_set ( Evas_Coord  size_) const
inline

Get the absolute minimum size of panes widget's right side.

Parameters
objThe panes object. int value representing minimum size of right side in pixels.
See also
elm_panes_content_right_min_size_set() for more details.
Parameters
sizevalue representing minimum size of right side in pixels.
double elm_panes::content_right_size_get ( ) const
inline

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

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.
Parameters
sizeValue between 0.0 and 1.0 representing size proportion of right side.
void elm_panes::content_right_size_set ( double  size_) const
inline

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

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.
Parameters
sizeValue between 0.0 and 1.0 representing size proportion of right side.
Evas_Object* elm_panes_add ( Evas_Object *  parent)

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

Parameters
parentThe parent object.
Returns
a new panes widget handle or NULL, on errors.

This function inserts a new panes widget on the canvas.

bool elm_panes::fixed_get ( ) const
inline

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

Returns
EINA_TRUE, if obj is set to be resizable by user interaction.
See also
elm_panes_fixed_set() for more details.
elm_panes_content_left_size_get()
elm_panes_content_right_size_get()
Parameters
fixedUse EINA_TRUE to fix the left and right panes sizes and make them not to be resized by user interaction. Use EINA_FALSE to make them resizable.
void elm_panes::fixed_set ( bool  fixed_) const
inline

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

Returns
EINA_TRUE, if obj is set to be resizable by user interaction.
See also
elm_panes_fixed_set() for more details.
elm_panes_content_left_size_get()
elm_panes_content_right_size_get()
Parameters
fixedUse EINA_TRUE to fix the left and right panes sizes and make them not to be resized by user interaction. Use EINA_FALSE to make them resizable.
bool elm_panes::horizontal_get ( ) const
inline

Retrieve the split direction of a given panes widget.

Returns
EINA_TRUE, if obj is set to be horizontal, EINA_FALSE if it's vertical (and on errors).
See also
elm_panes_horizontal_set() for more details.
Parameters
horizontalUse EINA_TRUE to make obj to split panes horizontally ("top" and "bottom" contents). EINA_FALSE to make it vertically ("left" and "right" contents)
void elm_panes::horizontal_set ( bool  horizontal_) const
inline

Retrieve the split direction of a given panes widget.

Returns
EINA_TRUE, if obj is set to be horizontal, EINA_FALSE if it's vertical (and on errors).
See also
elm_panes_horizontal_set() for more details.
Parameters
horizontalUse EINA_TRUE to make obj to split panes horizontally ("top" and "bottom" contents). EINA_FALSE to make it vertically ("left" and "right" contents)