GI.Gtk.Structs.ScrollInfo

The GtkScrollInfo can be used to provide more accurate data on how a scroll operation should be performed.

Scrolling functions usually allow passing a Nothing scroll info which will cause the default values to be used and just scroll the element into view.

Since: 4.12

Exported types

newtype ScrollInfo

Memory-managed wrapper type.

Constructors

ScrollInfo (ManagedPtr ScrollInfo)

Instances

Eq ScrollInfo

Defined in GI.Gtk.Structs.ScrollInfo

Methods

(==) :: ScrollInfo -> ScrollInfo -> Bool

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

GBoxed ScrollInfo

Defined in GI.Gtk.Structs.ScrollInfo

ManagedPtrNewtype ScrollInfo

Defined in GI.Gtk.Structs.ScrollInfo

Methods

toManagedPtr :: ScrollInfo -> ManagedPtr ScrollInfo

TypedObject ScrollInfo

Defined in GI.Gtk.Structs.ScrollInfo

Methods

glibType :: IO GType

HasParentTypes ScrollInfo

Defined in GI.Gtk.Structs.ScrollInfo

IsGValue (Maybe ScrollInfo)

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

Defined in GI.Gtk.Structs.ScrollInfo

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ScrollInfo

Defined in GI.Gtk.Structs.ScrollInfo

type ParentTypes ScrollInfo = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

ref, unref.

Getters

getEnableHorizontal, getEnableVertical.

Setters

setEnableHorizontal, setEnableVertical.

getEnableHorizontal

scrollInfoGetEnableHorizontal

Arguments

:: (HasCallStack, MonadIO m)

=> ScrollInfo

self: a GtkScrollInfo

-> m Bool

Returns: True if horizontal scrolling is enabled.

Checks if horizontal scrolling is enabled.

Since: 4.12

getEnableVertical

scrollInfoGetEnableVertical

Arguments

:: (HasCallStack, MonadIO m)

=> ScrollInfo

self: a GtkScrollInfo

-> m Bool

Returns: True if vertical scrolling is enabled.

Checks if vertical scrolling is enabled.

Since: 4.12

new

scrollInfoNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ScrollInfo

Returns: A new scroll info

Creates a new scroll info for scrolling an element into view.

Since: 4.12

ref

scrollInfoRef

Arguments

:: (HasCallStack, MonadIO m)

=> ScrollInfo

self: a GtkScrollInfo

-> m ScrollInfo

Returns: the passed in GtkScrollInfo.

Increases the reference count of a GtkScrollInfo by one.

Since: 4.12

setEnableHorizontal

scrollInfoSetEnableHorizontal

Arguments

:: (HasCallStack, MonadIO m)

=> ScrollInfo

self: a GtkScrollInfo

-> Bool

horizontal: if scrolling in the horizontal direction should happen

-> m ()

Turns horizontal scrolling on or off.

Since: 4.12

setEnableVertical

scrollInfoSetEnableVertical

Arguments

:: (HasCallStack, MonadIO m)

=> ScrollInfo

self: a GtkScrollInfo

-> Bool

vertical: if scrolling in the vertical direction should happen

-> m ()

Turns vertical scrolling on or off.

Since: 4.12

unref

scrollInfoUnref

Arguments

:: (HasCallStack, MonadIO m)

=> ScrollInfo

self: a GtkScrollInfo

-> m ()

Decreases the reference count of a GtkScrollInfo by one.

If the resulting reference count is zero, frees the self.

Since: 4.12