Skip to main content

Type Alias: GtkScrolledWindowProps

GtkScrolledWindowProps = WidgetProps & object

Defined in: generated/jsx.ts:7907

Props for the GtkScrolledWindow widget.

Type Declaration

NameTypeDescriptionDefined in
child?Gtk.Widget | nullThe child widget. When setting this property, if the child widget does not implement Scrollable, the scrolled window will add the child to a Viewport and then set the viewport as the child.generated/jsx.ts:7915
children?ReactNode-generated/jsx.ts:8023
hadjustment?Gtk.AdjustmentThe GtkAdjustment for the horizontal position.generated/jsx.ts:7917
hasFrame?booleanWhether to draw a frame around the contents.generated/jsx.ts:7919
hscrollbarPolicy?Gtk.PolicyTypeWhen the horizontal scrollbar is displayed. Use ScrolledWindow.set_policy to set this property.generated/jsx.ts:7926
kineticScrolling?booleanWhether kinetic scrolling is enabled or not. Kinetic scrolling only applies to devices with source %GDK_SOURCE_TOUCHSCREEN.generated/jsx.ts:7932
maxContentHeight?numberThe maximum content height of scrolled_window.generated/jsx.ts:7934
maxContentWidth?numberThe maximum content width of scrolled_window.generated/jsx.ts:7936
minContentHeight?numberThe minimum content height of scrolled_window.generated/jsx.ts:7938
minContentWidth?numberThe minimum content width of scrolled_window.generated/jsx.ts:7940
onEdgeOvershot()?(self, pos) => void | nullEmitted whenever user initiated scrolling makes the scrolled window firmly surpass the limits defined by the adjustment in that orientation. A similar behavior without edge resistance is provided by the ScrolledWindow.:edge-reached signal. Note: The pos argument is LTR/RTL aware, so callers should be aware too if intending to provide behavior on horizontal edges.generated/jsx.ts:7990
onEdgeReached()?(self, pos) => void | nullEmitted whenever user-initiated scrolling makes the scrolled window exactly reach the lower or upper limits defined by the adjustment in that orientation. A similar behavior with edge resistance is provided by the ScrolledWindow.:edge-overshot signal. Note: The pos argument is LTR/RTL aware, so callers should be aware too if intending to provide behavior on horizontal edges.generated/jsx.ts:8002
onMoveFocusOut()?(self, directionType) => void | nullEmitted when focus is moved away from the scrolled window by a keybinding. This is a keybinding signal. The default bindings for this signal are Ctrl+Tab to move forward and Ctrl+Shift+`Tab`` to move backward.generated/jsx.ts:8013
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:8029
onScrollChild()?(self, scroll, horizontal) => boolean | nullEmitted when a keybinding that scrolls is pressed. This is a keybinding signal. The horizontal or vertical adjustment is updated which triggers a signal that the scrolled window’s child may listen to and scroll itself.generated/jsx.ts:8022
overlayScrolling?booleanWhether 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 overlaid on top of the content, as narrow indicators. Note that overlay scrolling can also be globally disabled, with the Settings.gtk-overlay-scrolling setting.generated/jsx.ts:7951
propagateNaturalHeight?booleanWhether the natural height of the child should be calculated and propagated through the scrolled window’s requested natural height. This is useful in cases where an attempt should be made to allocate exactly enough space for the natural size of the child.generated/jsx.ts:7959
propagateNaturalWidth?booleanWhether the natural width of the child should be calculated and propagated through the scrolled window’s requested natural width. This is useful in cases where an attempt should be made to allocate exactly enough space for the natural size of the child.generated/jsx.ts:7967
ref?Ref<Gtk.ScrolledWindow>-generated/jsx.ts:8050
vadjustment?Gtk.AdjustmentThe GtkAdjustment for the vertical position.generated/jsx.ts:7969
vscrollbarPolicy?Gtk.PolicyTypeWhen the vertical scrollbar is displayed. Use ScrolledWindow.set_policy to set this property.generated/jsx.ts:7976
windowPlacement?Gtk.CornerTypeWhere the contents are located with respect to the scrollbars.generated/jsx.ts:7978