GI.Gtk.Interfaces.Scrollable

Scrollable is an interface that is implemented by widgets with native scrolling ability.

To implement this interface you should override the Scrollable:hadjustment and Scrollable:vadjustment properties.

Creating a scrollable widget

All scrollable widgets should do the following.

• When a parent widget sets the scrollable child widget’s adjustments, the widget should populate the adjustments’ Adjustment:lower, Adjustment:upper, Adjustment:step-increment, Adjustment:page-increment and Adjustment:page-size properties and connect to the Adjustment::value-changed signal.
• Because its preferred size is the size for a fully expanded widget, the scrollable widget must be able to cope with underallocations. This means that it must accept any value passed to its WidgetClass.size_allocate() function.
• When the parent allocates space to the scrollable child widget, the widget should update the adjustments’ properties with new values.
• When any of the adjustments emits the Adjustment::value-changed signal, the scrollable widget should scroll its contents.

Exported types

newtype Scrollable

Constructors

Scrollable (ManagedPtr Scrollable)

Instances

GObject Scrollable

Methods

gobjectType :: Scrollable -> IO GType

IsObject Scrollable

IsScrollable Scrollable

noScrollable :: Maybe Scrollable

class GObject o => IsScrollable o

Instances

(GObject a, UnknownAncestorError Constraint Scrollable a) => IsScrollable a

IsScrollable TreeView

IsScrollable IconView

IsScrollable Scrollable

IsScrollable Layout

IsScrollable TextView

IsScrollable ToolPalette

IsScrollable Viewport

toScrollable :: (MonadIO m, IsScrollable o) => o -> m Scrollable

Methods

getBorder

scrollableGetBorder

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a Scrollable

-> m (Bool, Border)

Returns: True if border has been set

Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.

Since: 3.16

getHadjustment

scrollableGetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a Scrollable

-> m Adjustment

Returns: horizontal Adjustment.

Retrieves the Adjustment used for horizontal scrolling.

Since: 3.0

getHscrollPolicy

scrollableGetHscrollPolicy

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a Scrollable

-> m ScrollablePolicy

Returns: The horizontal ScrollablePolicy.

Gets the horizontal ScrollablePolicy.

Since: 3.0

getVadjustment

scrollableGetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a Scrollable

-> m Adjustment

Returns: vertical Adjustment.

Retrieves the Adjustment used for vertical scrolling.

Since: 3.0

getVscrollPolicy

scrollableGetVscrollPolicy

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a Scrollable

-> m ScrollablePolicy

Returns: The vertical ScrollablePolicy.

Gets the vertical ScrollablePolicy.

Since: 3.0

setHadjustment

scrollableSetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a, IsAdjustment b)

=> a

scrollable: a Scrollable

-> Maybe b

hadjustment: a Adjustment

-> m ()

Sets the horizontal adjustment of the Scrollable.

Since: 3.0

setHscrollPolicy

scrollableSetHscrollPolicy

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a Scrollable

-> ScrollablePolicy

policy: the horizontal ScrollablePolicy

-> m ()

Sets the ScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.

Since: 3.0

setVadjustment

scrollableSetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a, IsAdjustment b)

=> a

scrollable: a Scrollable

-> Maybe b

vadjustment: a Adjustment

-> m ()

Sets the vertical adjustment of the Scrollable.

Since: 3.0

setVscrollPolicy

scrollableSetVscrollPolicy

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a Scrollable

-> ScrollablePolicy

policy: the vertical ScrollablePolicy

-> m ()

Sets the ScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.

Since: 3.0

Properties

hadjustment

clearScrollableHadjustment :: (MonadIO m, IsScrollable o) => o -> m ()

constructScrollableHadjustment :: (IsScrollable o, IsAdjustment a) => a -> IO (GValueConstruct o)

getScrollableHadjustment :: (MonadIO m, IsScrollable o) => o -> m Adjustment

setScrollableHadjustment :: (MonadIO m, IsScrollable o, IsAdjustment a) => o -> a -> m ()

hscrollPolicy

constructScrollableHscrollPolicy :: IsScrollable o => ScrollablePolicy -> IO (GValueConstruct o)

getScrollableHscrollPolicy :: (MonadIO m, IsScrollable o) => o -> m ScrollablePolicy

setScrollableHscrollPolicy :: (MonadIO m, IsScrollable o) => o -> ScrollablePolicy -> m ()

vadjustment

clearScrollableVadjustment :: (MonadIO m, IsScrollable o) => o -> m ()

constructScrollableVadjustment :: (IsScrollable o, IsAdjustment a) => a -> IO (GValueConstruct o)

getScrollableVadjustment :: (MonadIO m, IsScrollable o) => o -> m Adjustment

setScrollableVadjustment :: (MonadIO m, IsScrollable o, IsAdjustment a) => o -> a -> m ()

vscrollPolicy

constructScrollableVscrollPolicy :: IsScrollable o => ScrollablePolicy -> IO (GValueConstruct o)

getScrollableVscrollPolicy :: (MonadIO m, IsScrollable o) => o -> m ScrollablePolicy

setScrollableVscrollPolicy :: (MonadIO m, IsScrollable o) => o -> ScrollablePolicy -> m ()