shared between the scrollable widget and its parent.
gtk.scrollable_mixin
Module for [Scrollable] interface mixin
Templates 2
tmplScrollableT()
#GtkScrollable is an interface that is implemented by widgets with native scrolling ability.
To implement this interface you should override the #GtkScrollable: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’ #GtkAdjustment:lower, #GtkAdjustment:upper, #GtkAdjustment:step-increment, #GtkAdjustment:page-increment and #GtkAdjustment:page-size properties and connect to the #GtkAdjustment::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 #GtkWidgetClass.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 #GtkAdjustment::value-changed signal,
the scrollable widget should scroll its contents.
Functions
gtk.adjustment.Adjustment hadjustment()
Get hadjustment property.
Returns
Horizontal #GtkAdjustment of the scrollable widget. This adjustment is
void hadjustment(gtk.adjustment.Adjustment propval)
Set hadjustment property.
Parameters
propval | Horizontal #GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. |
gtk.types.ScrollablePolicy hscrollPolicy()
Get hscrollPolicy property.
Returns
Determines whether horizontal scrolling should start once the scrollable
widget is allocated less than its minimum width or less than its natural width.
void hscrollPolicy(gtk.types.ScrollablePolicy propval)
Set hscrollPolicy property.
Parameters
propval | Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width. |
gtk.adjustment.Adjustment vadjustment()
Get vadjustment property.
Returns
Verical #GtkAdjustment of the scrollable widget. This adjustment is shared
between the scrollable widget and its parent.
void vadjustment(gtk.adjustment.Adjustment propval)
Set vadjustment property.
Parameters
propval | Verical #GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. |
gtk.types.ScrollablePolicy vscrollPolicy()
Get vscrollPolicy property.
Returns
Determines whether vertical scrolling should start once the scrollable
widget is allocated less than its minimum height or less than its natural height.
void vscrollPolicy(gtk.types.ScrollablePolicy propval)
Set vscrollPolicy property.
Parameters
propval | Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height. |
bool getBorder(out gtk.border.Border border)
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 | return location for the results |
Returns
true if border has been set
gtk.adjustment.Adjustment getHadjustment()
Retrieves the #GtkAdjustment used for horizontal scrolling.
Returns
horizontal #GtkAdjustment.
gtk.types.ScrollablePolicy getHscrollPolicy()
Gets the horizontal #GtkScrollablePolicy.
Returns
The horizontal #GtkScrollablePolicy.
gtk.adjustment.Adjustment getVadjustment()
Retrieves the #GtkAdjustment used for vertical scrolling.
Returns
vertical #GtkAdjustment.
gtk.types.ScrollablePolicy getVscrollPolicy()
Gets the vertical #GtkScrollablePolicy.
Returns
The vertical #GtkScrollablePolicy.
void setHadjustment(gtk.adjustment.Adjustment hadjustment = null)
Sets the horizontal adjustment of the #GtkScrollable.
Parameters
hadjustment | a #GtkAdjustment |
void setHscrollPolicy(gtk.types.ScrollablePolicy policy)
Sets the #GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.
Parameters
policy | the horizontal #GtkScrollablePolicy |
void setVadjustment(gtk.adjustment.Adjustment vadjustment = null)
Sets the vertical adjustment of the #GtkScrollable.
Parameters
vadjustment | a #GtkAdjustment |
void setVscrollPolicy(gtk.types.ScrollablePolicy policy)
Sets the #GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.
Parameters
policy | the vertical #GtkScrollablePolicy |
tmplScrollableGidBuilderT()
Functions
T hadjustment(gtk.adjustment.Adjustment propval)
Set hadjustment property.
Parameters
propval | Horizontal #GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. |
Returns
Builder instance for fluent chaining
T hscrollPolicy(gtk.types.ScrollablePolicy propval)
Set hscrollPolicy property.
Parameters
propval | Determines whether horizontal scrolling should start once the scrollable widget is allocated less than its minimum width or less than its natural width. |
Returns
Builder instance for fluent chaining
T vadjustment(gtk.adjustment.Adjustment propval)
Set vadjustment property.
Parameters
propval | Verical #GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent. |
Returns
Builder instance for fluent chaining
T vscrollPolicy(gtk.types.ScrollablePolicy propval)
Set vscrollPolicy property.
Parameters
propval | Determines whether vertical scrolling should start once the scrollable widget is allocated less than its minimum height or less than its natural height. |
Returns
Builder instance for fluent chaining