Gtk.NativeDialog

Subclasses:

Gtk.FileChooserNative

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	destroy ()
	get_modal ()
	get_title ()
	get_transient_for ()
	get_visible ()
	hide ()
	set_modal (modal)
	set_title (title)
	set_transient_for (parent)
	show ()

Virtual Methods

Inherited:

GObject.Object (7)

	do_hide ()
	do_response (response_id)
	do_show ()

Properties

Name	Type	Flags	Short Description
modal	bool	r/w/en
title	str	r/w
transient-for	Gtk.Window	r/w/c/en
visible	bool	r/w/en

Signals

Inherited:

GObject.Object (1)

Name	Short Description
response	Emitted when the user responds to the dialog.

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	GObject.Object	r

Class Details

class Gtk.NativeDialog(**kwargs)

Bases:

GObject.Object

Abstract:

Yes

Structure:

Gtk.NativeDialogClass

Native dialogs are platform dialogs that don’t use GtkDialog.

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

The [class`Gtk`.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 [signal`Gtk`.NativeDialog::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.

destroy()

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.

get_modal()

Returns:

True if the dialog is set to be modal

Return type:

bool

Returns whether the dialog is modal.

get_title()

Returns:

the title of the dialog, or None if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed.

Return type:

str or None

Gets the title of the GtkNativeDialog.

get_transient_for()

Returns:

the transient parent for this window, or None if no transient parent has been set.

Return type:

Gtk.Window or None

Fetches the transient parent for this window.

get_visible()

Returns:

True if the dialog is visible

Return type:

bool

Determines whether the dialog is visible.

hide()

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

Once this is called the [signal`Gtk`.NativeDialog::response] signal will *not* be emitted until after the next call to [method`Gtk`.NativeDialog.show].

If the dialog is not visible this does nothing.

set_modal(modal)

Parameters:

modal (bool) – whether the window is modal

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 [method`Gtk`.NativeDialog.set_transient_for] to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

set_title(title)

Parameters:

title (str) – title of the dialog

Sets the title of the GtkNativeDialog.

set_transient_for(parent)

Parameters:

parent (Gtk.Window or None) – parent window

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.

show()

Shows the dialog on the display.

When the user accepts the state of the dialog the dialog will be automatically hidden and the [signal`Gtk`.NativeDialog::response] signal will be emitted.

Multiple calls while the dialog is visible will be ignored.

do_hide() virtual

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

Once this is called the [signal`Gtk`.NativeDialog::response] signal will *not* be emitted until after the next call to [method`Gtk`.NativeDialog.show].

If the dialog is not visible this does nothing.

do_response(response_id) virtual

Parameters:

response_id (int) –

class handler for the GtkNativeDialog::response signal

do_show() virtual

Shows the dialog on the display.

When the user accepts the state of the dialog the dialog will be automatically hidden and the [signal`Gtk`.NativeDialog::response] signal will be emitted.

Multiple calls while the dialog is visible will be ignored.

Signal Details

Gtk.NativeDialog.signals.response(native_dialog, response_id)

Signal Name:

response

Flags:

RUN_LAST

Parameters:

• native_dialog (Gtk.NativeDialog) – The object which received the signal

• response_id (int) – the response ID

Emitted when the user responds to the dialog.

When this is called the dialog has been hidden.

If you call [method`Gtk`.NativeDialog.hide] before the user responds to the dialog this signal will not be emitted.

Property Details

Gtk.NativeDialog.props.modal

Name:

modal

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.NativeDialog.props.title

Name:

title

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The title of the dialog window

Gtk.NativeDialog.props.transient_for

Name:

transient-for

Type:

Gtk.Window

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT, EXPLICIT_NOTIFY

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

Gtk.NativeDialog.props.visible

Name:

visible

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the window is currently visible.