Gtk2::Paned

Section: User Contributed Perl Documentation (3)
Updated: 2008-05-05
Index Return to Main Contents
 

NAME

Gtk2::Paned  

HIERARCHY

  Glib::Object
  +----Glib::InitiallyUnowned
       +----Gtk2::Object
            +----Gtk2::Widget
                 +----Gtk2::Container
                      +----Gtk2::Paned

 

INTERFACES

  Glib::Object::_Unregistered::AtkImplementorIface

Gtk2::Paned is the base class for widgets with two panes, arranged either horizontally (Gtk2::HPaned) or vertically (Gtk2::VPaned). Child widgets are added to the panes of the widget with "$paned->pack1" and "$paned->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. Often, it is useful to put each child inside a Gtk2::Frame with the shadow type set to '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 Gtk2::Paned 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 "$paned->set_position".  

METHODS

 

$paned->add1 ($child)

* $child (Gtk2::Widget)
 

$paned->add2 ($child)

* $child (Gtk2::Widget)
 

widget = $paned->child1

 

widget = $paned->get_child1

 

boolean = $paned->child1_resize

 

$paned->child1_resize (newval)

* $newval (boolean)

"child1_resize" determines whether the first child should expand when $paned is resized.

 

boolean = $paned->child1_shrink

 

$paned->child1_shrink (newval)

* $newval (boolean)

"child1_shrink" determines whether the first child may be made smaller than its requisition.

 

widget = $paned->child2

 

widget = $paned->get_child2

 

boolean = $paned->child2_resize

 

$paned->child2_resize (newval)

* $newval (boolean)

"child2_resize" determines whether the second child should expand when $paned is resized.

 

boolean = $paned->child2_shrink

 

$paned->child2_shrink (newval)

* $newval (boolean)

"child2_shrink" determines whether the second child may be made smaller than its requisition.

 

$paned->compute_position ($allocation, $child1_req, $child2_req)

* $allocation (integer)
* $child1_req (integer)
* $child2_req (integer)
 

$paned->pack1 ($child, $resize, $shrink)

* $child (Gtk2::Widget)
* $resize (boolean)
* $shrink (boolean)
 

$paned->pack2 ($child, $resize, $shrink)

* $child (Gtk2::Widget)
* $resize (boolean)
* $shrink (boolean)
 

integer = $paned->get_position

 

$paned->set_position ($position)

* $position (integer)
 

PROPERTIES

'max-position' (integer : readable / private)
Largest possible value for the ``position'' property
'min-position' (integer : readable / private)
Smallest possible value for the ``position'' property
'position' (integer : readable / writable / private)
Position of paned separator in pixels (0 means all the way to the left/top)
'position-set' (boolean : readable / writable / private)
TRUE if the Position property should be used
 

SIGNALS

boolean = cycle-child-focus (Gtk2::Paned, boolean)
boolean = toggle-handle-focus (Gtk2::Paned)
boolean = move-handle (Gtk2::Paned, Gtk2::ScrollType)
boolean = cycle-handle-focus (Gtk2::Paned, boolean)
boolean = accept-position (Gtk2::Paned)
boolean = cancel-position (Gtk2::Paned)
 

ENUMS AND FLAGS

 

enum Gtk2::ScrollType

* 'none' / 'GTK_SCROLL_NONE'
* 'jump' / 'GTK_SCROLL_JUMP'
* 'step-backward' / 'GTK_SCROLL_STEP_BACKWARD'
* 'step-forward' / 'GTK_SCROLL_STEP_FORWARD'
* 'page-backward' / 'GTK_SCROLL_PAGE_BACKWARD'
* 'page-forward' / 'GTK_SCROLL_PAGE_FORWARD'
* 'step-up' / 'GTK_SCROLL_STEP_UP'
* 'step-down' / 'GTK_SCROLL_STEP_DOWN'
* 'page-up' / 'GTK_SCROLL_PAGE_UP'
* 'page-down' / 'GTK_SCROLL_PAGE_DOWN'
* 'step-left' / 'GTK_SCROLL_STEP_LEFT'
* 'step-right' / 'GTK_SCROLL_STEP_RIGHT'
* 'page-left' / 'GTK_SCROLL_PAGE_LEFT'
* 'page-right' / 'GTK_SCROLL_PAGE_RIGHT'
* 'start' / 'GTK_SCROLL_START'
* 'end' / 'GTK_SCROLL_END'
 

SEE ALSO

Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object, Gtk2::Widget, Gtk2::Container  

COPYRIGHT

Copyright (C) 2003-2008 by the gtk2-perl team.

This software is licensed under the LGPL. See Gtk2 for a full notice.


 

Index

NAME
HIERARCHY
INTERFACES
METHODS
$paned->add1 ($child)
$paned->add2 ($child)
widget = $paned->child1
widget = $paned->get_child1
boolean = $paned->child1_resize
$paned->child1_resize (newval)
boolean = $paned->child1_shrink
$paned->child1_shrink (newval)
widget = $paned->child2
widget = $paned->get_child2
boolean = $paned->child2_resize
$paned->child2_resize (newval)
boolean = $paned->child2_shrink
$paned->child2_shrink (newval)
$paned->compute_position ($allocation, $child1_req, $child2_req)
$paned->pack1 ($child, $resize, $shrink)
$paned->pack2 ($child, $resize, $shrink)
integer = $paned->get_position
$paned->set_position ($position)
PROPERTIES
SIGNALS
ENUMS AND FLAGS
enum Gtk2::ScrollType
SEE ALSO
COPYRIGHT

linux.jgfs.net manual pages