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

((~) * info (ResolveScrollableMethod t Scrollable), MethodInfo * info Scrollable p) => IsLabel t (Scrollable -> p)

Methods

fromLabel :: Proxy# Symbol t -> Scrollable -> p

((~) * info (ResolveScrollableMethod t Scrollable), MethodInfo * info Scrollable p) => IsLabelProxy t (Scrollable -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Scrollable -> p

HasAttributeList * Scrollable

type AttributeList Scrollable

type AttributeList Scrollable

type SignalList Scrollable

type SignalList 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 :: IsScrollable o => o -> IO Scrollable

Methods

getBorder

data ScrollableGetBorderMethodInfo

Instances

((~) * signature (m (Bool, Border)), MonadIO m, IsScrollable a) => MethodInfo * ScrollableGetBorderMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableGetBorderMethodInfo a -> signature -> s

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

data ScrollableGetHadjustmentMethodInfo

Instances

((~) * signature (m Adjustment), MonadIO m, IsScrollable a) => MethodInfo * ScrollableGetHadjustmentMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableGetHadjustmentMethodInfo a -> signature -> s

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

data ScrollableGetHscrollPolicyMethodInfo

Instances

((~) * signature (m ScrollablePolicy), MonadIO m, IsScrollable a) => MethodInfo * ScrollableGetHscrollPolicyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableGetHscrollPolicyMethodInfo a -> signature -> s

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

data ScrollableGetVadjustmentMethodInfo

Instances

((~) * signature (m Adjustment), MonadIO m, IsScrollable a) => MethodInfo * ScrollableGetVadjustmentMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableGetVadjustmentMethodInfo a -> signature -> s

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

data ScrollableGetVscrollPolicyMethodInfo

Instances

((~) * signature (m ScrollablePolicy), MonadIO m, IsScrollable a) => MethodInfo * ScrollableGetVscrollPolicyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableGetVscrollPolicyMethodInfo a -> signature -> s

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

data ScrollableSetHadjustmentMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsScrollable a, IsAdjustment b) => MethodInfo * ScrollableSetHadjustmentMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableSetHadjustmentMethodInfo a -> signature -> s

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

data ScrollableSetHscrollPolicyMethodInfo

Instances

((~) * signature (ScrollablePolicy -> m ()), MonadIO m, IsScrollable a) => MethodInfo * ScrollableSetHscrollPolicyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableSetHscrollPolicyMethodInfo a -> signature -> s

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

data ScrollableSetVadjustmentMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsScrollable a, IsAdjustment b) => MethodInfo * ScrollableSetVadjustmentMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableSetVadjustmentMethodInfo a -> signature -> s

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

data ScrollableSetVscrollPolicyMethodInfo

Instances

((~) * signature (ScrollablePolicy -> m ()), MonadIO m, IsScrollable a) => MethodInfo * ScrollableSetVscrollPolicyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy ScrollableSetVscrollPolicyMethodInfo a -> signature -> s

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

data ScrollableHadjustmentPropertyInfo

Instances

AttrInfo ScrollableHadjustmentPropertyInfo

Associated Types

type AttrAllowedOps ScrollableHadjustmentPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ScrollableHadjustmentPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ScrollableHadjustmentPropertyInfo :: * -> Constraint

type AttrGetType ScrollableHadjustmentPropertyInfo :: *

type AttrLabel ScrollableHadjustmentPropertyInfo :: Symbol

type AttrOrigin ScrollableHadjustmentPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ScrollableHadjustmentPropertyInfo o => Proxy * ScrollableHadjustmentPropertyInfo -> o -> IO (AttrGetType ScrollableHadjustmentPropertyInfo)

attrSet :: (AttrBaseTypeConstraint ScrollableHadjustmentPropertyInfo o, AttrSetTypeConstraint ScrollableHadjustmentPropertyInfo b) => Proxy * ScrollableHadjustmentPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ScrollableHadjustmentPropertyInfo o => Proxy * ScrollableHadjustmentPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ScrollableHadjustmentPropertyInfo o, AttrSetTypeConstraint ScrollableHadjustmentPropertyInfo b) => Proxy * ScrollableHadjustmentPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ScrollableHadjustmentPropertyInfo

type AttrOrigin ScrollableHadjustmentPropertyInfo = Scrollable

type AttrLabel ScrollableHadjustmentPropertyInfo

type AttrLabel ScrollableHadjustmentPropertyInfo = "hadjustment"

type AttrGetType ScrollableHadjustmentPropertyInfo

type AttrGetType ScrollableHadjustmentPropertyInfo = Adjustment

type AttrBaseTypeConstraint ScrollableHadjustmentPropertyInfo

type AttrBaseTypeConstraint ScrollableHadjustmentPropertyInfo = IsScrollable

type AttrSetTypeConstraint ScrollableHadjustmentPropertyInfo

type AttrSetTypeConstraint ScrollableHadjustmentPropertyInfo = IsAdjustment

type AttrAllowedOps ScrollableHadjustmentPropertyInfo

type AttrAllowedOps ScrollableHadjustmentPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

scrollableHadjustment :: AttrLabelProxy "hadjustment"

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

hscrollPolicy

data ScrollableHscrollPolicyPropertyInfo

Instances

AttrInfo ScrollableHscrollPolicyPropertyInfo

Associated Types

type AttrAllowedOps ScrollableHscrollPolicyPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ScrollableHscrollPolicyPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ScrollableHscrollPolicyPropertyInfo :: * -> Constraint

type AttrGetType ScrollableHscrollPolicyPropertyInfo :: *

type AttrLabel ScrollableHscrollPolicyPropertyInfo :: Symbol

type AttrOrigin ScrollableHscrollPolicyPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ScrollableHscrollPolicyPropertyInfo o => Proxy * ScrollableHscrollPolicyPropertyInfo -> o -> IO (AttrGetType ScrollableHscrollPolicyPropertyInfo)

attrSet :: (AttrBaseTypeConstraint ScrollableHscrollPolicyPropertyInfo o, AttrSetTypeConstraint ScrollableHscrollPolicyPropertyInfo b) => Proxy * ScrollableHscrollPolicyPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ScrollableHscrollPolicyPropertyInfo o => Proxy * ScrollableHscrollPolicyPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ScrollableHscrollPolicyPropertyInfo o, AttrSetTypeConstraint ScrollableHscrollPolicyPropertyInfo b) => Proxy * ScrollableHscrollPolicyPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ScrollableHscrollPolicyPropertyInfo

type AttrOrigin ScrollableHscrollPolicyPropertyInfo = Scrollable

type AttrLabel ScrollableHscrollPolicyPropertyInfo

type AttrLabel ScrollableHscrollPolicyPropertyInfo = "hscroll-policy"

type AttrGetType ScrollableHscrollPolicyPropertyInfo

type AttrGetType ScrollableHscrollPolicyPropertyInfo = ScrollablePolicy

type AttrBaseTypeConstraint ScrollableHscrollPolicyPropertyInfo

type AttrBaseTypeConstraint ScrollableHscrollPolicyPropertyInfo = IsScrollable

type AttrSetTypeConstraint ScrollableHscrollPolicyPropertyInfo

type AttrSetTypeConstraint ScrollableHscrollPolicyPropertyInfo = * ~ ScrollablePolicy

type AttrAllowedOps ScrollableHscrollPolicyPropertyInfo

type AttrAllowedOps ScrollableHscrollPolicyPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

scrollableHscrollPolicy :: AttrLabelProxy "hscrollPolicy"

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

vadjustment

data ScrollableVadjustmentPropertyInfo

Instances

AttrInfo ScrollableVadjustmentPropertyInfo

Associated Types

type AttrAllowedOps ScrollableVadjustmentPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ScrollableVadjustmentPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ScrollableVadjustmentPropertyInfo :: * -> Constraint

type AttrGetType ScrollableVadjustmentPropertyInfo :: *

type AttrLabel ScrollableVadjustmentPropertyInfo :: Symbol

type AttrOrigin ScrollableVadjustmentPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ScrollableVadjustmentPropertyInfo o => Proxy * ScrollableVadjustmentPropertyInfo -> o -> IO (AttrGetType ScrollableVadjustmentPropertyInfo)

attrSet :: (AttrBaseTypeConstraint ScrollableVadjustmentPropertyInfo o, AttrSetTypeConstraint ScrollableVadjustmentPropertyInfo b) => Proxy * ScrollableVadjustmentPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ScrollableVadjustmentPropertyInfo o => Proxy * ScrollableVadjustmentPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ScrollableVadjustmentPropertyInfo o, AttrSetTypeConstraint ScrollableVadjustmentPropertyInfo b) => Proxy * ScrollableVadjustmentPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ScrollableVadjustmentPropertyInfo

type AttrOrigin ScrollableVadjustmentPropertyInfo = Scrollable

type AttrLabel ScrollableVadjustmentPropertyInfo

type AttrLabel ScrollableVadjustmentPropertyInfo = "vadjustment"

type AttrGetType ScrollableVadjustmentPropertyInfo

type AttrGetType ScrollableVadjustmentPropertyInfo = Adjustment

type AttrBaseTypeConstraint ScrollableVadjustmentPropertyInfo

type AttrBaseTypeConstraint ScrollableVadjustmentPropertyInfo = IsScrollable

type AttrSetTypeConstraint ScrollableVadjustmentPropertyInfo

type AttrSetTypeConstraint ScrollableVadjustmentPropertyInfo = IsAdjustment

type AttrAllowedOps ScrollableVadjustmentPropertyInfo

type AttrAllowedOps ScrollableVadjustmentPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

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

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

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

scrollableVadjustment :: AttrLabelProxy "vadjustment"

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

vscrollPolicy

data ScrollableVscrollPolicyPropertyInfo

Instances

AttrInfo ScrollableVscrollPolicyPropertyInfo

Associated Types

type AttrAllowedOps ScrollableVscrollPolicyPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ScrollableVscrollPolicyPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ScrollableVscrollPolicyPropertyInfo :: * -> Constraint

type AttrGetType ScrollableVscrollPolicyPropertyInfo :: *

type AttrLabel ScrollableVscrollPolicyPropertyInfo :: Symbol

type AttrOrigin ScrollableVscrollPolicyPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ScrollableVscrollPolicyPropertyInfo o => Proxy * ScrollableVscrollPolicyPropertyInfo -> o -> IO (AttrGetType ScrollableVscrollPolicyPropertyInfo)

attrSet :: (AttrBaseTypeConstraint ScrollableVscrollPolicyPropertyInfo o, AttrSetTypeConstraint ScrollableVscrollPolicyPropertyInfo b) => Proxy * ScrollableVscrollPolicyPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ScrollableVscrollPolicyPropertyInfo o => Proxy * ScrollableVscrollPolicyPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ScrollableVscrollPolicyPropertyInfo o, AttrSetTypeConstraint ScrollableVscrollPolicyPropertyInfo b) => Proxy * ScrollableVscrollPolicyPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ScrollableVscrollPolicyPropertyInfo

type AttrOrigin ScrollableVscrollPolicyPropertyInfo = Scrollable

type AttrLabel ScrollableVscrollPolicyPropertyInfo

type AttrLabel ScrollableVscrollPolicyPropertyInfo = "vscroll-policy"

type AttrGetType ScrollableVscrollPolicyPropertyInfo

type AttrGetType ScrollableVscrollPolicyPropertyInfo = ScrollablePolicy

type AttrBaseTypeConstraint ScrollableVscrollPolicyPropertyInfo

type AttrBaseTypeConstraint ScrollableVscrollPolicyPropertyInfo = IsScrollable

type AttrSetTypeConstraint ScrollableVscrollPolicyPropertyInfo

type AttrSetTypeConstraint ScrollableVscrollPolicyPropertyInfo = * ~ ScrollablePolicy

type AttrAllowedOps ScrollableVscrollPolicyPropertyInfo

type AttrAllowedOps ScrollableVscrollPolicyPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

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

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

scrollableVscrollPolicy :: AttrLabelProxy "vscrollPolicy"

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