mirror of
https://gitlab.gnome.org/GNOME/gtk.git
synced 2024-12-27 06:00:22 +00:00
31feb29bdf
2005-01-03 Matthias Clasen <mclasen@redhat.com> * gtk/gtkdialog.c (gtk_dialog_run): Some clarification regarding modality. (#112903, Dave Bordoley)
1234 lines
36 KiB
C
1234 lines
36 KiB
C
/* GTK - The GIMP Toolkit
|
|
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
/*
|
|
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
|
|
* file for a list of people on the GTK+ Team. See the ChangeLog
|
|
* files for a list of changes. These files are distributed with
|
|
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
|
|
*/
|
|
|
|
#include <config.h>
|
|
#include "gtkalias.h"
|
|
#include "gtkbutton.h"
|
|
#include "gtkdialog.h"
|
|
#include "gtkhbbox.h"
|
|
#include "gtklabel.h"
|
|
#include "gtkhseparator.h"
|
|
#include "gtkmarshalers.h"
|
|
#include "gtkvbox.h"
|
|
#include "gdkkeysyms.h"
|
|
#include "gtkmain.h"
|
|
#include "gtkintl.h"
|
|
#include "gtkbindings.h"
|
|
|
|
#define GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_DIALOG, GtkDialogPrivate))
|
|
|
|
typedef struct {
|
|
guint ignore_separator : 1;
|
|
} GtkDialogPrivate;
|
|
|
|
typedef struct _ResponseData ResponseData;
|
|
|
|
struct _ResponseData
|
|
{
|
|
gint response_id;
|
|
};
|
|
|
|
static void gtk_dialog_class_init (GtkDialogClass *klass);
|
|
static void gtk_dialog_init (GtkDialog *dialog);
|
|
|
|
static void gtk_dialog_add_buttons_valist (GtkDialog *dialog,
|
|
const gchar *first_button_text,
|
|
va_list args);
|
|
|
|
static gint gtk_dialog_delete_event_handler (GtkWidget *widget,
|
|
GdkEventAny *event,
|
|
gpointer user_data);
|
|
|
|
static void gtk_dialog_set_property (GObject *object,
|
|
guint prop_id,
|
|
const GValue *value,
|
|
GParamSpec *pspec);
|
|
static void gtk_dialog_get_property (GObject *object,
|
|
guint prop_id,
|
|
GValue *value,
|
|
GParamSpec *pspec);
|
|
static void gtk_dialog_style_set (GtkWidget *widget,
|
|
GtkStyle *prev_style);
|
|
static void gtk_dialog_map (GtkWidget *widget);
|
|
|
|
static void gtk_dialog_close (GtkDialog *dialog);
|
|
|
|
static ResponseData* get_response_data (GtkWidget *widget,
|
|
gboolean create);
|
|
|
|
enum {
|
|
PROP_0,
|
|
PROP_HAS_SEPARATOR
|
|
};
|
|
|
|
enum {
|
|
RESPONSE,
|
|
CLOSE,
|
|
LAST_SIGNAL
|
|
};
|
|
|
|
static gpointer parent_class;
|
|
static guint dialog_signals[LAST_SIGNAL];
|
|
|
|
GType
|
|
gtk_dialog_get_type (void)
|
|
{
|
|
static GType dialog_type = 0;
|
|
|
|
if (!dialog_type)
|
|
{
|
|
static const GTypeInfo dialog_info =
|
|
{
|
|
sizeof (GtkDialogClass),
|
|
NULL, /* base_init */
|
|
NULL, /* base_finalize */
|
|
(GClassInitFunc) gtk_dialog_class_init,
|
|
NULL, /* class_finalize */
|
|
NULL, /* class_data */
|
|
sizeof (GtkDialog),
|
|
0, /* n_preallocs */
|
|
(GInstanceInitFunc) gtk_dialog_init,
|
|
};
|
|
|
|
dialog_type = g_type_register_static (GTK_TYPE_WINDOW, "GtkDialog",
|
|
&dialog_info, 0);
|
|
}
|
|
|
|
return dialog_type;
|
|
}
|
|
|
|
static void
|
|
gtk_dialog_class_init (GtkDialogClass *class)
|
|
{
|
|
GObjectClass *gobject_class;
|
|
GtkWidgetClass *widget_class;
|
|
GtkBindingSet *binding_set;
|
|
|
|
gobject_class = G_OBJECT_CLASS (class);
|
|
widget_class = GTK_WIDGET_CLASS (class);
|
|
|
|
parent_class = g_type_class_peek_parent (class);
|
|
|
|
gobject_class->set_property = gtk_dialog_set_property;
|
|
gobject_class->get_property = gtk_dialog_get_property;
|
|
|
|
widget_class->map = gtk_dialog_map;
|
|
widget_class->style_set = gtk_dialog_style_set;
|
|
|
|
class->close = gtk_dialog_close;
|
|
|
|
g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));
|
|
|
|
g_object_class_install_property (gobject_class,
|
|
PROP_HAS_SEPARATOR,
|
|
g_param_spec_boolean ("has_separator",
|
|
P_("Has separator"),
|
|
P_("The dialog has a separator bar above its buttons"),
|
|
TRUE,
|
|
G_PARAM_READWRITE));
|
|
|
|
dialog_signals[RESPONSE] =
|
|
g_signal_new ("response",
|
|
G_OBJECT_CLASS_TYPE (class),
|
|
G_SIGNAL_RUN_LAST,
|
|
G_STRUCT_OFFSET (GtkDialogClass, response),
|
|
NULL, NULL,
|
|
_gtk_marshal_NONE__INT,
|
|
G_TYPE_NONE, 1,
|
|
G_TYPE_INT);
|
|
|
|
dialog_signals[CLOSE] =
|
|
g_signal_new ("close",
|
|
G_OBJECT_CLASS_TYPE (class),
|
|
G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
|
|
G_STRUCT_OFFSET (GtkDialogClass, close),
|
|
NULL, NULL,
|
|
_gtk_marshal_NONE__NONE,
|
|
G_TYPE_NONE, 0);
|
|
|
|
gtk_widget_class_install_style_property (widget_class,
|
|
g_param_spec_int ("content_area_border",
|
|
P_("Content area border"),
|
|
P_("Width of border around the main dialog area"),
|
|
0,
|
|
G_MAXINT,
|
|
2,
|
|
G_PARAM_READABLE));
|
|
gtk_widget_class_install_style_property (widget_class,
|
|
g_param_spec_int ("button_spacing",
|
|
P_("Button spacing"),
|
|
P_("Spacing between buttons"),
|
|
0,
|
|
G_MAXINT,
|
|
10,
|
|
G_PARAM_READABLE));
|
|
|
|
gtk_widget_class_install_style_property (widget_class,
|
|
g_param_spec_int ("action_area_border",
|
|
P_("Action area border"),
|
|
P_("Width of border around the button area at the bottom of the dialog"),
|
|
0,
|
|
G_MAXINT,
|
|
5,
|
|
G_PARAM_READABLE));
|
|
|
|
binding_set = gtk_binding_set_by_class (class);
|
|
|
|
gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
|
|
"close", 0);
|
|
}
|
|
|
|
static void
|
|
update_spacings (GtkDialog *dialog)
|
|
{
|
|
GtkWidget *widget;
|
|
gint content_area_border;
|
|
gint button_spacing;
|
|
gint action_area_border;
|
|
|
|
widget = GTK_WIDGET (dialog);
|
|
|
|
gtk_widget_style_get (widget,
|
|
"content_area_border",
|
|
&content_area_border,
|
|
"button_spacing",
|
|
&button_spacing,
|
|
"action_area_border",
|
|
&action_area_border,
|
|
NULL);
|
|
|
|
gtk_container_set_border_width (GTK_CONTAINER (dialog->vbox),
|
|
content_area_border);
|
|
gtk_box_set_spacing (GTK_BOX (dialog->action_area),
|
|
button_spacing);
|
|
gtk_container_set_border_width (GTK_CONTAINER (dialog->action_area),
|
|
action_area_border);
|
|
}
|
|
|
|
static void
|
|
gtk_dialog_init (GtkDialog *dialog)
|
|
{
|
|
GtkDialogPrivate *priv;
|
|
|
|
priv = GET_PRIVATE (dialog);
|
|
priv->ignore_separator = FALSE;
|
|
|
|
/* To avoid breaking old code that prevents destroy on delete event
|
|
* by connecting a handler, we have to have the FIRST signal
|
|
* connection on the dialog.
|
|
*/
|
|
g_signal_connect (dialog,
|
|
"delete_event",
|
|
G_CALLBACK (gtk_dialog_delete_event_handler),
|
|
NULL);
|
|
|
|
dialog->vbox = gtk_vbox_new (FALSE, 0);
|
|
|
|
gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
|
|
gtk_widget_show (dialog->vbox);
|
|
|
|
dialog->action_area = gtk_hbutton_box_new ();
|
|
|
|
gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog->action_area),
|
|
GTK_BUTTONBOX_END);
|
|
|
|
gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->action_area,
|
|
FALSE, TRUE, 0);
|
|
gtk_widget_show (dialog->action_area);
|
|
|
|
dialog->separator = gtk_hseparator_new ();
|
|
gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
|
|
gtk_widget_show (dialog->separator);
|
|
|
|
gtk_window_set_type_hint (GTK_WINDOW (dialog),
|
|
GDK_WINDOW_TYPE_HINT_DIALOG);
|
|
gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
|
|
}
|
|
|
|
|
|
static void
|
|
gtk_dialog_set_property (GObject *object,
|
|
guint prop_id,
|
|
const GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
GtkDialog *dialog;
|
|
|
|
dialog = GTK_DIALOG (object);
|
|
|
|
switch (prop_id)
|
|
{
|
|
case PROP_HAS_SEPARATOR:
|
|
gtk_dialog_set_has_separator (dialog, g_value_get_boolean (value));
|
|
break;
|
|
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void
|
|
gtk_dialog_get_property (GObject *object,
|
|
guint prop_id,
|
|
GValue *value,
|
|
GParamSpec *pspec)
|
|
{
|
|
GtkDialog *dialog;
|
|
|
|
dialog = GTK_DIALOG (object);
|
|
|
|
switch (prop_id)
|
|
{
|
|
case PROP_HAS_SEPARATOR:
|
|
g_value_set_boolean (value, dialog->separator != NULL);
|
|
break;
|
|
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static gint
|
|
gtk_dialog_delete_event_handler (GtkWidget *widget,
|
|
GdkEventAny *event,
|
|
gpointer user_data)
|
|
{
|
|
/* emit response signal */
|
|
gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
|
|
|
|
/* Do the destroy by default */
|
|
return FALSE;
|
|
}
|
|
|
|
/* A far too tricky heuristic for getting the right initial
|
|
* focus widget if none was set. What we do is we focus the first
|
|
* widget in the tab chain, but if this results in the focus
|
|
* ending up on one of the response widgets _other_ than the
|
|
* default response, we focus the default response instead.
|
|
*
|
|
* Additionally, skip selectable labels when looking for the
|
|
* right initial focus widget.
|
|
*/
|
|
static void
|
|
gtk_dialog_map (GtkWidget *widget)
|
|
{
|
|
GtkWindow *window = GTK_WINDOW (widget);
|
|
GtkDialog *dialog = GTK_DIALOG (widget);
|
|
|
|
GTK_WIDGET_CLASS (parent_class)->map (widget);
|
|
|
|
if (!window->focus_widget)
|
|
{
|
|
GList *children, *tmp_list;
|
|
|
|
do
|
|
{
|
|
g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
|
|
}
|
|
while (GTK_IS_LABEL (window->focus_widget));
|
|
|
|
tmp_list = children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
|
|
|
|
while (tmp_list)
|
|
{
|
|
GtkWidget *child = tmp_list->data;
|
|
|
|
if (window->focus_widget == NULL ||
|
|
(child == window->focus_widget &&
|
|
child != window->default_widget &&
|
|
window->default_widget))
|
|
{
|
|
gtk_widget_grab_focus (window->default_widget);
|
|
break;
|
|
}
|
|
|
|
tmp_list = tmp_list->next;
|
|
}
|
|
|
|
g_list_free (children);
|
|
}
|
|
}
|
|
|
|
static void
|
|
gtk_dialog_style_set (GtkWidget *widget,
|
|
GtkStyle *prev_style)
|
|
{
|
|
update_spacings (GTK_DIALOG (widget));
|
|
}
|
|
|
|
static GtkWidget *
|
|
dialog_find_button (GtkDialog *dialog,
|
|
gint response_id)
|
|
{
|
|
GList *children, *tmp_list;
|
|
GtkWidget *child = NULL;
|
|
|
|
children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
|
|
|
|
for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
|
|
{
|
|
ResponseData *rd = get_response_data (tmp_list->data, FALSE);
|
|
|
|
if (rd && rd->response_id == response_id)
|
|
{
|
|
child = tmp_list->data;
|
|
break;
|
|
}
|
|
}
|
|
|
|
g_list_free (children);
|
|
|
|
return child;
|
|
}
|
|
|
|
static void
|
|
gtk_dialog_close (GtkDialog *dialog)
|
|
{
|
|
/* Synthesize delete_event to close dialog. */
|
|
|
|
GtkWidget *widget = GTK_WIDGET (dialog);
|
|
GdkEvent *event;
|
|
|
|
if (!dialog_find_button (dialog, GTK_RESPONSE_CANCEL))
|
|
return;
|
|
|
|
event = gdk_event_new (GDK_DELETE);
|
|
|
|
event->any.window = g_object_ref (widget->window);
|
|
event->any.send_event = TRUE;
|
|
|
|
gtk_main_do_event (event);
|
|
gdk_event_free (event);
|
|
}
|
|
|
|
GtkWidget*
|
|
gtk_dialog_new (void)
|
|
{
|
|
return g_object_new (GTK_TYPE_DIALOG, NULL);
|
|
}
|
|
|
|
static GtkWidget*
|
|
gtk_dialog_new_empty (const gchar *title,
|
|
GtkWindow *parent,
|
|
GtkDialogFlags flags)
|
|
{
|
|
GtkDialog *dialog;
|
|
|
|
dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
|
|
|
|
if (title)
|
|
gtk_window_set_title (GTK_WINDOW (dialog), title);
|
|
|
|
if (parent)
|
|
gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
|
|
|
|
if (flags & GTK_DIALOG_MODAL)
|
|
gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
|
|
|
|
if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
|
|
gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
|
|
|
|
if (flags & GTK_DIALOG_NO_SEPARATOR)
|
|
gtk_dialog_set_has_separator (dialog, FALSE);
|
|
|
|
return GTK_WIDGET (dialog);
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_new_with_buttons:
|
|
* @title: Title of the dialog, or %NULL
|
|
* @parent: Transient parent of the dialog, or %NULL
|
|
* @flags: from #GtkDialogFlags
|
|
* @first_button_text: stock ID or text to go in first button, or %NULL
|
|
* @Varargs: response ID for first button, then additional buttons, ending with %NULL
|
|
*
|
|
* 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 either a stock ID such as
|
|
* #GTK_STOCK_OK, or some 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 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.
|
|
*
|
|
* Here's a simple example:
|
|
* <informalexample><programlisting>
|
|
* GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
|
|
* main_app_window,
|
|
* GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
|
|
* GTK_STOCK_OK,
|
|
* GTK_RESPONSE_ACCEPT,
|
|
* GTK_STOCK_CANCEL,
|
|
* GTK_RESPONSE_REJECT,
|
|
* NULL);
|
|
* </programlisting></informalexample>
|
|
*
|
|
* Return value: a new #GtkDialog
|
|
**/
|
|
GtkWidget*
|
|
gtk_dialog_new_with_buttons (const gchar *title,
|
|
GtkWindow *parent,
|
|
GtkDialogFlags flags,
|
|
const gchar *first_button_text,
|
|
...)
|
|
{
|
|
GtkDialog *dialog;
|
|
va_list args;
|
|
|
|
dialog = GTK_DIALOG (gtk_dialog_new_empty (title, parent, flags));
|
|
|
|
va_start (args, first_button_text);
|
|
|
|
gtk_dialog_add_buttons_valist (dialog,
|
|
first_button_text,
|
|
args);
|
|
|
|
va_end (args);
|
|
|
|
return GTK_WIDGET (dialog);
|
|
}
|
|
|
|
static ResponseData*
|
|
get_response_data (GtkWidget *widget,
|
|
gboolean create)
|
|
{
|
|
ResponseData *ad = g_object_get_data (G_OBJECT (widget),
|
|
"gtk-dialog-response-data");
|
|
|
|
if (ad == NULL && create)
|
|
{
|
|
ad = g_new (ResponseData, 1);
|
|
|
|
g_object_set_data_full (G_OBJECT (widget),
|
|
"gtk-dialog-response-data",
|
|
ad,
|
|
g_free);
|
|
}
|
|
|
|
return ad;
|
|
}
|
|
|
|
static void
|
|
action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
|
|
{
|
|
ResponseData *ad;
|
|
gint response_id;
|
|
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
|
|
response_id = GTK_RESPONSE_NONE;
|
|
|
|
ad = get_response_data (widget, TRUE);
|
|
|
|
g_assert (ad != NULL);
|
|
|
|
response_id = ad->response_id;
|
|
|
|
gtk_dialog_response (dialog, response_id);
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_add_action_widget:
|
|
* @dialog: a #GtkDialog
|
|
* @child: an activatable widget
|
|
* @response_id: response ID for @child
|
|
*
|
|
* 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
|
|
* <literal>action_area</literal> field of the #GtkDialog struct.
|
|
**/
|
|
void
|
|
gtk_dialog_add_action_widget (GtkDialog *dialog,
|
|
GtkWidget *child,
|
|
gint response_id)
|
|
{
|
|
ResponseData *ad;
|
|
gint signal_id = 0;
|
|
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
g_return_if_fail (GTK_IS_WIDGET (child));
|
|
|
|
ad = get_response_data (child, TRUE);
|
|
|
|
ad->response_id = response_id;
|
|
|
|
if (GTK_IS_BUTTON (child))
|
|
signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
|
|
else
|
|
signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal != 0;
|
|
|
|
if (signal_id)
|
|
{
|
|
GClosure *closure;
|
|
|
|
closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
|
|
G_OBJECT (dialog));
|
|
g_signal_connect_closure_by_id (child,
|
|
signal_id,
|
|
0,
|
|
closure,
|
|
FALSE);
|
|
}
|
|
else
|
|
g_warning ("Only 'activatable' widgets can be packed into the action area of a GtkDialog");
|
|
|
|
gtk_box_pack_end (GTK_BOX (dialog->action_area),
|
|
child,
|
|
FALSE, TRUE, 0);
|
|
|
|
if (response_id == GTK_RESPONSE_HELP)
|
|
gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area), child, TRUE);
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_add_button:
|
|
* @dialog: a #GtkDialog
|
|
* @button_text: text of button, or stock ID
|
|
* @response_id: response ID for the button
|
|
*
|
|
* Adds a button with the given text (or a stock button, if @button_text is a
|
|
* stock ID) 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.
|
|
*
|
|
* Return value: the button widget that was added
|
|
**/
|
|
GtkWidget*
|
|
gtk_dialog_add_button (GtkDialog *dialog,
|
|
const gchar *button_text,
|
|
gint response_id)
|
|
{
|
|
GtkWidget *button;
|
|
|
|
g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
|
|
g_return_val_if_fail (button_text != NULL, NULL);
|
|
|
|
button = gtk_button_new_from_stock (button_text);
|
|
|
|
GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
|
|
|
|
gtk_widget_show (button);
|
|
|
|
gtk_dialog_add_action_widget (dialog,
|
|
button,
|
|
response_id);
|
|
|
|
return button;
|
|
}
|
|
|
|
static void
|
|
gtk_dialog_add_buttons_valist (GtkDialog *dialog,
|
|
const gchar *first_button_text,
|
|
va_list args)
|
|
{
|
|
const gchar* text;
|
|
gint response_id;
|
|
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
|
|
if (first_button_text == NULL)
|
|
return;
|
|
|
|
text = first_button_text;
|
|
response_id = va_arg (args, gint);
|
|
|
|
while (text != NULL)
|
|
{
|
|
gtk_dialog_add_button (dialog, text, response_id);
|
|
|
|
text = va_arg (args, gchar*);
|
|
if (text == NULL)
|
|
break;
|
|
response_id = va_arg (args, int);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_add_buttons:
|
|
* @dialog: a #GtkDialog
|
|
* @first_button_text: button text or stock ID
|
|
* @Varargs: response ID for first button, then more text-response_id pairs
|
|
*
|
|
* 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.
|
|
**/
|
|
void
|
|
gtk_dialog_add_buttons (GtkDialog *dialog,
|
|
const gchar *first_button_text,
|
|
...)
|
|
{
|
|
va_list args;
|
|
|
|
va_start (args, first_button_text);
|
|
|
|
gtk_dialog_add_buttons_valist (dialog,
|
|
first_button_text,
|
|
args);
|
|
|
|
va_end (args);
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_set_response_sensitive:
|
|
* @dialog: a #GtkDialog
|
|
* @response_id: a response ID
|
|
* @setting: %TRUE for sensitive
|
|
*
|
|
* Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
|
|
* for each widget in the dialog's action area with the given @response_id.
|
|
* A convenient way to sensitize/desensitize dialog buttons.
|
|
**/
|
|
void
|
|
gtk_dialog_set_response_sensitive (GtkDialog *dialog,
|
|
gint response_id,
|
|
gboolean setting)
|
|
{
|
|
GList *children;
|
|
GList *tmp_list;
|
|
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
|
|
children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
|
|
|
|
tmp_list = children;
|
|
while (tmp_list != NULL)
|
|
{
|
|
GtkWidget *widget = tmp_list->data;
|
|
ResponseData *rd = g_object_get_data (G_OBJECT (widget),
|
|
"gtk-dialog-response-data");
|
|
|
|
if (rd && rd->response_id == response_id)
|
|
gtk_widget_set_sensitive (widget, setting);
|
|
|
|
tmp_list = g_list_next (tmp_list);
|
|
}
|
|
|
|
g_list_free (children);
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_set_default_response:
|
|
* @dialog: a #GtkDialog
|
|
* @response_id: a 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.
|
|
**/
|
|
void
|
|
gtk_dialog_set_default_response (GtkDialog *dialog,
|
|
gint response_id)
|
|
{
|
|
GList *children;
|
|
GList *tmp_list;
|
|
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
|
|
children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
|
|
|
|
tmp_list = children;
|
|
while (tmp_list != NULL)
|
|
{
|
|
GtkWidget *widget = tmp_list->data;
|
|
ResponseData *rd = g_object_get_data (G_OBJECT (widget),
|
|
"gtk-dialog-response-data");
|
|
|
|
if (rd && rd->response_id == response_id)
|
|
gtk_widget_grab_default (widget);
|
|
|
|
tmp_list = g_list_next (tmp_list);
|
|
}
|
|
|
|
g_list_free (children);
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_set_has_separator:
|
|
* @dialog: a #GtkDialog
|
|
* @setting: %TRUE to have a separator
|
|
*
|
|
* Sets whether the dialog has a separator above the buttons.
|
|
* %TRUE by default.
|
|
**/
|
|
void
|
|
gtk_dialog_set_has_separator (GtkDialog *dialog,
|
|
gboolean setting)
|
|
{
|
|
GtkDialogPrivate *priv;
|
|
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
|
|
priv = GET_PRIVATE (dialog);
|
|
|
|
/* this might fail if we get called before _init() somehow */
|
|
g_assert (dialog->vbox != NULL);
|
|
|
|
if (priv->ignore_separator)
|
|
{
|
|
g_warning ("Ignoring the separator setting");
|
|
return;
|
|
}
|
|
|
|
if (setting && dialog->separator == NULL)
|
|
{
|
|
dialog->separator = gtk_hseparator_new ();
|
|
gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
|
|
|
|
/* The app programmer could screw this up, but, their own fault.
|
|
* Moves the separator just above the action area.
|
|
*/
|
|
gtk_box_reorder_child (GTK_BOX (dialog->vbox), dialog->separator, 1);
|
|
gtk_widget_show (dialog->separator);
|
|
}
|
|
else if (!setting && dialog->separator != NULL)
|
|
{
|
|
gtk_widget_destroy (dialog->separator);
|
|
dialog->separator = NULL;
|
|
}
|
|
|
|
g_object_notify (G_OBJECT (dialog), "has_separator");
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_get_has_separator:
|
|
* @dialog: a #GtkDialog
|
|
*
|
|
* Accessor for whether the dialog has a separator.
|
|
*
|
|
* Return value: %TRUE if the dialog has a separator
|
|
**/
|
|
gboolean
|
|
gtk_dialog_get_has_separator (GtkDialog *dialog)
|
|
{
|
|
g_return_val_if_fail (GTK_IS_DIALOG (dialog), FALSE);
|
|
|
|
return dialog->separator != NULL;
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_response:
|
|
* @dialog: a #GtkDialog
|
|
* @response_id: 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;
|
|
* typically either you or gtk_dialog_run() will be monitoring the
|
|
* "response" signal and take appropriate action.
|
|
**/
|
|
void
|
|
gtk_dialog_response (GtkDialog *dialog,
|
|
gint response_id)
|
|
{
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
|
|
g_signal_emit (dialog,
|
|
dialog_signals[RESPONSE],
|
|
0,
|
|
response_id);
|
|
}
|
|
|
|
typedef struct
|
|
{
|
|
GtkDialog *dialog;
|
|
gint response_id;
|
|
GMainLoop *loop;
|
|
gboolean destroyed;
|
|
} RunInfo;
|
|
|
|
static void
|
|
shutdown_loop (RunInfo *ri)
|
|
{
|
|
if (g_main_loop_is_running (ri->loop))
|
|
g_main_loop_quit (ri->loop);
|
|
}
|
|
|
|
static void
|
|
run_unmap_handler (GtkDialog *dialog, gpointer data)
|
|
{
|
|
RunInfo *ri = data;
|
|
|
|
shutdown_loop (ri);
|
|
}
|
|
|
|
static void
|
|
run_response_handler (GtkDialog *dialog,
|
|
gint response_id,
|
|
gpointer data)
|
|
{
|
|
RunInfo *ri;
|
|
|
|
ri = data;
|
|
|
|
ri->response_id = response_id;
|
|
|
|
shutdown_loop (ri);
|
|
}
|
|
|
|
static gint
|
|
run_delete_handler (GtkDialog *dialog,
|
|
GdkEventAny *event,
|
|
gpointer data)
|
|
{
|
|
RunInfo *ri = data;
|
|
|
|
shutdown_loop (ri);
|
|
|
|
return TRUE; /* Do not destroy */
|
|
}
|
|
|
|
static void
|
|
run_destroy_handler (GtkDialog *dialog, gpointer data)
|
|
{
|
|
RunInfo *ri = data;
|
|
|
|
/* shutdown_loop will be called by run_unmap_handler */
|
|
|
|
ri->destroyed = TRUE;
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_run:
|
|
* @dialog: a #GtkDialog
|
|
*
|
|
* Blocks in a recursive main loop until the @dialog either emits the
|
|
* response signal, or is destroyed. If the dialog is destroyed during the call
|
|
* to gtk_dialog_run(), gtk_dialog_returns #GTK_RESPONSE_NONE.
|
|
* Otherwise, it returns the response ID from the "response" signal emission.
|
|
* Before entering the recursive main loop, gtk_dialog_run() calls
|
|
* gtk_widget_show() on the dialog for you. Note that you still
|
|
* need to show any children of the dialog yourself.
|
|
*
|
|
* During gtk_dialog_run(), the default behavior of "delete_event" is
|
|
* disabled; if the dialog receives "delete_event", it will not be
|
|
* destroyed as windows usually are, and gtk_dialog_run() will return
|
|
* #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be
|
|
* modal. You can force gtk_dialog_run() to return at any time by
|
|
* calling gtk_dialog_response() to emit the "response"
|
|
* signal. Destroying the dialog during gtk_dialog_run() is a very bad
|
|
* idea, because your post-run code won't know whether the dialog was
|
|
* destroyed or not.
|
|
*
|
|
* After gtk_dialog_run() returns, you are responsible for hiding or
|
|
* destroying the dialog if you wish to do so.
|
|
*
|
|
* Typical usage of this function might be:
|
|
* <informalexample><programlisting>
|
|
* gint 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);
|
|
* </programlisting></informalexample>
|
|
*
|
|
* Note that even though the recursive main loop gives the effect of a
|
|
* modal dialog (it prevents the user from interacting with other
|
|
* windows while the dialog is run), callbacks such as timeouts,
|
|
* IO channel watches, DND drops, etc, <emphasis>will</emphasis> be
|
|
* triggered during a gtk_dialog_run() call.
|
|
*
|
|
* Return value: response ID
|
|
**/
|
|
gint
|
|
gtk_dialog_run (GtkDialog *dialog)
|
|
{
|
|
RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL };
|
|
gboolean was_modal;
|
|
gulong response_handler;
|
|
gulong unmap_handler;
|
|
gulong destroy_handler;
|
|
gulong delete_handler;
|
|
|
|
g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);
|
|
|
|
g_object_ref (dialog);
|
|
|
|
was_modal = GTK_WINDOW (dialog)->modal;
|
|
if (!was_modal)
|
|
gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
|
|
|
|
if (!GTK_WIDGET_VISIBLE (dialog))
|
|
gtk_widget_show (GTK_WIDGET (dialog));
|
|
|
|
response_handler =
|
|
g_signal_connect (dialog,
|
|
"response",
|
|
G_CALLBACK (run_response_handler),
|
|
&ri);
|
|
|
|
unmap_handler =
|
|
g_signal_connect (dialog,
|
|
"unmap",
|
|
G_CALLBACK (run_unmap_handler),
|
|
&ri);
|
|
|
|
delete_handler =
|
|
g_signal_connect (dialog,
|
|
"delete_event",
|
|
G_CALLBACK (run_delete_handler),
|
|
&ri);
|
|
|
|
destroy_handler =
|
|
g_signal_connect (dialog,
|
|
"destroy",
|
|
G_CALLBACK (run_destroy_handler),
|
|
&ri);
|
|
|
|
ri.loop = g_main_loop_new (NULL, FALSE);
|
|
|
|
GDK_THREADS_LEAVE ();
|
|
g_main_loop_run (ri.loop);
|
|
GDK_THREADS_ENTER ();
|
|
|
|
g_main_loop_unref (ri.loop);
|
|
|
|
ri.loop = NULL;
|
|
ri.destroyed = FALSE;
|
|
|
|
if (!ri.destroyed)
|
|
{
|
|
if (!was_modal)
|
|
gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
|
|
|
|
g_signal_handler_disconnect (dialog, response_handler);
|
|
g_signal_handler_disconnect (dialog, unmap_handler);
|
|
g_signal_handler_disconnect (dialog, delete_handler);
|
|
g_signal_handler_disconnect (dialog, destroy_handler);
|
|
}
|
|
|
|
g_object_unref (dialog);
|
|
|
|
return ri.response_id;
|
|
}
|
|
|
|
void
|
|
_gtk_dialog_set_ignore_separator (GtkDialog *dialog,
|
|
gboolean ignore_separator)
|
|
{
|
|
GtkDialogPrivate *priv;
|
|
|
|
priv = GET_PRIVATE (dialog);
|
|
priv->ignore_separator = ignore_separator;
|
|
}
|
|
|
|
gint
|
|
_gtk_dialog_get_response_for_widget (GtkDialog *dialog,
|
|
GtkWidget *widget)
|
|
{
|
|
ResponseData *rd;
|
|
|
|
rd = get_response_data (widget, FALSE);
|
|
if (!rd)
|
|
return GTK_RESPONSE_NONE;
|
|
else
|
|
return rd->response_id;
|
|
}
|
|
|
|
/**
|
|
* gtk_alternative_dialog_button_order:
|
|
* @screen: a #GdkScreen, or %NULL to use the default screen
|
|
*
|
|
* Returns %TRUE if dialogs are expected to use an alternative
|
|
* button order on the screen @screen. See
|
|
* gtk_dialog_set_alternative_button_order() for more details
|
|
* about alternative button order.
|
|
*
|
|
* If you need to use this function, you should probably connect
|
|
* to the ::notify:gtk-alternative-button-order signal on the
|
|
* #GtkSettings object associated to @screen, in order to be
|
|
* notified if the button order setting changes.
|
|
*
|
|
* Returns: Whether the alternative button order should be used
|
|
*
|
|
* Since: 2.6
|
|
*/
|
|
gboolean
|
|
gtk_alternative_dialog_button_order (GdkScreen *screen)
|
|
{
|
|
GtkSettings *settings;
|
|
gboolean result;
|
|
|
|
if (screen)
|
|
settings = gtk_settings_get_for_screen (screen);
|
|
else
|
|
settings = gtk_settings_get_default ();
|
|
|
|
g_object_get (settings,
|
|
"gtk-alternative-button-order", &result, NULL);
|
|
|
|
return result;
|
|
}
|
|
|
|
static void
|
|
gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
|
|
gint first_response_id,
|
|
va_list args)
|
|
{
|
|
GtkWidget *child;
|
|
gint response_id;
|
|
gint position;
|
|
|
|
response_id = first_response_id;
|
|
position = 0;
|
|
while (response_id != -1)
|
|
{
|
|
/* reorder child with response_id to position */
|
|
child = dialog_find_button (dialog, response_id);
|
|
gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
|
|
|
|
response_id = va_arg (args, gint);
|
|
position++;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* gtk_dialog_set_alternative_button_order:
|
|
* @dialog: a #GtkDialog
|
|
* @first_response_id: a response id used by one @dialog's buttons
|
|
* @Varargs: a list of more response ids of @dialog's buttons, terminated by -1
|
|
*
|
|
* Sets an alternative button order. If the gtk-alternative-button-order
|
|
* setting is set to %TRUE, the dialog buttons are reordered according to
|
|
* the order of the response ids passed to this function.
|
|
*
|
|
* By default, GTK+ dialogs use the button order advocated by the Gnome
|
|
* <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
|
|
* Interface Guidelines</ulink> with the affirmative button at the far
|
|
* right, and the cancel button left of it. But the builtin GTK+ dialogs
|
|
* and #GtkMessageDialog<!-- -->s do provide an alternative button order,
|
|
* which is more suitable on some platforms, e.g. Windows.
|
|
*
|
|
* Use this function after adding all the buttons to your dialog, as the
|
|
* following example shows:
|
|
* <informalexample><programlisting>
|
|
* cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
|
|
* GTK_STOCK_CANCEL,
|
|
* GTK_RESPONSE_CANCEL);
|
|
*
|
|
* ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
|
|
* GTK_STOCK_OK,
|
|
* GTK_RESPONSE_OK);
|
|
*
|
|
* gtk_widget_grab_default (ok_button);
|
|
*
|
|
* help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
|
|
* GTK_STOCK_HELP,
|
|
* GTK_RESPONSE_HELP);
|
|
*
|
|
* gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
|
|
* GTK_RESPONSE_OK,
|
|
* GTK_RESPONSE_CANCEL,
|
|
* GTK_RESPONSE_HELP,
|
|
* -1);
|
|
* </programlisting></informalexample>
|
|
*
|
|
* Since: 2.6
|
|
*/
|
|
void
|
|
gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
|
|
gint first_response_id,
|
|
...)
|
|
{
|
|
GdkScreen *screen;
|
|
va_list args;
|
|
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
|
|
screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
|
|
if (!gtk_alternative_dialog_button_order (screen))
|
|
return;
|
|
|
|
va_start (args, first_response_id);
|
|
|
|
gtk_dialog_set_alternative_button_order_valist (dialog,
|
|
first_response_id,
|
|
args);
|
|
va_end (args);
|
|
}
|
|
/**
|
|
* gtk_dialog_set_alternative_button_order_from_array:
|
|
* @dialog: a #GtkDialog
|
|
* @n_params: the number of response ids in @new_order
|
|
* @new_order: an array of response ids of @dialog's buttons
|
|
*
|
|
* Sets an alternative button order. If the gtk-alternative-button-order
|
|
* setting is set to %TRUE, the dialog buttons are reordered according to
|
|
* the order of the response ids in @new_order.
|
|
*
|
|
* See gtk_dialog_set_alternative_button_order() for more information.
|
|
*
|
|
* This function is for use by language bindings.
|
|
*
|
|
* Since: 2.6
|
|
*/
|
|
void
|
|
gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
|
|
gint n_params,
|
|
gint *new_order)
|
|
{
|
|
GdkScreen *screen;
|
|
GtkWidget *child;
|
|
gint position;
|
|
|
|
g_return_if_fail (GTK_IS_DIALOG (dialog));
|
|
g_return_if_fail (new_order != NULL);
|
|
|
|
screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
|
|
if (!gtk_alternative_dialog_button_order (screen))
|
|
return;
|
|
|
|
for (position = 0; position < n_params; position++)
|
|
{
|
|
/* reorder child with response_id to position */
|
|
child = dialog_find_button (dialog, new_order[position]);
|
|
gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
|
|
}
|
|
}
|
|
|