GI.Gtk.Objects.Paned

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 panedPack1 and panedPack2. 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 with the shadow type set to ShadowTypeIn 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 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 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

plain code

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 of the children are always arranged from left to right. So :first-child will always select the leftmost child, regardless of text direction.

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_frame_set_shadow_type (GTK_FRAME (frame1), GTK_SHADOW_IN);
gtk_frame_set_shadow_type (GTK_FRAME (frame2), GTK_SHADOW_IN);

gtk_widget_set_size_request (hpaned, 200, -1);

gtk_paned_pack1 (GTK_PANED (hpaned), frame1, TRUE, FALSE);
gtk_widget_set_size_request (frame1, 50, -1);

gtk_paned_pack2 (GTK_PANED (hpaned), frame2, FALSE, FALSE);
gtk_widget_set_size_request (frame2, 50, -1);

Exported types

newtype Paned

Constructors

Paned (ManagedPtr Paned)

Instances

GObject Paned

Methods

gobjectType :: Paned -> IO GType

IsImplementorIface Paned

IsObject Paned

IsWidget Paned

IsPaned Paned

IsContainer Paned

IsOrientable Paned

IsBuildable Paned

class GObject o => IsPaned o

Instances

(GObject a, UnknownAncestorError Constraint Paned a) => IsPaned a

IsPaned Paned

IsPaned HPaned

IsPaned VPaned

toPaned :: (MonadIO m, IsPaned o) => o -> m Paned

noPaned :: Maybe Paned

Methods

add1

panedAdd1

Arguments

:: (HasCallStack, MonadIO m, IsPaned a, IsWidget b)

=> a

paned: a paned widget

-> b

child: the child to add

-> m ()

Adds a child to the top or left pane with default parameters. This is equivalent to gtk_paned_pack1 (paned, child, FALSE, TRUE).

add2

panedAdd2

Arguments

:: (HasCallStack, MonadIO m, IsPaned a, IsWidget b)

=> a

paned: a paned widget

-> b

child: the child to add

-> m ()

Adds a child to the bottom or right pane with default parameters. This is equivalent to gtk_paned_pack2 (paned, child, TRUE, TRUE).

getChild1

panedGetChild1

Arguments

:: (HasCallStack, MonadIO m, IsPaned a)

=> a

paned: a Paned widget

-> m (Maybe Widget)

Returns: first child, or Nothing if it is not set.

Obtains the first child of the paned widget.

Since: 2.4

getChild2

panedGetChild2

Arguments

:: (HasCallStack, MonadIO m, IsPaned a)

=> a

paned: a Paned widget

-> m (Maybe Widget)

Returns: second child, or Nothing if it is not set.

Obtains the second child of the paned widget.

Since: 2.4

getHandleWindow

panedGetHandleWindow

Arguments

:: (HasCallStack, MonadIO m, IsPaned a)

=> a

paned: a Paned

-> m Window

Returns: the paned’s handle window.

Returns the Window of the handle. This function is useful when handling button or motion events because it enables the callback to distinguish between the window of the paned, a child and the handle.

Since: 2.20

getPosition

panedGetPosition

Arguments

:: (HasCallStack, MonadIO m, IsPaned a)

=> a

paned: a Paned widget

-> m Int32

Returns: position of the divider

Obtains the position of the divider between the two panes.

getWideHandle

panedGetWideHandle

Arguments

:: (HasCallStack, MonadIO m, IsPaned a)

=> a

paned: a Paned

-> m Bool

Returns: True if the paned should have a wide handle

Gets the Paned:wide-handle property.

Since: 3.16

new

panedNew

Arguments

:: (HasCallStack, MonadIO m)

=> Orientation

orientation: the paned’s orientation.

-> m Paned

Returns: a new Paned.

Creates a new Paned widget.

Since: 3.0

pack1

panedPack1

Arguments

:: (HasCallStack, MonadIO m, IsPaned a, IsWidget b)

=> a

paned: a paned widget

-> b

child: the child to add

-> Bool

resize: should this child expand when the paned widget is resized.

-> Bool

shrink: can this child be made smaller than its requisition.

-> m ()

Adds a child to the top or left pane.

pack2

panedPack2

Arguments

:: (HasCallStack, MonadIO m, IsPaned a, IsWidget b)

=> a

paned: a paned widget

-> b

child: the child to add

-> Bool

resize: should this child expand when the paned widget is resized.

-> Bool

shrink: can this child be made smaller than its requisition.

-> m ()

Adds a child to the bottom or right pane.

setPosition

panedSetPosition

Arguments

:: (HasCallStack, MonadIO m, IsPaned a)

=> a

paned: a Paned widget

-> Int32

position: pixel position of divider, a negative value means that the position is unset.

-> m ()

Sets the position of the divider between the two panes.

setWideHandle

panedSetWideHandle

Arguments

:: (HasCallStack, MonadIO m, IsPaned a)

=> a

paned: a Paned

-> Bool

wide: the new value for the Paned:wide-handle property

-> m ()

Sets the Paned:wide-handle property.

Since: 3.16

Properties

maxPosition

getPanedMaxPosition :: (MonadIO m, IsPaned o) => o -> m Int32

minPosition

getPanedMinPosition :: (MonadIO m, IsPaned o) => o -> m Int32

position

constructPanedPosition :: IsPaned o => Int32 -> IO (GValueConstruct o)

getPanedPosition :: (MonadIO m, IsPaned o) => o -> m Int32

setPanedPosition :: (MonadIO m, IsPaned o) => o -> Int32 -> m ()

positionSet

constructPanedPositionSet :: IsPaned o => Bool -> IO (GValueConstruct o)

getPanedPositionSet :: (MonadIO m, IsPaned o) => o -> m Bool

setPanedPositionSet :: (MonadIO m, IsPaned o) => o -> Bool -> m ()

wideHandle

constructPanedWideHandle :: IsPaned o => Bool -> IO (GValueConstruct o)

getPanedWideHandle :: (MonadIO m, IsPaned o) => o -> m Bool

setPanedWideHandle :: (MonadIO m, IsPaned o) => o -> Bool -> m ()

Signals

acceptPosition

type C_PanedAcceptPositionCallback = Ptr () -> Ptr () -> IO CInt

type PanedAcceptPositionCallback = IO Bool

afterPanedAcceptPosition :: (IsPaned a, MonadIO m) => a -> PanedAcceptPositionCallback -> m SignalHandlerId

genClosure_PanedAcceptPosition :: PanedAcceptPositionCallback -> IO Closure

mk_PanedAcceptPositionCallback :: C_PanedAcceptPositionCallback -> IO (FunPtr C_PanedAcceptPositionCallback)

noPanedAcceptPositionCallback :: Maybe PanedAcceptPositionCallback

onPanedAcceptPosition :: (IsPaned a, MonadIO m) => a -> PanedAcceptPositionCallback -> m SignalHandlerId

wrap_PanedAcceptPositionCallback :: PanedAcceptPositionCallback -> Ptr () -> Ptr () -> IO CInt

cancelPosition

type C_PanedCancelPositionCallback = Ptr () -> Ptr () -> IO CInt

type PanedCancelPositionCallback = IO Bool

afterPanedCancelPosition :: (IsPaned a, MonadIO m) => a -> PanedCancelPositionCallback -> m SignalHandlerId

genClosure_PanedCancelPosition :: PanedCancelPositionCallback -> IO Closure

mk_PanedCancelPositionCallback :: C_PanedCancelPositionCallback -> IO (FunPtr C_PanedCancelPositionCallback)

noPanedCancelPositionCallback :: Maybe PanedCancelPositionCallback

onPanedCancelPosition :: (IsPaned a, MonadIO m) => a -> PanedCancelPositionCallback -> m SignalHandlerId

wrap_PanedCancelPositionCallback :: PanedCancelPositionCallback -> Ptr () -> Ptr () -> IO CInt

cycleChildFocus

type C_PanedCycleChildFocusCallback = Ptr () -> CInt -> Ptr () -> IO CInt

type PanedCycleChildFocusCallback = Bool -> IO Bool

afterPanedCycleChildFocus :: (IsPaned a, MonadIO m) => a -> PanedCycleChildFocusCallback -> m SignalHandlerId

genClosure_PanedCycleChildFocus :: PanedCycleChildFocusCallback -> IO Closure

mk_PanedCycleChildFocusCallback :: C_PanedCycleChildFocusCallback -> IO (FunPtr C_PanedCycleChildFocusCallback)

noPanedCycleChildFocusCallback :: Maybe PanedCycleChildFocusCallback

onPanedCycleChildFocus :: (IsPaned a, MonadIO m) => a -> PanedCycleChildFocusCallback -> m SignalHandlerId

wrap_PanedCycleChildFocusCallback :: PanedCycleChildFocusCallback -> Ptr () -> CInt -> Ptr () -> IO CInt

cycleHandleFocus

type C_PanedCycleHandleFocusCallback = Ptr () -> CInt -> Ptr () -> IO CInt

type PanedCycleHandleFocusCallback = Bool -> IO Bool

afterPanedCycleHandleFocus :: (IsPaned a, MonadIO m) => a -> PanedCycleHandleFocusCallback -> m SignalHandlerId

genClosure_PanedCycleHandleFocus :: PanedCycleHandleFocusCallback -> IO Closure

mk_PanedCycleHandleFocusCallback :: C_PanedCycleHandleFocusCallback -> IO (FunPtr C_PanedCycleHandleFocusCallback)

noPanedCycleHandleFocusCallback :: Maybe PanedCycleHandleFocusCallback

onPanedCycleHandleFocus :: (IsPaned a, MonadIO m) => a -> PanedCycleHandleFocusCallback -> m SignalHandlerId

wrap_PanedCycleHandleFocusCallback :: PanedCycleHandleFocusCallback -> Ptr () -> CInt -> Ptr () -> IO CInt

moveHandle

type C_PanedMoveHandleCallback = Ptr () -> CUInt -> Ptr () -> IO CInt

type PanedMoveHandleCallback = ScrollType -> IO Bool

afterPanedMoveHandle :: (IsPaned a, MonadIO m) => a -> PanedMoveHandleCallback -> m SignalHandlerId

genClosure_PanedMoveHandle :: PanedMoveHandleCallback -> IO Closure

mk_PanedMoveHandleCallback :: C_PanedMoveHandleCallback -> IO (FunPtr C_PanedMoveHandleCallback)

noPanedMoveHandleCallback :: Maybe PanedMoveHandleCallback

onPanedMoveHandle :: (IsPaned a, MonadIO m) => a -> PanedMoveHandleCallback -> m SignalHandlerId

wrap_PanedMoveHandleCallback :: PanedMoveHandleCallback -> Ptr () -> CUInt -> Ptr () -> IO CInt

toggleHandleFocus

type C_PanedToggleHandleFocusCallback = Ptr () -> Ptr () -> IO CInt

type PanedToggleHandleFocusCallback = IO Bool

afterPanedToggleHandleFocus :: (IsPaned a, MonadIO m) => a -> PanedToggleHandleFocusCallback -> m SignalHandlerId

genClosure_PanedToggleHandleFocus :: PanedToggleHandleFocusCallback -> IO Closure

mk_PanedToggleHandleFocusCallback :: C_PanedToggleHandleFocusCallback -> IO (FunPtr C_PanedToggleHandleFocusCallback)

noPanedToggleHandleFocusCallback :: Maybe PanedToggleHandleFocusCallback

onPanedToggleHandleFocus :: (IsPaned a, MonadIO m) => a -> PanedToggleHandleFocusCallback -> m SignalHandlerId

wrap_PanedToggleHandleFocusCallback :: PanedToggleHandleFocusCallback -> Ptr () -> Ptr () -> IO CInt