Interface: DialogProps

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

Props for the Dialog widget.

Extends

• WindowProps

Extended by

• AppChooserDialogProps
• ColorChooserDialogProps
• FileChooserDialogProps
• FontChooserDialogProps
• MessageDialogProps
• PageSetupUnixDialogProps
• PrintUnixDialogProps

Properties

application?

optional application: Application

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

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

Inherited from

WindowProps.application

---

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

WindowProps.canFocus

---

canTarget?

optional canTarget: boolean

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

Whether the widget can receive pointer events.

Inherited from

WindowProps.canTarget

---

children?

optional children: ReactNode

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

Inherited from

WindowProps.children

---

cssClasses?

optional cssClasses: string[]

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

A list of css classes applied to this widget.

Inherited from

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

WindowProps.cssName

---

cursor?

optional cursor: number

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

The cursor used by @widget.

Inherited from

WindowProps.cursor

---

decorated?

optional decorated: boolean

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

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

Inherited from

WindowProps.decorated

---

defaultHeight?

optional defaultHeight: number

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

The default height of the window.

Inherited from

WindowProps.defaultHeight

---

defaultWidth?

optional defaultWidth: number

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

The default width of the window.

Inherited from

WindowProps.defaultWidth

---

deletable?

optional deletable: boolean

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

Whether the window frame should have a close button.

Inherited from

WindowProps.deletable

---

destroyWithParent?

optional destroyWithParent: boolean

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

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

Inherited from

WindowProps.destroyWithParent

---

display?

optional display: number

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

The display that will display this window.

Inherited from

WindowProps.display

---

focusable?

optional focusable: boolean

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

Whether this widget itself will accept the input focus.

Inherited from

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

WindowProps.focusOnClick

---

focusVisible?

optional focusVisible: boolean

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

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

Inherited from

WindowProps.focusVisible

---

fullscreened?

optional fullscreened: boolean

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

Whether the window is fullscreen.

Setting this property is the equivalent of calling [method@Gtk.Window.fullscreen] or [method@Gtk.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.

Inherited from

WindowProps.fullscreened

---

gravity?

optional gravity: WindowGravity

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

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

Inherited from

WindowProps.gravity

---

halign?

optional halign: Align

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

How to distribute horizontal space if widget gets extra space.

Inherited from

WindowProps.halign

---

handleMenubarAccel?

optional handleMenubarAccel: boolean

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

Whether the window frame should handle F10 for activating menubars.

Inherited from

WindowProps.handleMenubarAccel

---

hasDefault?

optional hasDefault: boolean

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

Whether the widget is the default widget.

Inherited from

WindowProps.hasDefault

---

hasFocus?

optional hasFocus: boolean

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

Whether the widget has the input focus.

Inherited from

WindowProps.hasFocus

---

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

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

WindowProps.heightRequest

---

hexpand?

optional hexpand: boolean

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

Whether to expand horizontally.

Inherited from

WindowProps.hexpand

---

hexpandSet?

optional hexpandSet: boolean

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

Whether to use the hexpand property.

Inherited from

WindowProps.hexpandSet

---

hideOnClose?

optional hideOnClose: boolean

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

If this window should be hidden instead of destroyed when the user clicks the close button.

Inherited from

WindowProps.hideOnClose

---

iconName?

optional iconName: string

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

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

See [class@Gtk.IconTheme] for more details.

Inherited from

WindowProps.iconName

---

isActive?

optional isActive: boolean

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

Whether the toplevel is the currently active window.

Inherited from

WindowProps.isActive

---

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

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

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

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

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

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

WindowProps.marginTop

---

maximized?

optional maximized: boolean

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

Whether the window is maximized.

Setting this property is the equivalent of calling [method@Gtk.Window.maximize] or [method@Gtk.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.

Inherited from

WindowProps.maximized

---

mnemonicsVisible?

optional mnemonicsVisible: boolean

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

Whether mnemonics are currently visible in this window.

This property is maintained by GTK based on user input, and should not be set by applications.

Inherited from

WindowProps.mnemonicsVisible

---

modal?

optional modal: boolean

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

If true, the window is modal.

Inherited from

WindowProps.modal

---

name?

optional name: string

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

The name of the widget.

Inherited from

WindowProps.name

---

onActivateDefault()?

optional onActivateDefault: (self) => void

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

Emitted when the user activates the default widget.

This is a keybinding signal.

The keybindings for this signal are all forms of the Enter key.

Parameters

Parameter	Type
self	Window

Returns

void

Inherited from

WindowProps.onActivateDefault

---

onActivateFocus()?

optional onActivateFocus: (self) => void

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

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

This is a keybinding signal.

The default binding for this signal is ␣.

Parameters

Parameter	Type
self	Window

Returns

void

Inherited from

WindowProps.onActivateFocus

---

onClose()?

optional onClose: (self) => void

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

Emitted when the user uses a keybinding to close the dialog.

This is a keybinding signal.

The default binding for this signal is the Escape key.

Parameters

Parameter	Type
self	Dialog

Returns

void

---

onCloseRequest()?

optional onCloseRequest: (self) => boolean

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

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

Parameters

Parameter	Type
self	Window

Returns

boolean

Inherited from

WindowProps.onCloseRequest

---

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

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

WindowProps.onDirectionChanged

---

onEnableDebugging()?

optional onEnableDebugging: (self, toggle) => boolean

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

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

Parameters

Parameter	Type
self	Window
toggle	boolean

Returns

boolean

Inherited from

WindowProps.onEnableDebugging

---

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

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

WindowProps.onKeynavFailed

---

onKeysChanged()?

optional onKeysChanged: (self) => void

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

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

Parameters

Parameter	Type
self	Window

Returns

void

Inherited from

WindowProps.onKeysChanged

---

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

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

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

WindowProps.onMoveFocus

---

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

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

WindowProps.onRealize

---

onResponse()?

optional onResponse: (self, responseId) => void

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

Emitted when an action widget is clicked.

The signal is also emitted when the dialog receives a delete event, and when [method@Gtk.Dialog.response] is called. On a delete event, the response ID is %GTK_RESPONSE_DELETE_EVENT. Otherwise, it depends on which action widget was clicked.

Parameters

Parameter	Type
self	Dialog
responseId	number

Returns

void

---

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

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

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

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

WindowProps.onUnrealize

---

opacity?

optional opacity: number

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

The requested opacity of the widget.

Inherited from

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

WindowProps.overflow

---

parent?

optional parent: Widget

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

The parent widget of this widget.

Inherited from

WindowProps.parent

---

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

WindowProps.receivesDefault

---

ref?

optional ref: Ref<Dialog>

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

Overrides

WindowProps.ref

---

resizable?

optional resizable: boolean

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

If true, users can resize the window.

Inherited from

WindowProps.resizable

---

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

WindowProps.root

---

scaleFactor?

optional scaleFactor: number

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

The scale factor of the widget.

Inherited from

WindowProps.scaleFactor

---

sensitive?

optional sensitive: boolean

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

Whether the widget responds to input.

Inherited from

WindowProps.sensitive

---

startupId?

optional startupId: string

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

A write-only property for setting window's startup notification identifier.

Inherited from

WindowProps.startupId

---

suspended?

optional suspended: boolean

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

Whether the window is suspended.

See [method@Gtk.Window.is_suspended] for details about what suspended means.

Inherited from

WindowProps.suspended

---

title?

optional title: string

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

The title of the window.

Inherited from

WindowProps.title

---

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

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

WindowProps.tooltipText

---

useHeaderBar?

optional useHeaderBar: number

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

%TRUE if the dialog uses a headerbar for action buttons instead of the action-area.

For technical reasons, this property is declared as an integer property, but you should only set it to %TRUE or %FALSE.

Creating a dialog with headerbar

Builtin GtkDialog subclasses such as [class@Gtk.ColorChooserDialog] set this property according to platform conventions (using the [property@Gtk.Settings:gtk-dialogs-use-header] setting).

Here is how you can achieve the same:

g_object_get (settings, "gtk-dialogs-use-header", &header, NULL);
dialog = g_object_new (GTK_TYPE_DIALOG, header, TRUE, NULL);

---

valign?

optional valign: Align

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

How to distribute vertical space if widget gets extra space.

Inherited from

WindowProps.valign

---

vexpand?

optional vexpand: boolean

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

Whether to expand vertically.

Inherited from

WindowProps.vexpand

---

vexpandSet?

optional vexpandSet: boolean

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

Whether to use the vexpand property.

Inherited from

WindowProps.vexpandSet

---

visible?

optional visible: boolean

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

Whether the widget is visible.

Inherited from

WindowProps.visible

---

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

WindowProps.widthRequest