Etk
Main Page Object Hierarchy Data Structures Related Pages
Etk

Etk_Paned


Detailed Description

The Etk_Paned widget is a container that can contain two children separated by a draggable separator.

paned.png
Etk_Paned is the abstract class for two derived widgets: Etk_HPaned and Etk_VPaned.
  • Etk_HPaned is a paned where the two children are arranged horizontally and separated by a vertical draggable separator
  • Etk_VPaned is a paned where the two children are arranged vertically and separated by a horizontal draggable separator

Object Hierarchy:
  • Etk_Object
    • Etk_Widget
      • Etk_Container
        • Etk_Paned
          • Etk_HPaned
          • Etk_VPaned
Properties:
  • "position": The position of the separator in pixels. This is the position from the left border for a hpaned and from the top border for a vpaned
    • Type: Integer
    • Access: Read/Write
    • Default Value: 0


Data Structures

struct  Etk_Paned
 [Widget] A container that can contain two children separated by a draggable separator More...
struct  Etk_HPaned
 [Widget] A horizontal paned container More...
struct  Etk_VPaned
 [Widget] A vertical paned container More...

Defines

#define ETK_PANED_TYPE   (etk_paned_type_get())
#define ETK_PANED(obj)   (ETK_OBJECT_CAST((obj), ETK_PANED_TYPE, Etk_Paned))
#define ETK_IS_PANED(obj)   (ETK_OBJECT_CHECK_TYPE((obj), ETK_PANED_TYPE))
#define ETK_HPANED_TYPE   (etk_hpaned_type_get())
#define ETK_HPANED(obj)   (ETK_OBJECT_CAST((obj), ETK_HPANED_TYPE, Etk_HPaned))
#define ETK_IS_HPANED(obj)   (ETK_OBJECT_CHECK_TYPE((obj), ETK_HPANED_TYPE))
#define ETK_VPANED_TYPE   (etk_vpaned_type_get())
#define ETK_VPANED(obj)   (ETK_OBJECT_CAST((obj), ETK_VPANED_TYPE, Etk_VPaned))
#define ETK_IS_VPANED(obj)   (ETK_OBJECT_CHECK_TYPE((obj), ETK_VPANED_TYPE))

Functions

Etk_Widget * etk_hpaned_new (void)
 Creates a new horizontal paned container.
Etk_Widget * etk_vpaned_new (void)
 Creates a new vertical paned container.
void etk_paned_child1_set (Etk_Paned *paned, Etk_Widget *child, Etk_Bool expand)
 Sets the first child of the paned (the left one for a hpaned, the top one for a vpaned).
void etk_paned_child2_set (Etk_Paned *paned, Etk_Widget *child, Etk_Bool expand)
 Sets the second child of the paned (the right one for a hpaned, the bottom one for a vpaned).
Etk_Widget * etk_paned_child1_get (Etk_Paned *paned)
 Gets the first child of the paned (the left one for a hpaned, the top one for a vpaned).
Etk_Widget * etk_paned_child2_get (Etk_Paned *paned)
 Gets the second child of the paned (the right one for a hpaned, the bottom one for a vpaned).
void etk_paned_child1_expand_set (Etk_Paned *paned, Etk_Bool expand)
 Sets whether the first child should expand as much as possible when the paned is resized.
void etk_paned_child2_expand_set (Etk_Paned *paned, Etk_Bool expand)
 Sets whether the second child should expand as much as possible when the paned is resized.
Etk_Bool etk_paned_child1_expand_get (Etk_Paned *paned)
 Gets whether the first child expands.
Etk_Bool etk_paned_child2_expand_get (Etk_Paned *paned)
 Gets whether the second child expands.
void etk_paned_position_set (Etk_Paned *paned, int position)
 Sets the position in pixels of the separator of the paned.
int etk_paned_position_get (Etk_Paned *paned)
 Gets the position in pixels of the separator of the paned.


Define Documentation

#define ETK_PANED_TYPE   (etk_paned_type_get())

Gets the type of a paned

#define ETK_PANED ( obj   )     (ETK_OBJECT_CAST((obj), ETK_PANED_TYPE, Etk_Paned))

Casts the object to an Etk_Paned

#define ETK_IS_PANED ( obj   )     (ETK_OBJECT_CHECK_TYPE((obj), ETK_PANED_TYPE))

Checks if the object is an Etk_Paned

#define ETK_HPANED_TYPE   (etk_hpaned_type_get())

Gets the type of a hpaned

#define ETK_HPANED ( obj   )     (ETK_OBJECT_CAST((obj), ETK_HPANED_TYPE, Etk_HPaned))

Casts the object to an Etk_HPaned

#define ETK_IS_HPANED ( obj   )     (ETK_OBJECT_CHECK_TYPE((obj), ETK_HPANED_TYPE))

Checks if the object is an Etk_HPaned

#define ETK_VPANED_TYPE   (etk_vpaned_type_get())

Gets the type of a vpaned

#define ETK_VPANED ( obj   )     (ETK_OBJECT_CAST((obj), ETK_VPANED_TYPE, Etk_VPaned))

Casts the object to an Etk_VPaned

#define ETK_IS_VPANED ( obj   )     (ETK_OBJECT_CHECK_TYPE((obj), ETK_VPANED_TYPE))

Checks if the object is an Etk_VPaned


Function Documentation

Etk_Widget * etk_hpaned_new ( void   ) 

Creates a new horizontal paned container.

Returns:
Returns the horizontal paned container

Etk_Widget * etk_vpaned_new ( void   ) 

Creates a new vertical paned container.

Returns:
Returns the vertical paned container

void etk_paned_child1_set ( Etk_Paned *  paned,
Etk_Widget *  child,
Etk_Bool  expand 
)

Sets the first child of the paned (the left one for a hpaned, the top one for a vpaned).

Parameters:
paned a paned
child the child to set
expand if expand is ETK_TRUE, when the paned will be resized, the child will try to expand as much as possible

void etk_paned_child2_set ( Etk_Paned *  paned,
Etk_Widget *  child,
Etk_Bool  expand 
)

Sets the second child of the paned (the right one for a hpaned, the bottom one for a vpaned).

Parameters:
paned a paned
child the child to set
expand if expand is ETK_TRUE, when the paned will be resized, the first child will try to expand as much as possible

Etk_Widget * etk_paned_child1_get ( Etk_Paned *  paned  ) 

Gets the first child of the paned (the left one for a hpaned, the top one for a vpaned).

Parameters:
paned a paned
Returns:
Returns the first child of the paned

Etk_Widget * etk_paned_child2_get ( Etk_Paned *  paned  ) 

Gets the second child of the paned (the right one for a hpaned, the bottom one for a vpaned).

Parameters:
paned a paned
Returns:
Returns the second child of the paned

void etk_paned_child1_expand_set ( Etk_Paned *  paned,
Etk_Bool  expand 
)

Sets whether the first child should expand as much as possible when the paned is resized.

Parameters:
paned a paned
expand ETK_TRUE to make the first child expand, ETK_FALSE otherwise

void etk_paned_child2_expand_set ( Etk_Paned *  paned,
Etk_Bool  expand 
)

Sets whether the second child should expand as much as possible when the paned is resized.

Parameters:
paned a paned
expand ETK_TRUE to make the second child expand, ETK_FALSE otherwise

Etk_Bool etk_paned_child1_expand_get ( Etk_Paned *  paned  ) 

Gets whether the first child expands.

Parameters:
paned a paned
Returns:
Returns ETK_TRUE if the first child expands, ETK_FALSE otherwise

Etk_Bool etk_paned_child2_expand_get ( Etk_Paned *  paned  ) 

Gets whether the second child expands.

Parameters:
paned a paned
Returns:
Returns ETK_TRUE if the second child expands, ETK_FALSE otherwise

void etk_paned_position_set ( Etk_Paned *  paned,
int  position 
)

Sets the position in pixels of the separator of the paned.

Parameters:
paned a paned
position the new position in pixels of the separator. This is the position from the left border for a hpaned and from the top border for a vpaned

int etk_paned_position_get ( Etk_Paned *  paned  ) 

Gets the position in pixels of the separator of the paned.

Parameters:
paned a paned
Returns:
Returns the position in pixels of the separator. This is the position from the left border for a hpaned and from the top border for a vpaned