GI.Gtk.Objects.Dialog

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 VBox, and is where widgets such as a Label or a Entry 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.

Dialog boxes are created with a call to dialogNew 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 dialogGetContentArea and dialogGetActionArea, 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 windowSetModal on the dialog. Use the GTK_WINDOW() macro to cast the widget returned from dialogNew into a Window. 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 Dialog using gtk_dialog_new_with_buttons(), dialogAddButton, gtk_dialog_add_buttons(), or dialogAddActionWidget, clicking the button will emit a signal called Dialog::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 ResponseType enumeration (these all have values less than zero). If a dialog receives a delete event, the Dialog::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 dialogRun. 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 MessageDialog 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 code

// 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 Buildable interface exposes the vbox and actionArea 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 actionArea). 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 Dialog UI definition fragment: > >class="GtkDialog" id="dialog1" > type="action" > class="GtkButton" id="button_cancel"/ > /child > type="action" > class="GtkButton" id="button_ok" > name="can-default"True/property > /object > /child > action-widgets > response="cancel"button_cancel/action-widget > response="ok" default="true"button_ok/action-widget > /action-widgets >/object

Exported types

newtype Dialog

Memory-managed wrapper type.

Constructors

Dialog (ManagedPtr Dialog)

Instances

GObject Dialog

Defined in GI.Gtk.Objects.Dialog

Methods

gobjectType :: Dialog -> IO GType

IsImplementorIface Dialog

Defined in GI.Gtk.Objects.Dialog

IsObject Dialog

Defined in GI.Gtk.Objects.Dialog

IsBuildable Dialog

Defined in GI.Gtk.Objects.Dialog

IsBin Dialog

Defined in GI.Gtk.Objects.Dialog

IsContainer Dialog

Defined in GI.Gtk.Objects.Dialog

IsDialog Dialog

Defined in GI.Gtk.Objects.Dialog

IsWidget Dialog

Defined in GI.Gtk.Objects.Dialog

IsWindow Dialog

Defined in GI.Gtk.Objects.Dialog

class GObject o => IsDialog o

Type class for types which can be safely cast to Dialog, for instance with toDialog.

Instances

(GObject a, (UnknownAncestorError Dialog a :: Constraint)) => IsDialog a

Defined in GI.Gtk.Objects.Dialog

IsDialog Dialog

Defined in GI.Gtk.Objects.Dialog

IsDialog RecentChooserDialog

Defined in GI.Gtk.Objects.RecentChooserDialog

IsDialog MessageDialog

Defined in GI.Gtk.Objects.MessageDialog

IsDialog FontSelectionDialog

Defined in GI.Gtk.Objects.FontSelectionDialog

IsDialog FontChooserDialog

Defined in GI.Gtk.Objects.FontChooserDialog

IsDialog FileChooserDialog

Defined in GI.Gtk.Objects.FileChooserDialog

IsDialog ColorSelectionDialog

Defined in GI.Gtk.Objects.ColorSelectionDialog

IsDialog ColorChooserDialog

Defined in GI.Gtk.Objects.ColorChooserDialog

IsDialog AppChooserDialog

Defined in GI.Gtk.Objects.AppChooserDialog

IsDialog AboutDialog

Defined in GI.Gtk.Objects.AboutDialog

toDialog :: (MonadIO m, IsDialog o) => o -> m Dialog

Cast to Dialog, for types for which this is known to be safe. For general casts, use castTo.

noDialog :: Maybe Dialog

A convenience alias for Nothing :: Maybe Dialog.

Methods

addActionWidget

dialogAddActionWidget

Arguments

:: (HasCallStack, MonadIO m, IsDialog a, IsWidget b)

=> a

dialog: a Dialog

-> b

child: an activatable widget

-> Int32

responseId: response ID for child

-> m ()

Adds an activatable widget to the action area of a Dialog, connecting 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 actionArea field of the Dialog struct.

addButton

dialogAddButton

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> Text

buttonText: text of button

-> Int32

responseId: response ID for the button

-> m Widget

Returns: the Button widget that was added

Adds a button with the given text and sets things up so that clicking the button will emit the Dialog::response signal with the given responseId. 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.

getActionArea

dialogGetActionArea

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> m Widget

Returns: the action area

Deprecated: (Since version 3.12)Direct access to the action area is discouraged; use dialogAddButton, etc.

Returns the action area of dialog.

Since: 2.14

getContentArea

dialogGetContentArea

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> m Box

Returns: the content area Box.

Returns the content area of dialog.

Since: 2.14

getHeaderBar

dialogGetHeaderBar

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> m Widget

Returns: the header bar

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.

Since: 3.12

getResponseForWidget

dialogGetResponseForWidget

Arguments

:: (HasCallStack, MonadIO m, IsDialog a, IsWidget b)

=> a

dialog: a Dialog

-> b

widget: a widget in the action area of dialog

-> m Int32

Returns: the response id of widget, or ResponseTypeNone if widget doesn’t have a response id set.

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

Since: 2.8

getWidgetForResponse

dialogGetWidgetForResponse

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> Int32

responseId: the response ID used by the dialog widget

-> m (Maybe Widget)

Returns: the widget button that uses the given responseId, or Nothing.

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

Since: 2.20

new

dialogNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Dialog

Returns: the new dialog as a Widget

Creates a new dialog box.

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

response

dialogResponse

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> Int32

responseId: response ID

-> m ()

Emits the Dialog::response signal with the given response ID. Used to indicate that the user has responded to the dialog in some way; typically either you or dialogRun will be monitoring the ::response signal and take appropriate action.

run

dialogRun

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> m Int32

Returns: response ID

Blocks in a recursive main loop until the dialog either emits the Dialog::response signal, or is destroyed. If the dialog is destroyed during the call to dialogRun, dialogRun returns GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the ::response signal emission.

Before entering the recursive main loop, dialogRun calls widgetShow on the dialog for you. Note that you still need to show any children of the dialog yourself.

During dialogRun, the default behavior of Widget::delete-event is disabled; if the dialog receives ::delete_event, it will not be destroyed as windows usually are, and dialogRun will return GTK_RESPONSE_DELETE_EVENT. Also, during dialogRun the dialog will be modal. You can force dialogRun to return at any time by calling dialogResponse to emit the ::response signal. Destroying the dialog during dialogRun is a very bad idea, because your post-run code won’t know whether the dialog was destroyed or not.

After dialogRun returns, you are responsible for hiding or destroying the dialog if you wish to do so.

Typical usage of this function might be:

C code

 GtkWidget *dialog = gtk_dialog_new ();
 // Set up dialog...

 int result = gtk_dialog_run (GTK_DIALOG (dialog));
 switch (result)
   {
     case GTK_RESPONSE_ACCEPT:
        // do_application_specific_something ();
        break;
     default:
        // do_nothing_since_dialog_was_cancelled ();
        break;
   }
 gtk_widget_destroy (dialog);

Note that even though the recursive main loop gives the effect of a modal dialog (it prevents the user from interacting with other windows in the same window group while the dialog is run), callbacks such as timeouts, IO channel watches, DND drops, etc, will be triggered during a dialogRun call.

setAlternativeButtonOrderFromArray

dialogSetAlternativeButtonOrderFromArray

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> [Int32]

newOrder: an array of response ids of dialog’s buttons

-> m ()

Deprecated: (Since version 3.10)Deprecated

Sets an alternative button order. If the Settings:gtk-alternative-button-order setting is set to True, the dialog buttons are reordered according to the order of the response ids in newOrder.

See gtk_dialog_set_alternative_button_order() for more information.

This function is for use by language bindings.

Since: 2.6

setDefaultResponse

dialogSetDefaultResponse

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> Int32

responseId: a response ID

-> m ()

Sets the last widget in the dialog’s action area with the given responseId as the default widget for the dialog. Pressing “Enter” normally activates the default widget.

setResponseSensitive

dialogSetResponseSensitive

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

dialog: a Dialog

-> Int32

responseId: a response ID

-> Bool

setting: True for sensitive

-> m ()

Calls gtk_widget_set_sensitive (widget, @setting) for each widget in the dialog’s action area with the given responseId. A convenient way to sensitize/desensitize dialog buttons.

Properties

useHeaderBar

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.

Since: 3.12

constructDialogUseHeaderBar :: IsDialog o => Int32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “use-header-bar” property. This is rarely needed directly, but it is used by new.

getDialogUseHeaderBar :: (MonadIO m, IsDialog o) => o -> m Int32

Get the value of the “use-header-bar” property. When overloading is enabled, this is equivalent to

get dialog #useHeaderBar

Signals

close

type C_DialogCloseCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DialogCloseCallback = IO ()

The ::close signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user uses a keybinding to close the dialog.

The default binding for this signal is the Escape key.

afterDialogClose :: (IsDialog a, MonadIO m) => a -> DialogCloseCallback -> m SignalHandlerId

Connect a signal handler for the “close” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dialog #close callback

genClosure_DialogClose :: DialogCloseCallback -> IO Closure

Wrap the callback into a Closure.

mk_DialogCloseCallback :: C_DialogCloseCallback -> IO (FunPtr C_DialogCloseCallback)

Generate a function pointer callable from C code, from a C_DialogCloseCallback.

noDialogCloseCallback :: Maybe DialogCloseCallback

A convenience synonym for Nothing :: Maybe DialogCloseCallback.

onDialogClose :: (IsDialog a, MonadIO m) => a -> DialogCloseCallback -> m SignalHandlerId

Connect a signal handler for the “close” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dialog #close callback

wrap_DialogCloseCallback :: DialogCloseCallback -> C_DialogCloseCallback

Wrap a DialogCloseCallback into a C_DialogCloseCallback.

response

type C_DialogResponseCallback = Ptr () -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DialogResponseCallback

Arguments

 = Int32

responseId: the response ID

-> IO ()

Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls dialogResponse. On a delete event, the response ID is GTK_RESPONSE_DELETE_EVENT. Otherwise, it depends on which action widget was clicked.

afterDialogResponse :: (IsDialog a, MonadIO m) => a -> DialogResponseCallback -> m SignalHandlerId

Connect a signal handler for the “response” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dialog #response callback

genClosure_DialogResponse :: DialogResponseCallback -> IO Closure

Wrap the callback into a Closure.

mk_DialogResponseCallback :: C_DialogResponseCallback -> IO (FunPtr C_DialogResponseCallback)

Generate a function pointer callable from C code, from a C_DialogResponseCallback.

noDialogResponseCallback :: Maybe DialogResponseCallback

A convenience synonym for Nothing :: Maybe DialogResponseCallback.

onDialogResponse :: (IsDialog a, MonadIO m) => a -> DialogResponseCallback -> m SignalHandlerId

Connect a signal handler for the “response” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dialog #response callback

wrap_DialogResponseCallback :: DialogResponseCallback -> C_DialogResponseCallback

Wrap a DialogResponseCallback into a C_DialogResponseCallback.