ScrolledWindow

GtkScrolledWindow is a container that accepts a single child widget, makes that child scrollable using either internally added scrollbars or externally associated adjustments, and optionally draws a frame around the child.

Widgets with native scrolling support, i.e. those whose classes implement the GtkScrollable interface, are added directly. For other types of widget, the class gtk.Viewport acts as an adaptor, giving scrollability to other widgets. GtkScrolledWindow’s implementation of Container.add intelligently accounts for whether or not the added child is a GtkScrollable If it isn’t, gtk.ScrolledWindow wraps the child in a gtk.Viewport and adds that for you. Therefore, you can just add any child widget and not worry about the details.

If Container.add has added a gtk.Viewport for you, you can remove both your added child widget from the gtk.Viewport, and the gtk.Viewport from the GtkScrolledWindow, like this:

1 
2 GtkWidget *scrolled_window = gtk_scrolled_window_new (NULL, NULL);
3 GtkWidget *child_widget = gtk_button_new ();
4 
5 // GtkButton is not a GtkScrollable, so GtkScrolledWindow will automatically
6 // add a GtkViewport.
7 gtk_container_add (GTK_CONTAINER (scrolled_window),
8 child_widget);
9 
10 // Either of these will result in child_widget being unparented:
11 gtk_container_remove (GTK_CONTAINER (scrolled_window),
12 child_widget);
13 // or
14 gtk_container_remove (GTK_CONTAINER (scrolled_window),
15 gtk_bin_get_child (GTK_BIN (scrolled_window)));

Unless policy is GTK_POLICY_NEVER or GTK_POLICY_EXTERNAL, GtkScrolledWindow adds internal gtk.Scrollbar widgets around its child. The scroll position of the child, and if applicable the scrollbars, is controlled by the hadjustment and vadjustment that are associated with the GtkScrolledWindow. See the docs on gtk.Scrollbar for the details, but note that the “step_increment” and “page_increment” fields are only effective if the policy causes scrollbars to be present.

If a GtkScrolledWindow doesn’t behave quite as you would like, or doesn’t have exactly the right layout, it’s very possible to set up your own scrolling with gtk.Scrollbar and for example a gtk.Grid

Touch support

GtkScrolledWindow has built-in support for touch devices. When a touchscreen is used, swiping will move the scrolled window, and will expose 'kinetic' behavior. This can be turned off with the kinetic-scrolling property if it is undesired.

GtkScrolledWindow also displays visual 'overshoot' indication when the content is pulled beyond the end, and this situation can be captured with the edge-overshot signal.

If no mouse device is present, the scrollbars will overlayed as narrow, auto-hiding indicators over the content. If traditional scrollbars are desired although no mouse is present, this behaviour can be turned off with the overlay-scrolling property.

CSS nodes

GtkScrolledWindow has a main CSS node with name scrolledwindow.

It uses subnodes with names overshoot and undershoot to draw the overflow and underflow indications. These nodes get the .left, .right, .top or .bottom style class added depending on where the indication is drawn.

GtkScrolledWindow also sets the positional style classes (.left, .right, .top, .bottom) and style classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering) on its scrollbars.

If both scrollbars are visible, the area where they meet is drawn with a subnode named junction.

class ScrolledWindow : Bin {}

Constructors

this
this(GtkScrolledWindow* gtkScrolledWindow, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

this
this()
this
this(Widget widget)
this
this(PolicyType hPolicy, PolicyType vPolicy)

Creates a new Scrolled window and set the policy type

this
this(Adjustment hadjustment, Adjustment vadjustment)

Creates a new scrolled window.

Members

Functions

addOnEdgeOvershot
gulong addOnEdgeOvershot(void delegate(GtkPositionType, ScrolledWindow) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::edge-overshot signal is emitted whenever user initiated scrolling makes the scrolledwindow firmly surpass (ie. with some edge resistance) the lower or upper limits defined by the adjustment in that orientation.

addOnEdgeReached
gulong addOnEdgeReached(void delegate(GtkPositionType, ScrolledWindow) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::edge-reached signal is emitted whenever user-initiated scrolling makes the scrolledwindow exactly reaches the lower or upper limits defined by the adjustment in that orientation.

addOnMoveFocusOut
gulong addOnMoveFocusOut(void delegate(GtkDirectionType, ScrolledWindow) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::move-focus-out signal is a [keybinding signal]GtkBindingSignal which gets emitted when focus is moved away from the scrolled window by a keybinding. The move-focus signal is emitted with direction_type on this scrolled windows toplevel parent in the container hierarchy. The default bindings for this signal are Tab + Ctrl and Tab + Ctrl + Shift.

addOnScrollChild
gulong addOnScrollChild(bool delegate(GtkScrollType, bool, ScrolledWindow) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::scroll-child signal is a [keybinding signal]GtkBindingSignal which gets emitted when a keybinding that scrolls is pressed. The horizontal or vertical adjustment is updated which triggers a signal that the scrolled windows child may listen to and scroll itself.

addWithViewport
void addWithViewport(Widget child)

Used to add children without native scrolling capabilities. This is simply a convenience function; it is equivalent to adding the unscrollable child to a viewport, then adding the viewport to the scrolled window. If a child has native scrolling, use Container.add instead of this function.

getCaptureButtonPress
bool getCaptureButtonPress()

Return whether button presses are captured during kinetic scrolling. See ScrolledWindow.setCaptureButtonPress.

getHadjustment
Adjustment getHadjustment()

Returns the horizontal scrollbar’s adjustment, used to connect the horizontal scrollbar to the child widget’s horizontal scroll functionality.

getHscrollbar
Widget getHscrollbar()

Returns the horizontal scrollbar of scrolled_window.

getKineticScrolling
bool getKineticScrolling()

Returns the specified kinetic scrolling behavior.

getMaxContentHeight
int getMaxContentHeight()

Returns the maximum content height set.

getMaxContentWidth
int getMaxContentWidth()

Returns the maximum content width set.

getMinContentHeight
int getMinContentHeight()

Gets the minimal content height of scrolled_window, or -1 if not set.

getMinContentWidth
int getMinContentWidth()

Gets the minimum content width of scrolled_window, or -1 if not set.

getOverlayScrolling
bool getOverlayScrolling()

Returns whether overlay scrolling is enabled for this scrolled window.

getPlacement
GtkCornerType getPlacement()

Gets the placement of the contents with respect to the scrollbars for the scrolled window. See ScrolledWindow.setPlacement.

getPolicy
void getPolicy(out GtkPolicyType hscrollbarPolicy, out GtkPolicyType vscrollbarPolicy)

Retrieves the current policy values for the horizontal and vertical scrollbars. See ScrolledWindow.setPolicy.

getPropagateNaturalHeight
bool getPropagateNaturalHeight()

Reports whether the natural height of the child will be calculated and propagated through the scrolled windows requested natural height.

getPropagateNaturalWidth
bool getPropagateNaturalWidth()

Reports whether the natural width of the child will be calculated and propagated through the scrolled windows requested natural width.

getScrolledWindowStruct
GtkScrolledWindow* getScrolledWindowStruct(bool transferOwnership = false)

Get the main Gtk struct

getShadowType
GtkShadowType getShadowType()

Gets the shadow type of the scrolled window. See ScrolledWindow.setShadowType.

getStruct
void* getStruct()

the main Gtk struct as a void*

getVadjustment
Adjustment getVadjustment()

Returns the vertical scrollbar’s adjustment, used to connect the vertical scrollbar to the child widget’s vertical scroll functionality.

getVscrollbar
Widget getVscrollbar()

Returns the vertical scrollbar of scrolled_window.

setCaptureButtonPress
void setCaptureButtonPress(bool captureButtonPress)

Changes the behaviour of scrolled_window with regard to the initial event that possibly starts kinetic scrolling. When capture_button_press is set to TRUE, the event is captured by the scrolled window, and then later replayed if it is meant to go to the child widget.

setHadjustment
void setHadjustment(Adjustment hadjustment)

Sets the gtk.Adjustment for the horizontal scrollbar.

setKineticScrolling
void setKineticScrolling(bool kineticScrolling)

Turns kinetic scrolling on or off. Kinetic scrolling only applies to devices with source GDK_SOURCE_TOUCHSCREEN.

setMaxContentHeight
void setMaxContentHeight(int height)

Sets the maximum height that scrolled_window should keep visible. The scrolled_window will grow up to this height before it starts scrolling the content.

setMaxContentWidth
void setMaxContentWidth(int width)

Sets the maximum width that scrolled_window should keep visible. The scrolled_window will grow up to this width before it starts scrolling the content.

setMinContentHeight
void setMinContentHeight(int height)

Sets the minimum height that scrolled_window should keep visible. Note that this can and (usually will) be smaller than the minimum size of the content.

setMinContentWidth
void setMinContentWidth(int width)

Sets the minimum width that scrolled_window should keep visible. Note that this can and (usually will) be smaller than the minimum size of the content.

setOverlayScrolling
void setOverlayScrolling(bool overlayScrolling)

Enables or disables overlay scrolling for this scrolled window.

setPlacement
void setPlacement(GtkCornerType windowPlacement)

Sets the placement of the contents with respect to the scrollbars for the scrolled window.

setPolicy
void setPolicy(GtkPolicyType hscrollbarPolicy, GtkPolicyType vscrollbarPolicy)

Sets the scrollbar policy for the horizontal and vertical scrollbars.

setPropagateNaturalHeight
void setPropagateNaturalHeight(bool propagate)

Sets whether the natural height of the child should be calculated and propagated through the scrolled windows requested natural height.

setPropagateNaturalWidth
void setPropagateNaturalWidth(bool propagate)

Sets whether the natural width of the child should be calculated and propagated through the scrolled windows requested natural width.

setShadowType
void setShadowType(GtkShadowType type)

Changes the type of shadow drawn around the contents of scrolled_window.

setVadjustment
void setVadjustment(Adjustment vadjustment)

Sets the gtk.Adjustment for the vertical scrollbar.

unsetPlacement
void unsetPlacement()

Unsets the placement of the contents with respect to the scrollbars for the scrolled window. If no window placement is set for a scrolled window, it defaults to GTK_CORNER_TOP_LEFT.

Static functions

getType
GType getType()

Variables

gtkScrolledWindow
GtkScrolledWindow* gtkScrolledWindow;

the main Gtk struct

Inherited Members

From Bin

gtkBin
GtkBin* gtkBin;

the main Gtk struct

getBinStruct
GtkBin* getBinStruct(bool transferOwnership = false)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
getChild
Widget getChild()

Gets the child of the gtk.Bin, or NULL if the bin contains no child widget. The returned widget does not have a reference added, so you do not need to unref it.

Meta