Gtk.Scrollbar

Entities

Tagged Types

Access Types

Subtypes

Subprograms

Generic Instantiations

Description

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

Its position and movement are controlled by the adjustment that is passed to or created by Gtk.Scrollbar.Gtk_New. See Gtk.Adjustment.Gtk_Adjustment for more details. The Gtk.Adjustment.Gtk_Adjustment:value field sets the position of the thumb and must be between Gtk.Adjustment.Gtk_Adjustment:lower and Gtk.Adjustment.Gtk_Adjustment:upper

Gtk.Adjustment.Gtk_Adjustment:page-size represents the size of the visible scrollable area. The fields Gtk.Adjustment.Gtk_Adjustment:step-increment and Gtk.Adjustment.Gtk_Adjustment:page-increment fields are added to or subtracted from the Gtk.Adjustment.Gtk_Adjustment: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 Gtk.Scrolled_Window.Gtk_Scrolled_Window include the positional classes (.left, .right, .top, .bottom) and style classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering).

"+"

function "+"
  (Widget : access Gtk_Scrollbar_Record'Class)
return Gtk.Buildable.Gtk_Buildable
Parameters
Widget
Return Value

"+"

function "+"
  (Widget : access Gtk_Scrollbar_Record'Class)
return Gtk.Orientable.Gtk_Orientable
Parameters
Widget
Return Value

"-"

function "-"
  (Interf : Gtk.Buildable.Gtk_Buildable)
return Gtk_Scrollbar
Parameters
Interf
Return Value

"-"

function "-"
  (Interf : Gtk.Orientable.Gtk_Orientable)
return Gtk_Scrollbar
Parameters
Interf
Return Value

Get_Orientation

function Get_Orientation
   (Self : not null access Gtk_Scrollbar_Record)
    return Gtk.Enums.Gtk_Orientation
Parameters
Self
Return Value

Get_Type

function Get_Type return Glib.GType
Return Value

Gtk_Hscrollbar

subtype Gtk_Hscrollbar is Gtk_Scrollbar;

Gtk_Hscrollbar_New

function Gtk_Hscrollbar_New
   (Adjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)
    return Gtk_Hscrollbar

Creates a new horizontal scrollbar.

Parameters
Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment

Return Value

Gtk_Hscrollbar_Record

subtype Gtk_Hscrollbar_Record is Gtk_Scrollbar_Record;

Gtk_New

procedure Gtk_New
   (Scrollbar   : out Gtk_Scrollbar;
    Orientation : Gtk.Enums.Gtk_Orientation;
    Adjustment  : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Creates a new scrollbar with the given orientation. Since: gtk+ 3.0 Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Scrollbar
Orientation

the scrollbar's orientation.

Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment.

Gtk_New_Hscrollbar

procedure Gtk_New_Hscrollbar
   (Scrollbar  : out Gtk_Hscrollbar;
    Adjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Creates a new horizontal scrollbar. Initialize_Hscrollbar does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Scrollbar
Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment

Gtk_New_Vscrollbar

procedure Gtk_New_Vscrollbar
   (Scrollbar  : out Gtk_Vscrollbar;
    Adjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Creates a new vertical scrollbar. Initialize_Vscrollbar does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Scrollbar
Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment

Gtk_Scrollbar

type Gtk_Scrollbar is access all Gtk_Scrollbar_Record'Class;

Gtk_Scrollbar_New

function Gtk_Scrollbar_New
   (Orientation : Gtk.Enums.Gtk_Orientation;
    Adjustment  : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)
    return Gtk_Scrollbar

Creates a new scrollbar with the given orientation. Since: gtk+ 3.0

Parameters
Orientation

the scrollbar's orientation.

Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment.

Return Value

Gtk_Scrollbar_Record

type Gtk_Scrollbar_Record is new Gtk_Range_Record with null record;

Gtk_Vscrollbar

subtype Gtk_Vscrollbar is Gtk_Scrollbar;

Gtk_Vscrollbar_New

function Gtk_Vscrollbar_New
   (Adjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)
    return Gtk_Vscrollbar

Creates a new vertical scrollbar.

Parameters
Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment

Return Value

Gtk_Vscrollbar_Record

subtype Gtk_Vscrollbar_Record is Gtk_Scrollbar_Record;

Hscrollbar_Get_Type

function Hscrollbar_Get_Type return Glib.GType
Return Value

Implements_Gtk_Buildable

package Implements_Gtk_Buildable is new Glib.Types.Implements
  (Gtk.Buildable.Gtk_Buildable, Gtk_Scrollbar_Record, Gtk_Scrollbar);

Implements_Gtk_Orientable

package Implements_Gtk_Orientable is new Glib.Types.Implements
  (Gtk.Orientable.Gtk_Orientable, Gtk_Scrollbar_Record, Gtk_Scrollbar);

Initialize

procedure Initialize
   (Scrollbar   : not null access Gtk_Scrollbar_Record'Class;
    Orientation : Gtk.Enums.Gtk_Orientation;
    Adjustment  : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Creates a new scrollbar with the given orientation. Since: gtk+ 3.0 Initialize does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Scrollbar
Orientation

the scrollbar's orientation.

Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment.

Initialize_Hscrollbar

procedure Initialize_Hscrollbar
   (Scrollbar  : not null access Gtk_Hscrollbar_Record'Class;
    Adjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Creates a new horizontal scrollbar. Initialize_Hscrollbar does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Scrollbar
Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment

Initialize_Vscrollbar

procedure Initialize_Vscrollbar
   (Scrollbar  : not null access Gtk_Vscrollbar_Record'Class;
    Adjustment : access Gtk.Adjustment.Gtk_Adjustment_Record'Class)

Creates a new vertical scrollbar. Initialize_Vscrollbar does nothing if the object was already created with another call to Initialize* or G_New.

Parameters
Scrollbar
Adjustment

the Gtk.Adjustment.Gtk_Adjustment to use, or null to create a new adjustment

Set_Orientation

procedure Set_Orientation
   (Self        : not null access Gtk_Scrollbar_Record;
    Orientation : Gtk.Enums.Gtk_Orientation)
Parameters
Self
Orientation

Vscrollbar_Get_Type

function Vscrollbar_Get_Type return Glib.GType
Return Value