Interface: ScrolledWindowProps

Defined in: react/src/generated/jsx.ts:4713

Props for the ScrolledWindow widget.

Extends

• WidgetProps

Properties

canFocus?

optional canFocus: boolean

Defined in: react/src/generated/jsx.ts:412

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Inherited from

WidgetProps.canFocus

---

canTarget?

optional canTarget: boolean

Defined in: react/src/generated/jsx.ts:414

Whether the widget can receive pointer events.

Inherited from

WidgetProps.canTarget

---

children?

optional children: ReactNode

Defined in: react/src/generated/jsx.ts:688

Inherited from

WidgetProps.children

---

cssClasses?

optional cssClasses: string[]

Defined in: react/src/generated/jsx.ts:416

A list of css classes applied to this widget.

Inherited from

WidgetProps.cssClasses

---

cssName?

optional cssName: string

Defined in: react/src/generated/jsx.ts:423

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Inherited from

WidgetProps.cssName

---

cursor?

optional cursor: number

Defined in: react/src/generated/jsx.ts:425

The cursor used by @widget.

Inherited from

WidgetProps.cursor

---

focusable?

optional focusable: boolean

Defined in: react/src/generated/jsx.ts:433

Whether this widget itself will accept the input focus.

Inherited from

WidgetProps.focusable

---

focusOnClick?

optional focusOnClick: boolean

Defined in: react/src/generated/jsx.ts:431

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

This property is only relevant for widgets that can take focus.

Inherited from

WidgetProps.focusOnClick

---

hadjustment?

optional hadjustment: Adjustment

Defined in: react/src/generated/jsx.ts:4715

The GtkAdjustment for the horizontal position.

---

halign?

optional halign: Align

Defined in: react/src/generated/jsx.ts:435

How to distribute horizontal space if widget gets extra space.

Inherited from

WidgetProps.halign

---

hasDefault?

optional hasDefault: boolean

Defined in: react/src/generated/jsx.ts:437

Whether the widget is the default widget.

Inherited from

WidgetProps.hasDefault

---

hasFocus?

optional hasFocus: boolean

Defined in: react/src/generated/jsx.ts:439

Whether the widget has the input focus.

Inherited from

WidgetProps.hasFocus

---

hasFrame?

optional hasFrame: boolean

Defined in: react/src/generated/jsx.ts:4717

Whether to draw a frame around the contents.

---

hasTooltip?

optional hasTooltip: boolean

Defined in: react/src/generated/jsx.ts:448

Enables or disables the emission of the [signal@Gtk.Widget::query-tooltip] signal on @widget.

A true value indicates that widget can have a tooltip, in this case the widget will be queried using [signal@Gtk.Widget::query-tooltip] to determine whether it will provide a tooltip or not.

Inherited from

WidgetProps.hasTooltip

---

heightRequest?

optional heightRequest: number

Defined in: react/src/generated/jsx.ts:454

Overrides for height request of the widget.

If this is -1, the natural request will be used.

Inherited from

WidgetProps.heightRequest

---

hexpand?

optional hexpand: boolean

Defined in: react/src/generated/jsx.ts:456

Whether to expand horizontally.

Inherited from

WidgetProps.hexpand

---

hexpandSet?

optional hexpandSet: boolean

Defined in: react/src/generated/jsx.ts:458

Whether to use the hexpand property.

Inherited from

WidgetProps.hexpandSet

---

hscrollbarPolicy?

optional hscrollbarPolicy: PolicyType

Defined in: react/src/generated/jsx.ts:4724

When the horizontal scrollbar is displayed.

Use [method@Gtk.ScrolledWindow.set_policy] to set this property.

---

kineticScrolling?

optional kineticScrolling: boolean

Defined in: react/src/generated/jsx.ts:4730

Whether kinetic scrolling is enabled or not.

Kinetic scrolling only applies to devices with source %GDK_SOURCE_TOUCHSCREEN.

---

layoutManager?

optional layoutManager: LayoutManager

Defined in: react/src/generated/jsx.ts:466

The [class@Gtk.LayoutManager] instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Inherited from

WidgetProps.layoutManager

---

limitEvents?

optional limitEvents: boolean

Defined in: react/src/generated/jsx.ts:475

Makes this widget act like a modal dialog, with respect to event delivery.

Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See [method@Gtk.EventController.set_propagation_limit].

Inherited from

WidgetProps.limitEvents

---

marginBottom?

optional marginBottom: number

Defined in: react/src/generated/jsx.ts:483

Margin on bottom side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [method@Gtk.Widget.set_size_request] for example.

Inherited from

WidgetProps.marginBottom

---

marginEnd?

optional marginEnd: number

Defined in: react/src/generated/jsx.ts:494

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [method@Gtk.Widget.set_size_request] for example.

Inherited from

WidgetProps.marginEnd

---

marginStart?

optional marginStart: number

Defined in: react/src/generated/jsx.ts:505

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [method@Gtk.Widget.set_size_request] for example.

Inherited from

WidgetProps.marginStart

---

marginTop?

optional marginTop: number

Defined in: react/src/generated/jsx.ts:513

Margin on top side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [method@Gtk.Widget.set_size_request] for example.

Inherited from

WidgetProps.marginTop

---

maxContentHeight?

optional maxContentHeight: number

Defined in: react/src/generated/jsx.ts:4732

The maximum content height of @scrolled_window.

---

maxContentWidth?

optional maxContentWidth: number

Defined in: react/src/generated/jsx.ts:4734

The maximum content width of @scrolled_window.

---

minContentHeight?

optional minContentHeight: number

Defined in: react/src/generated/jsx.ts:4736

The minimum content height of @scrolled_window.

---

minContentWidth?

optional minContentWidth: number

Defined in: react/src/generated/jsx.ts:4738

The minimum content width of @scrolled_window.

---

name?

optional name: string

Defined in: react/src/generated/jsx.ts:515

The name of the widget.

Inherited from

WidgetProps.name

---

onDestroy()?

optional onDestroy: (self) => void

Defined in: react/src/generated/jsx.ts:593

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.

This signal is not suitable for saving widget state.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onDestroy

---

onDirectionChanged()?

optional onDirectionChanged: (self, previousDirection) => void

Defined in: react/src/generated/jsx.ts:595

Emitted when the text direction of a widget changes.

Parameters

Parameter	Type
self	Widget
previousDirection	TextDirection

Returns

void

Inherited from

WidgetProps.onDirectionChanged

---

onEdgeOvershot()?

optional onEdgeOvershot: (self, pos) => void

Defined in: react/src/generated/jsx.ts:4789

Emitted 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 [signal@Gtk.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.

Parameters

Parameter	Type
self	ScrolledWindow
pos	PositionType

Returns

void

---

onEdgeReached()?

optional onEdgeReached: (self, pos) => void

Defined in: react/src/generated/jsx.ts:4801

Emitted 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 [signal@Gtk.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.

Parameters

Parameter	Type
self	ScrolledWindow
pos	PositionType

Returns

void

---

onHide()?

optional onHide: (self) => void

Defined in: react/src/generated/jsx.ts:600

Emitted when widget is hidden.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onHide

---

onKeynavFailed()?

optional onKeynavFailed: (self, direction) => boolean

Defined in: react/src/generated/jsx.ts:606

Emitted if keyboard navigation fails.

See [method@Gtk.Widget.keynav_failed] for details.

Parameters

Parameter	Type
self	Widget
direction	DirectionType

Returns

boolean

Inherited from

WidgetProps.onKeynavFailed

---

onMap()?

optional onMap: (self) => void

Defined in: react/src/generated/jsx.ts:618

Emitted when widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with [property@Gtk.Widget:visible]) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of [signal@Gtk.Widget::unmap].

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onMap

---

onMnemonicActivate()?

optional onMnemonicActivate: (self, groupCycling) => boolean

Defined in: react/src/generated/jsx.ts:624

Emitted when a widget is activated via a mnemonic.

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

Parameters

Parameter	Type
self	Widget
groupCycling	boolean

Returns

boolean

Inherited from

WidgetProps.onMnemonicActivate

---

onMoveFocus()?

optional onMoveFocus: (self, direction) => void

Defined in: react/src/generated/jsx.ts:633

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Parameters

Parameter	Type
self	Widget
direction	DirectionType

Returns

void

Inherited from

WidgetProps.onMoveFocus

---

onMoveFocusOut()?

optional onMoveFocusOut: (self, directionType) => void

Defined in: react/src/generated/jsx.ts:4812

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

Parameters

Parameter	Type
self	ScrolledWindow
directionType	DirectionType

Returns

void

---

onQueryTooltip()?

optional onQueryTooltip: (self, x, y, keyboardMode, tooltip) => boolean

Defined in: react/src/generated/jsx.ts:648

Emitted when the widget’s tooltip is about to be shown.

This happens when the [property@Gtk.Widget:has-tooltip] property is true and the hover timeout has expired with the cursor hovering above @widget; or emitted when widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if keyboard_mode is true, the values of x and y are undefined and should not be used.

The signal handler is free to manipulate tooltip with the therefore destined function calls.

Parameters

Parameter	Type
self	Widget
x	number
y	number
keyboardMode	boolean
tooltip	Tooltip

Returns

boolean

Inherited from

WidgetProps.onQueryTooltip

---

onRealize()?

optional onRealize: (self) => void

Defined in: react/src/generated/jsx.ts:661

Emitted when widget is associated with a GdkSurface.

This means that [method@Gtk.Widget.realize] has been called or the widget has been mapped (that is, it is going to be drawn).

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onRealize

---

onScrollChild()?

optional onScrollChild: (self, scroll, horizontal) => boolean

Defined in: react/src/generated/jsx.ts:4824

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

Parameters

Parameter	Type
self	ScrolledWindow
scroll	ScrollType
horizontal	boolean

Returns

boolean

---

onShow()?

optional onShow: (self) => void

Defined in: react/src/generated/jsx.ts:663

Emitted when widget is shown.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onShow

---

onStateFlagsChanged()?

optional onStateFlagsChanged: (self, flags) => void

Defined in: react/src/generated/jsx.ts:669

Emitted when the widget state changes.

See [method@Gtk.Widget.get_state_flags].

Parameters

Parameter	Type
self	Widget
flags	StateFlags

Returns

void

Inherited from

WidgetProps.onStateFlagsChanged

---

onUnmap()?

optional onUnmap: (self) => void

Defined in: react/src/generated/jsx.ts:679

Emitted when widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onUnmap

---

onUnrealize()?

optional onUnrealize: (self) => void

Defined in: react/src/generated/jsx.ts:686

Emitted when the GdkSurface associated with widget is destroyed.

This means that [method@Gtk.Widget.unrealize] has been called or the widget has been unmapped (that is, it is going to be hidden).

Parameters

Parameter	Type
self	Widget

Returns

void

Inherited from

WidgetProps.onUnrealize

---

opacity?

optional opacity: number

Defined in: react/src/generated/jsx.ts:517

The requested opacity of the widget.

Inherited from

WidgetProps.opacity

---

overflow?

optional overflow: Overflow

Defined in: react/src/generated/jsx.ts:524

How content outside the widget's content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Inherited from

WidgetProps.overflow

---

overlayScrolling?

optional overlayScrolling: boolean

Defined in: react/src/generated/jsx.ts:4749

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 overlaid on top of the content, as narrow indicators.

Note that overlay scrolling can also be globally disabled, with the [property@Gtk.Settings:gtk-overlay-scrolling] setting.

---

parent?

optional parent: Widget

Defined in: react/src/generated/jsx.ts:526

The parent widget of this widget.

Inherited from

WidgetProps.parent

---

propagateNaturalHeight?

optional propagateNaturalHeight: boolean

Defined in: react/src/generated/jsx.ts:4757

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

---

propagateNaturalWidth?

optional propagateNaturalWidth: boolean

Defined in: react/src/generated/jsx.ts:4765

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

---

receivesDefault?

optional receivesDefault: boolean

Defined in: react/src/generated/jsx.ts:528

Whether the widget will receive the default action when it is focused.

Inherited from

WidgetProps.receivesDefault

---

ref?

optional ref: Ref<ScrolledWindow>

Defined in: react/src/generated/jsx.ts:4830

---

root?

optional root: Root

Defined in: react/src/generated/jsx.ts:534

The GtkRoot widget of the widget tree containing this widget.

This will be NULL if the widget is not contained in a root widget.

Inherited from

WidgetProps.root

---

scaleFactor?

optional scaleFactor: number

Defined in: react/src/generated/jsx.ts:536

The scale factor of the widget.

Inherited from

WidgetProps.scaleFactor

---

sensitive?

optional sensitive: boolean

Defined in: react/src/generated/jsx.ts:538

Whether the widget responds to input.

Inherited from

WidgetProps.sensitive

---

tooltipMarkup?

optional tooltipMarkup: string

Defined in: react/src/generated/jsx.ts:554

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see [method@Gtk.Tooltip.set_markup].

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: [property@Gtk.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signal@Gtk.Widget::query-tooltip] in the default signal handler.

Note that if both [property@Gtk.Widget:tooltip-text] and [property@Gtk.Widget:tooltip-markup] are set, the last one wins.

Inherited from

WidgetProps.tooltipMarkup

---

tooltipText?

optional tooltipText: string

Defined in: react/src/generated/jsx.ts:569

Sets the text of tooltip to be the given string.

Also see [method@Gtk.Tooltip.set_text].

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: [property@Gtk.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signal@Gtk.Widget::query-tooltip] in the default signal handler.

Note that if both [property@Gtk.Widget:tooltip-text] and [property@Gtk.Widget:tooltip-markup] are set, the last one wins.

Inherited from

WidgetProps.tooltipText

---

vadjustment?

optional vadjustment: Adjustment

Defined in: react/src/generated/jsx.ts:4767

The GtkAdjustment for the vertical position.

---

valign?

optional valign: Align

Defined in: react/src/generated/jsx.ts:571

How to distribute vertical space if widget gets extra space.

Inherited from

WidgetProps.valign

---

vexpand?

optional vexpand: boolean

Defined in: react/src/generated/jsx.ts:573

Whether to expand vertically.

Inherited from

WidgetProps.vexpand

---

vexpandSet?

optional vexpandSet: boolean

Defined in: react/src/generated/jsx.ts:575

Whether to use the vexpand property.

Inherited from

WidgetProps.vexpandSet

---

visible?

optional visible: boolean

Defined in: react/src/generated/jsx.ts:577

Whether the widget is visible.

Inherited from

WidgetProps.visible

---

vscrollbarPolicy?

optional vscrollbarPolicy: PolicyType

Defined in: react/src/generated/jsx.ts:4774

When the vertical scrollbar is displayed.

Use [method@Gtk.ScrolledWindow.set_policy] to set this property.

---

widthRequest?

optional widthRequest: number

Defined in: react/src/generated/jsx.ts:583

Overrides for width request of the widget.

If this is -1, the natural request will be used.

Inherited from

WidgetProps.widthRequest

---

windowPlacement?

optional windowPlacement: CornerType

Defined in: react/src/generated/jsx.ts:4776

Where the contents are located with respect to the scrollbars.