* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+#include <stdlib.h>
+#include <string.h>
#include <config.h>
#include "gtkbutton.h"
#include "gtkdialog.h"
#include "gtkintl.h"
#include "gtkbindings.h"
#include "gtkprivate.h"
+#include "gtkbuildable.h"
#include "gtkalias.h"
#define GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_DIALOG, GtkDialogPrivate))
static void gtk_dialog_close (GtkDialog *dialog);
+static void gtk_dialog_add (GtkContainer *container,
+ GtkWidget *widget);
+static void gtk_dialog_remove (GtkContainer *container,
+ GtkWidget *widget);
+
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,
static guint dialog_signals[LAST_SIGNAL];
-G_DEFINE_TYPE (GtkDialog, gtk_dialog, GTK_TYPE_WINDOW)
+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)
{
GObjectClass *gobject_class;
GtkWidgetClass *widget_class;
+ GtkContainerClass *container_class;
GtkBindingSet *binding_set;
gobject_class = G_OBJECT_CLASS (class);
widget_class = GTK_WIDGET_CLASS (class);
+ container_class = GTK_CONTAINER_CLASS (class);
gobject_class->set_property = gtk_dialog_set_property;
gobject_class->get_property = gtk_dialog_get_property;
+
+ container_class->add = gtk_dialog_add;
+ container_class->remove = gtk_dialog_remove;
widget_class->map = gtk_dialog_map;
widget_class->style_set = gtk_dialog_style_set;
g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));
+ /**
+ * GtkDialog:has-separator:
+ *
+ * When %TRUE, the dialog has a separator bar above its buttons.
+ */
g_object_class_install_property (gobject_class,
PROP_HAS_SEPARATOR,
g_param_spec_boolean ("has-separator",
P_("The dialog has a separator bar above its buttons"),
TRUE,
GTK_PARAM_READWRITE));
-
+
+ /**
+ * 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] =
g_signal_new (I_("response"),
G_OBJECT_CLASS_TYPE (class),
G_TYPE_NONE, 1,
G_TYPE_INT);
+ /**
+ * GtkDialog::close:
+ *
+ * The ::close signal is a
+ * <link linkend="keybinding-signals">keybinding signal</link>
+ * which getrs 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),
binding_set = gtk_binding_set_by_class (class);
- gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
- "close", 0);
+ gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0, "close", 0);
}
static void
NULL);
dialog->vbox = gtk_vbox_new (FALSE, 0);
-
- gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
+
+ /* gtk_container_add () from superclass */
+ GTK_CONTAINER_CLASS (gtk_dialog_parent_class)->add (GTK_CONTAINER (dialog),
+ dialog->vbox);
gtk_widget_show (dialog->vbox);
dialog->action_area = gtk_hbutton_box_new ();
gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
}
+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)
+{
+ if (strcmp (childname, "vbox") == 0)
+ return G_OBJECT (GTK_DIALOG (buildable)->vbox);
+ else if (strcmp (childname, "action_area") == 0)
+ return G_OBJECT (GTK_DIALOG (buildable)->action_area);
+
+ return parent_buildable_iface->get_internal_child (buildable,
+ builder,
+ childname);
+}
static void
gtk_dialog_set_property (GObject *object,
}
}
+static void
+gtk_dialog_add (GtkContainer *container,
+ GtkWidget *widget)
+{
+ GtkDialog *dialog;
+
+ dialog = GTK_DIALOG (container);
+
+ gtk_box_pack_start (GTK_BOX (dialog->vbox), widget, FALSE, FALSE, 0);
+}
+
+static void
+gtk_dialog_remove (GtkContainer *container,
+ GtkWidget *widget)
+{
+ GtkDialog *dialog;
+
+ dialog = GTK_DIALOG (container);
+
+ gtk_container_remove (GTK_CONTAINER (dialog->vbox), widget);
+}
+
static gint
gtk_dialog_delete_event_handler (GtkWidget *widget,
GdkEventAny *event,
* (#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
+ * #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,
+ * #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:
- * <informalexample><programlisting>
+ * |[
* GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
* main_app_window,
* GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
* GTK_STOCK_CANCEL,
* GTK_RESPONSE_REJECT,
* NULL);
- * </programlisting></informalexample>
+ * ]|
*
* Return value: a new #GtkDialog
**/
* @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,
*
* 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.
+ * #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: the button widget that was added
**/
* @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;
+ * 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,
* @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.
+ * #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_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.
+ * #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 (<!-- -->);
+ * do_application_specific_something ();
* break;
* default:
- * do_nothing_since_dialog_was_cancelled (<!-- -->);
+ * 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
delete_handler =
g_signal_connect (dialog,
- "delete_event",
+ "delete-event",
G_CALLBACK (run_delete_handler),
&ri);
* @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.
+ * 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://developer.gnome.org/projects/gup/hig/2.0/">Human
*
* 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);
* GTK_RESPONSE_CANCEL,
* GTK_RESPONSE_HELP,
* -1);
- * </programlisting></informalexample>
+ * ]|
*
* Since: 2.6
*/
* @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.
+ * 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.
*
}
}
+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,
+ };
+
+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)
+{
+ GSList *l;
+ ActionWidgetsSubParserData *parser_data;
+ GObject *object;
+ GtkDialog *dialog;
+ ResponseData *ad;
+ guint signal_id;
+
+ if (strcmp (tagname, "action-widgets"))
+ {
+ parent_buildable_iface->custom_finished (buildable, builder, child,
+ tagname, user_data);
+ return;
+ }
+
+ dialog = GTK_DIALOG (buildable);
+ 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 = atoi (item->response_id);
+
+ 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 (dialog->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: a #GtkHButtonBox.
+ *
+ * Since: GSEAL-branch
+ **/
+GtkHButtonBox *
+gtk_dialog_get_action_area (GtkDialog *dialog)
+{
+ g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
+
+ return dialog->action_area;
+}
+
+/**
+ * gtk_dialog_pack_start:
+ * @dialog: a #GtkDialog
+ * @widget: #GtkWidget to be added to @dialog.
+ * @expand: %TRUE if @widget should take all extra space.
+ * @fill: %TRUE if all space given should be used by @widget
+ * @padding: extra pixels to put between @widget and its neighbors
+ *
+ * This function similar to gtk_box_pack_start() packs @widget
+ * with reference to the start of @dialog.
+ *
+ * Since: GSEAL-branch
+ **/
+void
+gtk_dialog_pack_start (GtkDialog *dialog,
+ GtkWidget *widget,
+ gboolean expand,
+ gboolean fill,
+ guint padding)
+{
+ g_return_if_fail (GTK_IS_DIALOG (dialog));
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+
+ gtk_box_pack_start (GTK_BOX (dialog->vbox),
+ widget, expand, fill, padding);
+}
+
+/**
+ * gtk_dialog_pack_end:
+ * @dialog: a #GtkDialog
+ * @widget: #GtkWidget to be added to @dialog.
+ * @expand: %TRUE if @widget should take all extra space.
+ * @fill: %TRUE if all space given should be used by @widget
+ * @padding: extra pixels to put between @widget and its neighbors
+ *
+ * This function similar to gtk_box_pack_end() packs @widget
+ * with reference to the end of @dialog.
+ *
+ * Since: GSEAL-branch
+ **/
+void
+gtk_dialog_pack_end (GtkDialog *dialog,
+ GtkWidget *widget,
+ gboolean expand,
+ gboolean fill,
+ guint padding)
+{
+ g_return_if_fail (GTK_IS_DIALOG (dialog));
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+
+ gtk_box_pack_end (GTK_BOX (dialog->vbox),
+ widget, expand, fill, padding);
+}
+
#define __GTK_DIALOG_C__
#include "gtkaliasdef.c"
projects / ~andy / gtk / blobdiff