Gtk.Scrollbar

g GObject.GInterface GObject.GInterface Gtk.Accessible Gtk.Accessible GObject.GInterface->Gtk.Accessible Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable Gtk.ConstraintTarget Gtk.ConstraintTarget GObject.GInterface->Gtk.ConstraintTarget Gtk.Orientable Gtk.Orientable GObject.GInterface->Gtk.Orientable GObject.InitiallyUnowned GObject.InitiallyUnowned Gtk.Widget Gtk.Widget GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Accessible->Gtk.Widget Gtk.Buildable->Gtk.Widget Gtk.ConstraintTarget->Gtk.Widget Gtk.Scrollbar Gtk.Scrollbar Gtk.Orientable->Gtk.Scrollbar Gtk.Widget->Gtk.Scrollbar

Example

../_images/Scrollbar.png
Subclasses:

None

Methods

Inherited:

Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1), Gtk.Orientable (2)

Structs:

Gtk.WidgetClass (18), GObject.ObjectClass (5)

class

new (orientation, adjustment)

get_adjustment ()

set_adjustment (adjustment)

Virtual Methods

Inherited:

Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties

Inherited:

Gtk.Widget (34), Gtk.Accessible (1), Gtk.Orientable (1)

Name

Type

Flags

Short Description

adjustment

Gtk.Adjustment

r/w/c/en

Signals

Inherited:

Gtk.Widget (13), GObject.Object (1)

Fields

Inherited:

Gtk.Widget (13), GObject.Object (1)

Class Details

class Gtk.Scrollbar(**kwargs)
Bases:

Gtk.Widget, Gtk.Orientable

Abstract:

No

The GtkScrollbar widget is a horizontal or vertical scrollbar.

An example Gtk.Scrollbar

Its position and movement are controlled by the adjustment that is passed to or created by [ctor`Gtk`.Scrollbar.new]. See [class`Gtk`.Adjustment] for more details. The [property`Gtk`.Adjustment:value] field sets the position of the thumb and must be between [property`Gtk`.Adjustment:lower] and [property`Gtk`.Adjustment:upper] - [property`Gtk`.Adjustment:page-size]. The [property`Gtk`.Adjustment:page-size] represents the size of the visible scrollable area.

The fields [property`Gtk`.Adjustment:step-increment] and [property`Gtk`.Adjustment:page-increment] fields are added to or subtracted from the [property`Gtk`.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

``

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 [class`Gtk`.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.AccessibleRole.SCROLLBAR role.

classmethod new(orientation, adjustment)[source]
Parameters:
Returns:

the new GtkScrollbar.

Return type:

Gtk.Widget

Creates a new scrollbar with the given orientation.

get_adjustment()[source]
Returns:

the scrollbar’s adjustment

Return type:

Gtk.Adjustment

Returns the scrollbar’s adjustment.

set_adjustment(adjustment)[source]
Parameters:

adjustment (Gtk.Adjustment or None) – the adjustment to set

Makes the scrollbar use the given adjustment.

Property Details

Gtk.Scrollbar.props.adjustment
Name:

adjustment

Type:

Gtk.Adjustment

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

The GtkAdjustment controlled by this scrollbar.