ScrolledWindow

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_scrolled_window_get_type ()" ) ]
public sealed class ScrolledWindow : Widget, Accessible, Buildable, ConstraintTarget

`GtkScrolledWindow` is a container that makes its child scrollable.

It does so 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 [iface@Gtk.Scrollable] interface, are added directly. For other types of widget, the class [class@Gtk.Viewport] acts as an adaptor, giving scrollability to other widgets. [method@Gtk.ScrolledWindow.set_child] intelligently accounts for whether or not the added child is a `GtkScrollable`. If it isn’t, then it wraps the child in a `GtkViewport`. Therefore, you can just add any child widget and not worry about the details.

If [method@Gtk.ScrolledWindow.set_child] has added a `GtkViewport` for you, it will be automatically removed when you unset the child. Unless [ property@Gtk.ScrolledWindow:hscrollbar-policy] and [property@Gtk.ScrolledWindow:vscrollbar-policy] are gtk_policy_never or gtk_policy_external, `GtkScrolledWindow` adds internal `GtkScrollbar` widgets around its child. The scroll position of the child, and if applicable the scrollbars, is controlled by the [ property@Gtk.ScrolledWindow:hadjustment] and [property@Gtk.ScrolledWindow:vadjustment] that are associated with the `GtkScrolledWindow`. See the docs on [class@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 `GtkScrollbar` and for example a `GtkGrid`.

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 [property@Gtk.ScrolledWindow: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 [signal@Gtk.ScrolledWindow:GtkScrolledWindow:edge-overshot] signal.

If no mouse device is present, the scrollbars will overlaid 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 [property@Gtk.ScrolledWindow:overlay-scrolling] property.

CSS nodes

`GtkScrolledWindow` has a main CSS node with name scrolledwindow. It gets a .frame style class added when [ property@Gtk.ScrolledWindow:has-frame] is true.

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.

Accessibility

Until GTK 4.10, `GtkScrolledWindow` used the `GTK_ACCESSIBLE_ROLE_GROUP` role.

Starting from GTK 4.12, `GtkScrolledWindow` uses the `GTK_ACCESSIBLE_ROLE_GENERIC` role.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public Widget child { get; set; }
The child widget.
public Adjustment hadjustment { get; set construct; }
public bool has_frame { get; set; }
Whether to draw a frame around the contents.
public PolicyType hscrollbar_policy { get; set; }
When the horizontal scrollbar is displayed.
public bool kinetic_scrolling { get; set; }
Whether kinetic scrolling is enabled or not.
public int max_content_height { get; set; }
The maximum content height of scrolled_window.
public int max_content_width { get; set; }
The maximum content width of scrolled_window.
public int min_content_height { get; set; }
The minimum content height of scrolled_window.
public int min_content_width { get; set; }
The minimum content width of scrolled_window.
public bool overlay_scrolling { get; set; }
Whether overlay scrolling is enabled or not.
public bool propagate_natural_height { get; set; }
Whether the natural height of the child should be calculated and propagated through the scrolled window’s requested natural height.
public bool propagate_natural_width { get; set; }
Whether the natural width of the child should be calculated and propagated through the scrolled window’s requested natural width.
public Adjustment vadjustment { get; set construct; }
public PolicyType vscrollbar_policy { get; set; }
When the vertical scrollbar is displayed.
public CornerType window_placement { get; set; }
Where the contents are located with respect to the scrollbars.

Creation methods:

public ScrolledWindow ()
Creates a new scrolled window.

Methods:

public unowned Widget? get_child ()
Gets the child widget of this.
public unowned Adjustment get_hadjustment ()
Returns the horizontal scrollbar’s adjustment.
public bool get_has_frame ()
Gets whether the scrolled window draws a frame.
public unowned Widget get_hscrollbar ()
Returns the horizontal scrollbar of this.
public bool get_kinetic_scrolling ()
Returns the specified kinetic scrolling behavior.
public int get_max_content_height ()
Returns the maximum content height set.
public int get_max_content_width ()
Returns the maximum content width set.
public int get_min_content_height ()
Gets the minimal content height of this.
public int get_min_content_width ()
Gets the minimum content width of this.
public bool get_overlay_scrolling ()
Returns whether overlay scrolling is enabled for this scrolled window.
public CornerType get_placement ()
Gets the placement of the contents with respect to the scrollbars.
public void get_policy (out PolicyType hscrollbar_policy, out PolicyType vscrollbar_policy)
Retrieves the current policy values for the horizontal and vertical scrollbars.
public bool get_propagate_natural_height ()
Reports whether the natural height of the child will be calculated and propagated through the scrolled window’s requested natural height.
public bool get_propagate_natural_width ()
Reports whether the natural width of the child will be calculated and propagated through the scrolled window’s requested natural width.
public unowned Adjustment get_vadjustment ()
Returns the vertical scrollbar’s adjustment.
public unowned Widget get_vscrollbar ()
Returns the vertical scrollbar of this.
public void set_child (Widget? child)
Sets the child widget of this.
public void set_hadjustment (Adjustment? hadjustment)
Sets the `GtkAdjustment` for the horizontal scrollbar.
public void set_has_frame (bool has_frame)
Changes the frame drawn around the contents of this.
public void set_kinetic_scrolling (bool kinetic_scrolling)
Turns kinetic scrolling on or off.
public void set_max_content_height (int height)
Sets the maximum height that this should keep visible.
public void set_max_content_width (int width)
Sets the maximum width that this should keep visible.
public void set_min_content_height (int height)
Sets the minimum height that this should keep visible.
public void set_min_content_width (int width)
Sets the minimum width that this should keep visible.
public void set_overlay_scrolling (bool overlay_scrolling)
Enables or disables overlay scrolling for this scrolled window.
public void set_placement (CornerType window_placement)
Sets the placement of the contents with respect to the scrollbars for the scrolled window.
public void set_policy (PolicyType hscrollbar_policy, PolicyType vscrollbar_policy)
Sets the scrollbar policy for the horizontal and vertical scrollbars.
public void set_propagate_natural_height (bool propagate)
Sets whether the natural height of the child should be calculated and propagated through the scrolled window’s requested natural height.
public void set_propagate_natural_width (bool propagate)
Sets whether the natural width of the child should be calculated and propagated through the scrolled window’s requested natural width.
public void set_vadjustment (Adjustment? vadjustment)
Sets the `GtkAdjustment` for the vertical scrollbar.
public void unset_placement ()
Unsets the placement of the contents with respect to the scrollbars.

Signals:

public signal void edge_overshot (PositionType pos)
Emitted whenever user initiated scrolling makes the scrolled window firmly surpass the limits defined by the adjustment in that orientation.
public signal void edge_reached (PositionType pos)
Emitted whenever user-initiated scrolling makes the scrolled window exactly reach the lower or upper limits defined by the adjustment in that orientation.
public signal void move_focus_out (DirectionType direction_type)
Emitted when focus is moved away from the scrolled window by a keybinding.
public signal bool scroll_child (ScrollType scroll, bool horizontal)
Emitted when a keybinding that scrolls is pressed.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable