Package: gtk

Class gtk-paned

Superclasses

gtk-container, gtk-widget, g-initially-unowned, gtk-buildable, gtk-orientable, g-object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

Direct Slots

position
The "position" property of type :int (Read / Write)
Position of paned separator in pixels (0 means all the way to the left/top).
Allowed values: >= 0
Default value: 0
max-position
The "max-position" property of type :int (Read)
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
Since 2.4
min-position
The "min-position" property of type :int (Read)
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
Since 2.4
position-set
The "position-set" property of type :boolean (Read / Write)
True if the "position" property should be used.
Default value: nil

Details

gtk-paned has two panes, arranged either horizontally or vertically. The division between the two panes is adjustable by the user by dragging a handle.

Child widgets are added to the panes of the widget with the functions gtk-paned-pack1 and gtk-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. (The space in which the separator is called the gutter.) Often, it is useful to put each child inside a gtk-frame with the shadow type set to :in so that the gutter appears as a ridge. No separator is drawn if one of the children is missing.

Each child has two options that can be set, "resize" and "shrink". If resize is true, then when the gtk-paned is resized, that child will expand or shrink along with the paned widget. If "shrink" is true, then that child can be made smaller than its requisition by the user. Setting shrink to nil allows the application to set a minimum size. If "resize" is nil 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 the generic function gtk-paned-position.

Example

Creating a paned widget with minimum sizes.
  (let ((paned (make-instance 'gtk-paned
                              :orientation :horizontal
                              :width-request 250
                              :height-request 150))
        (frame1 (make-instance 'gtk-frame :shadow-type :in
                                          :width-request 100))
        (frame2 (make-instance 'gtk-frame :shadow-type :in
                                          :width-request 50)))
      (gtk-paned-pack1 paned frame1 :resize t :shrink nil)
      (gtk-paned-pack2 paned frame2 :resize nil :shrink nil)
      ... )    

Child Property Details

The "resize" child property
"resize" of type :boolean (Read / Write)
The "resize" child property determines whether the child expands and shrinks along with the paned widget.
Default value: true
Since 2.4

The "shrink" child property
"shrink" of type :boolean (Read / Write)
The "shrink" child property determines whether the child can be made smaller than its requisition.
Default value: true
Since 2.4

Style Property Details

The "handle-size" style property
"handle-size" of type :int (Read)
Width of handle.
Allowed values: >= 0
Default value: 5

Signal Details

The "accept-position" signal
 lambda (widget)   : Action      
The "accept-position" signal is a keybinding signal which gets emitted to accept the current position of the handle when moving it using key bindings. The default binding for this signal is Return or Space.
widget
The object that received the signal.
Since 2.0

The "cancel-position" signal
 lambda (widget)   : Action      
The "cancel-position" signal is a keybinding signal which gets emitted to cancel moving the position of the handle using key bindings. The position of the handle will be reset to the value prior to moving it. The default binding for this signal is Escape.
widget
The object that received the signal.
Since 2.0

The "cycle-child-focus" signal
 lambda (widget reversed)   : Action      
The "cycle-child-focus" signal is a keybinding signal which gets emitted to cycle the focus between the children of the paned. The default binding is f6.
widget
The object that received the signal.
reversed
Whether cycling backward or forward.
Since 2.0

The "cycle-handle-focus" signal
 lambda (widget reversed)   : Action      
The "cycle-handle-focus" signal is a keybinding signal which gets emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings. The default binding for this signal is f8.
widget
The object that received the signal.
reversed
Whether cycling backward or forward.
Since 2.0

The "move-handle" signal
 lambda (widget scroll-type)   : Action      
The "move-handle" signal is a keybinding signal which gets emitted to move the handle when the user is using key bindings to move it.
widget
The object that received the signal.
scroll-type
A gtk-scroll-type.
Since 2.0

The "toggle-handle-focus" signal
 lambda (widget)   : Action      
The "toggle-handle-focus" is a keybinding signal which gets emitted to accept the current position of the handle and then move focus to the next widget in the focus chain. The default binding is Tab.
widget
The object that received the signal.
Since 2.0
 

Slot Access Functions

Inherited Slot Access Functions

2013-5-18