| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Structs.ScrollInfo
Description
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
Synopsis
- newtype ScrollInfo = ScrollInfo (ManagedPtr ScrollInfo)
- scrollInfoGetEnableHorizontal :: (HasCallStack, MonadIO m) => ScrollInfo -> m Bool
- scrollInfoGetEnableVertical :: (HasCallStack, MonadIO m) => ScrollInfo -> m Bool
- scrollInfoNew :: (HasCallStack, MonadIO m) => m ScrollInfo
- scrollInfoRef :: (HasCallStack, MonadIO m) => ScrollInfo -> m ScrollInfo
- scrollInfoSetEnableHorizontal :: (HasCallStack, MonadIO m) => ScrollInfo -> Bool -> m ()
- scrollInfoSetEnableVertical :: (HasCallStack, MonadIO m) => ScrollInfo -> Bool -> m ()
- scrollInfoUnref :: (HasCallStack, MonadIO m) => ScrollInfo -> m ()
Exported types
newtype ScrollInfo Source #
Memory-managed wrapper type.
Constructors
| ScrollInfo (ManagedPtr ScrollInfo) |
Instances
| Eq ScrollInfo Source # | |
Defined in GI.Gtk.Structs.ScrollInfo | |
| GBoxed ScrollInfo Source # | |
Defined in GI.Gtk.Structs.ScrollInfo | |
| ManagedPtrNewtype ScrollInfo Source # | |
Defined in GI.Gtk.Structs.ScrollInfo Methods toManagedPtr :: ScrollInfo -> ManagedPtr ScrollInfo | |
| TypedObject ScrollInfo Source # | |
Defined in GI.Gtk.Structs.ScrollInfo | |
| HasParentTypes ScrollInfo Source # | |
Defined in GI.Gtk.Structs.ScrollInfo | |
| IsGValue (Maybe ScrollInfo) Source # | Convert |
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 Source # | |
Defined in GI.Gtk.Structs.ScrollInfo | |
Methods
Click to display all available methods, including inherited ones
getEnableHorizontal
scrollInfoGetEnableHorizontal Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ScrollInfo |
|
| -> m Bool | Returns: |
Checks if horizontal scrolling is enabled.
Since: 4.12
getEnableVertical
scrollInfoGetEnableVertical Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ScrollInfo |
|
| -> m Bool | Returns: |
Checks if vertical scrolling is enabled.
Since: 4.12
new
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
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ScrollInfo |
|
| -> m ScrollInfo | Returns: the passed in |
Increases the reference count of a GtkScrollInfo by one.
Since: 4.12
setEnableHorizontal
scrollInfoSetEnableHorizontal Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ScrollInfo |
|
| -> Bool |
|
| -> m () |
Turns horizontal scrolling on or off.
Since: 4.12
setEnableVertical
scrollInfoSetEnableVertical Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ScrollInfo |
|
| -> Bool |
|
| -> m () |
Turns vertical scrolling on or off.
Since: 4.12
unref
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ScrollInfo |
|
| -> m () |
Decreases the reference count of a GtkScrollInfo by one.
If the resulting reference count is zero, frees the self.
Since: 4.12