Skip to main content

Type Alias: GtkWindowProps

GtkWindowProps = WidgetProps & object

Defined in: generated/jsx.ts:337

Props for the GtkWindow widget.

Type Declaration

NameTypeDescriptionDefined in
application?Gtk.Application | nullThe GtkApplication associated with the window. The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() for a way to keep it alive without windows). Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the this property to NULL.generated/jsx.ts:349
child?Gtk.Widget | nullThe child widget.generated/jsx.ts:351
children?ReactNode-generated/jsx.ts:477
decorated?booleanWhether the window should have a frame (also known as decorations).generated/jsx.ts:353
defaultHeight?numberThe default height of the window.generated/jsx.ts:355
defaultWidget?Gtk.Widget | nullThe default widget.generated/jsx.ts:357
defaultWidth?numberThe default width of the window.generated/jsx.ts:359
deletable?booleanWhether the window frame should have a close button.generated/jsx.ts:361
destroyWithParent?booleanIf this window should be destroyed when the parent is destroyed.generated/jsx.ts:363
display?Gdk.DisplayThe display that will display this window.generated/jsx.ts:365
focusVisible?booleanWhether 'focus rectangles' are currently visible in this window. This property is maintained by GTK based on user input and should not be set by applications.generated/jsx.ts:372
focusWidget?Gtk.Widget | nullThe focus widget.generated/jsx.ts:374
fullscreened?booleanWhether the window is fullscreen. Setting this property is the equivalent of calling Window.fullscreen or Window.unfullscreen; either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.generated/jsx.ts:384
gravity?Gtk.WindowGravityThe gravity to use when resizing the window programmatically. Gravity describes which point of the window we want to keep fixed (meaning that the window will grow in the opposite direction). For example, a gravity of GTK_WINDOW_GRAVITY_TOP_RIGHT means that we want the to fix top right corner of the window.generated/jsx.ts:393
handleMenubarAccel?booleanWhether the window frame should handle F10 for activating menubars.generated/jsx.ts:398
hideOnClose?booleanIf this window should be hidden instead of destroyed when the user clicks the close button.generated/jsx.ts:403
iconName?string | nullSpecifies the name of the themed icon to use as the window icon. See IconTheme for more details.generated/jsx.ts:409
maximized?booleanWhether the window is maximized. Setting this property is the equivalent of calling Window.maximize or Window.unmaximize; either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.generated/jsx.ts:419
mnemonicsVisible?booleanWhether mnemonics are currently visible in this window. This property is maintained by GTK based on user input, and should not be set by applications.generated/jsx.ts:426
modal?booleanIf true, the window is modal.generated/jsx.ts:428
onActivateDefault?(self) => void | nullEmitted when the user activates the default widget. This is a keybinding signal. The keybindings for this signal are all forms of the Enter key.generated/jsx.ts:446
onActivateFocus?(self) => void | nullEmitted when the user activates the currently focused widget of window. This is a keybinding signal. The default binding for this signal is .generated/jsx.ts:455
onClose?() => void | nullCalled when the window close button is clicked. Control window visibility using React state.generated/jsx.ts:476
onEnableDebugging?(toggle, self) => boolean | nullEmitted when the user enables or disables interactive debugging. When toggle is true, interactive debugging is toggled on or off, when it is false, the debugger will be pointed at the widget under the pointer. This is a keybinding signal. The default bindings for this signal are Ctrl+Shift+I and Ctrl+Shift+D.generated/jsx.ts:469
onKeysChanged?(self) => void | nullEmitted when the set of accelerators or mnemonics that are associated with the window changes.generated/jsx.ts:474
ref?Ref<Gtk.Window>-generated/jsx.ts:478
resizable?booleanIf true, users can resize the window.generated/jsx.ts:430
startupId?stringA write-only property for setting window's startup notification identifier.generated/jsx.ts:432
title?string | nullThe title of the window.generated/jsx.ts:434
titlebar?Gtk.Widget | nullThe titlebar widget.generated/jsx.ts:436
transientFor?Gtk.Window | nullThe transient parent of the window.generated/jsx.ts:438