Dialog
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 ctor@Gtk.Dialog.new_with_buttons, or use method@Gtk.Dialog.add_button, method@Gtk.Dialog.add_buttons, or method@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 signal@Gtk.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 enum@Gtk.ResponseType enumeration (these all have values less than zero). If a dialog receives a delete event, the signal@Gtk.Dialog::response signal will be emitted with the %GTK_RESPONSE_DELETE_EVENT response ID.
Dialogs are created with a call to ctor@Gtk.Dialog.new or ctor@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 method@Gtk.Window.set_modal on the dialog. When using ctor@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 class@Gtk.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
Inheritors
Constructors
Properties
The accessible role of the given GtkAccessible implementation.
The GtkApplication associated with the window.
A list of css classes applied to this widget.
The default widget.
If this window should be destroyed when the parent is destroyed.
Whether the widget should grab focus when it is clicked with the mouse.
Whether 'focus rectangles' are currently visible in this window.
The focus widget.
Whether the window frame should handle F10 for activating menubars.
Enables or disables the emission of the ::query-tooltip signal on @widget.
Whether to use the hexpand property.
If this window should be hidden when the users clicks the close button.
The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
Margin on bottom side of widget.
Margin on start of widget, horizontally.
Whether mnemonics are currently visible in this window.
Whether the widget will receive the default action when it is focused.
The scale factor of the widget.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Sets the text of tooltip to be the given string.
The transient parent of the window.
Whether to use the vexpand property.
Functions
Enable or disable an action installed with gtk_widget_class_install_action().
Looks up the action in the action groups associated with
Activates the default.activate action from @widget.
For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
Adds an activatable widget to the action area of a GtkDialog.
Adds @controller to @widget so that it will receive events.
Adds a style class to @widget.
Adds a widget to the list of mnemonic labels for this widget.
Queues an animation frame update and adds a callback to be called before each frame.
This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.
Requests the user's screen reader to announce the given message.
Called by widgets as the user moves around the window using keyboard shortcuts.
Computes the bounds for @widget in the coordinate space of @target.
Computes whether a container should give this widget extra space when possible.
Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.
Computes a matrix suitable to describe a transformation from
Emitted when the user activates the default widget of @window.
Emitted when the user activates the currently focused widget of @window.
Emitted when the user uses a keybinding to close the dialog.
Emitted when the user clicks on the close button of the window.
Signals that all holders of a reference to the widget should release the reference that they hold.
Emitted when the text direction of a widget changes.
Emitted when the user enables or disables interactive debugging.
Emitted when @widget is hidden.
Emitted if keyboard navigation fails.
emitted when the set of accelerators or mnemonics that are associated with @window changes.
Emitted when @widget is going to be mapped.
Emitted when a widget is activated via a mnemonic.
Emitted when the focus is moved.
Emitted when the widget’s tooltip is about to be shown.
Emitted when @widget is associated with a GdkSurface.
Emitted when an action widget is clicked.
Emitted when @widget is shown.
Emitted when the widget state changes.
Emitted when @widget is going to be unmapped.
Emitted when the GdkSurface associated with @widget is destroyed.
Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.
Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.
Clears the template children for the given widget.
Checks to see if a drag movement has passed the GTK drag threshold.
Asks to place @window in the fullscreen state.
Asks to place @window in the fullscreen state on the given @monitor.
Retrieves the accessible parent for an accessible object.
Retrieves the accessible role of an accessible object.
Returns the baseline that has currently been allocated to @widget.
Returns the height that has currently been allocated to @widget.
Returns the width that has currently been allocated to @widget.
Gets the first ancestor of @widget with type @widget_type.
Retrieves the accessible implementation for the given GtkAccessible.
Returns the baseline that has currently been allocated to @widget.
Gets the ID of the @buildable object.
Gets the value set with gtk_widget_set_child_visible().
Gets the clipboard object for @widget.
Returns the content area of @dialog.
Gets the reading direction for a particular widget.
Get the GdkDisplay for the toplevel window associated with this widget.
Retrieves the first accessible child of an accessible object.
Returns the widget’s first child.
Returns the current focus child of @widget.
Gets the font map of @widget.
Obtains the frame clock for a widget.
Returns the group for @window.
Returns the header bar of @dialog.
Returns the widget’s last child.
Retrieves the next accessible sibling of an accessible object
Returns the widget’s next sibling.
Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.
Query a platform state, such as focus.
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
Returns the widget’s previous sibling.
Gets the primary clipboard of @widget.
Determines whether @widget is realized.
Returns the renderer that is used for this GtkNative.
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Gets the response id of a widget in the action area of a dialog.
Returns the display that this GtkRoot is on.
Returns the widget’s sensitivity.
Gets the settings object holding the settings used for this widget.
Returns the content width or height of the widget.
Returns the widget state as a flag set.
Returns the style context associated to @widget.
Returns the surface of this GtkNative.
Fetch an object build from the template XML for @widget_type in this @widget instance.
Determines whether the widget is visible.
Gets the widget button that uses the given response ID in the action area of a dialog.
Returns whether @css_class is currently applied to @widget.
Determines whether @widget is the current default widget within its toplevel.
Determines if the widget should show a visible indication that it has the global input focus.
Returns whether the widget is currently being destroyed.
Creates and initializes child widgets defined in templates.
Inserts @group into @widget.
Inserts @widget into the child widget list of @parent.
Inserts @widget into the child widget list of @parent.
Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.
Determines whether @widget can be drawn to.
Retrieves the current fullscreen state of @window.
Retrieves the current maximized state of @window.
Returns the widget’s effective sensitivity.
Retrieves the current suspended state of @window.
Emits the ::keynav-failed signal on the widget.
Returns the widgets for which this widget is the target of a mnemonic.
Emits the ::mnemonic-activate signal.
Realizes a GtkNative.
Unrealizes a GtkNative.
Returns a GListModel to track the children of @widget.
Returns a GListModel to track the class@Gtk.EventControllers of @widget.
Presents a window to the user in response to an user interaction.
Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.
Flags a widget to have its size renegotiated.
Removes @controller from @widget, so that it doesn't process events anymore.
Removes a style from @widget.
Removes a widget from the list of mnemonic labels for this widget.
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
Resets the accessible @property to its default value.
Resets the accessible @relation to its default value.
Resets the accessible @state to its default value.
Sets the parent and sibling of an accessible object.
Sets whether @widget should be mapped along with its parent.
Sets a named cursor to be shown when pointer devices point towards @widget.
Sets the default widget for the dialog based on the response ID.
Sets the default size of a window.
Sets the reading direction on a particular widget.
Sets the GdkDisplay where the @window is displayed.
Set @child as the current focus child of @widget.
Sets the font map to use for Pango rendering.
Set all margins to the same value.
Set start and end margin to horizontal and top and bottom margin to vertical
Set margins.
A convenient way to sensitize/desensitize dialog buttons.
Sets the sensitivity of a widget.
Sets the minimum size of a widget.
Sets the startup notification ID.
Turns on flag values in the current widget state.
Sets the visibility state of @widget.
Returns whether @widget should contribute to the measuring and allocation of its parent.
Triggers a tooltip query on the display where the toplevel of @widget is located.
Asks to remove the fullscreen state for @window, and return to its previous state.
Asks to unmaximize @window.
Asks to unminimize the specified @window.
Turns off flag values for the current widget state.
Updates the next accessible sibling of @self.