GtkDialog — Create popup windows
GtkWidget * | gtk_dialog_new () |
GtkWidget * | gtk_dialog_new_with_buttons () |
void | gtk_dialog_response () |
GtkWidget * | gtk_dialog_add_button () |
void | gtk_dialog_add_buttons () |
void | gtk_dialog_add_action_widget () |
void | gtk_dialog_set_default_response () |
void | gtk_dialog_set_response_sensitive () |
int | gtk_dialog_get_response_for_widget () |
GtkWidget * | gtk_dialog_get_widget_for_response () |
GtkWidget * | gtk_dialog_get_content_area () |
GtkWidget * | gtk_dialog_get_header_bar () |
int | use-header-bar | Read / Write / Construct Only |
struct | GtkDialog |
struct | GtkDialogClass |
enum | GtkDialogFlags |
enum | GtkResponseType |
GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkWindow ╰── GtkDialog ├── GtkAppChooserDialog ├── GtkColorChooserDialog ├── GtkFileChooserDialog ├── GtkFontChooserDialog ├── GtkMessageDialog ├── GtkPageSetupUnixDialog ╰── GtkPrintUnixDialog
GtkDialog implements GtkAccessible, GtkBuildable, GtkConstraintTarget, GtkNative, GtkShortcutManager and GtkRoot.
#include <gtk/gtk.h>
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 GtkBox, 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.
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 “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 “response” signal will be emitted with a response ID of GTK_RESPONSE_DELETE_EVENT.
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:
The GtkDialog implementation of the GtkBuildable interface exposes the content_area
and action_area
as internal children with the names “content_area” 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:
GtkDialog uses the GTK_ACCESSIBLE_ROLE_DIALOG role.
GtkWidget *
gtk_dialog_new (void
);
Creates a new dialog box.
Widgets should not be packed into this GtkWindow directly, but into the content_area
and action_area
, as described above.
the new dialog as a GtkWidget
GtkWidget * gtk_dialog_new_with_buttons (const char *title
,GtkWindow *parent
,GtkDialogFlags flags
,const char *first_button_text
,...
);
Creates a new GtkDialog with title title
(or NULL
for the default title; see gtk_window_set_title()
) and transient parent parent
(or NULL
for none; see gtk_window_set_transient_for()
). 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
, button text/response ID pairs should be listed, with a NULL
pointer ending the list. Button text can be arbitrary text. A response ID can be any positive number, or one of the values in the GtkResponseType enumeration. If the user clicks one of these dialog buttons, GtkDialog will emit the “response” signal with the corresponding response ID. If a GtkDialog receives a delete event, 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.
Here’s a simple example:
// 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); }
title | Title of the dialog, or | [allow-none] |
parent | Transient parent of the dialog, or | [allow-none] |
flags | from GtkDialogFlags | |
first_button_text | text to go in first button, or | [allow-none] |
... | response ID for first button, then additional buttons, ending with |
a new GtkDialog
void gtk_dialog_response (GtkDialog *dialog
,int response_id
);
Emits the “response” signal with the given response ID.
Used to indicate that the user has responded to the dialog in some way.
dialog | ||
response_id | response ID |
GtkWidget * gtk_dialog_add_button (GtkDialog *dialog
,const char *button_text
,int response_id
);
Adds a button with the given text and sets things up 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.
dialog | ||
button_text | text of button | |
response_id | response ID for the button |
void gtk_dialog_add_buttons (GtkDialog *dialog
,const char *first_button_text
,...
);
Adds more buttons, same as calling gtk_dialog_add_button()
repeatedly. The variable argument list should be NULL
-terminated as with gtk_dialog_new_with_buttons()
. Each button must have both text and response ID.
dialog | ||
first_button_text | button text | |
... | response ID for first button, then more text-response_id pairs |
void gtk_dialog_add_action_widget (GtkDialog *dialog
,GtkWidget *child
,int response_id
);
Adds an activatable widget to the action area of a GtkDialog, connecting 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.
dialog | ||
child | an activatable widget | |
response_id | response ID for |
void gtk_dialog_set_default_response (GtkDialog *dialog
,int response_id
);
Sets the last widget in the dialog’s action area with the given response_id
as the default widget for the dialog. Pressing “Enter” normally activates the default widget.
dialog | ||
response_id | a response ID |
void gtk_dialog_set_response_sensitive (GtkDialog *dialog
,int response_id
,gboolean setting
);
Calls gtk_widget_set_sensitive (widget, @setting)
for each widget in the dialog’s action area with the given response_id
. A convenient way to sensitize/desensitize dialog buttons.
dialog | ||
response_id | a response ID | |
setting |
|
int gtk_dialog_get_response_for_widget (GtkDialog *dialog
,GtkWidget *widget
);
Gets the response id of a widget in the action area of a dialog.
dialog | ||
widget | a widget in the action area of |
the response id of widget
, or GTK_RESPONSE_NONE
if widget
doesn’t have a response id set.
GtkWidget * gtk_dialog_get_widget_for_response (GtkDialog *dialog
,int response_id
);
Gets the widget button that uses the given response ID in the action area of a dialog.
dialog | ||
response_id | the response ID used by the |
the widget
button that uses the given response_id
, or NULL
.
[nullable][transfer none]
GtkWidget *
gtk_dialog_get_content_area (GtkDialog *dialog
);
Returns the content area of dialog
.
dialog |
GtkWidget *
gtk_dialog_get_header_bar (GtkDialog *dialog
);
Returns the header bar of dialog
. Note that the headerbar is only used by the dialog if the “use-header-bar” property is TRUE
.
dialog |
the header bar.
[type Gtk.HeaderBar][transfer none]
struct GtkDialog;
The GtkDialog contains only private fields and should not be directly accessed.
struct GtkDialogClass { GtkWindowClass parent_class; void (* response) (GtkDialog *dialog, int response_id); /* Keybinding signals */ void (* close) (GtkDialog *dialog); };
| Signal emitted when an action widget is activated. | |
| Signal emitted when the user uses a keybinding to close the dialog. |
Flags used to influence dialog construction.
GTK_DIALOG_MODAL | Make the constructed dialog modal, see | |
GTK_DIALOG_DESTROY_WITH_PARENT | Destroy the dialog when its parent is destroyed, see | |
GTK_DIALOG_USE_HEADER_BAR | Create dialog with actions in header bar instead of action area |
Predefined values for use as response ids in gtk_dialog_add_button()
. All predefined values are negative; GTK leaves values of 0 or greater for application-defined response ids.
GTK_RESPONSE_NONE | Returned if an action widget has no response id, or if the dialog gets programmatically hidden or destroyed | |
GTK_RESPONSE_REJECT | Generic response id, not used by GTK dialogs | |
GTK_RESPONSE_ACCEPT | Generic response id, not used by GTK dialogs | |
GTK_RESPONSE_DELETE_EVENT | Returned if the dialog is deleted | |
GTK_RESPONSE_OK | Returned by OK buttons in GTK dialogs | |
GTK_RESPONSE_CANCEL | Returned by Cancel buttons in GTK dialogs | |
GTK_RESPONSE_CLOSE | Returned by Close buttons in GTK dialogs | |
GTK_RESPONSE_YES | Returned by Yes buttons in GTK dialogs | |
GTK_RESPONSE_NO | Returned by No buttons in GTK dialogs | |
GTK_RESPONSE_APPLY | Returned by Apply buttons in GTK dialogs | |
GTK_RESPONSE_HELP | Returned by Help buttons in GTK dialogs |
“use-header-bar”
property“use-header-bar” int
TRUE
if the dialog uses a GtkHeaderBar 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
.
Owner: GtkDialog
Flags: Read / Write / Construct Only
Allowed values: [-1,1]
Default value: -1
“close”
signalvoid user_function (GtkDialog *dialog, gpointer user_data)
The ::close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the dialog.
The default binding for this signal is the Escape key.
user_data | user data set when the signal handler was connected. |
Flags: Action
“response”
signalvoid user_function (GtkDialog *dialog, int response_id, gpointer user_data)
Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls gtk_dialog_response()
. On a delete event, the response ID is GTK_RESPONSE_DELETE_EVENT. Otherwise, it depends on which action widget was clicked.
dialog | the object on which the signal is emitted | |
response_id | the response ID | |
user_data | user data set when the signal handler was connected. |
Flags: Run Last
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk4/4.0/GtkDialog.html