Class

GtkScrolledWindow

Description [src]

class Gtk.ScrolledWindow : Gtk.Bin {
  container: GtkBin,
  priv: GtkScrolledWindowPrivate*
}

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 GtkViewport acts as an adaptor, giving scrollability to other widgets. GtkScrolledWindow’s implementation of gtk_container_add() intelligently accounts for whether or not the added child is a GtkScrollable. If it isn’t, GtkScrolledWindow wraps the child in a GtkViewport and adds that for you. Therefore, you can just add any child widget and not worry about the details.

If gtk_container_add() has added a GtkViewport for you, you can remove both your added child widget from the GtkViewport, and the GtkViewport from the GtkScrolledWindow, like this:

GtkWidget *scrolled_window = gtk_scrolled_window_new (NULL, NULL);
GtkWidget *child_widget = gtk_button_new ();

// GtkButton is not a GtkScrollable, so GtkScrolledWindow will automatically
// add a GtkViewport.
gtk_container_add (GTK_CONTAINER (scrolled_window),
                   child_widget);

// Either of these will result in child_widget being unparented:
gtk_container_remove (GTK_CONTAINER (scrolled_window),
                      child_widget);
// or
gtk_container_remove (GTK_CONTAINER (scrolled_window),
                      gtk_bin_get_child (GTK_BIN (scrolled_window)));

Unless GtkScrolledWindow:policy is 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 GtkScrolledWindow:hadjustment and GtkScrolledWindow:vadjustment that are associated with the GtkScrolledWindow. See the docs on GtkScrollbar 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 GtkScrolledWindow: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 GtkScrolledWindow::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 GtkScrolledWindow: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.

Hierarchy

hierarchy this GtkScrolledWindow implements_0 AtkImplementorIface this--implements_0 implements_1 GtkBuildable this--implements_1 ancestor_0 GtkBin ancestor_0--this ancestor_1 GtkContainer ancestor_1--ancestor_0 ancestor_2 GtkWidget ancestor_2--ancestor_1 ancestor_3 GInitiallyUnowned ancestor_3--ancestor_2 ancestor_4 GObject ancestor_4--ancestor_3

Constructors

gtk_scrolled_window_new

Creates a new scrolled window.

Instance methods

gtk_scrolled_window_add_with_viewport

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 gtk_container_add() instead of this function.

Deprecated since: 3.8

gtk_scrolled_window_get_capture_button_press

Return whether button presses are captured during kinetic scrolling. See gtk_scrolled_window_set_capture_button_press().

Available since: 3.4

gtk_scrolled_window_get_hadjustment

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

gtk_scrolled_window_get_hscrollbar

Returns the horizontal scrollbar of scrolled_window.

Available since: 2.8

gtk_scrolled_window_get_kinetic_scrolling

Returns the specified kinetic scrolling behavior.

Available since: 3.4

gtk_scrolled_window_get_max_content_height

Returns the maximum content height set.

Available since: 3.22

gtk_scrolled_window_get_max_content_width

Returns the maximum content width set.

Available since: 3.22

gtk_scrolled_window_get_min_content_height

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

Available since: 3.0

gtk_scrolled_window_get_min_content_width

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

Available since: 3.0

gtk_scrolled_window_get_overlay_scrolling

Returns whether overlay scrolling is enabled for this scrolled window.

Available since: 3.16

gtk_scrolled_window_get_placement

Gets the placement of the contents with respect to the scrollbars for the scrolled window. See gtk_scrolled_window_set_placement().

gtk_scrolled_window_get_policy

Retrieves the current policy values for the horizontal and vertical scrollbars. See gtk_scrolled_window_set_policy().

gtk_scrolled_window_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.

Available since: 3.22

gtk_scrolled_window_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.

Available since: 3.22

gtk_scrolled_window_get_shadow_type

Gets the shadow type of the scrolled window. See gtk_scrolled_window_set_shadow_type().

gtk_scrolled_window_get_vadjustment

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

gtk_scrolled_window_get_vscrollbar

Returns the vertical scrollbar of scrolled_window.

Available since: 2.8

gtk_scrolled_window_set_capture_button_press

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.

Available since: 3.4

gtk_scrolled_window_set_hadjustment

Sets the GtkAdjustment for the horizontal scrollbar.

gtk_scrolled_window_set_kinetic_scrolling

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

Available since: 3.4

gtk_scrolled_window_set_max_content_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.

Available since: 3.22

gtk_scrolled_window_set_max_content_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.

Available since: 3.22

gtk_scrolled_window_set_min_content_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.

Available since: 3.0

gtk_scrolled_window_set_min_content_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.

Available since: 3.0

gtk_scrolled_window_set_overlay_scrolling

Enables or disables overlay scrolling for this scrolled window.

Available since: 3.16

gtk_scrolled_window_set_placement

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

gtk_scrolled_window_set_policy

Sets the scrollbar policy for the horizontal and vertical scrollbars.

gtk_scrolled_window_set_propagate_natural_height

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

Available since: 3.22

gtk_scrolled_window_set_propagate_natural_width

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

Available since: 3.22

gtk_scrolled_window_set_shadow_type

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

gtk_scrolled_window_set_vadjustment

Sets the GtkAdjustment for the vertical scrollbar.

gtk_scrolled_window_unset_placement

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.

Available since: 2.10

Methods inherited from GtkBin (1)
gtk_bin_get_child

Gets the child of the GtkBin, 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.

Methods inherited from GtkContainer (33)
gtk_container_add

Adds widget to container. Typically used for simple containers such as GtkWindow, GtkFrame, or GtkButton; for more complicated layout containers such as GtkBox or GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk_box_pack_start() and gtk_grid_attach() as an alternative to gtk_container_add() in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.

gtk_container_add_with_properties

Adds widget to container, setting child properties at the same time. See gtk_container_add() and gtk_container_child_set() for more details.

gtk_container_check_resize
No description available.
gtk_container_child_get

Gets the values of one or more child properties for child and container.

gtk_container_child_get_property

Gets the value of a child property for child and container.

gtk_container_child_get_valist

Gets the values of one or more child properties for child and container.

gtk_container_child_notify

Emits a GtkWidget::child-notify signal for the [child property][child-properties] child_property on the child.

Available since: 3.2

gtk_container_child_notify_by_pspec

Emits a GtkWidget::child-notify signal for the [child property][child-properties] specified by pspec on the child.

Available since: 3.18

gtk_container_child_set

Sets one or more child properties for child and container.

gtk_container_child_set_property

Sets a child property for child and container.

gtk_container_child_set_valist

Sets one or more child properties for child and container.

gtk_container_child_type

Returns the type of the children supported by the container.

gtk_container_forall

Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.

gtk_container_foreach

Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.

gtk_container_get_border_width

Retrieves the border width of the container. See gtk_container_set_border_width().

gtk_container_get_children

Returns the container’s non-internal children. See gtk_container_forall() for details on what constitutes an “internal” child.

gtk_container_get_focus_chain

Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores NULL in focusable_widgets and returns FALSE.

Deprecated since: 3.24

gtk_container_get_focus_child

Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk_window_get_focus().

Available since: 2.14

gtk_container_get_focus_hadjustment

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().

gtk_container_get_focus_vadjustment

Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().

gtk_container_get_path_for_child

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.

gtk_container_get_resize_mode

Returns the resize mode for the container. See gtk_container_set_resize_mode ().

Deprecated since: 3.12

gtk_container_propagate_draw

When a container receives a call to the draw function, it must send synthetic GtkWidget::draw calls to all children that don’t have their own GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its GtkWidget::draw function, calls gtk_container_propagate_draw() once for each child, passing in the cr the container received.

Methods inherited from GtkWidget (263)
gtk_widget_activate

For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. Activation is what happens when you press Enter on a widget during key navigation. If widget isn’t activatable, the function returns FALSE.

gtk_widget_add_accelerator

Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. The accel_group needs to be added to the widget’s toplevel via gtk_window_add_accel_group(), and the signal must be of type G_SIGNAL_ACTION. Accelerators added through this function are not user changeable during runtime. If you want to support accelerators that can be changed by the user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or gtk_menu_item_set_accel_path() instead.

gtk_widget_add_device_events

Adds the device events in the bitfield events to the event mask for widget. See gtk_widget_set_device_events() for details.

Available since: 3.0

gtk_widget_add_events

Adds the events in the bitfield events to the event mask for widget. See gtk_widget_set_events() and the [input handling overview][event-masks] for details.

gtk_widget_add_mnemonic_label

Adds a widget to the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well, by using a connection to the GtkWidget::destroy signal or a weak notifier.

Available since: 2.4

gtk_widget_add_tick_callback

Queues an animation frame update and adds a callback to be called before each frame. Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames. The tick callback does not automatically imply a relayout or repaint. If you want a repaint or relayout, and aren’t changing widget properties that would trigger that (for example, changing the text of a GtkLabel), then you will have to call gtk_widget_queue_resize() or gtk_widget_queue_draw_area() yourself.

Available since: 3.8

gtk_widget_can_activate_accel

Determines whether an accelerator that activates the signal identified by signal_id can currently be activated. This is done by emitting the GtkWidget::can-activate-accel signal on widget; if the signal isn’t overridden by a handler or in a derived widget, then the default check is that the widget must be sensitive, and the widget and all its ancestors mapped.

Available since: 2.4

gtk_widget_child_focus

This function is used by custom widget implementations; if you’re writing an app, you’d use gtk_widget_grab_focus() to move the focus to a particular widget, and gtk_container_set_focus_chain() to change the focus tab order. So you may want to investigate those functions instead.

gtk_widget_child_notify

Emits a GtkWidget::child-notify signal for the [child property][child-properties] child_property on widget.

gtk_widget_class_path

Same as gtk_widget_path(), but always uses the name of a widget’s type, never uses a custom name set with gtk_widget_set_name().

Deprecated since: 3.0

gtk_widget_compute_expand

Computes whether a container should give this widget extra space when possible. Containers should check this, rather than looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand().

gtk_widget_create_pango_context

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget. See also gtk_widget_get_pango_context().

gtk_widget_create_pango_layout

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

gtk_widget_destroy

Destroys a widget.

gtk_widget_destroyed

This function sets *widget_pointer to NULL if widget_pointer != NULL. It’s intended to be used as a callback connected to the “destroy” signal of a widget. You connect gtk_widget_destroyed() as a signal handler, and pass the address of your widget variable as user data. Then when the widget is destroyed, the variable will be set to NULL. Useful for example to avoid multiple copies of the same dialog.

gtk_widget_device_is_shadowed

Returns TRUE if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. This may be used in the GtkWidget::grab-notify signal to check for specific devices. See gtk_device_grab_add().

Available since: 3.0

gtk_drag_begin

This function is equivalent to gtk_drag_begin_with_coordinates(), passing -1, -1 as coordinates.

Deprecated since: 3.10

gtk_drag_begin_with_coordinates

Initiates a drag on the source side. The function only needs to be used when the application is starting drags itself, and is not needed when gtk_drag_source_set() is used.

Available since: 3.10

gtk_drag_check_threshold

Checks to see if a mouse drag starting at (start_x, start_y) and ending at (current_x, current_y) has passed the GTK+ drag threshold, and thus should trigger the beginning of a drag-and-drop operation.

gtk_drag_dest_add_image_targets

Add the image targets supported by GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk_target_list_add_image_targets() and gtk_drag_dest_set_target_list().

Available since: 2.6

gtk_drag_dest_add_text_targets

Add the text targets supported by GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk_target_list_add_text_targets() and gtk_drag_dest_set_target_list().

Available since: 2.6

gtk_drag_dest_add_uri_targets

Add the URI targets supported by GtkSelectionData to the target list of the drag destination. The targets are added with info = 0. If you need another value, use gtk_target_list_add_uri_targets() and gtk_drag_dest_set_target_list().

Available since: 2.6

gtk_drag_dest_find_target

Looks for a match between the supported targets of context and the dest_target_list, returning the first matching target, otherwise returning GDK_NONE. dest_target_list should usually be the return value from gtk_drag_dest_get_target_list(), but some widgets may have different valid targets for different parts of the widget; in that case, they will have to implement a drag_motion handler that passes the correct target list to this function.

Methods inherited from GObject (42)
Methods inherited from GtkBuildable (10)
gtk_buildable_add_child

Adds a child to buildable. type is an optional string describing how the child should be added.

Available since: 2.12

gtk_buildable_construct_child

Constructs a child of buildable with the name name.

Available since: 2.12

gtk_buildable_custom_finished

This is similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable.

Available since: 2.12

gtk_buildable_custom_tag_end

This is called at the end of each custom element handled by the buildable.

Available since: 2.12

gtk_buildable_custom_tag_start

This is called for each unknown element under <child>.

Available since: 2.12

gtk_buildable_get_internal_child

Get the internal child called childname of the buildable object.

Available since: 2.12

gtk_buildable_get_name

Gets the name of the buildable object.

Available since: 2.12

gtk_buildable_parser_finished

Called when the builder finishes the parsing of a [GtkBuilder UI definition][BUILDER-UI]. Note that this will be called once for each time gtk_builder_add_from_file() or gtk_builder_add_from_string() is called on a builder.

Available since: 2.12

gtk_buildable_set_buildable_property

Sets the property name name to value on the buildable object.

Available since: 2.12

gtk_buildable_set_name

Sets the name of the buildable object.

Available since: 2.12

Properties

Gtk.ScrolledWindow:hadjustment
No description available.
Gtk.ScrolledWindow:hscrollbar-policy
No description available.
Gtk.ScrolledWindow:kinetic-scrolling

Whether kinetic scrolling is enabled or not. Kinetic scrolling only applies to devices with source GDK_SOURCE_TOUCHSCREEN.

Available since: 3.4

Gtk.ScrolledWindow:max-content-height

The maximum content height of scrolled_window, or -1 if not set.

Available since: 3.22

Gtk.ScrolledWindow:max-content-width

The maximum content width of scrolled_window, or -1 if not set.

Available since: 3.22

Gtk.ScrolledWindow:min-content-height

The minimum content height of scrolled_window, or -1 if not set.

Available since: 3.0

Gtk.ScrolledWindow:min-content-width

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

Available since: 3.0

Gtk.ScrolledWindow:overlay-scrolling

Whether overlay scrolling is enabled or not. If it is, the scrollbars are only added as traditional widgets when a mouse is present. Otherwise, they are overlayed on top of the content, as narrow indicators.

Available since: 3.16

Gtk.ScrolledWindow:propagate-natural-height

Whether the natural height of the child should be calculated and propagated through the scrolled window’s requested natural height.

Available since: 3.22

Gtk.ScrolledWindow:propagate-natural-width

Whether the natural width of the child should be calculated and propagated through the scrolled window’s requested natural width.

Available since: 3.22

Gtk.ScrolledWindow:shadow-type
No description available.
Gtk.ScrolledWindow:vadjustment
No description available.
Gtk.ScrolledWindow:vscrollbar-policy
No description available.
Gtk.ScrolledWindow:window-placement
No description available.
Gtk.ScrolledWindow:window-placement-set

Whether “window-placement” should be used to determine the location of the contents with respect to the scrollbars.

Available since: 2.10

Deprecated since: 3.10

Properties inherited from GtkContainer (3)
Gtk.Container:border-width
No description available.
Gtk.Container:child
No description available.
Gtk.Container:resize-mode
No description available.
Properties inherited from GtkWidget (39)
Gtk.Widget:app-paintable
No description available.
Gtk.Widget:can-default
No description available.
Gtk.Widget:can-focus
No description available.
Gtk.Widget:composite-child
No description available.
Gtk.Widget:double-buffered

Whether the widget is double buffered.

Available since: 2.18

Deprecated since: 3.14

Gtk.Widget:events
No description available.
Gtk.Widget:expand

Whether to expand in both directions. Setting this sets both GtkWidget:hexpand and GtkWidget:vexpand.

Available since: 3.0

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Available since: 3.20

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space, see GtkAlign.

Available since: 3.0

Gtk.Widget:has-default
No description available.
Gtk.Widget:has-focus
No description available.
Gtk.Widget:has-tooltip

Enables or disables the emission of GtkWidget::query-tooltip on widget. A value of TRUE indicates that widget can have a tooltip, in this case the widget will be queried using GtkWidget::query-tooltip to determine whether it will provide a tooltip or not.

Available since: 2.12

Gtk.Widget:height-request
No description available.
Gtk.Widget:hexpand

Whether to expand horizontally. See gtk_widget_set_hexpand().

Available since: 3.0

Gtk.Widget:hexpand-set

Whether to use the GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().

Available since: 3.0

Gtk.Widget:is-focus
No description available.
Gtk.Widget:margin

Sets all four sides’ margin at once. If read, returns max margin on any side.

Available since: 3.0

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Available since: 3.0

Gtk.Widget:margin-end

Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.

Available since: 3.12

Gtk.Widget:margin-left

Margin on left side of widget.

Available since: 3.0

Deprecated since: 3.12

Gtk.Widget:margin-right

Margin on right side of widget.

Available since: 3.0

Deprecated since: 3.12

Gtk.Widget:margin-start

Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.

Available since: 3.12

Gtk.Widget:margin-top

Margin on top side of widget.

Available since: 3.0

Gtk.Widget:name
No description available.
Gtk.Widget:no-show-all
No description available.
Gtk.Widget:opacity

The requested opacity of the widget. See gtk_widget_set_opacity() for more details about window opacity.

Available since: 3.8

Gtk.Widget:parent
No description available.
Gtk.Widget:receives-default
No description available.
Gtk.Widget:scale-factor

The scale factor of the widget. See gtk_widget_get_scale_factor() for more details about widget scaling.

Available since: 3.10

Gtk.Widget:sensitive
No description available.
Gtk.Widget:style

The style of the widget, which contains information about how it will look (colors, etc).

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().

Available since: 2.12

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Available since: 2.12

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space, see GtkAlign.

Available since: 3.0

Gtk.Widget:vexpand

Whether to expand vertically. See gtk_widget_set_vexpand().

Available since: 3.0

Gtk.Widget:vexpand-set

Whether to use the GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().

Available since: 3.0

Gtk.Widget:visible
No description available.
Gtk.Widget:width-request
No description available.
Gtk.Widget:window

The widget’s window if it is realized, NULL otherwise.

Available since: 2.14

Signals

Gtk.ScrolledWindow::edge-overshot

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

Available since: 3.16

Gtk.ScrolledWindow::edge-reached

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

Available since: 3.16

Gtk.ScrolledWindow::move-focus-out

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 GtkWidget::move-focus signal is emitted with direction_type on this scrolled window’s toplevel parent in the container hierarchy. The default bindings for this signal are Ctrl + Tab to move forward and Ctrl + Shift + Tab to move backward.

Gtk.ScrolledWindow::scroll-child

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 window’s child may listen to and scroll itself.

Signals inherited from GtkContainer (4)
Gtk.Container::add
No description available.
Gtk.Container::check-resize
No description available.
Gtk.Container::remove
No description available.
Gtk.Container::set-focus-child
No description available.
Signals inherited from GtkWidget (69)
Gtk.Widget::accel-closures-changed
No description available.
Gtk.Widget::button-press-event

The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.

Gtk.Widget::button-release-event

The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.

Gtk.Widget::can-activate-accel

Determines whether an accelerator that activates the signal identified by signal_id can currently be activated. This signal is present to allow applications and derived widgets to override the default GtkWidget handling for determining whether an accelerator can be activated.

Gtk.Widget::child-notify

The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal’s detail holds the property name.

Gtk.Widget::composited-changed

The ::composited-changed signal is emitted when the composited status of widgets screen changes. See gdk_screen_is_composited().

Deprecated since: 3.22

Gtk.Widget::configure-event

The ::configure-event signal will be emitted when the size, position or stacking of the widgets window has changed.

Gtk.Widget::damage-event

Emitted when a redirected window belonging to widget gets drawn into. The region/area members of the event shows what area of the redirected drawable was drawn into.

Available since: 2.14

Gtk.Widget::delete-event

The ::delete-event signal is emitted if a user requests that a toplevel window is closed. The default handler for this signal destroys the window. Connecting gtk_widget_hide_on_delete() to this signal will cause the window to be hidden instead, so that it can later be shown again without reconstructing it.

Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released.

Gtk.Widget::destroy-event

The ::destroy-event signal is emitted when a GdkWindow is destroyed. You rarely get this signal, because most widgets disconnect themselves from their window before they destroy it, so no widget owns the window at destroy time.

Gtk.Widget::direction-changed

The ::direction-changed signal is emitted when the text direction of a widget changes.

Gtk.Widget::drag-begin

The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().

Gtk.Widget::drag-data-delete

The ::drag-data-delete signal is emitted on the drag source when a drag with the action GDK_ACTION_MOVE is successfully completed. The signal handler is responsible for deleting the data that has been dropped. What “delete” means depends on the context of the drag operation.

Gtk.Widget::drag-data-get

The ::drag-data-get signal is emitted on the drag source when the drop site requests the data which is dragged. It is the responsibility of the signal handler to fill data with the data in the format which is indicated by info. See gtk_selection_data_set() and gtk_selection_data_set_text().

Gtk.Widget::drag-data-received

The ::drag-data-received signal is emitted on the drop site when the dragged data has been received. If the data was received in order to determine whether the drop will be accepted, the handler is expected to call gdk_drag_status() and not finish the drag. If the data was received in response to a GtkWidget::drag-drop signal (and this is the last target to be received), the handler for this signal is expected to process the received data and then call gtk_drag_finish(), setting the success parameter depending on whether the data was processed successfully.

Gtk.Widget::drag-drop

The ::drag-drop signal is emitted on the drop site when the user drops the data onto the widget. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns FALSE and no further processing is necessary. Otherwise, the handler returns TRUE. In this case, the handler must ensure that gtk_drag_finish() is called to let the source know that the drop is done. The call to gtk_drag_finish() can be done either directly or in a GtkWidget::drag-data-received handler which gets triggered by calling gtk_drag_get_data() to receive the data for one or more of the supported targets.

Gtk.Widget::drag-end

The ::drag-end signal is emitted on the drag source when a drag is finished. A typical reason to connect to this signal is to undo things done in GtkWidget::drag-begin.

Gtk.Widget::drag-failed

The ::drag-failed signal is emitted on the drag source when a drag has failed. The signal handler may hook custom code to handle a failed DnD operation based on the type of error, it returns TRUE is the failure has been already handled (not showing the default “drag operation failed” animation), otherwise it returns FALSE.

Available since: 2.12

Gtk.Widget::drag-leave

The ::drag-leave signal is emitted on the drop site when the cursor leaves the widget. A typical reason to connect to this signal is to undo things done in GtkWidget::drag-motion, e.g. undo highlighting with gtk_drag_unhighlight().

Gtk.Widget::drag-motion

The ::drag-motion signal is emitted on the drop site when the user moves the cursor over the widget during a drag. The signal handler must determine whether the cursor position is in a drop zone or not. If it is not in a drop zone, it returns FALSE and no further processing is necessary. Otherwise, the handler returns TRUE. In this case, the handler is responsible for providing the necessary information for displaying feedback to the user, by calling gdk_drag_status().

Gtk.Widget::draw

This signal is emitted when a widget is supposed to render itself. The widgets top left corner must be painted at the origin of the passed in context and be sized to the values returned by gtk_widget_get_allocated_width() and gtk_widget_get_allocated_height().

Available since: 3.0

Gtk.Widget::enter-notify-event

The ::enter-notify-event will be emitted when the pointer enters the widgets window.

Gtk.Widget::event

The GTK+ main loop will emit three signals for each GDK event delivered to a widget: one generic ::event signal, another, more specific, signal that matches the type of event delivered (e.g. GtkWidget::key-press-event) and finally a generic GtkWidget::event-after signal.

Gtk.Widget::event-after

After the emission of the GtkWidget::event signal and (optionally) the second more specific signal, ::event-after will be emitted regardless of the previous two signals handlers return values.

Gtk.Widget::focus
No description available.
Gtk.Widget::focus-in-event

The ::focus-in-event signal will be emitted when the keyboard focus enters the widgets window.

Gtk.Widget::focus-out-event

The ::focus-out-event signal will be emitted when the keyboard focus leaves the widgets window.

Gtk.Widget::grab-broken-event

Emitted when a pointer or keyboard grab on a window belonging to widget gets broken.

Available since: 2.8

Gtk.Widget::grab-focus
No description available.
Gtk.Widget::grab-notify

The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.

Gtk.Widget::hide

The ::hide signal is emitted when widget is hidden, for example with gtk_widget_hide().

Gtk.Widget::hierarchy-changed

The ::hierarchy-changed signal is emitted when the anchored state of a widget changes. A widget is “anchored” when its toplevel ancestor is a GtkWindow. This signal is emitted when a widget changes from un-anchored to anchored or vice-versa.

Gtk.Widget::key-press-event

The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.

Gtk.Widget::key-release-event

The ::key-release-event signal is emitted when a key is released.

Gtk.Widget::keynav-failed

Gets emitted if keyboard navigation fails. See gtk_widget_keynav_failed() for details.

Available since: 2.12

Gtk.Widget::leave-notify-event

The ::leave-notify-event will be emitted when the pointer leaves the widgets window.

Gtk.Widget::map

The ::map signal is emitted when widget is going to be mapped, that is when the widget is visible (which is controlled with gtk_widget_set_visible()) and all its parents up to the toplevel widget are also visible. Once the map has occurred, GtkWidget::map-event will be emitted.

Gtk.Widget::map-event

The ::map-event signal will be emitted when the widgets window is mapped. A window is mapped when it becomes visible on the screen.

Gtk.Widget::mnemonic-activate

The default handler for this signal activates widget if group_cycling is FALSE, or just makes widget grab focus if group_cycling is TRUE.

Gtk.Widget::motion-notify-event

The ::motion-notify-event signal is emitted when the pointer moves over the widget’s GdkWindow.

Gtk.Widget::move-focus
No description available.
Gtk.Widget::parent-set

The ::parent-set signal is emitted when a new parent has been set on a widget.

Gtk.Widget::popup-menu

This signal gets emitted whenever a widget should pop up a context menu. This usually happens through the standard key binding mechanism; by pressing a certain key while a widget is focused, the user can cause the widget to pop up a menu. For example, the GtkEntry widget creates a menu with clipboard commands. See the [Popup Menu Migration Checklist][checklist-popup-menu] for an example of how to use this signal.

Gtk.Widget::property-notify-event

The ::property-notify-event signal will be emitted when a property on the widgets window has been changed or deleted.

Gtk.Widget::proximity-in-event

To receive this signal the GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_IN_MASK mask.

Gtk.Widget::proximity-out-event

To receive this signal the GdkWindow associated to the widget needs to enable the #GDK_PROXIMITY_OUT_MASK mask.

Gtk.Widget::query-tooltip

Emitted when GtkWidget:has-tooltip is TRUE and the hover timeout has expired with the cursor hovering “above” widget; or emitted when widget got focus in keyboard mode.

Available since: 2.12

Gtk.Widget::realize

The ::realize signal is emitted when widget is associated with a GdkWindow, which means that gtk_widget_realize() has been called or the widget has been mapped (that is, it is going to be drawn).

Gtk.Widget::screen-changed

The ::screen-changed signal gets emitted when the screen of a widget has changed.

Gtk.Widget::scroll-event

The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.

Gtk.Widget::selection-clear-event

The ::selection-clear-event signal will be emitted when the the widgets window has lost ownership of a selection.

Gtk.Widget::selection-get
No description available.
Gtk.Widget::selection-notify-event
No description available.
Gtk.Widget::selection-received
No description available.
Gtk.Widget::selection-request-event

The ::selection-request-event signal will be emitted when another client requests ownership of the selection owned by the widgets window.

Gtk.Widget::show

The ::show signal is emitted when widget is shown, for example with gtk_widget_show().

Gtk.Widget::show-help
No description available.
Gtk.Widget::size-allocate
No description available.
Gtk.Widget::state-changed

The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state().

Deprecated since: 3.0

Gtk.Widget::state-flags-changed

The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags().

Available since: 3.0

Gtk.Widget::style-set

The ::style-set signal is emitted when a new style has been set on a widget. Note that style-modifying functions like gtk_widget_modify_base() also cause this signal to be emitted.

Deprecated since: 3.0

Gtk.Widget::style-updated

The ::style-updated signal is a convenience signal that is emitted when the GtkStyleContext::changed signal is emitted on the widgets associated GtkStyleContext as returned by gtk_widget_get_style_context().

Available since: 3.0

Gtk.Widget::touch-event
No description available.
Gtk.Widget::unmap

The ::unmap signal is emitted when widget is going to be unmapped, which means that either it or any of its parents up to the toplevel widget have been set as hidden.

Gtk.Widget::unmap-event

The ::unmap-event signal will be emitted when the widgets window is unmapped. A window is unmapped when it becomes invisible on the screen.

Gtk.Widget::unrealize

The ::unrealize signal is emitted when the GdkWindow associated with widget is destroyed, which means that gtk_widget_unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Gtk.Widget::visibility-notify-event

The ::visibility-notify-event will be emitted when the widgets window is obscured or unobscured.

Deprecated since: 3.12

Gtk.Widget::window-state-event

The ::window-state-event will be emitted when the state of the toplevel window associated to the widget changes.

Signals inherited from GObject (1)

Class structure

struct GtkScrolledWindowClass {
  GtkBinClass parent_class;
  gint scrollbar_spacing;
  gboolean (* scroll_child) (
    GtkScrolledWindow* scrolled_window,
    GtkScrollType scroll,
    gboolean horizontal
  );
  void (* move_focus_out) (
    GtkScrolledWindow* scrolled_window,
    GtkDirectionType direction
  );
  void (* _gtk_reserved1) (
void
  );
  void (* _gtk_reserved2) (
void
  );
  void (* _gtk_reserved3) (
void
  );
  void (* _gtk_reserved4) (
void
  );
  
}
Class members
parent_class
GtkBinClass
 

The parent class.

scrollbar_spacing
gint
  No description available.
scroll_child
gboolean (* scroll_child) (
    GtkScrolledWindow* scrolled_window,
    GtkScrollType scroll,
    gboolean horizontal
  )
  No description available.
move_focus_out
void (* move_focus_out) (
    GtkScrolledWindow* scrolled_window,
    GtkDirectionType direction
  )
  No description available.
_gtk_reserved1
void (* _gtk_reserved1) (
void
  )
  No description available.
_gtk_reserved2
void (* _gtk_reserved2) (
void
  )
  No description available.
_gtk_reserved3
void (* _gtk_reserved3) (
void
  )
  No description available.
_gtk_reserved4
void (* _gtk_reserved4) (
void
  )
  No description available.

Virtual methods

Gtk.ScrolledWindowClass.move_focus_out
No description available.
Gtk.ScrolledWindowClass.scroll_child
No description available.