Module: Gtk::Scrollable

Defined in:
(unknown)

Overview

Gtk::Scrollable is an interface that is implemented by widgets with native scrolling ability.

To implement this interface you should override the Gtk::Scrollable:hadjustment and #GtkScrollable: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 populate the adjustments’ Gtk::Adjustment:lower, #GtkAdjustment:upper, Gtk::Adjustment:step-increment, #GtkAdjustment:page-increment and Gtk::Adjustment:page-size properties and connect to the Gtk::Adjustment::value-changed signal.

  • 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 Gtk::WidgetClass.size_allocate() function.

  • When the parent allocates space to the scrollable child widget, the widget should update the adjustments’ properties with new values.

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

Instance Method Summary collapse

Instance Method Details

#get_border(border) ⇒ TrueClass

Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.

Parameters:

  • border (Gtk::Border) —

    return location for the results

Returns:

  • (TrueClass) —

    true if border has been set

#hadjustment ⇒ Gtk::Adjustment

Retrieves the Gtk::Adjustment used for horizontal scrolling.

Returns:

#hadjustment=(hadjustment) ⇒ nil

Sets the horizontal adjustment of the Gtk::Scrollable.

Parameters:

Returns:

  • (nil)

#hscroll_policy ⇒ Gtk::ScrollablePolicy

Gets the horizontal Gtk::ScrollablePolicy.

Returns:

#hscroll_policy=(policy) ⇒ nil

Sets the Gtk::ScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.

Parameters:

Returns:

  • (nil)

#vadjustment ⇒ Gtk::Adjustment

Retrieves the Gtk::Adjustment used for vertical scrolling.

Returns:

#vadjustment=(vadjustment) ⇒ nil

Sets the vertical adjustment of the Gtk::Scrollable.

Parameters:

Returns:

  • (nil)

#vscroll_policy ⇒ Gtk::ScrollablePolicy

Gets the vertical Gtk::ScrollablePolicy.

Returns:

#vscroll_policy=(policy) ⇒ nil

Sets the Gtk::ScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.

Parameters:

Returns:

  • (nil)