Commit 9640eccd authored by William Jon McCann's avatar William Jon McCann Committed by Matthias Clasen

dialog: Add a headerbar

This change makes it possible for GtkDialog to pack
its action widgets into a header bar, instead of the
traditional action area. This change is controlled
by the use-header-bar construct-only property.

https://bugzilla.gnome.org/show_bug.cgi?id=720059
parent 25e6ba48
......@@ -1033,6 +1033,7 @@ gtk_dialog_get_response_for_widget
gtk_dialog_get_widget_for_response
gtk_dialog_get_action_area
gtk_dialog_get_content_area
gtk_dialog_get_header_bar
<SUBSECTION>
gtk_alternative_dialog_button_order
gtk_dialog_set_alternative_button_order
......
......@@ -29,6 +29,7 @@
#include "gtkbutton.h"
#include "gtkdialog.h"
#include "gtkheaderbar.h"
#include "gtkbbox.h"
#include "gtklabel.h"
#include "gtkmarshalers.h"
......@@ -171,7 +172,11 @@
struct _GtkDialogPrivate
{
GtkWidget *vbox;
GtkWidget *headerbar;
GtkWidget *action_area;
gboolean use_header_bar;
gboolean constructed;
};
typedef struct _ResponseData ResponseData;
......@@ -212,7 +217,7 @@ static void gtk_dialog_buildable_custom_finished (GtkBuildable *buildab
enum {
PROP_0,
PROP_HAS_SEPARATOR
PROP_USE_HEADER_BAR
};
enum {
......@@ -228,14 +233,205 @@ G_DEFINE_TYPE_WITH_CODE (GtkDialog, gtk_dialog, GTK_TYPE_WINDOW,
G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
gtk_dialog_buildable_interface_init))
static void
set_use_header_bar (GtkDialog *dialog,
gboolean use_header_bar)
{
GtkDialogPrivate *priv = dialog->priv;
priv->use_header_bar = use_header_bar;
gtk_widget_set_visible (priv->action_area, !priv->use_header_bar);
gtk_widget_set_visible (priv->headerbar, priv->use_header_bar);
if (!priv->use_header_bar)
gtk_window_set_titlebar (GTK_WINDOW (dialog), NULL);
}
static void
gtk_dialog_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkDialog *dialog = GTK_DIALOG (object);
switch (prop_id)
{
case PROP_USE_HEADER_BAR:
set_use_header_bar (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 = GTK_DIALOG (object);
GtkDialogPrivate *priv = dialog->priv;
switch (prop_id)
{
case PROP_USE_HEADER_BAR:
g_value_set_boolean (value, priv->use_header_bar);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
{
gint response_id;
response_id = gtk_dialog_get_response_for_widget (dialog, widget);
gtk_dialog_response (dialog, response_id);
}
typedef struct {
GtkWidget *child;
gint response_id;
} ActionWidgetData;
static void
add_response_data (GtkDialog *dialog,
GtkWidget *child,
gint response_id)
{
ResponseData *ad;
guint signal_id;
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;
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");
}
static void
add_to_header_bar (GtkDialog *dialog,
GtkWidget *child,
gint response_id)
{
GtkDialogPrivate *priv = dialog->priv;
gtk_widget_set_valign (child, GTK_ALIGN_CENTER);
if (response_id == GTK_RESPONSE_CANCEL || response_id == GTK_RESPONSE_HELP)
gtk_header_bar_pack_start (GTK_HEADER_BAR (priv->headerbar), child);
else
gtk_header_bar_pack_end (GTK_HEADER_BAR (priv->headerbar), child);
if (response_id == GTK_RESPONSE_CANCEL || response_id == GTK_RESPONSE_CLOSE)
gtk_header_bar_set_show_close_button (GTK_HEADER_BAR (priv->headerbar), FALSE);
}
static void
add_to_action_area (GtkDialog *dialog,
GtkWidget *child,
gint response_id)
{
GtkDialogPrivate *priv = dialog->priv;
gtk_widget_set_valign (child, GTK_ALIGN_BASELINE);
gtk_container_add (GTK_CONTAINER (priv->action_area), child);
if (response_id == GTK_RESPONSE_HELP)
gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area), child, TRUE);
}
static void
add_action_widgets (GtkDialog *dialog)
{
GtkDialogPrivate *priv = dialog->priv;
GList *children;
GList *l;
if (priv->use_header_bar)
{
children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
for (l = children; l != NULL; l = l->next)
{
GtkWidget *child = l->data;
gboolean has_default;
ResponseData *rd;
gint response_id;
has_default = gtk_widget_has_default (child);
rd = get_response_data (child, FALSE);
response_id = rd ? rd->response_id : GTK_RESPONSE_NONE;
g_object_ref (child);
gtk_container_remove (GTK_CONTAINER (priv->action_area), child);
add_to_header_bar (dialog, child, response_id);
g_object_unref (child);
if (has_default)
gtk_widget_grab_default (child);
}
g_list_free (children);
}
}
static GObject *
gtk_dialog_constructor (GType type,
guint n_construct_properties,
GObjectConstructParam *construct_params)
{
GObject *object;
GtkDialog *dialog;
GtkDialogPrivate *priv;
object = G_OBJECT_CLASS (gtk_dialog_parent_class)->constructor (type,
n_construct_properties,
construct_params);
dialog = GTK_DIALOG (object);
priv = dialog->priv;
priv->constructed = TRUE;
add_action_widgets (dialog);
return object;
}
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);
gobject_class->constructor = gtk_dialog_constructor;
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_updated = gtk_dialog_style_updated;
......@@ -326,6 +522,22 @@ gtk_dialog_class_init (GtkDialogClass *class)
5,
GTK_PARAM_READABLE));
/**
* GtkDialog:use-header-bar:
*
* %TRUE if the dialog uses a #GtkHeaderBar for action buttons
* instead of the action-area.
*
* Since: 3.12
*/
g_object_class_install_property (gobject_class,
PROP_USE_HEADER_BAR,
g_param_spec_boolean ("use-header-bar",
P_("Use Header Bar"),
P_("Use Header Bar for actions."),
FALSE,
GTK_PARAM_READWRITE|G_PARAM_CONSTRUCT_ONLY));
binding_set = gtk_binding_set_by_class (class);
gtk_binding_entry_add_signal (binding_set, GDK_KEY_Escape, 0, "close", 0);
......@@ -333,6 +545,7 @@ gtk_dialog_class_init (GtkDialogClass *class)
*/
gtk_widget_class_set_template_from_resource (widget_class, "/org/gtk/libgtk/gtkdialog.ui");
gtk_widget_class_bind_template_child_internal_private (widget_class, GtkDialog, vbox);
gtk_widget_class_bind_template_child_internal_private (widget_class, GtkDialog, headerbar);
gtk_widget_class_bind_template_child_internal_private (widget_class, GtkDialog, action_area);
gtk_widget_class_bind_template_callback (widget_class, gtk_dialog_delete_event_handler);
}
......@@ -360,6 +573,7 @@ update_spacings (GtkDialog *dialog)
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),
......@@ -398,6 +612,20 @@ gtk_dialog_delete_event_handler (GtkWidget *widget,
return FALSE;
}
static GList *
get_action_children (GtkDialog *dialog)
{
GtkDialogPrivate *priv = dialog->priv;
GList *children;
if (priv->constructed && priv->use_header_bar)
children = gtk_container_get_children (GTK_CONTAINER (priv->headerbar));
else
children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
return children;
}
/* 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
......@@ -413,7 +641,6 @@ gtk_dialog_map (GtkWidget *widget)
GtkWidget *default_widget, *focus;
GtkWindow *window = GTK_WINDOW (widget);
GtkDialog *dialog = GTK_DIALOG (widget);
GtkDialogPrivate *priv = dialog->priv;
GTK_WIDGET_CLASS (gtk_dialog_parent_class)->map (widget);
......@@ -442,7 +669,7 @@ gtk_dialog_map (GtkWidget *widget)
}
while (TRUE);
tmp_list = children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
tmp_list = children = get_action_children (dialog);
while (tmp_list)
{
......@@ -474,23 +701,22 @@ gtk_dialog_style_updated (GtkWidget *widget)
static GtkWidget *
dialog_find_button (GtkDialog *dialog,
gint response_id)
gint response_id)
{
GtkDialogPrivate *priv = dialog->priv;
GtkWidget *child = NULL;
GList *children, *tmp_list;
children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
children = get_action_children (dialog);
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;
}
{
child = tmp_list->data;
break;
}
}
g_list_free (children);
......@@ -527,7 +753,9 @@ gtk_dialog_new_empty (const gchar *title,
{
GtkDialog *dialog;
dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
dialog = g_object_new (GTK_TYPE_DIALOG,
"use-header-bar", (flags & GTK_DIALOG_USE_HEADER_BAR) != 0,
NULL);
if (title)
gtk_window_set_title (GTK_WINDOW (dialog), title);
......@@ -613,7 +841,7 @@ response_data_free (gpointer data)
g_slice_free (ResponseData, data);
}
static ResponseData*
static ResponseData *
get_response_data (GtkWidget *widget,
gboolean create)
{
......@@ -633,16 +861,6 @@ get_response_data (GtkWidget *widget,
return ad;
}
static void
action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
{
gint 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
......@@ -661,45 +879,17 @@ gtk_dialog_add_action_widget (GtkDialog *dialog,
GtkWidget *child,
gint response_id)
{
GtkDialogPrivate *priv;
ResponseData *ad;
guint signal_id;
GtkDialogPrivate *priv = dialog->priv;
g_return_if_fail (GTK_IS_DIALOG (dialog));
g_return_if_fail (GTK_IS_WIDGET (child));
priv = dialog->priv;
ad = get_response_data (child, TRUE);
ad->response_id = response_id;
add_response_data (dialog, child, response_id);
if (GTK_IS_BUTTON (child))
signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
if (priv->constructed && priv->use_header_bar)
add_to_header_bar (dialog, child, response_id);
else
signal_id = GTK_WIDGET_GET_CLASS (child)->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 (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 (priv->action_area),
child,
FALSE, TRUE, 0);
if (response_id == GTK_RESPONSE_HELP)
gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area), child, TRUE);
add_to_action_area (dialog, child, response_id);
}
/**
......@@ -740,14 +930,12 @@ gtk_dialog_add_button (GtkDialog *dialog,
G_GNUC_END_IGNORE_DEPRECATIONS;
gtk_style_context_add_class (gtk_widget_get_style_context (button), "text-button");
gtk_widget_set_can_default (button, TRUE);
gtk_widget_set_valign (button, GTK_ALIGN_BASELINE);
gtk_widget_show (button);
gtk_dialog_add_action_widget (dialog,
button,
response_id);
gtk_dialog_add_action_widget (dialog, button, response_id);
return button;
}
......@@ -821,15 +1009,12 @@ 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));
children = get_action_children (dialog);
tmp_list = children;
while (tmp_list != NULL)
......@@ -859,15 +1044,12 @@ 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));
children = get_action_children (dialog);
tmp_list = children;
while (tmp_list != NULL)
......@@ -1102,15 +1284,12 @@ 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));
children = get_action_children (dialog);
tmp_list = children;
while (tmp_list != NULL)
......@@ -1273,14 +1452,17 @@ gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
g_return_if_fail (GTK_IS_DIALOG (dialog));
if (dialog->priv->use_header_bar)
return;
if (!gtk_alt_dialog_button_order ())
return;
return;
va_start (args, first_response_id);
gtk_dialog_set_alternative_button_order_valist (dialog,
first_response_id,
args);
first_response_id,
args);
va_end (args);
}
/**
......@@ -1314,6 +1496,9 @@ gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
g_return_if_fail (GTK_IS_DIALOG (dialog));
g_return_if_fail (new_order != NULL);
if (dialog->priv->use_header_bar)
return;
if (!gtk_alt_dialog_button_order ())
return;
......@@ -1505,8 +1690,8 @@ gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
}
if (ad->response_id == GTK_RESPONSE_HELP)
gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area),
GTK_WIDGET (object), TRUE);
gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area),
GTK_WIDGET (object), TRUE);
g_free (item->widget_name);
g_free (item);
......@@ -1536,6 +1721,26 @@ gtk_dialog_get_action_area (GtkDialog *dialog)
return dialog->priv->action_area;
}
/**
* gtk_dialog_get_header_bar:
* @dialog: a #GtkDialog
*
* Returns the header bar of @dialog. Note that the
* headerbar is only used by the dialog if the
* #GtkDialog::use-header-bar property is %TRUE.
*
* Returns: (transfer none): the header bar
*
* Since: 3.12
*/
GtkWidget *
gtk_dialog_get_header_bar (GtkDialog *dialog)
{
g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
return dialog->priv->headerbar;
}
/**
* gtk_dialog_get_content_area:
* @dialog: a #GtkDialog
......
......@@ -41,13 +41,16 @@ G_BEGIN_DECLS
* see gtk_window_set_modal()
* @GTK_DIALOG_DESTROY_WITH_PARENT: Destroy the dialog when its
* parent is destroyed, see gtk_window_set_destroy_with_parent()
* @GTK_DIALOG_USE_HEADER_BAR: Create dialog with actions in header
* bar instead of action area. Since 3.12.
*
* Flags used to influence dialog construction.
*/
typedef enum
{
GTK_DIALOG_MODAL = 1 << 0,
GTK_DIALOG_DESTROY_WITH_PARENT = 1 << 1
GTK_DIALOG_DESTROY_WITH_PARENT = 1 << 1,
GTK_DIALOG_USE_HEADER_BAR = 1 << 2
} GtkDialogFlags;
/**
......@@ -192,6 +195,8 @@ GDK_DEPRECATED_IN_3_10
GtkWidget * gtk_dialog_get_action_area (GtkDialog *dialog);
GDK_AVAILABLE_IN_ALL
GtkWidget * gtk_dialog_get_content_area (GtkDialog *dialog);
GDK_AVAILABLE_IN_3_12
GtkWidget * gtk_dialog_get_header_bar (GtkDialog *dialog);
G_END_DECLS
......
......@@ -6,6 +6,13 @@
<property name="window_position">center-on-parent</property>
<property name="type_hint">dialog</property>
<signal name="delete-event" handler="gtk_dialog_delete_event_handler" swapped="no"/>
<child type="titlebar">
<object class="GtkHeaderBar" id="headerbar">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="show-close-button">True</property>
</object>
</child>
<child>
<object class="GtkBox" id="vbox">
<property name="visible">True</property>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment