gtk4/org.gtkkn.bindings.gtk/ScrolledWindow

ScrolledWindow

open class ScrolledWindow(pointer: <Error class: unknown class><<Error class: unknown class>>) : Widget

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

Shortcuts and Gestures

The following signals have default keybindings:

signal@Gtk.ScrolledWindow::scroll-child

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.

Skipped during bindings generation

parameter hscrollbar_policy: hscrollbar_policy: Out parameter is not supported
method hadjustment: Property TypeInfo of getter and setter do not match
method hscrollbar-policy: Property has no getter nor setter
method vadjustment: Property TypeInfo of getter and setter do not match
method vscrollbar-policy: Property has no getter nor setter

Constructors

ScrolledWindow

constructor()

Creates a new scrolled window.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

accessibleRole

open val accessibleRole: AccessibleRole

The accessible role of the given GtkAccessible implementation.

canFocus

open var canFocus: Boolean

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

canTarget

open var canTarget: Boolean

Whether the widget can receive pointer events.

child

open var child: Widget?

The child widget.

cssClasses

open var cssClasses: List<String>

A list of css classes applied to this widget.

cssName

open val cssName: String

The name of this widget in the CSS tree.

cursor

open var cursor: <Error class: unknown class>?

The cursor used by @widget.

focusable

open var focusable: Boolean

Whether this widget itself will accept the input focus.

focusOnClick

open var focusOnClick: Boolean

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

gtkAccessiblePointer

open override val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open override val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

gtkScrolledWindowPointer

val gtkScrolledWindowPointer: <Error class: unknown class><<Error class: unknown class>>

gtkWidgetPointer

val gtkWidgetPointer: <Error class: unknown class><<Error class: unknown class>>

halign

open var halign: Align

How to distribute horizontal space if widget gets extra space.

hasFrame

open var hasFrame: Boolean

Whether to draw a frame around the contents.

hasTooltip

open var hasTooltip: Boolean

Enables or disables the emission of the ::query-tooltip signal on @widget.

hexpand

open var hexpand: Boolean

Whether to expand horizontally.

hexpandSet

open var hexpandSet: Boolean

Whether to use the hexpand property.

kineticScrolling

open var kineticScrolling: Boolean

Whether kinetic scrolling is enabled or not.

layoutManager

open var layoutManager: LayoutManager?

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

marginBottom

open var marginBottom: Int

Margin on bottom side of widget.

marginEnd

open var marginEnd: Int

Margin on end of widget, horizontally.

marginStart

open var marginStart: Int

Margin on start of widget, horizontally.

marginTop

open var marginTop: Int

Margin on top side of widget.

maxContentHeight

open var maxContentHeight: Int

The maximum content height of @scrolled_window.

maxContentWidth

open var maxContentWidth: Int

The maximum content width of @scrolled_window.

minContentHeight

open var minContentHeight: Int

The minimum content height of @scrolled_window.

minContentWidth

open var minContentWidth: Int

The minimum content width of @scrolled_window.

name

open var name: String

The name of the widget.

opacity

open var opacity: Double

The requested opacity of the widget.

overflow

open var overflow: Overflow

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

overlayScrolling

open var overlayScrolling: Boolean

Whether overlay scrolling is enabled or not.

parent

open val parent: Widget?

The parent widget of this widget.

propagateNaturalHeight

open var propagateNaturalHeight: Boolean

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

propagateNaturalWidth

open var propagateNaturalWidth: Boolean

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

receivesDefault

open var receivesDefault: Boolean

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

root

open val root: Root?

The GtkRoot widget of the widget tree containing this widget.

scaleFactor

open val scaleFactor: Int

The scale factor of the widget.

tooltipMarkup

open var tooltipMarkup: String?

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

tooltipText

open var tooltipText: String?

Sets the text of tooltip to be the given string.

valign

open var valign: Align

How to distribute vertical space if widget gets extra space.

vexpand

open var vexpand: Boolean

Whether to expand vertically.

vexpandSet

open var vexpandSet: Boolean

Whether to use the vexpand property.

windowPlacement

open var windowPlacement: CornerType

Where the contents are located with respect to the scrollbars.

Functions

actionSetEnabled

open fun actionSetEnabled(actionName: String, enabled: Boolean)

Enable or disable an action installed with gtk_widget_class_install_action().

activate

open fun activate(): Boolean

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

activateAction

open fun activateAction(name: String, args: <Error class: unknown class>? = null): Boolean

Looks up the action in the action groups associated with

activateDefault

open fun activateDefault()

Activates the default.activate action from @widget.

addController

open fun addController(controller: EventController)

Adds @controller to @widget so that it will receive events.

addCssClass

open fun addCssClass(cssClass: String)

Adds a style class to @widget.

addMnemonicLabel

open fun addMnemonicLabel(label: Widget)

Adds a widget to the list of mnemonic labels for this widget.

addTickCallback

open fun addTickCallback(callback: TickCallback): <Error class: unknown class>

Queues an animation frame update and adds a callback to be called before each frame.

allocate

open fun allocate(width: Int, height: Int, baseline: Int, transform: <Error class: unknown class>? = null)

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

announce

open fun announce(message: String, priority: AccessibleAnnouncementPriority)

Requests the user's screen reader to announce the given message.

childFocus

open fun childFocus(direction: DirectionType): Boolean

Called by widgets as the user moves around the window using keyboard shortcuts.

computeBounds

open fun computeBounds(target: Widget, outBounds: <Error class: unknown class>): Boolean

Computes the bounds for @widget in the coordinate space of @target.

computeExpand

open fun computeExpand(orientation: Orientation): Boolean

Computes whether a container should give this widget extra space when possible.

computePoint

open fun computePoint(target: Widget, point: <Error class: unknown class>, outPoint: <Error class: unknown class>): Boolean

Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.

computeTransform

open fun computeTransform(target: Widget, outTransform: <Error class: unknown class>): Boolean

Computes a matrix suitable to describe a transformation from

connectDestroy

fun connectDestroy(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Signals that all holders of a reference to the widget should release the reference that they hold.

connectDirectionChanged

fun connectDirectionChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (previousDirection: TextDirection) -> Unit): <Error class: unknown class>

Emitted when the text direction of a widget changes.

connectEdgeOvershot

fun connectEdgeOvershot(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (pos: PositionType) -> Unit): <Error class: unknown class>

Emitted whenever user initiated scrolling makes the scrolled window firmly surpass the limits defined by the adjustment in that orientation.

connectEdgeReached

fun connectEdgeReached(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (pos: PositionType) -> Unit): <Error class: unknown class>

Emitted whenever user-initiated scrolling makes the scrolled window exactly reach the lower or upper limits defined by the adjustment in that orientation.

connectHide

fun connectHide(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is hidden.

connectKeynavFailed

fun connectKeynavFailed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (direction: DirectionType) -> Boolean): <Error class: unknown class>

Emitted if keyboard navigation fails.

connectMap

fun connectMap(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is going to be mapped.

connectMnemonicActivate

fun connectMnemonicActivate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (groupCycling: Boolean) -> Boolean): <Error class: unknown class>

Emitted when a widget is activated via a mnemonic.

connectMoveFocus

fun connectMoveFocus(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (direction: DirectionType) -> Unit): <Error class: unknown class>

Emitted when the focus is moved.

connectMoveFocusOut

fun connectMoveFocusOut(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (directionType: DirectionType) -> Unit): <Error class: unknown class>

Emitted when focus is moved away from the scrolled window by a keybinding.

connectQueryTooltip

fun connectQueryTooltip(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (x: Int, y: Int, keyboardMode: Boolean, tooltip: Tooltip) -> Boolean): <Error class: unknown class>

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

connectRealize

fun connectRealize(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is associated with a GdkSurface.

connectScrollChild

fun connectScrollChild(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (scroll: ScrollType, horizontal: Boolean) -> Boolean): <Error class: unknown class>

Emitted when a keybinding that scrolls is pressed.

connectShow

fun connectShow(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is shown.

connectStateFlagsChanged

fun connectStateFlagsChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (flags: StateFlags) -> Unit): <Error class: unknown class>

Emitted when the widget state changes.

connectUnmap

fun connectUnmap(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is going to be unmapped.

connectUnrealize

fun connectUnrealize(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the GdkSurface associated with @widget is destroyed.

contains

open fun contains(x: Double, y: Double): Boolean

Tests if the point at (@x, @y) is contained in @widget.

createPangoLayout

open fun createPangoLayout(text: String? = null): <Error class: unknown class>

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

disposeTemplate

open fun disposeTemplate(widgetType: <Error class: unknown class>)

Clears the template children for the given widget.

dragCheckThreshold

open fun dragCheckThreshold(startX: Int, startY: Int, currentX: Int, currentY: Int): Boolean

Checks to see if a drag movement has passed the GTK drag threshold.

errorBell

open fun errorBell()

Notifies the user about an input-related error on this widget.

getAccessibleParent

open fun getAccessibleParent(): Accessible?

Retrieves the accessible parent for an accessible object.

getAccessibleRole

open fun getAccessibleRole(): AccessibleRole

Retrieves the accessible role of an accessible object.

getAllocatedBaseline

open fun getAllocatedBaseline(): Int

Returns the baseline that has currently been allocated to @widget.

getAllocatedHeight

open fun getAllocatedHeight(): Int

Returns the height that has currently been allocated to @widget.

getAllocatedWidth

open fun getAllocatedWidth(): Int

Returns the width that has currently been allocated to @widget.

getAncestor

open fun getAncestor(widgetType: <Error class: unknown class>): Widget?

Gets the first ancestor of @widget with type @widget_type.

getAtContext

open fun getAtContext(): ATContext

Retrieves the accessible implementation for the given GtkAccessible.

getBaseline

open fun getBaseline(): Int

Returns the baseline that has currently been allocated to @widget.

getBuildableId

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

getCanFocus

open fun getCanFocus(): Boolean

Determines whether the input focus can enter @widget or any of its children.

getCanTarget

open fun getCanTarget(): Boolean

Queries whether @widget can be the target of pointer events.

getChild

open fun getChild(): Widget?

Gets the child widget of @scrolled_window.

getChildVisible

open fun getChildVisible(): Boolean

Gets the value set with gtk_widget_set_child_visible().

getClipboard

open fun getClipboard(): <Error class: unknown class>

Gets the clipboard object for @widget.

getColor

open fun getColor(color: <Error class: unknown class>)

Gets the current foreground color for the widget’s CSS style.

getCssClasses

open fun getCssClasses(): List<String>

Returns the list of style classes applied to @widget.

getCssName

open fun getCssName(): String

Returns the CSS name that is used for @self.

getCursor

open fun getCursor(): <Error class: unknown class>?

Queries the cursor set on @widget.

getDirection

open fun getDirection(): TextDirection

Gets the reading direction for a particular widget.

getDisplay

open fun getDisplay(): <Error class: unknown class>

Get the GdkDisplay for the toplevel window associated with this widget.

getFirstAccessibleChild

open fun getFirstAccessibleChild(): Accessible?

Retrieves the first accessible child of an accessible object.

getFirstChild

open fun getFirstChild(): Widget?

Returns the widget’s first child.

getFocusable

open fun getFocusable(): Boolean

Determines whether @widget can own the input focus.

getFocusChild

open fun getFocusChild(): Widget?

Returns the current focus child of @widget.

getFocusOnClick

open fun getFocusOnClick(): Boolean

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

getFontMap

open fun getFontMap(): <Error class: unknown class>?

Gets the font map of @widget.

getFrameClock

open fun getFrameClock(): <Error class: unknown class>?

Obtains the frame clock for a widget.

getHadjustment

open fun getHadjustment(): Adjustment

Returns the horizontal scrollbar’s adjustment.

getHalign

open fun getHalign(): Align

Gets the horizontal alignment of @widget.

getHasFrame

open fun getHasFrame(): Boolean

Gets whether the scrolled window draws a frame.

getHasTooltip

open fun getHasTooltip(): Boolean

Returns the current value of the has-tooltip property.

getHeight

open fun getHeight(): Int

Returns the content height of the widget.

getHexpand

open fun getHexpand(): Boolean

Gets whether the widget would like any available extra horizontal space.

getHexpandSet

open fun getHexpandSet(): Boolean

Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.

getHscrollbar

open fun getHscrollbar(): Widget

Returns the horizontal scrollbar of @scrolled_window.

getKineticScrolling

open fun getKineticScrolling(): Boolean

Returns the specified kinetic scrolling behavior.

getLastChild

open fun getLastChild(): Widget?

Returns the widget’s last child.

getLayoutManager

open fun getLayoutManager(): LayoutManager?

Retrieves the layout manager used by @widget.

getMapped

open fun getMapped(): Boolean

Whether the widget is mapped.

getMarginBottom

open fun getMarginBottom(): Int

Gets the bottom margin of @widget.

getMarginEnd

open fun getMarginEnd(): Int

Gets the end margin of @widget.

getMarginStart

open fun getMarginStart(): Int

Gets the start margin of @widget.

getMarginTop

open fun getMarginTop(): Int

Gets the top margin of @widget.

getMaxContentHeight

open fun getMaxContentHeight(): Int

Returns the maximum content height set.

getMaxContentWidth

open fun getMaxContentWidth(): Int

Returns the maximum content width set.

getMinContentHeight

open fun getMinContentHeight(): Int

Gets the minimal content height of @scrolled_window.

getMinContentWidth

open fun getMinContentWidth(): Int

Gets the minimum content width of @scrolled_window.

getName

open fun getName(): String

Retrieves the name of a widget.

getNative

open fun getNative(): Native?

Returns the nearest GtkNative ancestor of @widget.

getNextAccessibleSibling

open fun getNextAccessibleSibling(): Accessible?

Retrieves the next accessible sibling of an accessible object

getNextSibling

open fun getNextSibling(): Widget?

Returns the widget’s next sibling.

getOpacity

open fun getOpacity(): Double

#Fetches the requested opacity for this widget.

getOverflow

open fun getOverflow(): Overflow

Returns the widget’s overflow value.

getOverlayScrolling

open fun getOverlayScrolling(): Boolean

Returns whether overlay scrolling is enabled for this scrolled window.

getParent

open fun getParent(): Widget?

Returns the parent widget of @widget.

getPlacement

open fun getPlacement(): CornerType

Gets the placement of the contents with respect to the scrollbars.

getPlatformState

open fun getPlatformState(state: AccessiblePlatformState): Boolean

Query a platform state, such as focus.

getPreferredSize

open fun getPreferredSize(minimumSize: Requisition?, naturalSize: Requisition?)

Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.

getPrevSibling

open fun getPrevSibling(): Widget?

Returns the widget’s previous sibling.

getPrimaryClipboard

open fun getPrimaryClipboard(): <Error class: unknown class>

Gets the primary clipboard of @widget.

getPropagateNaturalHeight

open fun getPropagateNaturalHeight(): Boolean

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

getPropagateNaturalWidth

open fun getPropagateNaturalWidth(): Boolean

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

getRealized

open fun getRealized(): Boolean

Determines whether @widget is realized.

getReceivesDefault

open fun getReceivesDefault(): Boolean

Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

getRequestMode

open fun getRequestMode(): SizeRequestMode

Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

getRoot

open fun getRoot(): Root?

Returns the GtkRoot widget of @widget.

getScaleFactor

open fun getScaleFactor(): Int

Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.

getSensitive

open fun getSensitive(): Boolean

Returns the widget’s sensitivity.

getSettings

open fun getSettings(): Settings

Gets the settings object holding the settings used for this widget.

getSize

open fun getSize(orientation: Orientation): Int

Returns the content width or height of the widget.

getStateFlags

open fun getStateFlags(): StateFlags

Returns the widget state as a flag set.

getStyleContext

open fun getStyleContext(): StyleContext

Returns the style context associated to @widget.

getTemplateChild

open fun getTemplateChild(widgetType: <Error class: unknown class>, name: String): <Error class: unknown class>

Fetch an object build from the template XML for @widget_type in this @widget instance.

getTooltipMarkup

open fun getTooltipMarkup(): String?

Gets the contents of the tooltip for @widget.

getTooltipText

open fun getTooltipText(): String?

Gets the contents of the tooltip for @widget.

getVadjustment

open fun getVadjustment(): Adjustment

Returns the vertical scrollbar’s adjustment.

getValign

open fun getValign(): Align

Gets the vertical alignment of @widget.

getVexpand

open fun getVexpand(): Boolean

Gets whether the widget would like any available extra vertical space.

getVexpandSet

open fun getVexpandSet(): Boolean

Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.

getVisible

open fun getVisible(): Boolean

Determines whether the widget is visible.

getVscrollbar

open fun getVscrollbar(): Widget

Returns the vertical scrollbar of @scrolled_window.

getWidth

open fun getWidth(): Int

Returns the content width of the widget.

grabFocus

open fun grabFocus(): Boolean

Causes @widget to have the keyboard focus for the GtkWindow it's inside.

hasCssClass

open fun hasCssClass(cssClass: String): Boolean

Returns whether @css_class is currently applied to @widget.

hasDefault

open fun hasDefault(): Boolean

Determines whether @widget is the current default widget within its toplevel.

hasFocus

open fun hasFocus(): Boolean

Determines if the widget has the global input focus.

hasVisibleFocus

open fun hasVisibleFocus(): Boolean

Determines if the widget should show a visible indication that it has the global input focus.

hide

open fun hide()

Reverses the effects of gtk_widget_show().

inDestruction

open fun inDestruction(): Boolean

Returns whether the widget is currently being destroyed.

initTemplate

open fun initTemplate()

Creates and initializes child widgets defined in templates.

insertActionGroup

open fun insertActionGroup(name: String, group: <Error class: unknown class>? = null)

Inserts @group into @widget.

insertAfter

open fun insertAfter(parent: Widget, previousSibling: Widget? = null)

Inserts @widget into the child widget list of @parent.

insertBefore

open fun insertBefore(parent: Widget, nextSibling: Widget? = null)

Inserts @widget into the child widget list of @parent.

isAncestor

open fun isAncestor(ancestor: Widget): Boolean

Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.

isDrawable

open fun isDrawable(): Boolean

Determines whether @widget can be drawn to.

isFocus

open fun isFocus(): Boolean

Determines if the widget is the focus widget within its toplevel.

isSensitive

open fun isSensitive(): Boolean

Returns the widget’s effective sensitivity.

isVisible

open fun isVisible(): Boolean

Determines whether the widget and all its parents are marked as visible.

keynavFailed

open fun keynavFailed(direction: DirectionType): Boolean

Emits the ::keynav-failed signal on the widget.

listMnemonicLabels

open fun listMnemonicLabels(): <Error class: unknown class>

Returns the widgets for which this widget is the target of a mnemonic.

map

open fun map()

Causes a widget to be mapped if it isn’t already.

mnemonicActivate

open fun mnemonicActivate(groupCycling: Boolean): Boolean

Emits the ::mnemonic-activate signal.

observeChildren

open fun observeChildren(): <Error class: unknown class>

Returns a GListModel to track the children of @widget.

observeControllers

open fun observeControllers(): <Error class: unknown class>

Returns a GListModel to track the class@Gtk.EventControllers of @widget.

pick

open fun pick(x: Double, y: Double, flags: PickFlags): Widget?

Finds the descendant of @widget closest to the point (@x, @y).

queueAllocate

open fun queueAllocate()

Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.

queueDraw

open fun queueDraw()

Schedules this widget to be redrawn in the paint phase of the current or the next frame.

queueResize

open fun queueResize()

Flags a widget to have its size renegotiated.

realize

open fun realize()

Creates the GDK resources associated with a widget.

removeController

open fun removeController(controller: EventController)

Removes @controller from @widget, so that it doesn't process events anymore.

removeCssClass

open fun removeCssClass(cssClass: String)

Removes a style from @widget.

removeMnemonicLabel

open fun removeMnemonicLabel(label: Widget)

Removes a widget from the list of mnemonic labels for this widget.

removeTickCallback

open fun removeTickCallback(id: <Error class: unknown class>)

Removes a tick callback previously registered with gtk_widget_add_tick_callback().

resetProperty

open fun resetProperty(property: AccessibleProperty)

Resets the accessible @property to its default value.

resetRelation

open fun resetRelation(relation: AccessibleRelation)

Resets the accessible @relation to its default value.

resetState

open fun resetState(state: AccessibleState)

Resets the accessible @state to its default value.

setAccessibleParent

open fun setAccessibleParent(parent: Accessible? = null, nextSibling: Accessible? = null)

Sets the parent and sibling of an accessible object.

setCanFocus

open fun setCanFocus(canFocus: Boolean)

Specifies whether the input focus can enter the widget or any of its children.

setCanTarget

open fun setCanTarget(canTarget: Boolean)

Sets whether @widget can be the target of pointer events.

setChild

open fun setChild(child: Widget? = null)

Sets the child widget of @scrolled_window.

setChildVisible

open fun setChildVisible(childVisible: Boolean)

Sets whether @widget should be mapped along with its parent.

setCssClasses

open fun setCssClasses(classes: List<String>)

Clear all style classes applied to @widget and replace them with @classes.

setCursor

open fun setCursor(cursor: <Error class: unknown class>? = null)

Sets the cursor to be shown when pointer devices point towards @widget.

setCursorFromName

open fun setCursorFromName(name: String? = null)

Sets a named cursor to be shown when pointer devices point towards @widget.

setDirection

open fun setDirection(dir: TextDirection)

Sets the reading direction on a particular widget.

setFocusable

open fun setFocusable(focusable: Boolean)

Specifies whether @widget can own the input focus.

setFocusChild

open fun setFocusChild(child: Widget? = null)

Set @child as the current focus child of @widget.

setFocusOnClick

open fun setFocusOnClick(focusOnClick: Boolean)

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

setFontMap

open fun setFontMap(fontMap: <Error class: unknown class>? = null)

Sets the font map to use for Pango rendering.

setHadjustment

open fun setHadjustment(hadjustment: Adjustment? = null)

Sets the GtkAdjustment for the horizontal scrollbar.

setHalign

open fun setHalign(align: Align)

Sets the horizontal alignment of @widget.

setHasFrame

open fun setHasFrame(hasFrame: Boolean)

Changes the frame drawn around the contents of @scrolled_window.

setHasTooltip

open fun setHasTooltip(hasTooltip: Boolean)

Sets the has-tooltip property on @widget to @has_tooltip.

setHexpand

open fun setHexpand(expand: Boolean)

Sets whether the widget would like any available extra horizontal space.

setHexpandSet

open fun setHexpandSet(set: Boolean)

Sets whether the hexpand flag will be used.

setKineticScrolling

open fun setKineticScrolling(kineticScrolling: Boolean)

Turns kinetic scrolling on or off.

setLayoutManager

open fun setLayoutManager(layoutManager: LayoutManager? = null)

Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.

setMarginBottom

open fun setMarginBottom(margin: Int)

Sets the bottom margin of @widget.

setMarginEnd

open fun setMarginEnd(margin: Int)

Sets the end margin of @widget.

setMargins

fun Widget.setMargins(all: Int)

Set all margins to the same value.

fun Widget.setMargins(horizontal: Int = 0, vertical: Int = 0)

Set start and end margin to horizontal and top and bottom margin to vertical

fun Widget.setMargins(start: Int = 0, top: Int = 0, end: Int = 0, bottom: Int = 0)

Set margins.

setMarginStart

open fun setMarginStart(margin: Int)

Sets the start margin of @widget.

setMarginTop

open fun setMarginTop(margin: Int)

Sets the top margin of @widget.

setMaxContentHeight

open fun setMaxContentHeight(height: Int)

Sets the maximum height that @scrolled_window should keep visible.

setMaxContentWidth

open fun setMaxContentWidth(width: Int)

Sets the maximum width that @scrolled_window should keep visible.

setMinContentHeight

open fun setMinContentHeight(height: Int)

Sets the minimum height that @scrolled_window should keep visible.

setMinContentWidth

open fun setMinContentWidth(width: Int)

Sets the minimum width that @scrolled_window should keep visible.

setName

open fun setName(name: String)

Sets a widgets name.

setOpacity

open fun setOpacity(opacity: Double)

Request the @widget to be rendered partially transparent.

setOverflow

open fun setOverflow(overflow: Overflow)

Sets how @widget treats content that is drawn outside the widget's content area.

setOverlayScrolling

open fun setOverlayScrolling(overlayScrolling: Boolean)

Enables or disables overlay scrolling for this scrolled window.

setParent

open fun setParent(parent: Widget)

Sets @parent as the parent widget of @widget.

setPlacement

open fun setPlacement(windowPlacement: CornerType)

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

setPolicy

open fun setPolicy(hscrollbarPolicy: PolicyType, vscrollbarPolicy: PolicyType)

Sets the scrollbar policy for the horizontal and vertical scrollbars.

setPropagateNaturalHeight

open fun setPropagateNaturalHeight(propagate: Boolean)

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

setPropagateNaturalWidth

open fun setPropagateNaturalWidth(propagate: Boolean)

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

setReceivesDefault

open fun setReceivesDefault(receivesDefault: Boolean)

Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

setSensitive

open fun setSensitive(sensitive: Boolean)

Sets the sensitivity of a widget.

setSizeRequest

open fun setSizeRequest(width: Int, height: Int)

Sets the minimum size of a widget.

setStateFlags

open fun setStateFlags(flags: StateFlags, clear: Boolean)

Turns on flag values in the current widget state.

setTooltipMarkup

open fun setTooltipMarkup(markup: String? = null)

Sets @markup as the contents of the tooltip, which is marked up with Pango markup.

setTooltipText

open fun setTooltipText(text: String? = null)

Sets @text as the contents of the tooltip.

setVadjustment

open fun setVadjustment(vadjustment: Adjustment? = null)

Sets the GtkAdjustment for the vertical scrollbar.

setValign

open fun setValign(align: Align)

Sets the vertical alignment of @widget.

setVexpand

open fun setVexpand(expand: Boolean)

Sets whether the widget would like any available extra vertical space.

setVexpandSet

open fun setVexpandSet(set: Boolean)

Sets whether the vexpand flag will be used.

setVisible

open fun setVisible(visible: Boolean)

Sets the visibility state of @widget.

shouldLayout

open fun shouldLayout(): Boolean

Returns whether @widget should contribute to the measuring and allocation of its parent.

show

open fun show()

Flags a widget to be displayed.

triggerTooltipQuery

open fun triggerTooltipQuery()

Triggers a tooltip query on the display where the toplevel of @widget is located.

unmap

open fun unmap()

Causes a widget to be unmapped if it’s currently mapped.

unparent

open fun unparent()

Dissociate @widget from its parent.

unrealize

open fun unrealize()

Causes a widget to be unrealized (frees all GDK resources associated with the widget).

unsetPlacement

open fun unsetPlacement()

Unsets the placement of the contents with respect to the scrollbars.

unsetStateFlags

open fun unsetStateFlags(flags: StateFlags)

Turns off flag values for the current widget state.

updateNextAccessibleSibling

open fun updateNextAccessibleSibling(newSibling: Accessible? = null)

Updates the next accessible sibling of @self.