ScrolledWindow

GtkScrolledWindow is a GtkBin subclass: it's a container the accepts a single child widget. GtkScrolledWindow adds scrollbars to the child widget and optionally draws a beveled frame around the child widget.

The scrolled window can work in two ways. Some widgets have native scrolling support; these widgets implement the GtkScrollable interface. Widgets with native scroll support include GtkTreeView, GtkTextView, and GtkLayout.

For widgets that lack native scrolling support, the GtkViewport widget acts as an adaptor class, implementing scrollability for child widgets that lack their own scrolling capabilities. Use GtkViewport to scroll child widgets such as GtkGrid, GtkBox, and so on.

If a widget has native scrolling abilities, it can be added to the GtkScrolledWindow with gtk_container_add(). If a widget does not, you must first add the widget to a GtkViewport, then add the GtkViewport to the scrolled window. gtk_container_add() will do this for you for widgets that don't implement GtkScrollable natively, so you can ignore the presence of the viewport.

The position of the scrollbars is controlled by the scroll adjustments. See GtkAdjustment for the fields in an adjustment - for GtkScrollbar, used by GtkScrolledWindow, the "value" field represents the position of the scrollbar, which must be between the "lower" field and "upper - page_size." The "page_size" field represents the size of the visible scrollable area. The "step_increment" and "page_increment" fields are used when the user asks to step down (using the small stepper arrows) or page down (using for example the PageDown key).

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.

class ScrolledWindow : Bin {

protected

GtkScrolledWindow* gtkScrolledWindow;

GtkScrolledWindow* getScrolledWindowStruct();

void* getStruct();

this(GtkScrolledWindow* gtkScrolledWindow);

void setStruct(GObject* obj);

this();

this(Widget widget);

this(PolicyType hPolicy, PolicyType vPolicy);

int[string] connectedSignals;

void delegate(GtkDirectionType, ScrolledWindow)[] onMoveFocusOutListeners;

void addOnMoveFocusOut(void delegate(GtkDirectionType, ScrolledWindow) dlg, ConnectFlags connectFlags);

static void callBackMoveFocusOut(GtkScrolledWindow* scrolledWindowStruct, GtkDirectionType directionType, ScrolledWindow _scrolledWindow);

bool delegate(GtkScrollType, gboolean, ScrolledWindow)[] onScrollChildListeners;

void addOnScrollChild(bool delegate(GtkScrollType, gboolean, ScrolledWindow) dlg, ConnectFlags connectFlags);

static gboolean callBackScrollChild(GtkScrolledWindow* scrolledWindowStruct, GtkScrollType scroll, gboolean horizontal, ScrolledWindow _scrolledWindow);

this(Adjustment hadjustment, Adjustment vadjustment);

Adjustment getHadjustment();

Adjustment getVadjustment();

Widget getHscrollbar();

Widget getVscrollbar();

void setPolicy(GtkPolicyType hscrollbarPolicy, GtkPolicyType vscrollbarPolicy);

void addWithViewport(Widget child);

void setPlacement(GtkCornerType windowPlacement);

void unsetPlacement();

void setShadowType(GtkShadowType type);

void setHadjustment(Adjustment hadjustment);

void setVadjustment(Adjustment vadjustment);

GtkCornerType getPlacement();

void getPolicy(GtkPolicyType hscrollbarPolicy, GtkPolicyType vscrollbarPolicy);

GtkShadowType getShadowType();

int getMinContentWidth();

void setMinContentWidth(int width);

int getMinContentHeight();

void setMinContentHeight(int height);

void setKineticScrolling(int kineticScrolling);

int getKineticScrolling();

void setCaptureButtonPress(int captureButtonPress);

int getCaptureButtonPress();

}

Constructors

this this(GtkScrolledWindow* gtkScrolledWindow): 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. The two arguments are the scrolled window's adjustments; these will be shared with the scrollbars and the child widget to keep the bars in sync with the child. Usually you want to pass NULL for the adjustments, which will cause the scrolled window to create them for you.

Members

Functions

addOnMoveFocusOut void addOnMoveFocusOut(void delegate(GtkDirectionType, ScrolledWindow) dlg, ConnectFlags connectFlags): The ::move-focus-out signal is a keybinding signal 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 void addOnScrollChild(bool delegate(GtkScrollType, gboolean, ScrolledWindow) dlg, ConnectFlags connectFlags): The ::scroll-child signal is a keybinding signal 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. See Also GtkScrollable, GtkViewport, GtkAdjustment
addWithViewport void addWithViewport(Widget child): Warning gtk_scrolled_window_add_with_viewport has been deprecated since version 3.8 and should not be used in newly-written code. gtk_container_add() will now automatically add a GtkViewport if the child doesn't implement GtkScrollable. 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. The viewport scrolls the child by moving its GdkWindow, and takes the size of the child to be the size of its toplevel GdkWindow. This will be very wrong for most widgets that support native scrolling; for example, if you add a widget such as GtkTreeView with a viewport, the whole widget will scroll, including the column headings. Thus, widgets with native scrolling support should not be used with the GtkViewport proxy. A widget supports scrolling natively if it implements the GtkScrollable interface.
getCaptureButtonPress int getCaptureButtonPress(): Return whether button presses are captured during kinetic scrolling. See gtk_scrolled_window_set_capture_button_press().
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. Since 2.8
getKineticScrolling int getKineticScrolling(): Returns the specified kinetic scrolling behavior.
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.
getPlacement GtkCornerType getPlacement(): Gets the placement of the contents with respect to the scrollbars for the scrolled window. See gtk_scrolled_window_set_placement().
getPolicy void getPolicy(GtkPolicyType hscrollbarPolicy, GtkPolicyType vscrollbarPolicy): Retrieves the current policy values for the horizontal and vertical scrollbars. See gtk_scrolled_window_set_policy().
getScrolledWindowStruct GtkScrolledWindow* getScrolledWindowStruct(): Get the main Gtk struct
getShadowType GtkShadowType getShadowType(): Gets the shadow type of the scrolled window. See gtk_scrolled_window_set_shadow_type().
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. Since 2.8
setCaptureButtonPress void setCaptureButtonPress(int captureButtonPress): Changes the behaviour of scrolled_window wrt. 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. This should be enabled if any child widgets perform non-reversible actions on "button-press-event". If they don't, and handle additionally handle "grab-broken-event", it might be better to set capture_button_press to FALSE. This setting only has an effect if kinetic scrolling is enabled.
setHadjustment void setHadjustment(Adjustment hadjustment): Sets the GtkAdjustment for the horizontal scrollbar.
setKineticScrolling void setKineticScrolling(int kineticScrolling): Turns kinetic scrolling on or off. Kinetic scrolling only applies to devices with source GDK_SOURCE_TOUCHSCREEN.
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.
setPlacement void setPlacement(GtkCornerType windowPlacement): Sets the placement of the contents with respect to the scrollbars for the scrolled window. The default is GTK_CORNER_TOP_LEFT, meaning the child is in the top left, with the scrollbars underneath and to the right. Other values in GtkCornerType are GTK_CORNER_TOP_RIGHT, GTK_CORNER_BOTTOM_LEFT, and GTK_CORNER_BOTTOM_RIGHT. See also gtk_scrolled_window_get_placement() and gtk_scrolled_window_unset_placement().
setPolicy void setPolicy(GtkPolicyType hscrollbarPolicy, GtkPolicyType vscrollbarPolicy): Sets the scrollbar policy for the horizontal and vertical scrollbars. The policy determines when the scrollbar should appear; it is a value from the GtkPolicyType enumeration. If GTK_POLICY_ALWAYS, the scrollbar is always present; if GTK_POLICY_NEVER, the scrollbar is never present; if GTK_POLICY_AUTOMATIC, the scrollbar is present only if needed (that is, if the slider part of the bar would be smaller than the trough - the display is larger than the page size).
setShadowType void setShadowType(GtkShadowType type): Changes the type of shadow drawn around the contents of scrolled_window.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
setVadjustment void setVadjustment(Adjustment vadjustment): Sets the GtkAdjustment 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. See also gtk_scrolled_window_set_placement() and gtk_scrolled_window_get_placement(). Since 2.10

Static functions

callBackMoveFocusOut void callBackMoveFocusOut(GtkScrolledWindow* scrolledWindowStruct, GtkDirectionType directionType, ScrolledWindow _scrolledWindow): Undocumented in source. Be warned that the author may not have intended to support it.
callBackScrollChild gboolean callBackScrollChild(GtkScrolledWindow* scrolledWindowStruct, GtkScrollType scroll, gboolean horizontal, ScrolledWindow _scrolledWindow): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals int[string] connectedSignals;
gtkScrolledWindow GtkScrolledWindow* gtkScrolledWindow;: the main Gtk struct
onMoveFocusOutListeners void delegate(GtkDirectionType, ScrolledWindow)[] onMoveFocusOutListeners;: Undocumented in source.
onScrollChildListeners bool delegate(GtkScrollType, gboolean, ScrolledWindow)[] onScrollChildListeners;: Undocumented in source.

Inherited Members

From Bin

gtkBin GtkBin* gtkBin;: the main Gtk struct
getBinStruct GtkBin* getBinStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
getChild Widget getChild(): 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.