Panes

- Main Page
- Related Pages
- Data Structures
- Files
- Examples

Functions
Panes

## Functions
EOAPI void | elm_obj_panes_content_left_size_set (double size)
| Set the size proportion of panes widget's left side. More...
EOAPI double | elm_obj_panes_content_left_size_get (void)
| Get the size proportion of panes widget's left side. More...
EOAPI void | elm_obj_panes_horizontal_set (Eina_Bool horizontal)
| Set how to split and dispose each content. More...
EOAPI Eina_Bool | elm_obj_panes_horizontal_get (void)
| Get the split direction of a given panes widget. More...
EOAPI void | elm_obj_panes_fixed_set (Eina_Bool fixed)
| Set whether the left and right panes can be resized by user interaction. More...
EOAPI Eina_Bool | elm_obj_panes_fixed_get (void)
| Get the resize mode for the panes of a given panes widget. More...
EOAPI void | elm_obj_panes_content_right_size_set (double size)
| Set the size proportion of panes widget's right side. More...
EOAPI double | elm_obj_panes_content_right_size_get (void)
| Get the size proportion of panes widget's right side. More...
EOAPI void | elm_obj_panes_content_left_min_relative_size_set (double size)
| Set the relative minimum size of panes widget's left side. More...
EOAPI double | elm_obj_panes_content_left_min_relative_size_get (void)
| Get the relative minimum size of panes widget's left side. More...
EOAPI void | elm_obj_panes_content_right_min_relative_size_set (double size)
| Set the relative minimum size of panes widget's right side. More...
EOAPI double | elm_obj_panes_content_right_min_relative_size_get (void)
| Get the relative minimum size of panes widget's right side. More...
EOAPI void | elm_obj_panes_content_left_min_size_set (Evas_Coord size)
| Set the absolute minimum size of panes widget's left side. More...
EOAPI Evas_Coord | elm_obj_panes_content_left_min_size_get (void)
| Get the absolute minimum size of panes widget's left side. More...
EOAPI void | elm_obj_panes_content_right_min_size_set (Evas_Coord size)
| Set the absolute minimum size of panes widget's right side. More...
EOAPI Evas_Coord | elm_obj_panes_content_right_min_size_get (void)
| Get the absolute minimum size of panes widget's right side. More...
void | elm_panes_content_left_size_set (Elm_Panes *obj, double size)
| Set the size proportion of panes widget's left side. More...
double | elm_panes_content_left_size_get (const Elm_Panes *obj)
| Get the size proportion of panes widget's left side. More...
void | elm_panes_horizontal_set (Elm_Panes *obj, Eina_Bool horizontal)
| Set how to split and dispose each content. More...
Eina_Bool | elm_panes_horizontal_get (const Elm_Panes *obj)
| Get the split direction of a given panes widget. More...
void | elm_panes_fixed_set (Elm_Panes *obj, Eina_Bool fixed)
| Set whether the left and right panes can be resized by user interaction. More...
Eina_Bool | elm_panes_fixed_get (const Elm_Panes *obj)
| Get the resize mode for the panes of a given panes widget. More...
void | elm_panes_content_right_size_set (Elm_Panes *obj, double size)
| Set the size proportion of panes widget's right side. More...
double | elm_panes_content_right_size_get (const Elm_Panes *obj)
| Get the size proportion of panes widget's right side. More...
void | elm_panes_content_left_min_relative_size_set (Elm_Panes *obj, double size)
| Set the relative minimum size of panes widget's left side. More...
double | elm_panes_content_left_min_relative_size_get (const Elm_Panes *obj)
| Get the relative minimum size of panes widget's left side. More...
void | elm_panes_content_right_min_relative_size_set (Elm_Panes *obj, double size)
| Set the relative minimum size of panes widget's right side. More...
double | elm_panes_content_right_min_relative_size_get (const Elm_Panes *obj)
| Get the relative minimum size of panes widget's right side. More...
void | elm_panes_content_left_min_size_set (Elm_Panes *obj, Evas_Coord size)
| Set the absolute minimum size of panes widget's left side. More...
Evas_Coord | elm_panes_content_left_min_size_get (const Elm_Panes *obj)
| Get the absolute minimum size of panes widget's left side. More...
void | elm_panes_content_right_min_size_set (Elm_Panes *obj, Evas_Coord size)
| Set the absolute minimum size of panes widget's right side. More...
Evas_Coord | elm_panes_content_right_min_size_get (const Elm_Panes *obj)
| 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

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:

- `"press"` - The panes has been pressed (button wasn't released yet).
- `"unpress"` - 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
- "top" - A top content of the vertical panes
- "bottom" - A bottom content of the vertical panes

If panes are displayed vertically, left content will be displayed on top.

Supported elm_object common APIs.

- elm_object_part_content_set
- elm_object_part_content_get
- elm_object_part_content_unset

Here is an example on its usage:

- Panes widget example

## Function Documentation

EOAPI double elm_obj_panes_content_left_min_relative_size_get | ( | void |  | ) |

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

Parameters

  obj | The 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.

Referenced by elm_panes_content_left_min_relative_size_get().

EOAPI void elm_obj_panes_content_left_min_relative_size_set | ( | double | size | ) |

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

Parameters

  obj | The panes object.
  size | double value between 0.0 and 1.0 representing size proportion of minimum size of left side.

Note
  If displayed vertically, left content is displayed at top.

See also
  elm_panes_content_left_min_size_relative_get()

Parameters

  [in] | size | value between 0.0 and 1.0 representing size proportion of minimum size of left side.

Referenced by elm_panes_content_left_min_relative_size_set().

EOAPI Evas_Coord elm_obj_panes_content_left_min_size_get | ( | void |  | ) |

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

Parameters

  obj | The panes object. int value representing minimum size of left side in pixels.

See also
  elm_panes_content_left_min_size_set() for more details.

Referenced by elm_panes_content_left_min_size_get().

EOAPI void elm_obj_panes_content_left_min_size_set | ( | Evas_Coord | size | ) |

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

Parameters

  obj | The panes object.
  size | int value representing minimum size of left side in pixels.

Note
  If displayed vertically, left content is displayed at top.

See also
  elm_panes_content_left_min_size_get()

Parameters

  [in] | size | value representing minimum size of left side in pixels.

Referenced by elm_panes_content_left_min_size_set().

EOAPI double elm_obj_panes_content_left_size_get | ( | void |  | ) |

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.

Referenced by elm_panes_content_left_size_get().

EOAPI void elm_obj_panes_content_left_size_set | ( | double | size | ) |

Set the size proportion of panes widget's 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()

Parameters

  [in] | size | Value between 0.0 and 1.0 representing size proportion of left side.

Referenced by elm_panes_content_left_size_set().

EOAPI double elm_obj_panes_content_right_min_relative_size_get | ( | void |  | ) |

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

Parameters

  obj | The 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.

Referenced by elm_panes_content_right_min_relative_size_get().

EOAPI void elm_obj_panes_content_right_min_relative_size_set | ( | double | size | ) |

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

Parameters

  obj | The panes object.
  size | double value between 0.0 and 1.0 representing size proportion of minimum size of right side.

Note
  If displayed vertically, right content is displayed at bottom.

See also
  elm_panes_content_right_min_relative_size_get()

Parameters

  [in] | size | value between 0.0 and 1.0 representing size proportion of minimum size of right side.

Referenced by elm_panes_content_right_min_relative_size_set().

EOAPI Evas_Coord elm_obj_panes_content_right_min_size_get | ( | void |  | ) |

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

Parameters

  obj | The panes object. int value representing minimum size of right side in pixels.

See also
  elm_panes_content_right_min_size_set() for more details.

Referenced by elm_panes_content_right_min_size_get().

EOAPI void elm_obj_panes_content_right_min_size_set | ( | Evas_Coord | size | ) |

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

Parameters

  obj | The panes object.
  size | int value representing minimum size of right side in pixels.

Note
  If displayed vertically, right content is displayed at bottom.

See also
  elm_panes_content_right_min_size_get()

Parameters

  [in] | size | value representing minimum size of right side in pixels.

Referenced by elm_panes_content_right_min_size_set().

EOAPI double elm_obj_panes_content_right_size_get | ( | void |  | ) |

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.

Referenced by elm_panes_content_right_size_get().

EOAPI void elm_obj_panes_content_right_size_set | ( | double | size | ) |

Set the size proportion of panes widget's 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()

Parameters

  [in] | size | Value between 0.0 and 1.0 representing size proportion of right side.

Referenced by elm_panes_content_right_size_set().

EOAPI Eina_Bool elm_obj_panes_fixed_get | ( | void |  | ) |

Get 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()

Referenced by elm_panes_fixed_get().

EOAPI void elm_obj_panes_fixed_set | ( | Eina_Bool | fixed | ) |

Set whether the left and right panes can be resized by user interaction.

By default panes' contents are resizable by user interaction.

See also
  elm_panes_fixed_get()
  elm_panes_content_left_size_set()
  elm_panes_content_right_size_set()

Parameters

  [in] | fixed | Use `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.

Referenced by elm_panes_fixed_set().

EOAPI Eina_Bool elm_obj_panes_horizontal_get | ( | void |  | ) |

Get 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.

Referenced by elm_panes_horizontal_get().

EOAPI void elm_obj_panes_horizontal_set | ( | Eina_Bool | horizontal | ) |

Set how to split and dispose each content.

Use this function to change how your panes is to be disposed: vertically or horizontally. Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents.

By default panes is in a vertical mode.

See also
  elm_panes_horizontal_get()

Parameters

  [in] | horizontal | Use `EINA_TRUE` to make `obj` to split panes horizontally ("top" and "bottom" contents). `EINA_FALSE` to make it vertically ("left" and "right" contents)

Referenced by elm_panes_horizontal_set().

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_min_relative_size_get | ( | const Elm_Panes * | obj | ) |

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

Parameters

  obj | The 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.

References elm_obj_panes_content_left_min_relative_size_get().

void elm_panes_content_left_min_relative_size_set | ( | Elm_Panes * | obj,
|  | double | size
| ) |  |

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

Parameters

  obj | The panes object.
  size | double value between 0.0 and 1.0 representing size proportion of minimum size of left side.

Note
  If displayed vertically, left content is displayed at top.

See also
  elm_panes_content_left_min_size_relative_get()

Parameters

  [in] | size | value between 0.0 and 1.0 representing size proportion of minimum size of left side.

References elm_obj_panes_content_left_min_relative_size_set().

Evas_Coord elm_panes_content_left_min_size_get | ( | const Elm_Panes * | obj | ) |

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

Parameters

  obj | The panes object. int value representing minimum size of left side in pixels.

See also
  elm_panes_content_left_min_size_set() for more details.

References elm_obj_panes_content_left_min_size_get().

void elm_panes_content_left_min_size_set | ( | Elm_Panes * | obj,
|  | Evas_Coord | size
| ) |  |

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

Parameters

  obj | The panes object.
  size | int value representing minimum size of left side in pixels.

Note
  If displayed vertically, left content is displayed at top.

See also
  elm_panes_content_left_min_size_get()

Parameters

  [in] | size | value representing minimum size of left side in pixels.

References elm_obj_panes_content_left_min_size_set().

double elm_panes_content_left_size_get | ( | const Elm_Panes * | obj | ) |

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.

References elm_obj_panes_content_left_size_get().

void elm_panes_content_left_size_set | ( | Elm_Panes * | obj,
|  | double | size
| ) |  |

Set the size proportion of panes widget's 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()

Parameters

  [in] | size | Value between 0.0 and 1.0 representing size proportion of left side.

References elm_obj_panes_content_left_size_set().

double elm_panes_content_right_min_relative_size_get | ( | const Elm_Panes * | obj | ) |

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

Parameters

  obj | The 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.

References elm_obj_panes_content_right_min_relative_size_get().

void elm_panes_content_right_min_relative_size_set | ( | Elm_Panes * | obj,
|  | double | size
| ) |  |

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

Parameters

  obj | The panes object.
  size | double value between 0.0 and 1.0 representing size proportion of minimum size of right side.

Note
  If displayed vertically, right content is displayed at bottom.

See also
  elm_panes_content_right_min_relative_size_get()

Parameters

  [in] | size | value between 0.0 and 1.0 representing size proportion of minimum size of right side.

References elm_obj_panes_content_right_min_relative_size_set().

Evas_Coord elm_panes_content_right_min_size_get | ( | const Elm_Panes * | obj | ) |

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

Parameters

  obj | The panes object. int value representing minimum size of right side in pixels.

See also
  elm_panes_content_right_min_size_set() for more details.

References elm_obj_panes_content_right_min_size_get().

void elm_panes_content_right_min_size_set | ( | Elm_Panes * | obj,
|  | Evas_Coord | size
| ) |  |

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

Parameters

  obj | The panes object.
  size | int value representing minimum size of right side in pixels.

Note
  If displayed vertically, right content is displayed at bottom.

See also
  elm_panes_content_right_min_size_get()

Parameters

  [in] | size | value representing minimum size of right side in pixels.

References elm_obj_panes_content_right_min_size_set().

double elm_panes_content_right_size_get | ( | const Elm_Panes * | obj | ) |

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.

References elm_obj_panes_content_right_size_get().

void elm_panes_content_right_size_set | ( | Elm_Panes * | obj,
|  | double | size
| ) |  |

Set the size proportion of panes widget's 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()

Parameters

  [in] | size | Value between 0.0 and 1.0 representing size proportion of right side.

References elm_obj_panes_content_right_size_set().

Eina_Bool elm_panes_fixed_get | ( | const Elm_Panes * | obj | ) |

Get 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()

References elm_obj_panes_fixed_get().

void elm_panes_fixed_set | ( | Elm_Panes * | obj,
|  | Eina_Bool | fixed
| ) |  |

Set whether the left and right panes can be resized by user interaction.

By default panes' contents are resizable by user interaction.

See also
  elm_panes_fixed_get()
  elm_panes_content_left_size_set()
  elm_panes_content_right_size_set()

Parameters

  [in] | fixed | Use `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.

References elm_obj_panes_fixed_set().

Eina_Bool elm_panes_horizontal_get | ( | const Elm_Panes * | obj | ) |

Get 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.

References elm_obj_panes_horizontal_get().

void elm_panes_horizontal_set | ( | Elm_Panes * | obj,
|  | Eina_Bool | horizontal
| ) |  |

Set how to split and dispose each content.

Use this function to change how your panes is to be disposed: vertically or horizontally. Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents.

By default panes is in a vertical mode.

See also
  elm_panes_horizontal_get()

Parameters

  [in] | horizontal | Use `EINA_TRUE` to make `obj` to split panes horizontally ("top" and "bottom" contents). `EINA_FALSE` to make it vertically ("left" and "right" contents)

References elm_obj_panes_horizontal_set().