Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
A widget with 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
panedSetStartChild
and panedSetEndChild
.
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 Frame
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 GtkPaned
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 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
.
CSS nodes
paned ├── <child> ├── separator[.wide] ╰── <child>
GtkPaned
has a main CSS node with name paned, and a subnode for
the separator with name separator. The subnode gets a .wide style
class when the paned is supposed to be wide.
In horizontal orientation, the nodes are arranged based on the text direction, so in left-to-right mode, :first-child will select the leftmost child, while it will select the rightmost child in RTL layouts.
Creating a paned widget with minimum sizes.
c code
GtkWidget *hpaned = gtk_paned_new (GTK_ORIENTATION_HORIZONTAL); GtkWidget *frame1 = gtk_frame_new (NULL); GtkWidget *frame2 = gtk_frame_new (NULL); gtk_widget_set_size_request (hpaned, 200, -1); gtk_paned_set_start_child (GTK_PANED (hpaned), frame1); gtk_paned_set_resize_start_child (GTK_PANED (hpaned), TRUE); gtk_paned_set_shrink_start_child (GTK_PANED (hpaned), FALSE); gtk_widget_set_size_request (frame1, 50, -1); gtk_paned_set_end_child (GTK_PANED (hpaned), frame2); gtk_paned_set_resize_end_child (GTK_PANED (hpaned), FALSE); gtk_paned_set_shrink_end_child (GTK_PANED (hpaned), FALSE); gtk_widget_set_size_request (frame2, 50, -1);
Synopsis
- newtype Paned = Paned (ManagedPtr Paned)
- class (GObject o, IsDescendantOf Paned o) => IsPaned o
- toPaned :: (MonadIO m, IsPaned o) => o -> m Paned
- panedGetEndChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> m (Maybe Widget)
- panedGetPosition :: (HasCallStack, MonadIO m, IsPaned a) => a -> m Int32
- panedGetResizeEndChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> m Bool
- panedGetResizeStartChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> m Bool
- panedGetShrinkEndChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> m Bool
- panedGetShrinkStartChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> m Bool
- panedGetStartChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> m (Maybe Widget)
- panedGetWideHandle :: (HasCallStack, MonadIO m, IsPaned a) => a -> m Bool
- panedNew :: (HasCallStack, MonadIO m) => Orientation -> m Paned
- panedSetEndChild :: (HasCallStack, MonadIO m, IsPaned a, IsWidget b) => a -> Maybe b -> m ()
- panedSetPosition :: (HasCallStack, MonadIO m, IsPaned a) => a -> Int32 -> m ()
- panedSetResizeEndChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> Bool -> m ()
- panedSetResizeStartChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> Bool -> m ()
- panedSetShrinkEndChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> Bool -> m ()
- panedSetShrinkStartChild :: (HasCallStack, MonadIO m, IsPaned a) => a -> Bool -> m ()
- panedSetStartChild :: (HasCallStack, MonadIO m, IsPaned a, IsWidget b) => a -> Maybe b -> m ()
- panedSetWideHandle :: (HasCallStack, MonadIO m, IsPaned a) => a -> Bool -> m ()
- clearPanedEndChild :: (MonadIO m, IsPaned o) => o -> m ()
- constructPanedEndChild :: (IsPaned o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getPanedEndChild :: (MonadIO m, IsPaned o) => o -> m (Maybe Widget)
- setPanedEndChild :: (MonadIO m, IsPaned o, IsWidget a) => o -> a -> m ()
- getPanedMaxPosition :: (MonadIO m, IsPaned o) => o -> m Int32
- getPanedMinPosition :: (MonadIO m, IsPaned o) => o -> m Int32
- constructPanedPosition :: (IsPaned o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getPanedPosition :: (MonadIO m, IsPaned o) => o -> m Int32
- setPanedPosition :: (MonadIO m, IsPaned o) => o -> Int32 -> m ()
- constructPanedPositionSet :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPanedPositionSet :: (MonadIO m, IsPaned o) => o -> m Bool
- setPanedPositionSet :: (MonadIO m, IsPaned o) => o -> Bool -> m ()
- constructPanedResizeEndChild :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPanedResizeEndChild :: (MonadIO m, IsPaned o) => o -> m Bool
- setPanedResizeEndChild :: (MonadIO m, IsPaned o) => o -> Bool -> m ()
- constructPanedResizeStartChild :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPanedResizeStartChild :: (MonadIO m, IsPaned o) => o -> m Bool
- setPanedResizeStartChild :: (MonadIO m, IsPaned o) => o -> Bool -> m ()
- constructPanedShrinkEndChild :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPanedShrinkEndChild :: (MonadIO m, IsPaned o) => o -> m Bool
- setPanedShrinkEndChild :: (MonadIO m, IsPaned o) => o -> Bool -> m ()
- constructPanedShrinkStartChild :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPanedShrinkStartChild :: (MonadIO m, IsPaned o) => o -> m Bool
- setPanedShrinkStartChild :: (MonadIO m, IsPaned o) => o -> Bool -> m ()
- clearPanedStartChild :: (MonadIO m, IsPaned o) => o -> m ()
- constructPanedStartChild :: (IsPaned o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getPanedStartChild :: (MonadIO m, IsPaned o) => o -> m (Maybe Widget)
- setPanedStartChild :: (MonadIO m, IsPaned o, IsWidget a) => o -> a -> m ()
- constructPanedWideHandle :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPanedWideHandle :: (MonadIO m, IsPaned o) => o -> m Bool
- setPanedWideHandle :: (MonadIO m, IsPaned o) => o -> Bool -> m ()
- type PanedAcceptPositionCallback = IO Bool
- afterPanedAcceptPosition :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedAcceptPositionCallback) -> m SignalHandlerId
- onPanedAcceptPosition :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedAcceptPositionCallback) -> m SignalHandlerId
- type PanedCancelPositionCallback = IO Bool
- afterPanedCancelPosition :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCancelPositionCallback) -> m SignalHandlerId
- onPanedCancelPosition :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCancelPositionCallback) -> m SignalHandlerId
- type PanedCycleChildFocusCallback = Bool -> IO Bool
- afterPanedCycleChildFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCycleChildFocusCallback) -> m SignalHandlerId
- onPanedCycleChildFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCycleChildFocusCallback) -> m SignalHandlerId
- type PanedCycleHandleFocusCallback = Bool -> IO Bool
- afterPanedCycleHandleFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCycleHandleFocusCallback) -> m SignalHandlerId
- onPanedCycleHandleFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCycleHandleFocusCallback) -> m SignalHandlerId
- type PanedMoveHandleCallback = ScrollType -> IO Bool
- afterPanedMoveHandle :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedMoveHandleCallback) -> m SignalHandlerId
- onPanedMoveHandle :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedMoveHandleCallback) -> m SignalHandlerId
- type PanedToggleHandleFocusCallback = IO Bool
- afterPanedToggleHandleFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedToggleHandleFocusCallback) -> m SignalHandlerId
- onPanedToggleHandleFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedToggleHandleFocusCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Paned Source # | |
GObject Paned Source # | |
Defined in GI.Gtk.Objects.Paned | |
ManagedPtrNewtype Paned Source # | |
Defined in GI.Gtk.Objects.Paned toManagedPtr :: Paned -> ManagedPtr Paned | |
TypedObject Paned Source # | |
Defined in GI.Gtk.Objects.Paned | |
HasParentTypes Paned Source # | |
Defined in GI.Gtk.Objects.Paned | |
IsGValue (Maybe Paned) Source # | Convert |
Defined in GI.Gtk.Objects.Paned gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Paned -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Paned) | |
type ParentTypes Paned Source # | |
Defined in GI.Gtk.Objects.Paned type ParentTypes Paned = '[Widget, Object, Accessible, AccessibleRange, Buildable, ConstraintTarget, Orientable] |
class (GObject o, IsDescendantOf Paned o) => IsPaned o Source #
Instances
(GObject o, IsDescendantOf Paned o) => IsPaned o Source # | |
Defined in GI.Gtk.Objects.Paned |
Methods
Click to display all available methods, including inherited ones
Methods
actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBounds, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getEndChild, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOrientation, getOverflow, getPangoContext, getParent, getPlatformState, getPosition, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getResizeEndChild, getResizeStartChild, getRoot, getScaleFactor, getSensitive, getSettings, getShrinkEndChild, getShrinkStartChild, getSize, getSizeRequest, getStartChild, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWideHandle, getWidth.
Setters
setAccessibleParent, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setEndChild, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOrientation, setOverflow, setParent, setPosition, setProperty, setReceivesDefault, setResizeEndChild, setResizeStartChild, setSensitive, setShrinkEndChild, setShrinkStartChild, setSizeRequest, setStartChild, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, setWideHandle.
getEndChild
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the end child widget |
Retrieves the end child of the given GtkPaned
.
getPosition
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> m Int32 | Returns: the position of the divider, in pixels |
Obtains the position of the divider between the two panes.
getResizeEndChild
panedGetResizeEndChild Source #
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> m Bool | Returns: true if the end child is resizable |
Returns whether the Paned:endChild can be resized.
getResizeStartChild
panedGetResizeStartChild Source #
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> m Bool | Returns: true if the start child is resizable |
Returns whether the Paned:startChild can be resized.
getShrinkEndChild
panedGetShrinkEndChild Source #
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> m Bool | Returns: true if the end child is shrinkable |
Returns whether the Paned:endChild can shrink.
getShrinkStartChild
panedGetShrinkStartChild Source #
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> m Bool | Returns: true if the start child is shrinkable |
Returns whether the Paned:startChild can shrink.
getStartChild
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the start child widget |
Retrieves the start child of the given GtkPaned
.
getWideHandle
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether the separator should be wide.
new
:: (HasCallStack, MonadIO m) | |
=> Orientation |
|
-> m Paned | Returns: the newly created paned widget |
Creates a new GtkPaned
widget.
setEndChild
:: (HasCallStack, MonadIO m, IsPaned a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the end child of paned
to child
.
If child
is NULL
, the existing child will be removed.
setPosition
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> Int32 |
|
-> m () |
Sets the position of the divider between the two panes.
setResizeEndChild
panedSetResizeEndChild Source #
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the Paned:endChild can be resized.
setResizeStartChild
panedSetResizeStartChild Source #
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the Paned:startChild can be resized.
setShrinkEndChild
panedSetShrinkEndChild Source #
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the Paned:endChild can shrink.
setShrinkStartChild
panedSetShrinkStartChild Source #
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the Paned:startChild can shrink.
setStartChild
:: (HasCallStack, MonadIO m, IsPaned a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the start child of paned
to child
.
If child
is NULL
, the existing child will be removed.
setWideHandle
:: (HasCallStack, MonadIO m, IsPaned a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the separator should be wide.
Properties
endChild
The second child.
clearPanedEndChild :: (MonadIO m, IsPaned o) => o -> m () Source #
Set the value of the “end-child
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#endChild
constructPanedEndChild :: (IsPaned o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “end-child
” property. This is rarely needed directly, but it is used by new
.
getPanedEndChild :: (MonadIO m, IsPaned o) => o -> m (Maybe Widget) Source #
Get the value of the “end-child
” property.
When overloading is enabled, this is equivalent to
get
paned #endChild
setPanedEndChild :: (MonadIO m, IsPaned o, IsWidget a) => o -> a -> m () Source #
Set the value of the “end-child
” property.
When overloading is enabled, this is equivalent to
set
paned [ #endChild:=
value ]
maxPosition
The largest possible value for the Paned:position property.
This property is derived from the size and shrinkability of the widget's children.
getPanedMaxPosition :: (MonadIO m, IsPaned o) => o -> m Int32 Source #
Get the value of the “max-position
” property.
When overloading is enabled, this is equivalent to
get
paned #maxPosition
minPosition
The smallest possible value for the Paned:position property.
This property is derived from the size and shrinkability of the widget's children.
getPanedMinPosition :: (MonadIO m, IsPaned o) => o -> m Int32 Source #
Get the value of the “min-position
” property.
When overloading is enabled, this is equivalent to
get
paned #minPosition
position
Position of the separator in pixels, from the left/top.
constructPanedPosition :: (IsPaned o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “position
” property. This is rarely needed directly, but it is used by new
.
getPanedPosition :: (MonadIO m, IsPaned o) => o -> m Int32 Source #
Get the value of the “position
” property.
When overloading is enabled, this is equivalent to
get
paned #position
setPanedPosition :: (MonadIO m, IsPaned o) => o -> Int32 -> m () Source #
Set the value of the “position
” property.
When overloading is enabled, this is equivalent to
set
paned [ #position:=
value ]
positionSet
Whether the Paned:position property has been set.
constructPanedPositionSet :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “position-set
” property. This is rarely needed directly, but it is used by new
.
getPanedPositionSet :: (MonadIO m, IsPaned o) => o -> m Bool Source #
Get the value of the “position-set
” property.
When overloading is enabled, this is equivalent to
get
paned #positionSet
setPanedPositionSet :: (MonadIO m, IsPaned o) => o -> Bool -> m () Source #
Set the value of the “position-set
” property.
When overloading is enabled, this is equivalent to
set
paned [ #positionSet:=
value ]
resizeEndChild
Determines whether the second child expands and shrinks along with the paned widget.
constructPanedResizeEndChild :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “resize-end-child
” property. This is rarely needed directly, but it is used by new
.
getPanedResizeEndChild :: (MonadIO m, IsPaned o) => o -> m Bool Source #
Get the value of the “resize-end-child
” property.
When overloading is enabled, this is equivalent to
get
paned #resizeEndChild
setPanedResizeEndChild :: (MonadIO m, IsPaned o) => o -> Bool -> m () Source #
Set the value of the “resize-end-child
” property.
When overloading is enabled, this is equivalent to
set
paned [ #resizeEndChild:=
value ]
resizeStartChild
Determines whether the first child expands and shrinks along with the paned widget.
constructPanedResizeStartChild :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “resize-start-child
” property. This is rarely needed directly, but it is used by new
.
getPanedResizeStartChild :: (MonadIO m, IsPaned o) => o -> m Bool Source #
Get the value of the “resize-start-child
” property.
When overloading is enabled, this is equivalent to
get
paned #resizeStartChild
setPanedResizeStartChild :: (MonadIO m, IsPaned o) => o -> Bool -> m () Source #
Set the value of the “resize-start-child
” property.
When overloading is enabled, this is equivalent to
set
paned [ #resizeStartChild:=
value ]
shrinkEndChild
Determines whether the second child can be made smaller than its requisition.
constructPanedShrinkEndChild :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “shrink-end-child
” property. This is rarely needed directly, but it is used by new
.
getPanedShrinkEndChild :: (MonadIO m, IsPaned o) => o -> m Bool Source #
Get the value of the “shrink-end-child
” property.
When overloading is enabled, this is equivalent to
get
paned #shrinkEndChild
setPanedShrinkEndChild :: (MonadIO m, IsPaned o) => o -> Bool -> m () Source #
Set the value of the “shrink-end-child
” property.
When overloading is enabled, this is equivalent to
set
paned [ #shrinkEndChild:=
value ]
shrinkStartChild
Determines whether the first child can be made smaller than its requisition.
constructPanedShrinkStartChild :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “shrink-start-child
” property. This is rarely needed directly, but it is used by new
.
getPanedShrinkStartChild :: (MonadIO m, IsPaned o) => o -> m Bool Source #
Get the value of the “shrink-start-child
” property.
When overloading is enabled, this is equivalent to
get
paned #shrinkStartChild
setPanedShrinkStartChild :: (MonadIO m, IsPaned o) => o -> Bool -> m () Source #
Set the value of the “shrink-start-child
” property.
When overloading is enabled, this is equivalent to
set
paned [ #shrinkStartChild:=
value ]
startChild
The first child.
clearPanedStartChild :: (MonadIO m, IsPaned o) => o -> m () Source #
Set the value of the “start-child
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#startChild
constructPanedStartChild :: (IsPaned o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “start-child
” property. This is rarely needed directly, but it is used by new
.
getPanedStartChild :: (MonadIO m, IsPaned o) => o -> m (Maybe Widget) Source #
Get the value of the “start-child
” property.
When overloading is enabled, this is equivalent to
get
paned #startChild
setPanedStartChild :: (MonadIO m, IsPaned o, IsWidget a) => o -> a -> m () Source #
Set the value of the “start-child
” property.
When overloading is enabled, this is equivalent to
set
paned [ #startChild:=
value ]
wideHandle
Whether the GtkPaned
should provide a stronger visual separation.
For example, this could be set when a paned contains two
Notebook
s, whose tab rows would otherwise merge visually.
constructPanedWideHandle :: (IsPaned o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “wide-handle
” property. This is rarely needed directly, but it is used by new
.
getPanedWideHandle :: (MonadIO m, IsPaned o) => o -> m Bool Source #
Get the value of the “wide-handle
” property.
When overloading is enabled, this is equivalent to
get
paned #wideHandle
setPanedWideHandle :: (MonadIO m, IsPaned o) => o -> Bool -> m () Source #
Set the value of the “wide-handle
” property.
When overloading is enabled, this is equivalent to
set
paned [ #wideHandle:=
value ]
Signals
acceptPosition
type PanedAcceptPositionCallback = IO Bool Source #
Emitted to accept the current position of the handle when moving it using key bindings.
This is a keybinding signal.
The default binding for this signal is <kbd>Return</kbd> or <kbd>Space</kbd>.
afterPanedAcceptPosition :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedAcceptPositionCallback) -> m SignalHandlerId Source #
Connect a signal handler for the acceptPosition signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
paned #acceptPosition callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onPanedAcceptPosition :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedAcceptPositionCallback) -> m SignalHandlerId Source #
Connect a signal handler for the acceptPosition signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
paned #acceptPosition callback
cancelPosition
type PanedCancelPositionCallback = IO Bool Source #
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.
This is a keybinding signal.
The default binding for this signal is <kbd>Escape</kbd>.
afterPanedCancelPosition :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCancelPositionCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cancelPosition signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
paned #cancelPosition callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onPanedCancelPosition :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCancelPositionCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cancelPosition signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
paned #cancelPosition callback
cycleChildFocus
type PanedCycleChildFocusCallback Source #
Emitted to cycle the focus between the children of the paned.
This is a keybinding signal.
The default binding is <kbd>F6</kbd>.
afterPanedCycleChildFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCycleChildFocusCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cycleChildFocus signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
paned #cycleChildFocus callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onPanedCycleChildFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCycleChildFocusCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cycleChildFocus signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
paned #cycleChildFocus callback
cycleHandleFocus
type PanedCycleHandleFocusCallback Source #
Emitted to cycle whether the paned should grab focus to allow the user to change position of the handle by using key bindings.
This is a keybinding signal.
The default binding for this signal is <kbd>F8</kbd>.
afterPanedCycleHandleFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCycleHandleFocusCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cycleHandleFocus signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
paned #cycleHandleFocus callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onPanedCycleHandleFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedCycleHandleFocusCallback) -> m SignalHandlerId Source #
Connect a signal handler for the cycleHandleFocus signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
paned #cycleHandleFocus callback
moveHandle
type PanedMoveHandleCallback Source #
= ScrollType |
|
-> IO Bool |
Emitted to move the handle with key bindings.
This is a keybinding signal.
afterPanedMoveHandle :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedMoveHandleCallback) -> m SignalHandlerId Source #
Connect a signal handler for the moveHandle signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
paned #moveHandle callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onPanedMoveHandle :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedMoveHandleCallback) -> m SignalHandlerId Source #
Connect a signal handler for the moveHandle signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
paned #moveHandle callback
toggleHandleFocus
type PanedToggleHandleFocusCallback = IO Bool Source #
Emitted to accept the current position of the handle and then move focus to the next widget in the focus chain.
This is a keybinding signal.
The default binding is <kbd>Tab</kbd>.
afterPanedToggleHandleFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedToggleHandleFocusCallback) -> m SignalHandlerId Source #
Connect a signal handler for the toggleHandleFocus signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
paned #toggleHandleFocus callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onPanedToggleHandleFocus :: (IsPaned a, MonadIO m) => a -> ((?self :: a) => PanedToggleHandleFocusCallback) -> m SignalHandlerId Source #
Connect a signal handler for the toggleHandleFocus signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
paned #toggleHandleFocus callback