Dialog

open class Dialog : Window, DialogProtocol

Dialog boxes are a convenient way to prompt the user for a small amount of input, e.g. to display a message, ask a question, or anything else that does not require extensive effort on the user’s part.

GTK+ treats a dialog as a window split vertically. The top section is a GtkVBox, and is where widgets such as a GtkLabel or a GtkEntry should be packed. The bottom area is known as the “action area”. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply.

GtkDialog boxes are created with a call to gtk_dialog_new() or gtk_dialog_new_with_buttons(). gtk_dialog_new_with_buttons() is recommended; it allows you to set the dialog title, some convenient flags, and add simple buttons.

If “dialog” is a newly created dialog, the two primary areas of the window can be accessed through gtk_dialog_get_content_area() and gtk_dialog_get_action_area(), as can be seen from the example below.

A “modal” dialog (that is, one which freezes the rest of the application from user input), can be created by calling gtk_window_set_modal() on the dialog. Use the GTK_WINDOW() macro to cast the widget returned from gtk_dialog_new() into a GtkWindow. When using gtk_dialog_new_with_buttons() you can also pass the GTK_DIALOG_MODAL flag to make a dialog modal.

If you add buttons to GtkDialog using gtk_dialog_new_with_buttons(), gtk_dialog_add_button(), gtk_dialog_add_buttons(), or gtk_dialog_add_action_widget(), clicking the button will emit a signal called GtkDialog::response 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 GtkResponseType enumeration (these all have values less than zero). If a dialog receives a delete event, the GtkDialog::response signal will be emitted with a response ID of GTK_RESPONSE_DELETE_EVENT.

If you want to block waiting for a dialog to return before returning control flow to your code, you can call gtk_dialog_run(). This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked.

For the simple dialog in the following example, in reality you’d probably use GtkMessageDialog to save yourself 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: (C Language Example):

// Function to open a dialog box with a message
void
quick_message (GtkWindow *parent, gchar *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_widget_destroy),
                           dialog);

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

 gtk_container_add (GTK_CONTAINER (content_area), label);
 gtk_widget_show_all (dialog);
}

GtkDialog as GtkBuildable

The GtkDialog implementation of the GtkBuildable interface exposes the vbox and action_area as internal children with the names “vbox” and “action_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">
      <property name="can-default">True</property>
    </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>

The Dialog type acts as a reference-counted owner of an underlying GtkDialog instance. It provides the methods that can operate on this data type through DialogProtocol conformance. Use Dialog as a strong reference or owner of a GtkDialog instance.

Show on GitHub 
  • Designated initialiser from the underlying `C` data type.

    This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Dialog instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GtkDialog>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Dialog instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GtkDialog>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Dialog instance.

    Declaration

    Swift

    @inlinable
override public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Dialog instance.

    Declaration

    Swift

    @inlinable
override public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Dialog instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GtkDialog>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the Dialog instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GtkDialog>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. Will retain GtkDialog. i.e., ownership is transferred to the Dialog instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GtkDialog>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements DialogProtocol Will retain GtkDialog.

    Declaration

    Swift

    @inlinable
public init<T>(dialog other: T) where T : DialogProtocol

    Parameters

    other

    an instance of a related type that implements DialogProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to DialogProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to DialogProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to DialogProtocol.

    Declaration

    Swift

    @inlinable
override public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to DialogProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to DialogProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to DialogProtocol.

    Declaration

    Swift

    @inlinable
required public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to DialogProtocol.

    Declaration

    Swift

    @inlinable
override public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to DialogProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Creates a new dialog box.

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

    Declaration

    Swift

    @inlinable
public init()
    Show on GitHub

  • Convenience constructor to create a dialog with a single button. This creates a new GtkDialog with title title (or NULL for the default title; see gtk_window_set_title()). The flags argument can be used to make the dialog modal (GTK_DIALOG_MODAL) and/or to have it destroyed along with its transient parent (GTK_DIALOG_DESTROY_WITH_PARENT). After flags, the button text and response ID pairs should be listed. The button text can be an arbitrary text. If the user clicks the dialog button, GtkDialog will emit the “response” signal with the corresponding response ID. If a GtkDialog receives the “delete-event” signal, it will emit ::response with a response ID of GTK_RESPONSE_DELETE_EVENT. However, destroying a dialog does not emit the ::response signal; so be careful relying on ::response when using the GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, so the first button in the list will be the leftmost button in the dialog. @param title Title of the dialog @param parent parent window @param flags flags to use such as GTK_DIALOG_MODAL @param first_button_text text to display for the button @param response_type any positive number, or one of the values in the GtkResponseType enumeration.

    Declaration

    Swift

    @inlinable
convenience init(title: UnsafePointer<gchar>! = nil, flags: DialogFlags = .modal, text: String, responseType: ResponseType = .ok)

    Parameters

    title

    Title of the dialog
    flags

    flags to use such as .modal (default) or .destroy_with_parent
    text

    title of the button
    responseType

    response type for the button (default: .accept)
    Show on GitHub

  • Convenience constructor to create a dialog with a single button. This creates a new GtkDialog with title title (or NULL for the default title; see gtk_window_set_title()) and transient parent parent. The flags argument can be used to make the dialog modal (GTK_DIALOG_MODAL) and/or to have it destroyed along with its transient parent (GTK_DIALOG_DESTROY_WITH_PARENT). After flags, the button text and response ID pairs should be listed. The button text can be an arbitrary text. If the user clicks the dialog button, GtkDialog will emit the “response” signal with the corresponding response ID. If a GtkDialog receives the “delete-event” signal, it will emit ::response with a response ID of GTK_RESPONSE_DELETE_EVENT. However, destroying a dialog does not emit the ::response signal; so be careful relying on ::response when using the GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, so the first button in the list will be the leftmost button in the dialog. @param title @param parent @param flags flags to use such as GTK_DIALOG_MODAL @param first_button_text text to display for the button @param response_type any positive number, or one of the values in the GtkResponseType enumeration.

    Declaration

    Swift

    @inlinable
convenience init<W>(title: UnsafePointer<gchar>! = nil, parent: W, flags: DialogFlags = .modal, text: String, responseType: ResponseType = .ok) where W : WindowProtocol

    Parameters

    title

    Title of the dialog
    parent

    parent window
    flags

    flags to use such as .modal (default) or .destroy_with_parent
    text

    title of the button
    responseType

    response type for the button
    Show on GitHub

  • Convenience constructor to create a dialog with two buttons. This creates a new GtkDialog with title title (or NULL for the default title; see gtk_window_set_title()) and transient parent parent. The flags argument can be used to make the dialog modal (GTK_DIALOG_MODAL) and/or to have it destroyed along with its transient parent (GTK_DIALOG_DESTROY_WITH_PARENT). After flags, the button text and response ID pairs should be listed. Each button text can be an arbitrary text. If the user clicks the dialog button, GtkDialog will emit the “response” signal with the corresponding response ID. If a GtkDialog receives the “delete-event” signal, it will emit ::response with a response ID of GTK_RESPONSE_DELETE_EVENT. However, destroying a dialog does not emit the ::response signal; so be careful relying on ::response when using the GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, so the first button in the list will be the leftmost button in the dialog.

    Declaration

    Swift

    @inlinable
convenience init(title: UnsafePointer<gchar>! = nil, flags: DialogFlags = .modal, firstText: String, firstResponseType: ResponseType = .cancel, secondText: String, secondResponseType: ResponseType = .ok)

    Parameters

    title

    Title of the dialog
    flags

    flags to use such as .modal (default) or .destroy_with_parent
    firstText

    title of the first button
    firstResponseType

    response type for the first button
    secondText

    title of the second button
    secondResponseType

    response type for the second button
    Show on GitHub

  • Convenience constructor to create a dialog with two buttons. This creates a new GtkDialog with title title (or NULL for the default title; see gtk_window_set_title()) and transient parent parent. The flags argument can be used to make the dialog modal (GTK_DIALOG_MODAL) and/or to have it destroyed along with its transient parent (GTK_DIALOG_DESTROY_WITH_PARENT). After flags, the button text and response ID pairs should be listed. Each button text can be an arbitrary text. If the user clicks the dialog button, GtkDialog will emit the “response” signal with the corresponding response ID. If a GtkDialog receives the “delete-event” signal, it will emit ::response with a response ID of GTK_RESPONSE_DELETE_EVENT. However, destroying a dialog does not emit the ::response signal; so be careful relying on ::response when using the GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, so the first button in the list will be the leftmost button in the dialog.

    Declaration

    Swift

    @inlinable
convenience init<W>(title: UnsafePointer<gchar>! = nil, parent: W, flags: DialogFlags = .modal, firstText: String, firstResponseType: ResponseType = .cancel, secondText: String, secondResponseType: ResponseType = .ok) where W : WindowProtocol

    Parameters

    title

    Title of the dialog
    parent

    parent window
    flags

    flags to use such as .modal (default) or .destroy_with_parent
    firstText

    title of the first button
    firstResponseType

    response type for the first button
    secondText

    title of the second button
    secondResponseType

    response type for the second button
    Show on GitHub

  • Convenience constructor to create a dialog with three buttons. This creates a new GtkDialog with title title (or NULL for the default title; see gtk_window_set_title()) and transient parent parent. The flags argument can be used to make the dialog modal (GTK_DIALOG_MODAL) and/or to have it destroyed along with its transient parent (GTK_DIALOG_DESTROY_WITH_PARENT). After flags, the button text and response ID pairs should be listed. Each button text can be an arbitrary text. If the user clicks the dialog button, GtkDialog will emit the “response” signal with the corresponding response ID. If a GtkDialog receives the “delete-event” signal, it will emit ::response with a response ID of GTK_RESPONSE_DELETE_EVENT. However, destroying a dialog does not emit the ::response signal; so be careful relying on ::response when using the GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, so the first button in the list will be the leftmost button in the dialog.

    Declaration

    Swift

    @inlinable
convenience init(title: UnsafePointer<gchar>! = nil, flags: DialogFlags = .modal, firstText: String, firstResponseType: ResponseType = .help, secondText: String, secondResponseType: ResponseType = .cancel, thirdText: String, thirdResponseType: ResponseType = .ok)

    Parameters

    title

    Title of the dialog
    flags

    flags to use such as .modal (default) or .destroy_with_parent
    firstText

    title of the first button
    firstResponseType

    response type for the first button
    secondText

    title of the second button
    secondResponseType

    response type for the second button
    thirdText

    title of the third button
    thirdResponseType

    response type for the third button
    Show on GitHub

  • Convenience constructor to create a dialog with three buttons. This creates a new GtkDialog with title title (or NULL for the default title; see gtk_window_set_title()) and transient parent parent. The flags argument can be used to make the dialog modal (GTK_DIALOG_MODAL) and/or to have it destroyed along with its transient parent (GTK_DIALOG_DESTROY_WITH_PARENT). After flags, the button text and response ID pairs should be listed. Each button text can be an arbitrary text. If the user clicks the dialog button, GtkDialog will emit the “response” signal with the corresponding response ID. If a GtkDialog receives the “delete-event” signal, it will emit ::response with a response ID of GTK_RESPONSE_DELETE_EVENT. However, destroying a dialog does not emit the ::response signal; so be careful relying on ::response when using the GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, so the first button in the list will be the leftmost button in the dialog.

    Declaration

    Swift

    @inlinable
convenience init<W>(title: UnsafePointer<gchar>! = nil, parent: W, flags: DialogFlags = .modal, firstText: String, firstResponseType: ResponseType = .help, secondText: String, secondResponseType: ResponseType = .cancel, thirdText: String, thirdResponseType: ResponseType = .ok) where W : WindowProtocol

    Parameters

    title

    Title of the dialog
    parent

    parent window
    flags

    flags to use such as .modal (default) or .destroy_with_parent
    firstText

    title of the first button
    firstResponseType

    response type for the first button
    secondText

    title of the second button
    secondResponseType

    response type for the second button
    thirdText

    title of the third button
    thirdResponseType

    response type for the third button
    Show on GitHub