* 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.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* 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/.
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+#include "config.h"
+
+#include <stdlib.h>
+#include <string.h>
+
#include "gtkbutton.h"
#include "gtkdialog.h"
-#include "gtkhbbox.h"
-#include "gtkhseparator.h"
-#include "gtkvbox.h"
-#include "gtksignal.h"
-#include "gdkkeysyms.h"
+#include "gtkbbox.h"
+#include "gtklabel.h"
+#include "gtkmarshalers.h"
+#include "gtkbox.h"
+#include "gtkboxprivate.h"
#include "gtkmain.h"
+#include "gtkintl.h"
+#include "gtkbindings.h"
+#include "gtkprivate.h"
+#include "gtkbuildable.h"
+#include "gtksettings.h"
-static void gtk_dialog_class_init (GtkDialogClass *klass);
-static void gtk_dialog_init (GtkDialog *dialog);
-static gint gtk_dialog_key_press (GtkWidget *widget,
- GdkEventKey *key);
+/**
+ * SECTION:gtkdialog
+ * @Short_description: Create popup windows
+ * @Title: GtkDialog
+ * @See_also: #GtkVBox, #GtkWindow, #GtkButton
+ *
+ * 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
+ * #GtkVBox, and is where widgets such as a #GtkLabel or a #GtkEntry should
+ * be packed. The bottom area is known as the
+ * <structfield>action_area</structfield>. 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.
+ *
+ * If 'dialog' is a newly created dialog, the two primary areas of the
+ * window can be accessed through gtk_dialog_get_content_area() and
+ * gtk_dialog_get_action_area(), 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 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 #GtkDialog::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 #GtkDialog::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 gtk_dialog_run(). 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 #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.
+ * <example>
+ * <title>Simple GtkDialog usage</title>
+ * <programlisting>
+ * /* Function to open a dialog box displaying the message provided. */
+ * void
+ * quick_message (gchar *message)
+ * {
+ * GtkWidget *dialog, *label, *content_area;
+ *
+ * /* Create the widgets */
+ * dialog = gtk_dialog_new_with_buttons ("Message",
+ * main_application_window,
+ * GTK_DIALOG_DESTROY_WITH_PARENT,
+ * GTK_STOCK_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 to the dialog */
+ *
+ * gtk_container_add (GTK_CONTAINER (content_area), label);
+ * gtk_widget_show_all (dialog);
+ * }
+ * </programlisting>
+ * </example>
+ *
+ * <refsect2 id="GtkDialog-BUILDER-UI"><title>GtkDialog as GtkBuildable</title>
+ * <para>
+ * The GtkDialog implementation of the #GtkBuildable interface exposes the
+ * @vbox and @action_area as internal children with the names "vbox" and
+ * "action_area".
+ * </para>
+ * <para>
+ * 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).
+ * </para>
+ * <example>
+ * <title>A <structname>GtkDialog</structname> UI definition fragment.</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkDialog" id="dialog1">
+ * <child internal-child="vbox">"
+ * <object class="GtkVBox" id="vbox">
+ * <child internal-child="action_area">
+ * <object class="GtkHButtonBox" id="button_box">
+ * <child>
+ * <object class="GtkButton" id="button_cancel"/>
+ * </child>
+ * <child>
+ * <object class="GtkButton" id="button_ok"/>
+ * </child>
+ * </object>
+ * </child>
+ * </object>
+ * </child>
+ * <action-widgets>
+ * <action-widget response="3">button_ok</action-widget>
+ * <action-widget response="-5">button_cancel</action-widget>
+ * </action-widgets>
+ * </object>
+ * ]]></programlisting>
+ * </example>
+ * </refsect2>
+ */
-static void gtk_dialog_add_buttons_valist (GtkDialog *dialog,
- const gchar *first_button_text,
- va_list args);
+struct _GtkDialogPrivate
+{
+ GtkWidget *vbox;
+ GtkWidget *action_area;
+};
-static gint gtk_dialog_delete_event_handler (GtkWidget *widget,
- GdkEventAny *event,
- gpointer user_data);
+typedef struct _ResponseData ResponseData;
+struct _ResponseData
+{
+ gint response_id;
+};
+
+static void gtk_dialog_add_buttons_valist (GtkDialog *dialog,
+ const gchar *first_button_text,
+ va_list args);
+
+static gboolean gtk_dialog_delete_event_handler (GtkWidget *widget,
+ GdkEventAny *event,
+ gpointer user_data);
+static void gtk_dialog_style_updated (GtkWidget *widget);
+static void gtk_dialog_map (GtkWidget *widget);
+
+static void gtk_dialog_close (GtkDialog *dialog);
+
+static ResponseData * get_response_data (GtkWidget *widget,
+ gboolean create);
+
+static void gtk_dialog_buildable_interface_init (GtkBuildableIface *iface);
+static GObject * gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
+ GtkBuilder *builder,
+ const gchar *childname);
+static gboolean gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
+ GtkBuilder *builder,
+ GObject *child,
+ const gchar *tagname,
+ GMarkupParser *parser,
+ gpointer *data);
+static void gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
+ GtkBuilder *builder,
+ GObject *child,
+ const gchar *tagname,
+ gpointer user_data);
+
+
+enum {
+ PROP_0,
+ PROP_HAS_SEPARATOR
+};
enum {
RESPONSE,
+ CLOSE,
LAST_SIGNAL
};
-static gpointer parent_class;
static guint dialog_signals[LAST_SIGNAL];
-GtkType
-gtk_dialog_get_type (void)
-{
- static GtkType dialog_type = 0;
-
- if (!dialog_type)
- {
- static const GtkTypeInfo dialog_info =
- {
- "GtkDialog",
- sizeof (GtkDialog),
- sizeof (GtkDialogClass),
- (GtkClassInitFunc) gtk_dialog_class_init,
- (GtkObjectInitFunc) gtk_dialog_init,
- /* reserved_1 */ NULL,
- /* reserved_2 */ NULL,
- (GtkClassInitFunc) NULL,
- };
-
- dialog_type = gtk_type_unique (GTK_TYPE_WINDOW, &dialog_info);
- }
-
- return dialog_type;
-}
+G_DEFINE_TYPE_WITH_CODE (GtkDialog, gtk_dialog, GTK_TYPE_WINDOW,
+ G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
+ gtk_dialog_buildable_interface_init))
static void
gtk_dialog_class_init (GtkDialogClass *class)
{
- GtkObjectClass *object_class;
+ GObjectClass *gobject_class;
GtkWidgetClass *widget_class;
-
- object_class = (GtkObjectClass*) class;
- widget_class = (GtkWidgetClass*) class;
+ GtkBindingSet *binding_set;
- parent_class = g_type_class_peek_parent (class);
-
+ gobject_class = G_OBJECT_CLASS (class);
+ widget_class = GTK_WIDGET_CLASS (class);
+
+ widget_class->map = gtk_dialog_map;
+ widget_class->style_updated = gtk_dialog_style_updated;
+
+ gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_DIALOG);
+
+ class->close = gtk_dialog_close;
+
+ g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));
+
+ /**
+ * GtkDialog::response:
+ * @dialog: the object on which the signal is emitted
+ * @response_id: the response ID
+ *
+ * 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_signals[RESPONSE] =
- gtk_signal_new ("response",
- GTK_RUN_LAST,
- GTK_CLASS_TYPE (object_class),
- GTK_SIGNAL_OFFSET (GtkDialogClass, response),
- gtk_marshal_NONE__INT,
- GTK_TYPE_NONE, 1,
- GTK_TYPE_INT);
+ g_signal_new (I_("response"),
+ G_OBJECT_CLASS_TYPE (class),
+ G_SIGNAL_RUN_LAST,
+ G_STRUCT_OFFSET (GtkDialogClass, response),
+ NULL, NULL,
+ _gtk_marshal_VOID__INT,
+ G_TYPE_NONE, 1,
+ G_TYPE_INT);
+
+ /**
+ * GtkDialog::close:
+ *
+ * The ::close signal is a
+ * <link linkend="keybinding-signals">keybinding signal</link>
+ * which gets emitted when the user uses a keybinding to close
+ * the dialog.
+ *
+ * The default binding for this signal is the Escape key.
+ */
+ dialog_signals[CLOSE] =
+ g_signal_new (I_("close"),
+ G_OBJECT_CLASS_TYPE (class),
+ G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
+ G_STRUCT_OFFSET (GtkDialogClass, close),
+ NULL, NULL,
+ _gtk_marshal_VOID__VOID,
+ 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,
+ GTK_PARAM_READABLE));
+ /**
+ * GtkDialog:content-area-spacing:
+ *
+ * The default spacing used between elements of the
+ * content area of the dialog, as returned by
+ * gtk_dialog_get_content_area(), unless gtk_box_set_spacing()
+ * was called on that widget directly.
+ *
+ * Since: 2.16
+ */
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_int ("content-area-spacing",
+ P_("Content area spacing"),
+ P_("Spacing between elements of the main dialog area"),
+ 0,
+ G_MAXINT,
+ 0,
+ GTK_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,
+ 6,
+ GTK_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,
+ GTK_PARAM_READABLE));
+
+ binding_set = gtk_binding_set_by_class (class);
+
+ gtk_binding_entry_add_signal (binding_set, GDK_KEY_Escape, 0, "close", 0);
+}
- gtk_object_class_add_signals (object_class, dialog_signals, LAST_SIGNAL);
+static void
+update_spacings (GtkDialog *dialog)
+{
+ GtkDialogPrivate *priv = dialog->priv;
+ gint content_area_border;
+ gint content_area_spacing;
+ gint button_spacing;
+ gint action_area_border;
+
+ gtk_widget_style_get (GTK_WIDGET (dialog),
+ "content-area-border", &content_area_border,
+ "content-area-spacing", &content_area_spacing,
+ "button-spacing", &button_spacing,
+ "action-area-border", &action_area_border,
+ NULL);
- widget_class->key_press_event = gtk_dialog_key_press;
+
+ gtk_container_set_border_width (GTK_CONTAINER (priv->vbox),
+ content_area_border);
+ if (!_gtk_box_get_spacing_set (GTK_BOX (priv->vbox)))
+ {
+ gtk_box_set_spacing (GTK_BOX (priv->vbox), content_area_spacing);
+ _gtk_box_set_spacing_set (GTK_BOX (priv->vbox), FALSE);
+ }
+ gtk_box_set_spacing (GTK_BOX (priv->action_area),
+ button_spacing);
+ gtk_container_set_border_width (GTK_CONTAINER (priv->action_area),
+ action_area_border);
}
static void
gtk_dialog_init (GtkDialog *dialog)
{
- GtkWidget *separator;
+ GtkDialogPrivate *priv;
+
+ dialog->priv = G_TYPE_INSTANCE_GET_PRIVATE (dialog,
+ GTK_TYPE_DIALOG,
+ GtkDialogPrivate);
+ priv = dialog->priv;
/* 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.
*/
- gtk_signal_connect (GTK_OBJECT (dialog),
- "delete_event",
- GTK_SIGNAL_FUNC (gtk_dialog_delete_event_handler),
- NULL);
-
- dialog->vbox = gtk_vbox_new (FALSE, 0);
+ g_signal_connect (dialog,
+ "delete-event",
+ G_CALLBACK (gtk_dialog_delete_event_handler),
+ NULL);
- gtk_container_set_border_width (GTK_CONTAINER (dialog->vbox), 2);
-
- gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
- gtk_widget_show (dialog->vbox);
+ priv->vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
+ gtk_container_add (GTK_CONTAINER (dialog), priv->vbox);
+ gtk_widget_show (priv->vbox);
- dialog->action_area = gtk_hbutton_box_new ();
+ priv->action_area = gtk_button_box_new (GTK_ORIENTATION_HORIZONTAL);
- gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog->action_area),
- GTK_BUTTONBOX_SPREAD);
-
- gtk_container_set_border_width (GTK_CONTAINER (dialog->action_area), 10);
- gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->action_area,
+ gtk_button_box_set_layout (GTK_BUTTON_BOX (priv->action_area),
+ GTK_BUTTONBOX_END);
+
+ gtk_box_pack_end (GTK_BOX (priv->vbox), priv->action_area,
FALSE, TRUE, 0);
- gtk_widget_show (dialog->action_area);
+ gtk_widget_show (priv->action_area);
- separator = gtk_hseparator_new ();
- gtk_box_pack_end (GTK_BOX (dialog->vbox), separator, FALSE, TRUE, 0);
- gtk_widget_show (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);
+
+ update_spacings (dialog);
}
-static gint
+static GtkBuildableIface *parent_buildable_iface;
+
+static void
+gtk_dialog_buildable_interface_init (GtkBuildableIface *iface)
+{
+ parent_buildable_iface = g_type_interface_peek_parent (iface);
+ iface->get_internal_child = gtk_dialog_buildable_get_internal_child;
+ iface->custom_tag_start = gtk_dialog_buildable_custom_tag_start;
+ iface->custom_finished = gtk_dialog_buildable_custom_finished;
+}
+
+static GObject *
+gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
+ GtkBuilder *builder,
+ const gchar *childname)
+{
+ GtkDialogPrivate *priv = GTK_DIALOG (buildable)->priv;
+
+ if (strcmp (childname, "vbox") == 0)
+ return G_OBJECT (priv->vbox);
+ else if (strcmp (childname, "action_area") == 0)
+ return G_OBJECT (priv->action_area);
+
+ return parent_buildable_iface->get_internal_child (buildable,
+ builder,
+ childname);
+}
+
+static gboolean
gtk_dialog_delete_event_handler (GtkWidget *widget,
GdkEventAny *event,
gpointer user_data)
{
/* emit response signal */
- gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_NONE);
+ gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
/* Do the destroy by default */
return FALSE;
}
-static gint
-gtk_dialog_key_press (GtkWidget *widget,
- GdkEventKey *key)
+/* 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)
{
- GdkEventAny event;
+ GtkWidget *default_widget, *focus;
+ GtkWindow *window = GTK_WINDOW (widget);
+ GtkDialog *dialog = GTK_DIALOG (widget);
+ GtkDialogPrivate *priv = dialog->priv;
- event.type = GDK_DELETE;
- event.window = widget->window;
- event.send_event = TRUE;
+ GTK_WIDGET_CLASS (gtk_dialog_parent_class)->map (widget);
- if (GTK_WIDGET_CLASS (parent_class)->key_press_event (widget, key))
- return TRUE;
+ focus = gtk_window_get_focus (window);
+ if (!focus)
+ {
+ GList *children, *tmp_list;
+ GtkWidget *first_focus = NULL;
+
+ do
+ {
+ g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
+
+ focus = gtk_window_get_focus (window);
+ if (GTK_IS_LABEL (focus) &&
+ !gtk_label_get_current_uri (GTK_LABEL (focus)))
+ gtk_label_select_region (GTK_LABEL (focus), 0, 0);
+
+ if (first_focus == NULL)
+ first_focus = focus;
+ else if (first_focus == focus)
+ break;
+
+ if (!GTK_IS_LABEL (focus))
+ break;
+ }
+ while (TRUE);
+
+ tmp_list = children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
+
+ while (tmp_list)
+ {
+ GtkWidget *child = tmp_list->data;
+
+ default_widget = gtk_window_get_default_widget (window);
+ if ((focus == NULL || child == focus) &&
+ child != default_widget &&
+ default_widget)
+ {
+ gtk_widget_grab_focus (default_widget);
+ break;
+ }
+
+ tmp_list = tmp_list->next;
+ }
+
+ g_list_free (children);
+ }
+}
- if (key->keyval != GDK_Escape)
- return FALSE;
+static void
+gtk_dialog_style_updated (GtkWidget *widget)
+{
+ GTK_WIDGET_CLASS (gtk_dialog_parent_class)->style_updated (widget);
- /* Synthesize delete_event on key press. */
- g_object_ref (G_OBJECT (event.window));
-
- gtk_main_do_event ((GdkEvent*)&event);
-
- g_object_unref (G_OBJECT (event.window));
+ update_spacings (GTK_DIALOG (widget));
+}
+
+static GtkWidget *
+dialog_find_button (GtkDialog *dialog,
+ gint response_id)
+{
+ GtkDialogPrivate *priv = dialog->priv;
+ GtkWidget *child = NULL;
+ GList *children, *tmp_list;
- return TRUE;
+ children = gtk_container_get_children (GTK_CONTAINER (priv->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;
+
+ event = gdk_event_new (GDK_DELETE);
+
+ event->any.window = g_object_ref (gtk_widget_get_window (widget));
+ event->any.send_event = TRUE;
+
+ gtk_main_do_event (event);
+ gdk_event_free (event);
+}
+
+/**
+ * gtk_dialog_new:
+ *
+ * Creates a new dialog box.
+ *
+ * Widgets should not be packed into this #GtkWindow
+ * directly, but into the @vbox and @action_area, as described above.
+ *
+ * Returns: the new dialog as a #GtkWidget
+ */
GtkWidget*
gtk_dialog_new (void)
{
- return GTK_WIDGET (gtk_type_new (GTK_TYPE_DIALOG));
+ return g_object_new (GTK_TYPE_DIALOG, NULL);
}
static GtkWidget*
{
GtkDialog *dialog;
- dialog = GTK_DIALOG (g_object_new (GTK_TYPE_DIALOG, NULL));
+ dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
if (title)
gtk_window_set_title (GTK_WINDOW (dialog), title);
/**
* gtk_dialog_new_with_buttons:
- * @title: Title of the dialog, or NULL
- * @parent: Transient parent of the dialog, or NULL
+ * @title: (allow-none): Title of the dialog, or %NULL
+ * @parent: (allow-none): 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
+ * @first_button_text: (allow-none): stock ID or text to go in first button, or %NULL
+ * @...: 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)
+ * %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
+ * (#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_BUTTON_OK, or some arbitrary text. A response ID can be
+ * #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_NONE.
- * 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,
+ * #GtkDialog will emit the #GtkDialog::response signal with the corresponding
+ * response ID. If a #GtkDialog receives the #GtkWidget::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:
- * <programlisting>
+ * |[
* GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
* main_app_window,
* GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
- * GTK_STOCK_BUTTON_OK,
+ * GTK_STOCK_OK,
* GTK_RESPONSE_ACCEPT,
- * GTK_STOCK_BUTTON_CANCEL,
- * GTK_RESPONSE_NONE,
+ * GTK_STOCK_CANCEL,
+ * GTK_RESPONSE_REJECT,
* NULL);
- * </programlisting>
- *
+ * ]|
+ *
* Return value: a new #GtkDialog
- **/
+ */
GtkWidget*
gtk_dialog_new_with_buttons (const gchar *title,
GtkWindow *parent,
{
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);
}
-typedef struct _ResponseData ResponseData;
-
-struct _ResponseData
+static void
+response_data_free (gpointer data)
{
- gint response_id;
-};
+ g_slice_free (ResponseData, data);
+}
static ResponseData*
-get_response_data (GtkWidget *widget)
+get_response_data (GtkWidget *widget,
+ gboolean create)
{
- ResponseData *ad = gtk_object_get_data (GTK_OBJECT (widget),
- "gtk-dialog-response-data");
+ ResponseData *ad = g_object_get_data (G_OBJECT (widget),
+ "gtk-dialog-response-data");
- if (ad == NULL)
+ if (ad == NULL && create)
{
- ad = g_new (ResponseData, 1);
-
- gtk_object_set_data_full (GTK_OBJECT (widget),
- "gtk-dialog-response-data",
- ad,
- g_free);
+ ad = g_slice_new (ResponseData);
+
+ g_object_set_data_full (G_OBJECT (widget),
+ I_("gtk-dialog-response-data"),
+ ad,
+ response_data_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);
- g_assert (ad != NULL);
-
- response_id = ad->response_id;
+ response_id = gtk_dialog_get_response_for_widget (dialog, widget);
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.
- *
+ * connecting a signal handler that will emit the #GtkDialog::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.
**/
void
-gtk_dialog_add_action_widget (GtkDialog *dialog,
- GtkWidget *child,
- gint response_id)
+gtk_dialog_add_action_widget (GtkDialog *dialog,
+ GtkWidget *child,
+ gint response_id)
{
+ GtkDialogPrivate *priv;
ResponseData *ad;
-
+ guint signal_id;
+
g_return_if_fail (GTK_IS_DIALOG (dialog));
g_return_if_fail (GTK_IS_WIDGET (child));
- ad = get_response_data (child);
+ priv = dialog->priv;
+
+ ad = get_response_data (child, TRUE);
ad->response_id = response_id;
- if (GTK_WIDGET_GET_CLASS (child)->activate_signal != 0)
+ if (GTK_IS_BUTTON (child))
+ signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
+ else
+ signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
+
+ if (signal_id)
{
- const gchar* name =
- gtk_signal_name (GTK_WIDGET_GET_CLASS (child)->activate_signal);
-
- gtk_signal_connect_while_alive (GTK_OBJECT (child),
- name,
- GTK_SIGNAL_FUNC (action_widget_activated),
- dialog,
- GTK_OBJECT (dialog));
+ 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),
+ gtk_box_pack_end (GTK_BOX (priv->action_area),
child,
- FALSE, TRUE, 5);
+ FALSE, TRUE, 0);
+
+ if (response_id == GTK_RESPONSE_HELP)
+ gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area), child, TRUE);
}
/**
* @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.
- *
+ * #GtkDialog::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: (transfer none): the #GtkButton widget that was added
**/
-void
+GtkWidget*
gtk_dialog_add_button (GtkDialog *dialog,
const gchar *button_text,
gint response_id)
{
GtkWidget *button;
-
- g_return_if_fail (GTK_IS_DIALOG (dialog));
- g_return_if_fail (button_text != NULL);
- button = gtk_button_new_stock (button_text,
- gtk_window_get_default_accel_group (GTK_WINDOW (dialog)));
+ 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_can_default (button, TRUE);
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)
+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);
* 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
- *
+ * @...: 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
+ * 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)
+{
+ GtkDialogPrivate *priv;
+ GList *children;
+ GList *tmp_list;
+
+ g_return_if_fail (GTK_IS_DIALOG (dialog));
+
+ priv = dialog->priv;
+
+ children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
+
+ tmp_list = children;
+ while (tmp_list != NULL)
+ {
+ GtkWidget *widget = tmp_list->data;
+ ResponseData *rd = get_response_data (widget, FALSE);
+
+ 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)
+{
+ GtkDialogPrivate *priv;
+ GList *children;
+ GList *tmp_list;
+
+ g_return_if_fail (GTK_IS_DIALOG (dialog));
+
+ priv = dialog->priv;
+
+ children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
+
+ tmp_list = children;
+ while (tmp_list != NULL)
+ {
+ GtkWidget *widget = tmp_list->data;
+ ResponseData *rd = get_response_data (widget, FALSE);
+
+ 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_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;
+ * @response_id: response ID
+ *
+ * Emits the #GtkDialog::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.
+ * ::response signal and take appropriate action.
**/
void
gtk_dialog_response (GtkDialog *dialog,
gint response_id)
{
- g_return_if_fail (dialog != NULL);
g_return_if_fail (GTK_IS_DIALOG (dialog));
- gtk_signal_emit (GTK_OBJECT (dialog),
- dialog_signals[RESPONSE],
- response_id);
+ 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 (ri->loop != NULL)
- {
- g_main_quit (ri->loop);
- g_main_destroy (ri->loop);
- ri->loop = NULL;
- }
+ if (g_main_loop_is_running (ri->loop))
+ g_main_loop_quit (ri->loop);
}
static void
-run_destroy_handler (GtkDialog *dialog, gpointer data)
+run_unmap_handler (GtkDialog *dialog, gpointer data)
{
RunInfo *ri = data;
gpointer data)
{
RunInfo *ri = data;
-
+
shutdown_loop (ri);
- /* emit response signal */
- gtk_dialog_response (dialog, GTK_RESPONSE_NONE);
-
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,
- * gtk_dialog_run() 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
+ * #GtkDialog::response signal, or is destroyed. If the dialog is
+ * destroyed during the call to gtk_dialog_run(), gtk_dialog_run() 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
+ * During gtk_dialog_run(), the default behavior of #GtkWidget::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_NONE. 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.
+ * #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:
- * <programlisting>
+ * |[
* gint result = gtk_dialog_run (GTK_DIALOG (dialog));
* switch (result)
* {
* break;
* }
* gtk_widget_destroy (dialog);
- * </programlisting>
- *
+ * ]|
+ *
+ * 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, <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 };
+ RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL, FALSE };
gboolean was_modal;
- guint response_handler;
- guint destroy_handler;
- guint delete_handler;
-
+ gulong response_handler;
+ gulong unmap_handler;
+ gulong destroy_handler;
+ gulong delete_handler;
+
g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);
- gtk_object_ref (GTK_OBJECT (dialog));
+ g_object_ref (dialog);
- if (!GTK_WIDGET_VISIBLE (dialog))
- gtk_widget_show (GTK_WIDGET (dialog));
-
- was_modal = GTK_WINDOW (dialog)->modal;
+ was_modal = gtk_window_get_modal (GTK_WINDOW (dialog));
if (!was_modal)
gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
+ if (!gtk_widget_get_visible (GTK_WIDGET (dialog)))
+ gtk_widget_show (GTK_WIDGET (dialog));
+
response_handler =
- gtk_signal_connect (GTK_OBJECT (dialog),
- "response",
- GTK_SIGNAL_FUNC (run_response_handler),
- &ri);
-
- destroy_handler =
- gtk_signal_connect (GTK_OBJECT (dialog),
- "destroy",
- GTK_SIGNAL_FUNC (run_destroy_handler),
- &ri);
-
+ 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 =
- gtk_signal_connect (GTK_OBJECT (dialog),
- "delete_event",
- GTK_SIGNAL_FUNC (run_delete_handler),
- &ri);
-
- ri.loop = g_main_new (FALSE);
+ g_signal_connect (dialog,
+ "delete-event",
+ G_CALLBACK (run_delete_handler),
+ &ri);
- g_main_run (ri.loop);
-
- g_assert (ri.loop == NULL);
-
- if (!GTK_OBJECT_DESTROYED (dialog))
+ 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;
+
+ if (!ri.destroyed)
{
if (!was_modal)
gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
-
- gtk_signal_disconnect (GTK_OBJECT (dialog), destroy_handler);
- gtk_signal_disconnect (GTK_OBJECT (dialog), response_handler);
- gtk_signal_disconnect (GTK_OBJECT (dialog), delete_handler);
+
+ 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);
}
- gtk_object_unref (GTK_OBJECT (dialog));
+ g_object_unref (dialog);
return ri.response_id;
}
+/**
+ * gtk_dialog_get_widget_for_response:
+ * @dialog: a #GtkDialog
+ * @response_id: the response ID used by the @dialog widget
+ *
+ * Gets the widget button that uses the given response ID in the action area
+ * of a dialog.
+ *
+ * Returns: (transfer none): the @widget button that uses the given
+ * @response_id, or %NULL.
+ *
+ * Since: 2.20
+ */
+GtkWidget*
+gtk_dialog_get_widget_for_response (GtkDialog *dialog,
+ gint response_id)
+{
+ GtkDialogPrivate *priv;
+ GList *children;
+ GList *tmp_list;
+
+ g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
+
+ priv = dialog->priv;
+
+ children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
+
+ tmp_list = children;
+ while (tmp_list != NULL)
+ {
+ GtkWidget *widget = tmp_list->data;
+ ResponseData *rd = get_response_data (widget, FALSE);
+
+ if (rd && rd->response_id == response_id)
+ {
+ g_list_free (children);
+ return widget;
+ }
+
+ tmp_list = g_list_next (tmp_list);
+ }
+
+ g_list_free (children);
+
+ return NULL;
+}
+
+/**
+ * gtk_dialog_get_response_for_widget:
+ * @dialog: a #GtkDialog
+ * @widget: a widget in the action area of @dialog
+ *
+ * Gets the response id of a widget in the action area
+ * of a dialog.
+ *
+ * Returns: the response id of @widget, or %GTK_RESPONSE_NONE
+ * if @widget doesn't have a response id set.
+ *
+ * Since: 2.8
+ */
+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: (allow-none): 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)
+{
+ GtkDialogPrivate *priv = dialog->priv;
+ 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 (priv->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
+ * @...: a list of more response ids of @dialog's buttons, terminated by -1
+ *
+ * Sets an alternative button order. If the
+ * #GtkSettings: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://library.gnome.org/devel/hig-book/stable/">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:
+ * |[
+ * 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);
+ * ]|
+ *
+ * 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: (array length=n_params): an array of response ids of
+ * @dialog's buttons
+ *
+ * Sets an alternative button order. If the
+ * #GtkSettings: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)
+{
+ GtkDialogPrivate *priv = dialog->priv;
+ 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 (priv->action_area), child, position);
+ }
+}
+
+typedef struct {
+ gchar *widget_name;
+ gchar *response_id;
+} ActionWidgetInfo;
+
+typedef struct {
+ GtkDialog *dialog;
+ GtkBuilder *builder;
+ GSList *items;
+ gchar *response;
+} ActionWidgetsSubParserData;
+
+static void
+attributes_start_element (GMarkupParseContext *context,
+ const gchar *element_name,
+ const gchar **names,
+ const gchar **values,
+ gpointer user_data,
+ GError **error)
+{
+ ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
+ guint i;
+
+ if (strcmp (element_name, "action-widget") == 0)
+ {
+ for (i = 0; names[i]; i++)
+ if (strcmp (names[i], "response") == 0)
+ parser_data->response = g_strdup (values[i]);
+ }
+ else if (strcmp (element_name, "action-widgets") == 0)
+ return;
+ else
+ g_warning ("Unsupported tag for GtkDialog: %s\n", element_name);
+}
+
+static void
+attributes_text_element (GMarkupParseContext *context,
+ const gchar *text,
+ gsize text_len,
+ gpointer user_data,
+ GError **error)
+{
+ ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
+ ActionWidgetInfo *item;
+
+ if (!parser_data->response)
+ return;
+
+ item = g_new (ActionWidgetInfo, 1);
+ item->widget_name = g_strndup (text, text_len);
+ item->response_id = parser_data->response;
+ parser_data->items = g_slist_prepend (parser_data->items, item);
+ parser_data->response = NULL;
+}
+
+static const GMarkupParser attributes_parser =
+ {
+ attributes_start_element,
+ NULL,
+ attributes_text_element,
+ };
+
+static gboolean
+gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
+ GtkBuilder *builder,
+ GObject *child,
+ const gchar *tagname,
+ GMarkupParser *parser,
+ gpointer *data)
+{
+ ActionWidgetsSubParserData *parser_data;
+
+ if (child)
+ return FALSE;
+
+ if (strcmp (tagname, "action-widgets") == 0)
+ {
+ parser_data = g_slice_new0 (ActionWidgetsSubParserData);
+ parser_data->dialog = GTK_DIALOG (buildable);
+ parser_data->items = NULL;
+
+ *parser = attributes_parser;
+ *data = parser_data;
+ return TRUE;
+ }
+
+ return parent_buildable_iface->custom_tag_start (buildable, builder, child,
+ tagname, parser, data);
+}
+
+static void
+gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
+ GtkBuilder *builder,
+ GObject *child,
+ const gchar *tagname,
+ gpointer user_data)
+{
+ GtkDialog *dialog = GTK_DIALOG (buildable);
+ GtkDialogPrivate *priv = dialog->priv;
+ GSList *l;
+ ActionWidgetsSubParserData *parser_data;
+ GObject *object;
+ ResponseData *ad;
+ guint signal_id;
+
+ if (strcmp (tagname, "action-widgets"))
+ {
+ parent_buildable_iface->custom_finished (buildable, builder, child,
+ tagname, user_data);
+ return;
+ }
+
+ parser_data = (ActionWidgetsSubParserData*)user_data;
+ parser_data->items = g_slist_reverse (parser_data->items);
+
+ for (l = parser_data->items; l; l = l->next)
+ {
+ ActionWidgetInfo *item = l->data;
+
+ object = gtk_builder_get_object (builder, item->widget_name);
+ if (!object)
+ {
+ g_warning ("Unknown object %s specified in action-widgets of %s",
+ item->widget_name,
+ gtk_buildable_get_name (GTK_BUILDABLE (buildable)));
+ continue;
+ }
+
+ ad = get_response_data (GTK_WIDGET (object), TRUE);
+ ad->response_id = g_ascii_strtoll (item->response_id, NULL, 10);
+
+ if (GTK_IS_BUTTON (object))
+ signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
+ else
+ signal_id = GTK_WIDGET_GET_CLASS (object)->activate_signal;
+
+ if (signal_id)
+ {
+ GClosure *closure;
+
+ closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
+ G_OBJECT (dialog));
+ g_signal_connect_closure_by_id (object,
+ signal_id,
+ 0,
+ closure,
+ FALSE);
+ }
+
+ if (ad->response_id == GTK_RESPONSE_HELP)
+ gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area),
+ GTK_WIDGET (object), TRUE);
+
+ g_free (item->widget_name);
+ g_free (item->response_id);
+ g_free (item);
+ }
+ g_slist_free (parser_data->items);
+ g_slice_free (ActionWidgetsSubParserData, parser_data);
+}
+
+/**
+ * gtk_dialog_get_action_area:
+ * @dialog: a #GtkDialog
+ *
+ * Returns the action area of @dialog.
+ *
+ * Returns: (transfer none): the action area.
+ *
+ * Since: 2.14
+ **/
+GtkWidget *
+gtk_dialog_get_action_area (GtkDialog *dialog)
+{
+ g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
+ return dialog->priv->action_area;
+}
+/**
+ * gtk_dialog_get_content_area:
+ * @dialog: a #GtkDialog
+ *
+ * Returns the content area of @dialog.
+ *
+ * Returns: (transfer none): the content area #GtkBox.
+ *
+ * Since: 2.14
+ **/
+GtkWidget *
+gtk_dialog_get_content_area (GtkDialog *dialog)
+{
+ g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
+ return dialog->priv->vbox;
+}
projects / ~andy / gtk / blobdiff