bionic (3) Gtk2::Paned.3pm.gz

NAME

       Gtk2::Paned - wrapper for GtkPaned

HIERARCHY

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

INTERFACES

         Glib::Object::_Unregistered::AtkImplementorIface
         Gtk2::Buildable
         Gtk2::Orientable

       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 between 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)

   window = $paned->get_handle_window
       Since: gtk+ 2.20

   $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 : default INT_MAX : readable / private)
           Largest possible value for the "position" property

       'min-position' (integer : default 0 : readable / private)
           Smallest possible value for the "position" property

       'position' (integer : default 0 : readable / writable / private)
           Position of paned separator in pixels (0 means all the way to the left/top)

       'position-set' (boolean : default false : readable / writable / private)
           TRUE if the Position property should be used

CHILD PROPERTIES

       'resize' (boolean : default true : readable / writable / private)
           If TRUE, the child expands and shrinks along with the paned widget

       'shrink' (boolean : default true : readable / writable / private)
           If TRUE, the child can be made smaller than its requisition

STYLE PROPERTIES

       'handle-size' (integer : default 5 : readable / private)
           Width of handle

SIGNALS

       boolean = accept-position (Gtk2::Paned)
       boolean = cancel-position (Gtk2::Paned)
       boolean = cycle-child-focus (Gtk2::Paned, boolean)
       boolean = cycle-handle-focus (Gtk2::Paned, boolean)
       boolean = move-handle (Gtk2::Paned, Gtk2::ScrollType)
       boolean = toggle-handle-focus (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-2011 by the gtk2-perl team.

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