NativeDialog

class NativeDialog(**properties: Any)

Superclasses: Object

Subclasses: FileChooserNative

Base class for platform dialogs that don’t use GtkDialog.

Native dialogs are used in order to integrate better with a platform, by looking the same as other native applications and supporting platform specific features.

The Dialog functions cannot be used on such objects, but we need a similar API in order to drive them. The GtkNativeDialog object is an API that allows you to do this. It allows you to set various common properties on the dialog, as well as show and hide it and get a response signal when the user finished with the dialog.

Note that unlike GtkDialog, GtkNativeDialog objects are not toplevel widgets, and GTK does not keep them alive. It is your responsibility to keep a reference until you are done with the object.

Methods

class NativeDialog

destroy() → None

Destroys a dialog.

When a dialog is destroyed, it will break any references it holds to other objects.

If it is visible it will be hidden and any underlying window system resources will be destroyed.

Note that this does not release any reference to the object (as opposed to destroying a GtkWindow) because there is no reference from the windowing system to the GtkNativeDialog.

do_hide(self) → None

do_response(self, response_id: int) → None

Parameters:

response_id

do_show(self) → None

get_modal() → bool

Returns whether the dialog is modal.

get_title() → str | None

Gets the title of the GtkNativeDialog.

get_transient_for() → Window | None

Fetches the transient parent for this window.

get_visible() → bool

Determines whether the dialog is visible.

hide() → None

Hides the dialog if it is visible, aborting any interaction.

Once this is called the response signal will not be emitted until after the next call to show.

If the dialog is not visible this does nothing.

set_modal(modal: bool) → None

Sets a dialog modal or non-modal.

Modal dialogs prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use set_transient_for to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

Parameters:

modal – whether the window is modal

set_title(title: str) → None

Sets the title of the GtkNativeDialog.

Parameters:

title – title of the dialog

set_transient_for(parent: Window | None = None) → None

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.

Passing None for parent unsets the current transient window.

Parameters:

parent – parent window

show() → None

Shows the dialog on the display.

When the user accepts the state of the dialog the dialog will be automatically hidden and the response signal will be emitted.

Multiple calls while the dialog is visible will be ignored.

Properties

class NativeDialog

props.modal: bool

Whether the window should be modal with respect to its transient parent.

props.title: str

The title of the dialog window

props.transient_for: Window

The transient parent of the dialog, or None for none.

props.visible: bool

Whether the window is currently visible.

Signals

class NativeDialog.signals

response(response_id: int) → None

Emitted when the user responds to the dialog.

When this is called the dialog has been hidden.

If you call hide before the user responds to the dialog this signal will not be emitted.

Parameters:

response_id – the response ID

Virtual Methods

class NativeDialog

do_hide() → None

Hides the dialog if it is visible, aborting any interaction.

Once this is called the response signal will not be emitted until after the next call to show.

If the dialog is not visible this does nothing.

do_response(response_id: int) → None

class handler for the GtkNativeDialog::response signal

Parameters:

response_id

do_show() → None

Shows the dialog on the display.

When the user accepts the state of the dialog the dialog will be automatically hidden and the response signal will be emitted.

Multiple calls while the dialog is visible will be ignored.

Fields

class NativeDialog

parent_instance