Dialog

Deprecated since version 4.10: Use Window instead

class Dialog(*args, **kwargs)

Superclasses: Window, Widget, InitiallyUnowned, Object

Subclasses: AppChooserDialog, ColorChooserDialog, FileChooserDialog, FontChooserDialog, MessageDialog, PageSetupUnixDialog, PrintUnixDialog

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

Constructors:

Dialog(**properties)
new() -> Gtk.Widget

Constructors

class Dialog

classmethod new() → Widget

Creates a new dialog box.

Widgets should not be packed into the GtkWindow directly, but into the content_area and action_area, as described above.

Deprecated since version 4.10: Use Window instead

Methods

class Dialog

add_action_widget(child: Widget, response_id: int) → None

Adds an activatable widget to the action area of a GtkDialog.

GTK connects a signal handler that will emit the response signal on the dialog when the widget is activated. The widget is appended to the end of the dialog’s action area.

If you want to add a non-activatable widget, simply pack it into the action_area field of the GtkDialog struct.

Deprecated since version 4.10: Use Window instead

Parameters:

• child – an activatable widget

• response_id – response ID for child

add_button(button_text: str, response_id: int) → Widget

Adds a button with the given text.

GTK arranges things so that clicking the button will emit the response signal with the given response_id. The button is appended to the end of the dialog’s action area. The button widget is returned, but usually you don’t need it.

Deprecated since version 4.10: Use Window instead

Parameters:

• button_text – text of button

• response_id – response ID for the button

add_buttons(*args)

The add_buttons() method adds several buttons to the Gtk.Dialog using the button data passed as arguments to the method. This method is the same as calling the Gtk.Dialog.add_button() repeatedly. The button data pairs - button text (or stock ID) and a response ID integer are passed individually. For example:

dialog.add_buttons(Gtk.STOCK_OPEN, 42, "Close", Gtk.ResponseType.CLOSE)

will add “Open” and “Close” buttons to dialog.

Deprecated since version 4.10: Use Window instead

Parameters:

args

get_content_area() → Box

Returns the content area of dialog.

Deprecated since version 4.10: Use Window instead

get_header_bar() → HeaderBar

Returns the header bar of dialog.

Note that the headerbar is only used by the dialog if the use_header_bar property is True.

Deprecated since version 4.10: Use Window instead

get_response_for_widget(widget: Widget) → int

Gets the response id of a widget in the action area of a dialog.

Deprecated since version 4.10: Use Window instead

Parameters:

widget – a widget in the action area of dialog

get_widget_for_response(response_id: int) → Widget | None

Gets the widget button that uses the given response ID in the action area of a dialog.

Deprecated since version 4.10: Use Window instead

Parameters:

response_id – the response ID used by the dialog widget

response(response_id: int) → None

Emits the ::response signal with the given response ID.

Used to indicate that the user has responded to the dialog in some way.

Deprecated since version 4.10: Use Window instead

Parameters:

response_id – response ID

set_default_response(response_id: int) → None

Sets the default widget for the dialog based on the response ID.

Pressing “Enter” normally activates the default widget.

Deprecated since version 4.10: Use Window instead

Parameters:

response_id – a response ID

set_response_sensitive(response_id: int, setting: bool) → None

A convenient way to sensitize/desensitize dialog buttons.

Calls gtk_widget_set_sensitive (widget, ``setting`)` for each widget in the dialog’s action area with the given response_id.

Deprecated since version 4.10: Use Window instead

Parameters:

• response_id – a response ID

• setting – True for sensitive

Properties

class Dialog

props.use_header_bar: int

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 ColorChooserDialog set this property according to platform conventions (using the 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);

Deprecated since version 4.10: Use Window instead

Signals

class Dialog.signals

close() → None

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.

Deprecated since version 4.10: Use Window instead

response(response_id: int) → None

Emitted when an action widget is clicked.

The signal is also emitted when the dialog receives a delete event, and when response is called. On a delete event, the response ID is DELETE_EVENT. Otherwise, it depends on which action widget was clicked.

Deprecated since version 4.10: Use Window instead

Parameters:

response_id – the response ID

Virtual Methods

class Dialog

do_close() → None

Signal emitted when the user uses a keybinding to close the dialog.

do_response(response_id: int) → None

Emits the ::response signal with the given response ID.

Used to indicate that the user has responded to the dialog in some way.

Deprecated since version 4.10: Use Window instead

Parameters:

response_id – response ID

Fields

class Dialog

parent_instance