GtkPaned

A base class for GtkHPaned and GtkVPaned.

Object Hierarchy

GObject
`-- GtkObject
       `-- GtkWidget
              `-- GtkContainer
                     `-- GtkPaned

Direct Subclasses

Description

GtkPaned is the base class for widgets with two panes, arranged either horizontally (GtkHPaned) or vertically (GtkVPaned). Child widgets are added to the panes of the widget with pack1() and pack2() . The division beween the two children is set by default from the size requests of the children, but it can be adjusted by the user.

A paned widget draws a separator between the two child widgets and a small handle that the user can drag to adjust the division. It does not draw any relief around the children or around the separator. (The space in which the separator is called the gutter.) Often, it is useful to put each child inside a GtkFrame with the shadow type set to Gtk::SHADOW_IN so that the gutter appears as a ridge.

Each child has two options that can be set, resize and shrink. If resize is true, then when the GtkPaned is resized, that child will expand or shrink along with the paned widget. If shrink is true, then when that child can be made smaller than its requisition by the user. Setting shrink to false allows the application to set a minimum size. If resize is false for both children, then this is treated as if resize is true for both children.

The application can set the position of the slider as if it were set by the user, by calling set_position() .

Methods

add1()
  Adds a child to the top or left pane.
add2()
  Adds a child to the bottom or right pane.
compute_position()
  Calculates the position of the separator.
get_child1()
  Obtains the first child of the paned widget.
get_child2()
  Obtains the second child of the paned widget.
get_position()
  Obtains the position of the divider between the two panes.
pack1()
  Adds a child to the top or left pane.
pack2()
  Adds a child to the bottom or right pane.
set_position()
  Sets the position of the divider between the two panes.

Properties

Use get_property and set_property methods to access these.

max-position:
  The largest possible value for the position property.
min-position:
  The smallest possible value for the position property.
position:
  Position of paned separator in pixels.
position-set:
  If the Position property should be used.
resize:
  Child property: Whether the child expands and shrinks.
shrink:
  Child property: Whether the child can be made smaller than its requisition.

Signals

"accept-position"
  Set gutter position and activate the child widget.
"cancel-position"
  Cancels gutter positioning.
"cycle-child-focus"
  Cycles the focus between children.
"cycle-handle-focus"
  Cycles the focus between children.
"move-handle"
  Moves the gutter.
"toggle-handle-focus"
  Focus shall be transferred to the gutter.