Gtk.Dialog¶

class — extends Window, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

:::warning Deprecated since 4.10 This API is deprecated. :::

Dialogs are a convenient way to prompt the user for a small amount of input.

Typical uses are to display a message, ask a question, or anything else that does not require extensive effort on the user’s part.

The main area of a GtkDialog is called the "content area", and is yours to populate with widgets such a GtkLabel or GtkEntry, to present your information, questions, or tasks to the user.

In addition, dialogs allow you to add "action widgets". Most commonly, action widgets are buttons. Depending on the platform, action widgets may be presented in the header bar at the top of the window, or at the bottom of the window. To add action widgets, create your GtkDialog using Dialog.new_with_buttons, or use Dialog.add_button, Dialog.add_buttons, or Dialog.add_action_widget.

GtkDialogs uses some heuristics to decide whether to add a close button to the window decorations. If any of the action buttons use the response ID ResponseType.CLOSE or ResponseType.CANCEL, the close button is omitted.

Clicking a button that was added as an action widget will emit the Dialog.response signal with a response ID that you specified. GTK will never assign a meaning to positive response IDs; these are entirely user-defined. But for convenience, you can use the response IDs in the ResponseType enumeration (these all have values less than zero). If a dialog receives a delete event, the Dialog.response signal will be emitted with the ResponseType.DELETE_EVENT response ID.

Dialogs are created with a call to Dialog.new or Dialog.new_with_buttons. The latter is recommended; it allows you to set the dialog title, some convenient flags, and add buttons.

A “modal” dialog (that is, one which freezes the rest of the application from user input), can be created by calling Window.set_modal on the dialog. When using Dialog.new_with_buttons, you can also pass the DialogFlags.MODAL flag to make a dialog modal.

For the simple dialog in the following example, a MessageDialog would save some effort. But you’d need to create the dialog contents manually if you had more than a simple message in the dialog.

An example for simple GtkDialog usage:

// Function to open a dialog box with a message
void
quick_message (GtkWindow *parent, char *message)
{
 GtkWidget *dialog, *label, *content_area;
 GtkDialogFlags flags;

 // Create the widgets
 flags = GTK_DIALOG_DESTROY_WITH_PARENT;
 dialog = gtk_dialog_new_with_buttons ("Message",
                                       parent,
                                       flags,
                                       _("_OK"),
                                       GTK_RESPONSE_NONE,
                                       NULL);
 content_area = gtk_dialog_get_content_area (GTK_DIALOG (dialog));
 label = gtk_label_new (message);

 // Ensure that the dialog box is destroyed when the user responds

 g_signal_connect_swapped (dialog,
                           "response",
                           G_CALLBACK (gtk_window_destroy),
                           dialog);

 // Add the label, and show everything we’ve added

 gtk_box_append (GTK_BOX (content_area), label);
 gtk_widget_show (dialog);
}

GtkDialog as GtkBuildable¶

The GtkDialog implementation of the GtkBuildable interface exposes the content_area as an internal child with the name “content_area”.

GtkDialog supports a custom <action-widgets> element, which can contain multiple <action-widget> elements. The “response” attribute specifies a numeric response, and the content of the element is the id of widget (which should be a child of the dialogs action_area). To mark a response as default, set the “default” attribute of the <action-widget> element to true.

GtkDialog supports adding action widgets by specifying “action” as the “type” attribute of a <child> element. The widget will be added either to the action area or the headerbar of the dialog, depending on the “use-header-bar” property. The response id has to be associated with the action widget using the <action-widgets> element.

An example of a GtkDialog UI definition fragment:

<object class="GtkDialog" id="dialog1">
  <child type="action">
    <object class="GtkButton" id="button_cancel"/>
  </child>
  <child type="action">
    <object class="GtkButton" id="button_ok">
    </object>
  </child>
  <action-widgets>
    <action-widget response="cancel">button_cancel</action-widget>
    <action-widget response="ok" default="true">button_ok</action-widget>
  </action-widgets>
</object>

Accessibility¶

GtkDialog uses the AccessibleRole.DIALOG role.

Constructors¶

new¶

@classmethod
def new(cls) -> Widget

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Methods¶

add_action_widget¶

def add_action_widget(self, child: Widget, response_id: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

GTK connects a signal handler that will emit the Dialog.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.

Parameters:

child — an activatable widget
response_id — response ID for child

add_button¶

def add_button(self, button_text: str, response_id: int) -> Widget

:::warning Deprecated since 4.10 This API is deprecated. :::

Adds a button with the given text.

GTK arranges things so that clicking the button will emit the Dialog.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.

Parameters:

button_text — text of button
response_id — response ID for the button

get_content_area¶

def get_content_area(self) -> Box

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns the content area of dialog.

get_header_bar¶

def get_header_bar(self) -> HeaderBar

:::warning Deprecated since 4.10 This API is deprecated. :::

Returns the header bar of dialog.

Note that the headerbar is only used by the dialog if the Dialog.use-header-bar property is True.

get_response_for_widget¶

def get_response_for_widget(self, widget: Widget) -> int

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

widget — a widget in the action area of dialog

get_widget_for_response¶

def get_widget_for_response(self, response_id: int) -> Widget | None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Parameters:

response_id — the response ID used by the dialog widget

response¶

def response(self, response_id: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

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

Parameters:

response_id — response ID

set_default_response¶

def set_default_response(self, response_id: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

Pressing “Enter” normally activates the default widget.

Parameters:

response_id — a response ID

set_response_sensitive¶

def set_response_sensitive(self, response_id: int, setting: bool) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

Parameters:

response_id — a response ID
setting — True for sensitive

Virtual methods¶

do_close¶

def do_close(self) -> None

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

do_response¶

def do_response(self, response_id: int) -> None

:::warning Deprecated since 4.10 This API is deprecated. :::

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

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

Parameters:

response_id — response ID

Properties¶

use_header_bar¶

use_header_bar: int  # read/write

:::warning Deprecated since 4.10 This API is deprecated. :::

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 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);

Signals¶

close¶

def on_close(self) -> None: ...

:::warning Deprecated since 4.10 This API is deprecated. :::

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.

response¶

def on_response(self, response_id: int) -> None: ...

:::warning Deprecated since 4.10 This API is deprecated. :::

Emitted when an action widget is clicked.

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