Class

GtkDialog

Description [src]

class Gtk.Dialog : Gtk.Window {
  parent_instance: GtkWindow
}

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

An example GtkDialog

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 gtk_dialog_new_with_buttons(), or use gtk_dialog_add_button(), gtk_dialog_add_buttons(), or gtk_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 GTK_RESPONSE_CLOSE or GTK_RESPONSE_CANCEL, the close button is omitted.

Clicking a button that was added as an action widget will emit the GtkDialog::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 GtkResponseType enumeration (these all have values less than zero). If a dialog receives a delete event, the GtkDialog::response signal will be emitted with the GTK_RESPONSE_DELETE_EVENT response ID.

Dialogs are created with a call to gtk_dialog_new() or gtk_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 gtk_window_set_modal() on the dialog. When using gtk_dialog_new_with_buttons(), you can also pass the GTK_DIALOG_MODAL flag to make a dialog modal.

For the simple dialog in the following example, a GtkMessageDialog 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 element, which can contain multiple 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 element to true.

GtkDialog supports adding action widgets by specifying “action“ as the “type“ attribute of a 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  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 GTK_ACCESSIBLE_ROLE_DIALOG role.

Hierarchy

hierarchy this GtkDialog implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 implements_3 GtkNative this--implements_3 implements_4 GtkRoot this--implements_4 implements_5 GtkShortcutManager this--implements_5 ancestor_0 GtkWindow ancestor_0--this ancestor_1 GtkWidget ancestor_1--ancestor_0 ancestor_2 GInitiallyUnowned ancestor_2--ancestor_1 ancestor_3 GObject ancestor_3--ancestor_2

Ancestors

Constructors

gtk_dialog_new

Creates a new dialog box.

gtk_dialog_new_with_buttons

Creates a new GtkDialog with the given title and transient parent.

Instance methods

gtk_dialog_add_action_widget

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

gtk_dialog_add_button

Adds a button with the given text.

gtk_dialog_add_buttons

Adds multiple buttons.

gtk_dialog_get_content_area

Returns the content area of dialog.

gtk_dialog_get_header_bar

Returns the header bar of dialog.

gtk_dialog_get_response_for_widget

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

gtk_dialog_get_widget_for_response

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

gtk_dialog_response

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

gtk_dialog_set_default_response

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

gtk_dialog_set_response_sensitive

A convenient way to sensitize/desensitize dialog buttons.

Methods inherited from GtkWindow (54)
gtk_window_close

Requests that the window is closed.

gtk_window_destroy

Drop the internal reference GTK holds on toplevel windows.

gtk_window_fullscreen

Asks to place window in the fullscreen state.

gtk_window_fullscreen_on_monitor

Asks to place window in the fullscreen state on the given monitor.

gtk_window_get_application

Gets the GtkApplication associated with the window.

gtk_window_get_child

Gets the child widget of window.

gtk_window_get_decorated

Returns whether the window has been set to have decorations.

gtk_window_get_default_size

Gets the default size of the window.

gtk_window_get_default_widget

Returns the default widget for window.

gtk_window_get_deletable

Returns whether the window has been set to have a close button.

gtk_window_get_destroy_with_parent

Returns whether the window will be destroyed with its transient parent.

gtk_window_get_focus

Retrieves the current focused widget within the window.

gtk_window_get_focus_visible

Gets whether “focus rectangles” are supposed to be visible.

gtk_window_get_group

Returns the group for window.

gtk_window_get_handle_menubar_accel

Returns whether this window reacts to F10 key presses by activating a menubar it contains.

Available since: 4.2

gtk_window_get_hide_on_close

Returns whether the window will be hidden when the close button is clicked.

gtk_window_get_icon_name

Returns the name of the themed icon for the window.

gtk_window_get_mnemonics_visible

Gets whether mnemonics are supposed to be visible.

gtk_window_get_modal

Returns whether the window is modal.

gtk_window_get_resizable

Gets the value set by gtk_window_set_resizable().

gtk_window_get_title

Retrieves the title of the window.

gtk_window_get_titlebar

Returns the custom titlebar that has been set with gtk_window_set_titlebar().

gtk_window_get_transient_for

Fetches the transient parent for this window.

Methods inherited from GtkWidget (159)
gtk_widget_action_set_enabled

Enable or disable an action installed with gtk_widget_class_install_action().

gtk_widget_activate

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

gtk_widget_activate_action

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_action_variant

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

gtk_widget_activate_default

Activates the default.activate action from widget.

gtk_widget_add_controller

Adds controller to widget so that it will receive events.

gtk_widget_add_css_class

Adds a style class to widget.

gtk_widget_add_mnemonic_label

Adds a widget to the list of mnemonic labels for this widget.

gtk_widget_add_tick_callback

Queues an animation frame update and adds a callback to be called before each frame.

gtk_widget_allocate

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

gtk_widget_child_focus

Called by widgets as the user moves around the window using keyboard shortcuts.

gtk_widget_compute_bounds

Computes the bounds for widget in the coordinate space of target.

gtk_widget_compute_expand

Computes whether a container should give this widget extra space when possible.

gtk_widget_compute_point

Translates the given point in widgets coordinates to coordinates relative to target’s coordinate system.

gtk_widget_compute_transform

Computes a matrix suitable to describe a transformation from widgets coordinate system into targets coordinate system.

gtk_widget_contains

Tests if the point at (x, y) is contained in widget.

gtk_widget_create_pango_context

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.

gtk_widget_create_pango_layout

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

gtk_drag_check_threshold

Checks to see if a drag movement has passed the GTK drag threshold.

gtk_widget_error_bell

Notifies the user about an input-related error on this widget.

gtk_widget_get_allocated_baseline

Returns the baseline that has currently been allocated to widget.

gtk_widget_get_allocated_height

Returns the height that has currently been allocated to widget.

gtk_widget_get_allocated_width

Returns the width that has currently been allocated to widget.

Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkNative (5)
gtk_native_get_renderer

Returns the renderer that is used for this GtkNative.

gtk_native_get_surface

Returns the surface of this GtkNative.

gtk_native_get_surface_transform

Retrieves the surface transform of self.

gtk_native_realize

Realizes a GtkNative.

gtk_native_unrealize

Unrealizes a GtkNative.

Methods inherited from GtkRoot (3)
gtk_root_get_display

Returns the display that this GtkRoot is on.

gtk_root_get_focus

Retrieves the current focused widget within the root.

gtk_root_set_focus

If focus is not the current focus widget, and is focusable, sets it as the focus widget for the root.

Properties

Gtk.Dialog:use-header-bar

TRUE if the dialog uses a headerbar for action buttons instead of the action-area.

Properties inherited from GtkWindow (23)
Gtk.Window:application

The GtkApplication associated with the window.

Gtk.Window:child

The child widget.

Gtk.Window:decorated

Whether the window should have a frame (also known as decorations).

Gtk.Window:default-height

The default height of the window.

Gtk.Window:default-widget

The default widget.

Gtk.Window:default-width

The default width of the window.

Gtk.Window:deletable

Whether the window frame should have a close button.

Gtk.Window:destroy-with-parent

If this window should be destroyed when the parent is destroyed.

Gtk.Window:display

The display that will display this window.

Gtk.Window:focus-visible

Whether ‘focus rectangles’ are currently visible in this window.

Gtk.Window:focus-widget

The focus widget.

Gtk.Window:fullscreened

Whether the window is fullscreen.

Gtk.Window:handle-menubar-accel

Whether the window frame should handle F10 for activating menubars.

Available since: 4.2

Gtk.Window:hide-on-close

If this window should be hidden when the users clicks the close button.

Gtk.Window:icon-name

Specifies the name of the themed icon to use as the window icon.

Gtk.Window:is-active

Whether the toplevel is the currently active window.

Gtk.Window:maximized

Whether the window is maximized.

Gtk.Window:mnemonics-visible

Whether mnemonics are currently visible in this window.

Gtk.Window:modal

If TRUE, the window is modal.

Gtk.Window:resizable

If TRUE, users can resize the window.

Gtk.Window:startup-id

A write-only property for setting window’s startup notification identifier.

Gtk.Window:title

The title of the window.

Gtk.Window:transient-for

The transient parent of the window.

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Signals

Gtk.Dialog::close

Emitted when the user uses a keybinding to close the dialog.

Gtk.Dialog::response

Emitted when an action widget is clicked.

Signals inherited from GtkWindow (5)
Gtk.Window::activate-default

Emitted when the user activates the default widget of window.

Gtk.Window::activate-focus

Emitted when the user activates the currently focused widget of window.

Gtk.Window::close-request

Emitted when the user clicks on the close button of the window.

Gtk.Window::enable-debugging

Emitted when the user enables or disables interactive debugging.

Gtk.Window::keys-changed

Emitted when the set of accelerators or mnemonics that are associated with window changes.

Signals inherited from GtkWidget (13)
Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

Gtk.Widget::hide

Emitted when widget is hidden.

Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

Gtk.Widget::map

Emitted when widget is going to be mapped.

Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

Gtk.Widget::move-focus

Emitted when the focus is moved.

Gtk.Widget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

Gtk.Widget::realize

Emitted when widget is associated with a GdkSurface.

Gtk.Widget::show

Emitted when widget is shown.

Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

Gtk.Widget::unmap

Emitted when widget is going to be unmapped.

Gtk.Widget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Class structure

struct GtkDialogClass {
  GtkWindowClass parent_class;
  void (* response) (
    GtkDialog* dialog,
    int response_id
  );
  void (* close) (
    GtkDialog* dialog
  );
  
}
Class members
parent_class
GtkWindowClass
 

The parent class.

response
void (* response) (
    GtkDialog* dialog,
    int response_id
  )
  No description available.
close
void (* close) (
    GtkDialog* dialog
  )
  No description available.

Virtual methods

Gtk.DialogClass.close
No description available.
Gtk.DialogClass.response

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