gtk4/org.gtkkn.bindings.gtk/ApplicationWindow

ApplicationWindow

open class ApplicationWindow(pointer: <Error class: unknown class><<Error class: unknown class>>) : Window

GtkApplicationWindow is a GtkWindow subclass that integrates with GtkApplication.

Notably, GtkApplicationWindow can handle an application menubar.

This class implements the GActionGroup and GActionMap interfaces, to let you add window-specific actions that will be exported by the associated class@Gtk.Application, together with its application-wide actions. Window-specific actions are prefixed with the “win.” prefix and application-wide actions are prefixed with the “app.” prefix. Actions must be addressed with the prefixed name when referring to them from a GMenuModel.

Note that widgets that are placed inside a GtkApplicationWindow can also activate these actions, if they implement the iface@Gtk.Actionable interface.

The settings property@Gtk.Settings:gtk-shell-shows-app-menu and property@Gtk.Settings:gtk-shell-shows-menubar tell GTK whether the desktop environment is showing the application menu and menubar models outside the application as part of the desktop shell. For instance, on OS X, both menus will be displayed remotely; on Windows neither will be.

If the desktop environment does not display the menubar, then GtkApplicationWindow will automatically show a menubar for it. This behaviour can be overridden with the property@Gtk.ApplicationWindow:show-menubar property. If the desktop environment does not display the application menu, then it will automatically be included in the menubar or in the windows client-side decorations.

See class@Gtk.PopoverMenu for information about the XML language used by GtkBuilder for menu models.

See also: method@Gtk.Application.set_menubar.

A GtkApplicationWindow with a menubar

The code sample below shows how to set up a GtkApplicationWindow with a menu bar defined on the class@Gtk.Application:

GtkApplication *app = gtk_application_new ("org.gtk.test", 0);

GtkBuilder *builder = gtk_builder_new_from_string (
    "<interface>"
    "  <menu id='menubar'>"
    "    <submenu>"
    "      <attribute name='label' translatable='yes'>_Edit</attribute>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>_Copy</attribute>"
    "        <attribute name='action'>win.copy</attribute>"
    "      </item>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>_Paste</attribute>"
    "        <attribute name='action'>win.paste</attribute>"
    "      </item>"
    "    </submenu>"
    "  </menu>"
    "</interface>",
    -1);

GMenuModel *menubar = G_MENU_MODEL (gtk_builder_get_object (builder, "menubar"));
gtk_application_set_menubar (GTK_APPLICATION (app), menubar);
g_object_unref (builder);

// ...

GtkWidget *window = gtk_application_window_new (app);

Constructors

ApplicationWindow

constructor(application: Application)

Creates a new GtkApplicationWindow.

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.

application

open var application: Application?

The GtkApplication associated with the window.

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.

decorated

open var decorated: Boolean

Whether the window should have a frame (also known as decorations).

defaultWidget

open var defaultWidget: Widget?

The default widget.

deletable

open var deletable: Boolean

Whether the window frame should have a close button.

destroyWithParent

open var destroyWithParent: Boolean

If this window should be destroyed when the parent is destroyed.

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.

focusVisible

open var focusVisible: Boolean

Whether 'focus rectangles' are currently visible in this window.

focusWidget

open var focusWidget: Widget?

The focus widget.

gioActionGroupPointer

open val gioActionGroupPointer: <Error class: unknown class><<Error class: unknown class>>

gioActionMapPointer

open val gioActionMapPointer: <Error class: unknown class><<Error class: unknown class>>

gtkAccessiblePointer

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

gtkApplicationWindowPointer

val gtkApplicationWindowPointer: <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>>

gtkNativePointer

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

gtkRootPointer

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

gtkShortcutManagerPointer

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

gtkWidgetPointer

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

gtkWindowPointer

val gtkWindowPointer: <Error class: unknown class><<Error class: unknown class>>

halign

open var halign: Align

How to distribute horizontal space if widget gets extra space.

handleMenubarAccel

open var handleMenubarAccel: Boolean

Whether the window frame should handle F10 for activating menubars.

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.

hideOnClose

open var hideOnClose: Boolean

If this window should be hidden when the users clicks the close button.

iconName

open var iconName: String?

Specifies the name of the themed icon to use as the window icon.

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.

mnemonicsVisible

open var mnemonicsVisible: Boolean

Whether mnemonics are currently visible in this window.

modal

open var modal: Boolean

If true, the window is modal.

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.

parent

open val parent: Widget?

The parent widget of this widget.

receivesDefault

open var receivesDefault: Boolean

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

resizable

open var resizable: Boolean

If true, users can resize the window.

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.

showMenubar

open var showMenubar: Boolean

If this property is true, the window will display a menubar unless it is shown by the desktop shell.

title

open var title: String?

The title of the window.

titlebar

open var titlebar: Widget?

The titlebar 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.

transientFor

open var transientFor: Window?

The transient parent of the window.

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.

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.

open fun close()

Requests that the window is closed.

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

connectActivateDefault

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

Emitted when the user activates the default widget of @window.

connectActivateFocus

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

Emitted when the user activates the currently focused widget of @window.

connectCloseRequest

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

Emitted when the user clicks on the close button of the window.

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.

connectEnableDebugging

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

Emitted when the user enables or disables interactive debugging.

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.

connectKeysChanged

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

emitted when the set of accelerators or mnemonics that are associated with @window changes.

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.

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.

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.

destroy

open fun destroy()

Drop the internal reference GTK holds on toplevel windows.

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.

fullscreen

open fun fullscreen()

Asks to place @window in the fullscreen state.

fullscreenOnMonitor

open fun fullscreenOnMonitor(monitor: <Error class: unknown class>)

Asks to place @window in the fullscreen state on the given @monitor.

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.

getApplication

open fun getApplication(): Application?

Gets the GtkApplication associated with the window.

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

getDecorated

open fun getDecorated(): Boolean

Returns whether the window has been set to have decorations.

getDefaultWidget

open fun getDefaultWidget(): Widget?

Returns the default widget for @window.

getDeletable

open fun getDeletable(): Boolean

Returns whether the window has been set to have a close button.

getDestroyWithParent

open fun getDestroyWithParent(): Boolean

Returns whether the window will be destroyed with its transient parent.

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.

getDisplay_

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

Returns the display that this GtkRoot is on.

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.

getFocus

open override fun getFocus(): Widget?

Retrieves the current focused widget within the window.

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.

getFocusVisible

open fun getFocusVisible(): Boolean

Gets whether “focus rectangles” are supposed to be visible.

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.

getGroup

open fun getGroup(): WindowGroup

Returns the group for @window.

getHalign

open fun getHalign(): Align

Gets the horizontal alignment of @widget.

getHandleMenubarAccel

open fun getHandleMenubarAccel(): Boolean

Returns whether this window reacts to F10 key presses by activating a menubar it contains.

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.

getHelpOverlay

open fun getHelpOverlay(): ShortcutsWindow?

Gets the GtkShortcutsWindow that is associated with @window.

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.

getHideOnClose

open fun getHideOnClose(): Boolean

Returns whether the window will be hidden when the close button is clicked.

getIconName

open fun getIconName(): String?

Returns the name of the themed icon for the window.

getId

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

Returns the unique ID of the window.

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.

getMnemonicsVisible

open fun getMnemonicsVisible(): Boolean

Gets whether mnemonics are supposed to be visible.

getModal

open fun getModal(): Boolean

Returns whether the window is modal.

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.

getParent

open fun getParent(): Widget?

Returns the parent widget of @widget.

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.

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.

getRenderer

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

Returns the renderer that is used for this GtkNative.

getRequestMode

open fun getRequestMode(): SizeRequestMode

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

getResizable

open fun getResizable(): Boolean

Gets the value set by gtk_window_set_resizable().

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.

getShowMenubar

open fun getShowMenubar(): Boolean

Returns whether the window will display a menubar for the app menu and menubar as needed.

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.

getSurface

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

Returns the surface of this GtkNative.

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.

getTitle

open fun getTitle(): String?

Retrieves the title of the window.

getTitlebar

open fun getTitlebar(): Widget?

Returns the custom titlebar that has been set with gtk_window_set_titlebar().

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.

getTransientFor

open fun getTransientFor(): Window?

Fetches the transient parent for this window.

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.

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.

hasGroup

open fun hasGroup(): Boolean

Returns whether @window has an explicit window group.

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.

isActive

open fun isActive(): Boolean

Returns whether the window is part of the current active toplevel.

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.

isFullscreen

open fun isFullscreen(): Boolean

Retrieves the current fullscreen state of @window.

isMaximized

open fun isMaximized(): Boolean

Retrieves the current maximized state of @window.

isSensitive

open fun isSensitive(): Boolean

Returns the widget’s effective sensitivity.

isSuspended

open fun isSuspended(): Boolean

Retrieves the current suspended state of @window.

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.

maximize

open fun maximize()

Asks to maximize @window, so that it fills the screen.

minimize

open fun minimize()

Asks to minimize the specified @window.

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

present

open fun present()

Presents a window to the user.

presentWithTime

open fun presentWithTime(timestamp: <Error class: unknown class>)

Presents a window to the user in response to an user interaction.

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.

realize_

open fun realize_()

Realizes a GtkNative.

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.

setApplication

open fun setApplication(application: Application? = null)

Sets or unsets the GtkApplication associated with the window.

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

setDecorated

open fun setDecorated(setting: Boolean)

Sets whether the window should be decorated.

setDefaultSize

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

Sets the default size of a window.

setDefaultWidget

open fun setDefaultWidget(defaultWidget: Widget? = null)

Sets the default widget.

setDeletable

open fun setDeletable(setting: Boolean)

Sets whether the window should be deletable.

setDestroyWithParent

open fun setDestroyWithParent(setting: Boolean)

If @setting is true, then destroying the transient parent of @window will also destroy @window itself.

setDirection

open fun setDirection(dir: TextDirection)

Sets the reading direction on a particular widget.

setDisplay

open fun setDisplay(display: <Error class: unknown class>)

Sets the GdkDisplay where the @window is displayed.

setFocus

open override fun setFocus(focus: Widget?)

Sets the focus 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.

setFocusVisible

open fun setFocusVisible(setting: Boolean)

Sets whether “focus rectangles” are supposed to be visible.

setFontMap

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

Sets the font map to use for Pango rendering.

setHalign

open fun setHalign(align: Align)

Sets the horizontal alignment of @widget.

setHandleMenubarAccel

open fun setHandleMenubarAccel(handleMenubarAccel: Boolean)

Sets whether this window should react to F10 key presses by activating a menubar it contains.

setHasTooltip

open fun setHasTooltip(hasTooltip: Boolean)

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

setHelpOverlay

open fun setHelpOverlay(helpOverlay: ShortcutsWindow? = null)

Associates a shortcuts window with the application window.

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.

setHideOnClose

open fun setHideOnClose(setting: Boolean)

If @setting is true, then clicking the close button on the window will not destroy it, but only hide it.

setIconName

open fun setIconName(name: String? = null)

Sets the icon for the window from a named themed icon.

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.

setMnemonicsVisible

open fun setMnemonicsVisible(setting: Boolean)

Sets whether mnemonics are supposed to be visible.

setModal

open fun setModal(modal: Boolean)

Sets a window modal or non-modal.

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.

setParent

open fun setParent(parent: Widget)

Sets @parent as the parent widget of @widget.

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.

setResizable

open fun setResizable(resizable: Boolean)

Sets whether the user can resize a window.

setSensitive

open fun setSensitive(sensitive: Boolean)

Sets the sensitivity of a widget.

setShowMenubar

open fun setShowMenubar(showMenubar: Boolean)

Sets whether the window will display a menubar for the app menu and menubar as needed.

setSizeRequest

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

Sets the minimum size of a widget.

setStartupId

open fun setStartupId(startupId: String)

Sets the startup notification ID.

setStateFlags

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

Turns on flag values in the current widget state.

setTitle

open fun setTitle(title: String? = null)

Sets the title of the GtkWindow.

setTitlebar

open fun setTitlebar(titlebar: Widget? = null)

Sets a custom titlebar for @window.

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.

setTransientFor

open fun setTransientFor(parent: Window? = null)

Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. ctor@Gtk.Dialog.new_with_buttons and other convenience functions in GTK will sometimes call gtk_window_set_transient_for() on your behalf.

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.