|
Graphics.UI.Gtk.Abstract.Paned | Portability | portable (depends on GHC) | Stability | provisional | Maintainer | gtk2hs-users@lists.sourceforge.net |
|
|
|
|
|
Description |
Base class for widgets with two adjustable panes
|
|
Synopsis |
|
|
|
|
Detail
|
|
Paned is the base class for widgets with two panes, arranged either
horizontally (HPaned) or vertically (VPaned). Child widgets are added to
the panes of the widget with panedPack1 and panedPack2. 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 Frame with the shadow type set to
Graphics.UI.Gtk.General.Enums.ShadowIn 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 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 panedSetPosition.
|
|
Class Hierarchy
|
|
| GObject
| +----Object
| +----Widget
| +----Container
| +----Paned
| +----HPaned
| +----VPaned
|
|
Types
|
|
|
|
|
|
|
|
|
|
|
|
|
Methods
|
|
|
:: (PanedClass self, WidgetClass child) | | => self | child - the child to add
| -> child | | -> IO () | | Adds a child to the top or left pane with default parameters. This is
equivalent to panedPack1 paned child False True.
|
|
|
|
:: (PanedClass self, WidgetClass child) | | => self | child - the child to add
| -> child | | -> IO () | | Adds a child to the bottom or right pane with default parameters. This is
equivalent to panedPack2 paned child True True.
|
|
|
|
:: (PanedClass self, WidgetClass child) | | => self | child - the child to add
| -> child | resize - should this child expand when the paned widget is
resized.
| -> Bool | shrink - can this child be made smaller than its requsition.
| -> Bool | | -> IO () | | Adds a child to the top or left pane.
|
|
|
|
:: (PanedClass self, WidgetClass child) | | => self | child - the child to add
| -> child | resize - should this child expand when the paned widget is
resized.
| -> Bool | shrink - can this child be made smaller than its requsition.
| -> Bool | | -> IO () | | Adds a child to the bottom or right pane.
|
|
|
|
:: PanedClass self | | => self | position - pixel position of divider, a negative value means
that the position is unset.
| -> Int | | -> IO () | | Sets the position of the divider between the two panes.
|
|
|
|
:: PanedClass self | | => self | returns position of the divider
| -> IO Int | | Obtains the position of the divider between the two panes.
|
|
|
|
:: PanedClass self | | => self | returns first child, or Nothing if it is not set.
| -> IO (Maybe Widget) | | Obtains the first child of the paned widget.
- Available since Gtk+ version 2.4
|
|
|
|
:: PanedClass self | | => self | returns second child, or Nothing if it is not
set.
| -> IO (Maybe Widget) | | Obtains the second child of the paned widget.
- Available since Gtk+ version 2.4
|
|
|
Attributes
|
|
|
Position of paned separator in pixels (0 means all the way to the
left/top).
Allowed values: >= 0
Default value: 0
|
|
|
True if the Position property should be used.
Default value: False
|
|
|
The smallest possible value for the position property. This property is
derived from the size and shrinkability of the widget's children.
Allowed values: >= 0
Default value: 0
|
|
|
The largest possible value for the position property. This property is
derived from the size and shrinkability of the widget's children.
Allowed values: >= 0
Default value: 2147483647
|
|
Child Attributes
|
|
|
The "resize" child property determines whether the child expands and
shrinks along with the paned widget.
Default value: True
|
|
|
The "shrink" child property determines whether the child can be made
smaller than its requisition.
Default value: True
|
|
Deprecated Signals
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Produced by Haddock version 2.6.0 |