GI.Gtk.Interfaces.Scrollable

GtkScrollable is an interface for 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:stepIncrement, Adjustment:pageIncrement and Adjustment:pageSize properties and connect to the Adjustment::valueChanged 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 Widget.size_allocate() implementation.
• 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::valueChanged signal, the scrollable widget should scroll its contents.

Exported types

newtype Scrollable

Memory-managed wrapper type.

Constructors

Scrollable (ManagedPtr Scrollable)

Instances

Eq Scrollable

Defined in GI.Gtk.Interfaces.Scrollable

Methods

(==) :: Scrollable -> Scrollable -> Bool

(/=) :: Scrollable -> Scrollable -> Bool

GObject Scrollable

Defined in GI.Gtk.Interfaces.Scrollable

ManagedPtrNewtype Scrollable

Defined in GI.Gtk.Interfaces.Scrollable

Methods

toManagedPtr :: Scrollable -> ManagedPtr Scrollable

TypedObject Scrollable

Defined in GI.Gtk.Interfaces.Scrollable

Methods

glibType :: IO GType

HasParentTypes Scrollable

Defined in GI.Gtk.Interfaces.Scrollable

IsGValue (Maybe Scrollable)

Convert Scrollable to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Interfaces.Scrollable

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Scrollable -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Scrollable)

type ParentTypes Scrollable

Defined in GI.Gtk.Interfaces.Scrollable

type ParentTypes Scrollable = '[Object]

class (GObject o, IsDescendantOf Scrollable o) => IsScrollable o

Type class for types which can be safely cast to Scrollable, for instance with toScrollable.

Instances

(GObject o, IsDescendantOf Scrollable o) => IsScrollable o

Defined in GI.Gtk.Interfaces.Scrollable

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

Cast to Scrollable, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getBorder, getData, getHadjustment, getHscrollPolicy, getProperty, getQdata, getVadjustment, getVscrollPolicy.

Setters

setData, setDataFull, setHadjustment, setHscrollPolicy, setProperty, setVadjustment, setVscrollPolicy.

getBorder

scrollableGetBorder

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a GtkScrollable

-> 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 overlaid graphics, like the overshoot indication, at the right position.

getHadjustment

scrollableGetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a GtkScrollable

-> m Adjustment

Returns: horizontal GtkAdjustment.

Retrieves the GtkAdjustment used for horizontal scrolling.

getHscrollPolicy

scrollableGetHscrollPolicy

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a GtkScrollable

-> m ScrollablePolicy

Returns: The horizontal GtkScrollablePolicy.

Gets the horizontal GtkScrollablePolicy.

getVadjustment

scrollableGetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a GtkScrollable

-> m Adjustment

Returns: vertical GtkAdjustment.

Retrieves the GtkAdjustment used for vertical scrolling.

getVscrollPolicy

scrollableGetVscrollPolicy

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a GtkScrollable

-> m ScrollablePolicy

Returns: The vertical GtkScrollablePolicy.

Gets the vertical GtkScrollablePolicy.

setHadjustment

scrollableSetHadjustment

Arguments

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

=> a

scrollable: a GtkScrollable

-> Maybe b

hadjustment: a GtkAdjustment

-> m ()

Sets the horizontal adjustment of the GtkScrollable.

setHscrollPolicy

scrollableSetHscrollPolicy

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a GtkScrollable

-> ScrollablePolicy

policy: the horizontal GtkScrollablePolicy

-> m ()

Sets the GtkScrollablePolicy.

The policy determines whether horizontal scrolling should start below the minimum width or below the natural width.

setVadjustment

scrollableSetVadjustment

Arguments

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

=> a

scrollable: a GtkScrollable

-> Maybe b

vadjustment: a GtkAdjustment

-> m ()

Sets the vertical adjustment of the GtkScrollable.

setVscrollPolicy

scrollableSetVscrollPolicy

Arguments

:: (HasCallStack, MonadIO m, IsScrollable a)

=> a

scrollable: a GtkScrollable

-> ScrollablePolicy

policy: the vertical GtkScrollablePolicy

-> m ()

Sets the GtkScrollablePolicy.

The policy determines whether vertical scrolling should start below the minimum height or below the natural height.

Properties

hadjustment

Horizontal GtkAdjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

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

Set the value of the “hadjustment” property to Nothing. When overloading is enabled, this is equivalent to

clear #hadjustment

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

Construct a GValueConstruct with valid value for the “hadjustment” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “hadjustment” property. When overloading is enabled, this is equivalent to

get scrollable #hadjustment

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

Set the value of the “hadjustment” property. When overloading is enabled, this is equivalent to

set scrollable [ #hadjustment := value ]

hscrollPolicy

Determines when horizontal scrolling should start.

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

Construct a GValueConstruct with valid value for the “hscroll-policy” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “hscroll-policy” property. When overloading is enabled, this is equivalent to

get scrollable #hscrollPolicy

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

Set the value of the “hscroll-policy” property. When overloading is enabled, this is equivalent to

set scrollable [ #hscrollPolicy := value ]

vadjustment

Vertical GtkAdjustment of the scrollable widget.

This adjustment is shared between the scrollable widget and its parent.

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

Set the value of the “vadjustment” property to Nothing. When overloading is enabled, this is equivalent to

clear #vadjustment

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

Construct a GValueConstruct with valid value for the “vadjustment” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “vadjustment” property. When overloading is enabled, this is equivalent to

get scrollable #vadjustment

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

Set the value of the “vadjustment” property. When overloading is enabled, this is equivalent to

set scrollable [ #vadjustment := value ]

vscrollPolicy

Determines when vertical scrolling should start.

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

Construct a GValueConstruct with valid value for the “vscroll-policy” property. This is rarely needed directly, but it is used by new.

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

Get the value of the “vscroll-policy” property. When overloading is enabled, this is equivalent to

get scrollable #vscrollPolicy

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

Set the value of the “vscroll-policy” property. When overloading is enabled, this is equivalent to

set scrollable [ #vscrollPolicy := value ]