Scrollable

interface Scrollable

GtkScrollable is an interface for widgets with native scrolling ability.

To implement this interface you should override the property@Gtk.Scrollable:hadjustment and property@Gtk.Scrollable:vadjustment properties.

Creating a scrollable widget

All scrollable widgets should do the following.

  • When a parent widget sets the scrollable child widget’s adjustments, the widget should connect to the signal@Gtk.Adjustment::value-changed signal. The child widget should then populate the adjustments’ properties as soon as possible, which usually means queueing an allocation right away and populating the properties in the vfunc@Gtk.Widget.size_allocate implementation.

  • Because its preferred size is the size for a fully expanded widget, the scrollable widget must be able to cope with underallocations. This means that it must accept any value passed to its vfunc@Gtk.Widget.size_allocate implementation.

  • When the parent allocates space to the scrollable child widget, the widget must ensure the adjustments’ property values are correct and up to date, for example using method@Gtk.Adjustment.configure.

  • When any of the adjustments emits the signal@Gtk.Adjustment::value-changed signal, the scrollable widget should scroll its contents.

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val gtkScrollablePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard

Horizontal GtkAdjustment of the scrollable widget.

Link copied to clipboard

Determines when horizontal scrolling should start.

Link copied to clipboard

Vertical GtkAdjustment of the scrollable widget.

Link copied to clipboard

Determines when vertical scrolling should start.

Functions

Link copied to clipboard
open fun getBorder(border: Border): Boolean

Returns the size of a non-scrolling border around the outside of the scrollable.

Link copied to clipboard

Retrieves the GtkAdjustment used for horizontal scrolling.

Link copied to clipboard

Gets the horizontal GtkScrollablePolicy.

Link copied to clipboard

Retrieves the GtkAdjustment used for vertical scrolling.

Link copied to clipboard

Gets the vertical GtkScrollablePolicy.

Link copied to clipboard
open fun setHadjustment(hadjustment: Adjustment? = null)

Sets the horizontal adjustment of the GtkScrollable.

Link copied to clipboard

Sets the GtkScrollablePolicy.

Link copied to clipboard
open fun setVadjustment(vadjustment: Adjustment? = null)

Sets the vertical adjustment of the GtkScrollable.

Link copied to clipboard

Sets the GtkScrollablePolicy.