gtk.scrollbar

Module for Scrollbar class

class Scrollbar ScrollbarGidBuilder ScrollbarGidBuilderImpl

Types 3

classScrollbar : gtk.widget.Widget, gtk.orientable.Orientable

The gtk.scrollbar.Scrollbar widget is a horizontal or vertical scrollbar.

!An example GtkScrollbar

Its position and movement are controlled by the adjustment that is passed to or created by gtk.scrollbar.Scrollbar.new_. See gtk.adjustment.Adjustment for more details. The gtk.adjustment.Adjustment.value field sets the position of the thumb and must be between gtk.adjustment.Adjustment.lower and gtk.adjustment.Adjustment.upper - gtk.adjustment.Adjustment.pageSize. The gtk.adjustment.Adjustment.pageSize represents the size of the visible scrollable area.

The fields gtk.adjustment.Adjustment.stepIncrement and gtk.adjustment.Adjustment.pageIncrement fields are added to or subtracted from the gtk.adjustment.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

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

gtk.scrollbar.Scrollbar 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 gtk.scrolled_window.ScrolledWindow include the positional classes (.left, .right, .top, .bottom) and style classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering).

Accessibility

gtk.scrollbar.Scrollbar uses the gtk.types.AccessibleRole.Scrollbar role.

Methods
GType _getGType()
GType _gType() @property
Scrollbar self()Returns `this`, for use in `with` statements.
ScrollbarGidBuilder builder()Get builder for [gtk.scrollbar.Scrollbar] Returns: New builder object
gtk.adjustment.Adjustment adjustment() @propertyGet `adjustment` property. Returns: The [gtk.adjustment.Adjustment] controlled by this scrollbar.
void adjustment(gtk.adjustment.Adjustment propval) @propertySet `adjustment` property. Params: propval = The [gtk.adjustment.Adjustment] controlled by this scrollbar.
gtk.adjustment.Adjustment getAdjustment()Returns the scrollbar's adjustment. Returns: the scrollbar's adjustment
void setAdjustment(gtk.adjustment.Adjustment adjustment = null)Makes the scrollbar use the given adjustment.
Constructors
this(void * ptr, Flag!"Take" take)
this(gtk.types.Orientation orientation, gtk.adjustment.Adjustment adjustment = null)Creates a new scrollbar with the given orientation.
classScrollbarGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T, gtk.orientable.OrientableGidBuilderImpl!T

Fluent builder implementation template for gtk.scrollbar.Scrollbar

Methods
T adjustment(gtk.adjustment.Adjustment propval)Set `adjustment` property. Params: propval = The [gtk.adjustment.Adjustment] controlled by this scrollbar. Returns: Builder instance for fluent chaining
classScrollbarGidBuilder : ScrollbarGidBuilderImpl!ScrollbarGidBuilder

Fluent builder for gtk.scrollbar.Scrollbar

Methods
Scrollbar build()Create object from builder. Returns: New object