GI.Gtk.Objects.Scrollbar

The Scrollbar widget is a horizontal or vertical scrollbar, depending on the value of the Orientable:orientation property.

Its position and movement are controlled by the adjustment that is passed to or created by scrollbarNew. See Adjustment for more details. The Adjustment:value field sets the position of the thumb and must be between Adjustment:lower and Adjustment:upper - Adjustment:page-size. The Adjustment:page-size represents the size of the visible scrollable area. The fields Adjustment:step-increment and Adjustment:page-increment fields are added to or subtracted from the Adjustment:value when the user asks to move by a step (using e.g. the cursor arrow keys) or by a page (using e.g. the Page Down/Up keys).

CSS nodes

plain code

scrollbar
╰── range[.fine-tune]
    ╰── trough
        ╰── slider

GtkScrollbar has a main CSS node with name scrollbar and a subnode for its contents. The main node gets the .horizontal or .vertical style classes applied, depending on the scrollbar's orientation.

The range node gets the style class .fine-tune added when the scrollbar is in 'fine-tuning' mode.

Other style classes that may be added to scrollbars inside ScrolledWindow include the positional classes (.left, .right, .top, .bottom) and style classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering).

Accessibility

GtkScrollbar uses the GTK_ACCESSIBLE_ROLE_SCROLLBAR role.

Exported types

newtype Scrollbar

Memory-managed wrapper type.

Constructors

Scrollbar (ManagedPtr Scrollbar)

Instances

Eq Scrollbar

Defined in GI.Gtk.Objects.Scrollbar

Methods

(==) :: Scrollbar -> Scrollbar -> Bool

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

GObject Scrollbar

Defined in GI.Gtk.Objects.Scrollbar

ManagedPtrNewtype Scrollbar

Defined in GI.Gtk.Objects.Scrollbar

Methods

toManagedPtr :: Scrollbar -> ManagedPtr Scrollbar

TypedObject Scrollbar

Defined in GI.Gtk.Objects.Scrollbar

Methods

glibType :: IO GType

HasParentTypes Scrollbar

Defined in GI.Gtk.Objects.Scrollbar

IsGValue (Maybe Scrollbar)

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

Defined in GI.Gtk.Objects.Scrollbar

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Scrollbar

Defined in GI.Gtk.Objects.Scrollbar

type ParentTypes Scrollbar = '[Widget, Object, Accessible, Buildable, ConstraintTarget, Orientable]

class (GObject o, IsDescendantOf Scrollbar o) => IsScrollbar o

Type class for types which can be safely cast to Scrollbar, for instance with toScrollbar.

Instances

(GObject o, IsDescendantOf Scrollbar o) => IsScrollbar o

Defined in GI.Gtk.Objects.Scrollbar

toScrollbar :: (MonadIO m, IsScrollbar o) => o -> m Scrollbar

Cast to Scrollbar, 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

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAdjustment, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOrientation, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setAdjustment, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOrientation, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

getAdjustment

scrollbarGetAdjustment

Arguments

:: (HasCallStack, MonadIO m, IsScrollbar a)

=> a

self: a Scrollbar

-> m Adjustment

Returns: the scrollbar's adjustment

Returns the scrollbar's adjustment.

new

scrollbarNew

Arguments

:: (HasCallStack, MonadIO m, IsAdjustment a)

=> Orientation

orientation: the scrollbar’s orientation.

-> Maybe a

adjustment: the Adjustment to use, or Nothing to create a new adjustment.

-> m Scrollbar

Returns: the new Scrollbar.

Creates a new scrollbar with the given orientation.

setAdjustment

scrollbarSetAdjustment

Arguments

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

=> a

self: a Scrollbar

-> Maybe b

adjustment: the adjustment to set

-> m ()

Makes the scrollbar use the given adjustment.

Properties

adjustment

No description available in the introspection data.

clearScrollbarAdjustment :: (MonadIO m, IsScrollbar o) => o -> m ()

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

clear #adjustment

constructScrollbarAdjustment :: (IsScrollbar o, MonadIO m, IsAdjustment a) => a -> m (GValueConstruct o)

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

getScrollbarAdjustment :: (MonadIO m, IsScrollbar o) => o -> m Adjustment

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

get scrollbar #adjustment

setScrollbarAdjustment :: (MonadIO m, IsScrollbar o, IsAdjustment a) => o -> a -> m ()

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

set scrollbar [ #adjustment := value ]