Scrollbar

The #GtkScrollbar widget is a horizontal or vertical scrollbar, depending on the value of the #GtkOrientable:orientation property.

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

CSS nodes

scrollbar[.fine-tune]
╰── contents
    ├── [button.up]
    ├── [button.down]
    ├── trough
    │   ╰── slider
    ├── [button.up]
    ╰── [button.down]

GtkScrollbar has a main CSS node with name scrollbar and a subnode for its contents, with subnodes named trough and slider.

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

If steppers are enabled, they are represented by up to four additional subnodes with name button. These get the style classes .up and .down to indicate in which direction they are moving.

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

class Scrollbar : Range {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

Scrollbar self();

static ScrollbarGidBuilder builder();

this(gtk.types.Orientation orientation, gtk.adjustment.Adjustment adjustment);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(gtk.types.Orientation orientation, gtk.adjustment.Adjustment adjustment): Creates a new scrollbar with the given orientation.

Members

Functions

self Scrollbar self(): Returns this, for use in with statements.

Properties

_gType GType _gType [@property getter]

Static functions

_getGType GType _getGType()
builder ScrollbarGidBuilder builder(): Get builder for gtk.scrollbar.Scrollbar

Inherited Members

From Range

_getGType GType _getGType()
_gType GType _gType [@property getter]
self Range self(): Returns this, for use in with statements.
builder RangeGidBuilder builder(): Get builder for gtk.range.Range
adjustment gtk.adjustment.Adjustment adjustment [@property getter]
adjustment gtk.adjustment.Adjustment adjustment [@property setter]
fillLevel double fillLevel [@property getter]: Get fillLevel property.
fillLevel double fillLevel [@property setter]: Set fillLevel property.
inverted bool inverted [@property getter]
inverted bool inverted [@property setter]
lowerStepperSensitivity gtk.types.SensitivityType lowerStepperSensitivity [@property getter]
lowerStepperSensitivity gtk.types.SensitivityType lowerStepperSensitivity [@property setter]
restrictToFillLevel bool restrictToFillLevel [@property getter]: Get restrictToFillLevel property.
restrictToFillLevel bool restrictToFillLevel [@property setter]: Set restrictToFillLevel property.
roundDigits int roundDigits [@property getter]: Get roundDigits property.
roundDigits int roundDigits [@property setter]: Set roundDigits property.
showFillLevel bool showFillLevel [@property getter]: Get showFillLevel property.
showFillLevel bool showFillLevel [@property setter]: Set showFillLevel property.
upperStepperSensitivity gtk.types.SensitivityType upperStepperSensitivity [@property getter]
upperStepperSensitivity gtk.types.SensitivityType upperStepperSensitivity [@property setter]
getAdjustment gtk.adjustment.Adjustment getAdjustment(): Get the #GtkAdjustment which is the “model” object for #GtkRange. See gtk.range.Range.setAdjustment for details. The return value does not have a reference added, so should not be unreferenced.
getFillLevel double getFillLevel(): Gets the current position of the fill level indicator.
getFlippable bool getFlippable(): Gets the value set by gtk.range.Range.setFlippable.
getInverted bool getInverted(): Gets the value set by gtk.range.Range.setInverted.
getLowerStepperSensitivity gtk.types.SensitivityType getLowerStepperSensitivity(): Gets the sensitivity policy for the stepper that points to the 'lower' end of the GtkRange’s adjustment.
getMinSliderSize int getMinSliderSize(): This function is useful mainly for #GtkRange subclasses.
getRangeRect void getRangeRect(gdk.rectangle.Rectangle rangeRect): This function returns the area that contains the range’s trough and its steppers, in widget->window coordinates.
getRestrictToFillLevel bool getRestrictToFillLevel(): Gets whether the range is restricted to the fill level.
getRoundDigits int getRoundDigits(): Gets the number of digits to round the value to when it changes. See #GtkRange::change-value.
getShowFillLevel bool getShowFillLevel(): Gets whether the range displays the fill level graphically.
getSliderRange void getSliderRange(int sliderStart, int sliderEnd): This function returns sliders range along the long dimension, in widget->window coordinates.
getSliderSizeFixed bool getSliderSizeFixed(): This function is useful mainly for #GtkRange subclasses.
getUpperStepperSensitivity gtk.types.SensitivityType getUpperStepperSensitivity(): Gets the sensitivity policy for the stepper that points to the 'upper' end of the GtkRange’s adjustment.
getValue double getValue(): Gets the current value of the range.
setAdjustment void setAdjustment(gtk.adjustment.Adjustment adjustment): Sets the adjustment to be used as the “model” object for this range widget. The adjustment indicates the current range value, the minimum and maximum range values, the step/page increments used for keybindings and scrolling, and the page size. The page size is normally 0 for #GtkScale and nonzero for #GtkScrollbar, and indicates the size of the visible area of the widget being scrolled. The page size affects the size of the scrollbar slider.
setFillLevel void setFillLevel(double fillLevel): Set the new position of the fill level indicator.
setFlippable void setFlippable(bool flippable): If a range is flippable, it will switch its direction if it is horizontal and its direction is gtk.types.TextDirection.Rtl.
setIncrements void setIncrements(double step, double page): Sets the step and page sizes for the range. The step size is used when the user clicks the #GtkScrollbar arrows or moves #GtkScale via arrow keys. The page size is used for example when moving via Page Up or Page Down keys.
setInverted void setInverted(bool setting): Ranges normally move from lower to higher values as the slider moves from top to bottom or left to right. Inverted ranges have higher values at the top or on the right rather than on the bottom or left.
setLowerStepperSensitivity void setLowerStepperSensitivity(gtk.types.SensitivityType sensitivity): Sets the sensitivity policy for the stepper that points to the 'lower' end of the GtkRange’s adjustment.
setMinSliderSize void setMinSliderSize(int minSize): Sets the minimum size of the range’s slider.
setRange void setRange(double min, double max): Sets the allowable values in the #GtkRange, and clamps the range value to be between min and max. (If the range has a non-zero page size, it is clamped between min and max - page-size.)
setRestrictToFillLevel void setRestrictToFillLevel(bool restrictToFillLevel): Sets whether the slider is restricted to the fill level. See gtk.range.Range.setFillLevel for a general description of the fill level concept.
setRoundDigits void setRoundDigits(int roundDigits): Sets the number of digits to round the value to when it changes. See #GtkRange::change-value.
setShowFillLevel void setShowFillLevel(bool showFillLevel): Sets whether a graphical fill level is show on the trough. See gtk.range.Range.setFillLevel for a general description of the fill level concept.
setSliderSizeFixed void setSliderSizeFixed(bool sizeFixed): Sets whether the range’s slider has a fixed size, or a size that depends on its adjustment’s page size.
setUpperStepperSensitivity void setUpperStepperSensitivity(gtk.types.SensitivityType sensitivity): Sets the sensitivity policy for the stepper that points to the 'upper' end of the GtkRange’s adjustment.
setValue void setValue(double value): Sets the current value of the range; if the value is outside the minimum or maximum range values, it will be clamped to fit inside them. The range emits the #GtkRange::value-changed signal if the value changes.
connectAdjustBounds gulong connectAdjustBounds(T callback, Flag!"After" after): Connect to AdjustBounds signal.
connectChangeValue gulong connectChangeValue(T callback, Flag!"After" after): Connect to ChangeValue signal.
connectMoveSlider gulong connectMoveSlider(T callback, Flag!"After" after): Connect to MoveSlider signal.
connectValueChanged gulong connectValueChanged(T callback, Flag!"After" after): Connect to ValueChanged signal.

gtk scrollbar classes