gtkheaderbar.c 65.9 KB
Newer Older
Matthias Clasen's avatar
Matthias Clasen committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * Copyright (c) 2013 Red Hat, Inc.
 *
 * This program 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 program 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 program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#include "config.h"

#include "gtkheaderbar.h"
23
#include "gtkheaderbarprivate.h"
Matthias Clasen's avatar
Matthias Clasen committed
24 25 26 27 28
#include "gtkintl.h"
#include "gtkprivate.h"
#include "gtktypebuiltins.h"
#include "gtkwidgetprivate.h"
#include "gtkcontainerprivate.h"
29
#include "gtkwindowprivate.h"
Matthias Clasen's avatar
Matthias Clasen committed
30 31 32 33 34 35 36 37
#include "a11y/gtkcontaineraccessible.h"

#include <string.h>

/**
 * SECTION:gtkheaderbar
 * @Short_description: A box with a centered child
 * @Title: GtkHeaderBar
38
 * @See_also: #GtkBox, #GtkActionBar
Matthias Clasen's avatar
Matthias Clasen committed
39
 *
40 41
 * GtkHeaderBar is similar to a horizontal #GtkBox. It allows children to 
 * be placed at the start or the end. In addition, it allows a title and
42 43 44 45 46 47 48 49 50
 * subtitle to be displayed. The title will be centered with respect to
 * the width of the box, even if the children at either side take up
 * different amounts of space. The height of the titlebar will be
 * set to provide sufficient space for the subtitle, even if none is
 * currently set. If a subtitle is not needed, the space reservation
 * can be turned off with gtk_header_bar_set_has_subtitle().
 *
 * GtkHeaderBar can add typical window frame controls, such as minimize,
 * maximize and close buttons, or the window icon.
Matthias Clasen's avatar
Matthias Clasen committed
51 52 53
 */

#define DEFAULT_SPACING 6
54
#define MIN_TITLE_CHARS 20
Matthias Clasen's avatar
Matthias Clasen committed
55 56 57 58

struct _GtkHeaderBarPrivate
{
  gchar *title;
59 60 61 62 63
  gchar *subtitle;
  GtkWidget *title_label;
  GtkWidget *subtitle_label;
  GtkWidget *label_box;
  GtkWidget *label_sizing_box;
64
  GtkWidget *subtitle_sizing_label;
Matthias Clasen's avatar
Matthias Clasen committed
65 66
  GtkWidget *custom_title;
  gint spacing;
67
  gboolean has_subtitle;
Matthias Clasen's avatar
Matthias Clasen committed
68 69

  GList *children;
70 71

  gboolean shows_wm_decorations;
72 73
  gchar *decoration_layout;
  gboolean decoration_layout_set;
74 75 76 77 78 79 80 81 82

  GtkWidget *titlebar_start_box;
  GtkWidget *titlebar_end_box;

  GtkWidget *titlebar_icon;
  GtkWidget *titlebar_menu_button;
  GtkWidget *titlebar_min_button;
  GtkWidget *titlebar_max_button;
  GtkWidget *titlebar_close_button;
Matthias Clasen's avatar
Matthias Clasen committed
83 84 85 86 87 88 89 90 91 92 93 94
};

typedef struct _Child Child;
struct _Child
{
  GtkWidget *widget;
  GtkPackType pack_type;
};

enum {
  PROP_0,
  PROP_TITLE,
95
  PROP_SUBTITLE,
96
  PROP_HAS_SUBTITLE,
Matthias Clasen's avatar
Matthias Clasen committed
97 98
  PROP_CUSTOM_TITLE,
  PROP_SPACING,
99
  PROP_SHOW_CLOSE_BUTTON,
100 101
  PROP_DECORATION_LAYOUT,
  PROP_DECORATION_LAYOUT_SET
Matthias Clasen's avatar
Matthias Clasen committed
102 103 104 105 106 107 108 109
};

enum {
  CHILD_PROP_0,
  CHILD_PROP_PACK_TYPE,
  CHILD_PROP_POSITION
};

110
static void gtk_header_bar_buildable_init (GtkBuildableIface *iface);
Matthias Clasen's avatar
Matthias Clasen committed
111 112

G_DEFINE_TYPE_WITH_CODE (GtkHeaderBar, gtk_header_bar, GTK_TYPE_CONTAINER,
113
                         G_ADD_PRIVATE (GtkHeaderBar)
Matthias Clasen's avatar
Matthias Clasen committed
114
                         G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
115
                                                gtk_header_bar_buildable_init));
Matthias Clasen's avatar
Matthias Clasen committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

static void
get_css_padding_and_border (GtkWidget *widget,
                            GtkBorder *border)
{
  GtkStyleContext *context;
  GtkStateFlags state;
  GtkBorder tmp;

  context = gtk_widget_get_style_context (widget);
  state = gtk_widget_get_state_flags (widget);

  gtk_style_context_get_padding (context, state, border);
  gtk_style_context_get_border (context, state, &tmp);
  border->top += tmp.top;
  border->right += tmp.right;
  border->bottom += tmp.bottom;
  border->left += tmp.left;
}

static void
137
init_sizing_box (GtkHeaderBar *bar)
Matthias Clasen's avatar
Matthias Clasen committed
138
{
139
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
140
  GtkWidget *w;
141
  GtkStyleContext *context;
142 143 144 145 146 147 148

  /* We use this box to always request size for the two labels (title
   * and subtitle) as if they were always visible, but then allocate
   * the real label box with its actual size, to keep it center-aligned
   * in case we have only the title.
   */
  priv->label_sizing_box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
149
  gtk_widget_show (priv->label_sizing_box);
150 151

  w = gtk_label_new (NULL);
152
  gtk_widget_show (w);
153 154
  context = gtk_widget_get_style_context (w);
  gtk_style_context_add_class (context, "title");
155 156 157 158
  gtk_box_pack_start (GTK_BOX (priv->label_sizing_box), w, FALSE, FALSE, 0);
  gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
  gtk_label_set_single_line_mode (GTK_LABEL (w), TRUE);
  gtk_label_set_ellipsize (GTK_LABEL (w), PANGO_ELLIPSIZE_END);
159
  gtk_label_set_width_chars (GTK_LABEL (w), MIN_TITLE_CHARS);
160 161

  w = gtk_label_new (NULL);
162 163 164
  context = gtk_widget_get_style_context (w);
  gtk_style_context_add_class (context, "subtitle");
  gtk_style_context_add_class (context, "dim-label");
165 166 167 168
  gtk_box_pack_start (GTK_BOX (priv->label_sizing_box), w, FALSE, FALSE, 0);
  gtk_label_set_line_wrap (GTK_LABEL (w), FALSE);
  gtk_label_set_single_line_mode (GTK_LABEL (w), TRUE);
  gtk_label_set_ellipsize (GTK_LABEL (w), PANGO_ELLIPSIZE_END);
169
  gtk_widget_set_visible (w, priv->has_subtitle || (priv->subtitle && priv->subtitle[0]));
170
  priv->subtitle_sizing_label = w;
171
}
Matthias Clasen's avatar
Matthias Clasen committed
172

173 174 175 176 177
static GtkWidget *
create_title_box (const char *title,
                  const char *subtitle,
                  GtkWidget **ret_title_label,
                  GtkWidget **ret_subtitle_label)
178 179 180 181
{
  GtkWidget *label_box;
  GtkWidget *title_label;
  GtkWidget *subtitle_label;
182
  GtkStyleContext *context;
183 184 185 186 187 188

  label_box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
  gtk_widget_set_valign (label_box, GTK_ALIGN_CENTER);
  gtk_widget_show (label_box);

  title_label = gtk_label_new (title);
189 190
  context = gtk_widget_get_style_context (title_label);
  gtk_style_context_add_class (context, "title");
191 192 193 194 195
  gtk_label_set_line_wrap (GTK_LABEL (title_label), FALSE);
  gtk_label_set_single_line_mode (GTK_LABEL (title_label), TRUE);
  gtk_label_set_ellipsize (GTK_LABEL (title_label), PANGO_ELLIPSIZE_END);
  gtk_box_pack_start (GTK_BOX (label_box), title_label, FALSE, FALSE, 0);
  gtk_widget_show (title_label);
196
  gtk_label_set_width_chars (GTK_LABEL (title_label), MIN_TITLE_CHARS);
197 198

  subtitle_label = gtk_label_new (subtitle);
199 200
  context = gtk_widget_get_style_context (subtitle_label);
  gtk_style_context_add_class (context, "subtitle");
201
  gtk_style_context_add_class (context, "dim-label");
202 203 204 205 206 207 208 209 210 211 212 213 214 215
  gtk_label_set_line_wrap (GTK_LABEL (subtitle_label), FALSE);
  gtk_label_set_single_line_mode (GTK_LABEL (subtitle_label), TRUE);
  gtk_label_set_ellipsize (GTK_LABEL (subtitle_label), PANGO_ELLIPSIZE_END);
  gtk_box_pack_start (GTK_BOX (label_box), subtitle_label, FALSE, FALSE, 0);
  gtk_widget_set_no_show_all (subtitle_label, TRUE);

  if (ret_title_label)
    *ret_title_label = title_label;
  if (ret_subtitle_label)
    *ret_subtitle_label = subtitle_label;

  return label_box;
}

216
gboolean
217
_gtk_header_bar_update_window_icon (GtkHeaderBar *bar,
218
                                    GtkWindow    *window)
219 220
{
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
221
  GdkPixbuf *pixbuf;
222 223 224 225 226

  if (priv->titlebar_icon == NULL)
    return FALSE;

  if (GTK_IS_BUTTON (gtk_widget_get_parent (priv->titlebar_icon)))
227
    pixbuf = gtk_window_get_icon_for_size (window, 16);
228
  else
229
    pixbuf = gtk_window_get_icon_for_size (window, 20);
230

231
  if (pixbuf)
232
    {
233 234
      gtk_image_set_from_pixbuf (GTK_IMAGE (priv->titlebar_icon), pixbuf);
      g_object_unref (pixbuf);
235
      gtk_widget_show (priv->titlebar_icon);
236 237

      return TRUE;
238
    }
239 240

  return FALSE;
241 242
}

243 244
void
_gtk_header_bar_update_window_buttons (GtkHeaderBar *bar)
245 246
{
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
247
  GtkWidget *widget = GTK_WIDGET (bar);
248 249 250 251 252 253 254
  GtkWindow *window;
  GtkTextDirection direction;
  gchar *layout_desc;
  gchar **tokens, **t;
  gint i, j;
  GMenuModel *menu;
  gboolean shown_by_shell;
255
  GdkWindowTypeHint type_hint;
256

257
  if (!gtk_widget_get_realized (widget))
258 259
    return;

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
  if (priv->titlebar_icon)
    {
      gtk_widget_destroy (priv->titlebar_icon);
      priv->titlebar_icon = NULL;
    }
  if (priv->titlebar_menu_button)
    {
      gtk_widget_destroy (priv->titlebar_menu_button);
      priv->titlebar_menu_button = NULL;
    }
  if (priv->titlebar_min_button)
    {
      gtk_widget_destroy (priv->titlebar_min_button);
      priv->titlebar_min_button = NULL;
    }
  if (priv->titlebar_max_button)
    {
      gtk_widget_destroy (priv->titlebar_max_button);
      priv->titlebar_max_button = NULL;
    }
  if (priv->titlebar_close_button)
    {
      gtk_widget_destroy (priv->titlebar_close_button);
      priv->titlebar_close_button = NULL;
    }
  if (priv->titlebar_start_box)
    {
      gtk_widget_destroy (priv->titlebar_start_box);
      priv->titlebar_start_box = NULL;
    }
  if (priv->titlebar_end_box)
    {
      gtk_widget_destroy (priv->titlebar_end_box);
      priv->titlebar_end_box = NULL;
    }
295

296 297 298
  if (!priv->shows_wm_decorations)
    return;

299 300 301 302 303 304
  direction = gtk_widget_get_direction (widget);

  g_object_get (gtk_widget_get_settings (widget),
                "gtk-shell-shows-app-menu", &shown_by_shell,
                "gtk-decoration-layout", &layout_desc,
                NULL);
305

306 307 308 309 310 311 312
  if (priv->decoration_layout_set)
    {
      g_free (layout_desc);
      layout_desc = g_strdup (priv->decoration_layout);
    }

  window = GTK_WINDOW (gtk_widget_get_toplevel (widget));
313

314 315 316 317 318
  if (!shown_by_shell && gtk_window_get_application (window))
    menu = gtk_application_get_app_menu (gtk_window_get_application (window));
  else
    menu = NULL;

319 320
  type_hint = gtk_window_get_type_hint (window);

321 322
  tokens = g_strsplit (layout_desc, ":", 2);
  if (tokens)
323
    {
324
      for (i = 0; i < 2; i++)
325
        {
326 327 328 329 330
          GtkWidget *box;
          GtkWidget *separator;
          int n_children = 0;

          if (tokens[i] == NULL)
331
            break;
332 333 334 335

          t = g_strsplit (tokens[i], ",", -1);

          separator = gtk_separator_new (GTK_ORIENTATION_VERTICAL);
336
          gtk_widget_show (separator);
337 338 339 340 341 342 343 344 345

          box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, priv->spacing);

          for (j = 0; t[j]; j++)
            {
              GtkWidget *button = NULL;
              GtkWidget *image = NULL;
              AtkObject *accessible;

346
              if (strcmp (t[j], "icon") == 0 &&
347
                  type_hint == GDK_WINDOW_TYPE_HINT_NORMAL)
348 349
                {
                  button = gtk_image_new ();
350
                  gtk_widget_set_valign (button, GTK_ALIGN_CENTER);
351
                  priv->titlebar_icon = button;
352 353 354
                  gtk_style_context_add_class (gtk_widget_get_style_context (button), "titlebutton");
                  gtk_widget_set_size_request (button, 20, 20);
                  gtk_widget_show (button);
355
                  if (!_gtk_header_bar_update_window_icon (bar, window))
356 357 358 359 360
                    {
                      gtk_widget_destroy (button);
                      priv->titlebar_icon = NULL;
                      button = NULL;
                    }
361
                }
362 363
              else if (strcmp (t[j], "menu") == 0 &&
                       menu != NULL &&
364
                       type_hint == GDK_WINDOW_TYPE_HINT_NORMAL)
365 366
                {
                  button = gtk_menu_button_new ();
367
                  gtk_widget_set_valign (button, GTK_ALIGN_CENTER);
368 369
                  gtk_menu_button_set_menu_model (GTK_MENU_BUTTON (button), menu);
                  gtk_style_context_add_class (gtk_widget_get_style_context (button), "titlebutton");
370
                  image = gtk_image_new ();
371 372 373 374 375 376
                  gtk_container_add (GTK_CONTAINER (button), image);
                  gtk_widget_set_can_focus (button, FALSE);
                  gtk_widget_show_all (button);
                  accessible = gtk_widget_get_accessible (button);
                  if (GTK_IS_ACCESSIBLE (accessible))
                    atk_object_set_name (accessible, _("Application menu"));
377
                  priv->titlebar_icon = image;
378
                  priv->titlebar_menu_button = button;
379 380
                  if (!_gtk_header_bar_update_window_icon (bar, window))
                    gtk_image_set_from_icon_name (GTK_IMAGE (priv->titlebar_icon), "process-stop-symbolic", GTK_ICON_SIZE_MENU);
381 382
                }
              else if (strcmp (t[j], "minimize") == 0 &&
383
                       type_hint == GDK_WINDOW_TYPE_HINT_NORMAL)
384 385
                {
                  button = gtk_button_new ();
386
                  gtk_widget_set_valign (button, GTK_ALIGN_CENTER);
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
                  gtk_style_context_add_class (gtk_widget_get_style_context (button), "titlebutton");
                  image = gtk_image_new_from_icon_name ("window-minimize-symbolic", GTK_ICON_SIZE_MENU);
                  g_object_set (image, "use-fallback", TRUE, NULL);
                  gtk_container_add (GTK_CONTAINER (button), image);
                  gtk_widget_set_can_focus (button, FALSE);
                  gtk_widget_show_all (button);
                  g_signal_connect_swapped (button, "clicked",
                                            G_CALLBACK (gtk_window_iconify), window);
                  accessible = gtk_widget_get_accessible (button);
                  if (GTK_IS_ACCESSIBLE (accessible))
                    atk_object_set_name (accessible, _("Minimize"));
                  priv->titlebar_min_button = button;
                }
              else if (strcmp (t[j], "maximize") == 0 &&
                       gtk_window_get_resizable (window) &&
402
                       type_hint == GDK_WINDOW_TYPE_HINT_NORMAL)
403 404
                {
                  const gchar *icon_name;
405
                  gboolean maximized = gtk_window_is_maximized (window);
406 407 408

                  icon_name = maximized ? "window-restore-symbolic" : "window-maximize-symbolic";
                  button = gtk_button_new ();
409
                  gtk_widget_set_valign (button, GTK_ALIGN_CENTER);
410 411 412 413 414 415 416 417 418 419 420 421 422 423
                  gtk_style_context_add_class (gtk_widget_get_style_context (button), "titlebutton");
                  image = gtk_image_new_from_icon_name (icon_name, GTK_ICON_SIZE_MENU);
                  g_object_set (image, "use-fallback", TRUE, NULL);
                  gtk_container_add (GTK_CONTAINER (button), image);
                  gtk_widget_set_can_focus (button, FALSE);
                  gtk_widget_show_all (button);
                  g_signal_connect_swapped (button, "clicked",
                                            G_CALLBACK (_gtk_window_toggle_maximized), window);
                  accessible = gtk_widget_get_accessible (button);
                  if (GTK_IS_ACCESSIBLE (accessible))
                    atk_object_set_name (accessible, maximized ? _("Restore") : _("Maximize"));
                  priv->titlebar_max_button = button;
                }
              else if (strcmp (t[j], "close") == 0 &&
424
                       gtk_window_get_deletable (window))
425 426
                {
                  button = gtk_button_new ();
427
                  gtk_widget_set_valign (button, GTK_ALIGN_CENTER);
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
                  image = gtk_image_new_from_icon_name ("window-close-symbolic", GTK_ICON_SIZE_MENU);
                  gtk_style_context_add_class (gtk_widget_get_style_context (button), "titlebutton");
                  g_object_set (image, "use-fallback", TRUE, NULL);
                  gtk_container_add (GTK_CONTAINER (button), image);
                  gtk_widget_set_can_focus (button, FALSE);
                  gtk_widget_show_all (button);
                  g_signal_connect_swapped (button, "clicked",
                                            G_CALLBACK (gtk_window_close), window);
                  accessible = gtk_widget_get_accessible (button);
                  if (GTK_IS_ACCESSIBLE (accessible))
                    atk_object_set_name (accessible, _("Close"));
                  priv->titlebar_close_button = button;
                }

              if (button)
                {
                  gtk_box_pack_start (GTK_BOX (box), button, FALSE, FALSE, 0);
                  n_children ++;
                }
            }
          g_strfreev (t);

          if (n_children == 0)
            {
              gtk_widget_destroy (box);
              continue;
            }

          gtk_widget_show (box);
          gtk_widget_set_parent (box, GTK_WIDGET (bar));

459 460 461 462
          gtk_box_pack_start (GTK_BOX (box), separator, FALSE, FALSE, 0);
          if (i ==1)
            gtk_box_reorder_child (GTK_BOX (box), separator, 0);

463 464
          if ((direction == GTK_TEXT_DIR_LTR && i == 0) ||
              (direction == GTK_TEXT_DIR_RTL && i == 1))
465
            gtk_style_context_add_class (gtk_widget_get_style_context (box), "left");
466
          else
467
            gtk_style_context_add_class (gtk_widget_get_style_context (box), "right");
468 469 470 471 472

          if (i == 0)
            priv->titlebar_start_box = box;
          else
            priv->titlebar_end_box = box;
473
        }
474
      g_strfreev (tokens);
475
    }
476 477
  g_free (layout_desc);
}
478

479
gboolean
480
_gtk_header_bar_shows_app_menu (GtkHeaderBar *bar)
481 482
{
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
483 484 485 486 487 488 489 490 491 492 493 494 495
  GtkWindow *window;
  gchar *layout_desc;
  gboolean ret;

  window = GTK_WINDOW (gtk_widget_get_toplevel (GTK_WIDGET (bar)));
  gtk_widget_style_get (GTK_WIDGET (window),
                        "decoration-button-layout", &layout_desc,
                        NULL);

  ret = priv->shows_wm_decorations &&
        (layout_desc && strstr (layout_desc, "menu"));

  g_free (layout_desc);
496

497
  return ret;
498 499
}

500 501 502
static void
construct_label_box (GtkHeaderBar *bar)
{
503
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
504

505 506
  g_assert (priv->label_box == NULL);

507 508 509 510
  priv->label_box = create_title_box (priv->title,
                                      priv->subtitle,
                                      &priv->title_label,
                                      &priv->subtitle_label);
511
  gtk_widget_set_parent (priv->label_box, GTK_WIDGET (bar));
512 513 514 515 516 517 518 519
}

static void
gtk_header_bar_init (GtkHeaderBar *bar)
{
  GtkStyleContext *context;
  GtkHeaderBarPrivate *priv;

520
  priv = gtk_header_bar_get_instance_private (bar);
521 522 523

  gtk_widget_set_has_window (GTK_WIDGET (bar), FALSE);
  gtk_widget_set_redraw_on_allocate (GTK_WIDGET (bar), FALSE);
Matthias Clasen's avatar
Matthias Clasen committed
524 525

  priv->title = NULL;
526
  priv->subtitle = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
527 528 529
  priv->custom_title = NULL;
  priv->children = NULL;
  priv->spacing = DEFAULT_SPACING;
530
  priv->has_subtitle = TRUE;
531 532
  priv->decoration_layout = NULL;
  priv->decoration_layout_set = FALSE;
Matthias Clasen's avatar
Matthias Clasen committed
533

534 535
  init_sizing_box (bar);
  construct_label_box (bar);
536

Matthias Clasen's avatar
Matthias Clasen committed
537 538 539 540 541 542 543 544
  context = gtk_widget_get_style_context (GTK_WIDGET (bar));
  gtk_style_context_add_class (context, "header-bar");
  gtk_style_context_add_class (context, GTK_STYLE_CLASS_HORIZONTAL);
}

static gint
count_visible_children (GtkHeaderBar *bar)
{
545
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
546 547 548 549 550
  GList *l;
  Child *child;
  gint n;

  n = 0;
551
  for (l = priv->children; l; l = l->next)
Matthias Clasen's avatar
Matthias Clasen committed
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
    {
      child = l->data;
      if (gtk_widget_get_visible (child->widget))
        n++;
    }

  return n;
}

static gboolean
add_child_size (GtkWidget      *child,
                GtkOrientation  orientation,
                gint           *minimum,
                gint           *natural)
{
  gint child_minimum, child_natural;

  if (!gtk_widget_get_visible (child))
    return FALSE;

  if (orientation == GTK_ORIENTATION_HORIZONTAL)
    gtk_widget_get_preferred_width (child, &child_minimum, &child_natural);
  else
    gtk_widget_get_preferred_height (child, &child_minimum, &child_natural);

  if (GTK_ORIENTATION_HORIZONTAL == orientation)
    {
      *minimum += child_minimum;
      *natural += child_natural;
    }
  else
    {
      *minimum = MAX (*minimum, child_minimum);
      *natural = MAX (*natural, child_natural);
    }

  return TRUE;
}

static void
gtk_header_bar_get_size (GtkWidget      *widget,
                         GtkOrientation  orientation,
                         gint           *minimum_size,
                         gint           *natural_size)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (widget);
598
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
599 600 601 602
  GList *l;
  gint nvis_children;
  gint minimum, natural;
  GtkBorder css_borders;
603
  gint center_min, center_nat;
Matthias Clasen's avatar
Matthias Clasen committed
604 605 606 607 608 609 610 611 612 613 614 615

  minimum = natural = 0;
  nvis_children = 0;

  for (l = priv->children; l; l = l->next)
    {
      Child *child = l->data;

      if (add_child_size (child->widget, orientation, &minimum, &natural))
        nvis_children += 1;
    }

616
  center_min = center_nat = 0;
617
  if (priv->label_box != NULL)
618
    {
619
      if (add_child_size (priv->label_sizing_box, orientation, &center_min, &center_nat))
620 621
        nvis_children += 1;
    }
Matthias Clasen's avatar
Matthias Clasen committed
622

623
  if (priv->custom_title != NULL)
Matthias Clasen's avatar
Matthias Clasen committed
624
    {
625
      if (add_child_size (priv->custom_title, orientation, &center_min, &center_nat))
Matthias Clasen's avatar
Matthias Clasen committed
626 627 628
        nvis_children += 1;
    }

629
  if (priv->titlebar_start_box != NULL)
630
    {
631
      if (add_child_size (priv->titlebar_start_box, orientation, &minimum, &natural))
632 633 634
        nvis_children += 1;
    }

635
  if (priv->titlebar_end_box != NULL)
636
    {
637
      if (add_child_size (priv->titlebar_end_box, orientation, &minimum, &natural))
638 639 640
        nvis_children += 1;
    }

Matthias Clasen's avatar
Matthias Clasen committed
641 642 643 644 645 646 647 648 649 650
  if (nvis_children > 0 && orientation == GTK_ORIENTATION_HORIZONTAL)
    {
      minimum += nvis_children * priv->spacing;
      natural += nvis_children * priv->spacing;
    }

  get_css_padding_and_border (widget, &css_borders);

  if (GTK_ORIENTATION_HORIZONTAL == orientation)
    {
651 652
      minimum += center_min + css_borders.left + css_borders.right;
      natural += center_nat + css_borders.left + css_borders.right;
Matthias Clasen's avatar
Matthias Clasen committed
653 654 655
    }
  else
    {
656 657 658 659 660
      /* We don't enforce css borders on the center widget, to make
       * title/subtitle combinations fit without growing the header
       */
      minimum = MAX (center_min, minimum + css_borders.top + css_borders.bottom);
      natural = MAX (center_nat, natural + css_borders.top + css_borders.bottom);
Matthias Clasen's avatar
Matthias Clasen committed
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
    }

  if (minimum_size)
    *minimum_size = minimum;

  if (natural_size)
    *natural_size = natural;
}

static void
gtk_header_bar_compute_size_for_orientation (GtkWidget *widget,
                                             gint       avail_size,
                                             gint      *minimum_size,
                                             gint      *natural_size)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (widget);
677
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
  GList *children;
  gint required_size = 0;
  gint required_natural = 0;
  gint child_size;
  gint child_natural;
  gint nvis_children;
  GtkBorder css_borders;

  nvis_children = 0;

  for (children = priv->children; children != NULL; children = children->next)
    {
      Child *child = children->data;

      if (gtk_widget_get_visible (child->widget))
        {
          gtk_widget_get_preferred_width_for_height (child->widget,
                                                     avail_size, &child_size, &child_natural);

          required_size += child_size;
          required_natural += child_natural;

          nvis_children += 1;
        }
    }

704
  if (priv->label_box != NULL)
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
    {
      gtk_widget_get_preferred_width (priv->label_sizing_box,
                                      &child_size, &child_natural);
      required_size += child_size;
      required_natural += child_natural;
    }

  if (priv->custom_title != NULL &&
      gtk_widget_get_visible (priv->custom_title))
    {
      gtk_widget_get_preferred_width (priv->custom_title,
                                      &child_size, &child_natural);
      required_size += child_size;
      required_natural += child_natural;
    }
Matthias Clasen's avatar
Matthias Clasen committed
720

721
  if (priv->titlebar_start_box != NULL)
722
    {
723
      gtk_widget_get_preferred_width (priv->titlebar_start_box,
724 725 726
                                      &child_size, &child_natural);
      required_size += child_size;
      required_natural += child_natural;
727
      nvis_children += 1;
728 729
    }

730
  if (priv->titlebar_end_box != NULL)
731
    {
732
      gtk_widget_get_preferred_width (priv->titlebar_end_box,
733 734 735
                                      &child_size, &child_natural);
      required_size += child_size;
      required_natural += child_natural;
736
      nvis_children += 1;
737 738
    }

Matthias Clasen's avatar
Matthias Clasen committed
739 740 741 742 743 744 745 746
  if (nvis_children > 0)
    {
      required_size += nvis_children * priv->spacing;
      required_natural += nvis_children * priv->spacing;
    }

  get_css_padding_and_border (widget, &css_borders);

747 748
  required_size += css_borders.left + css_borders.right;
  required_natural += css_borders.left + css_borders.right;
Matthias Clasen's avatar
Matthias Clasen committed
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

  if (minimum_size)
    *minimum_size = required_size;

  if (natural_size)
    *natural_size = required_natural;
}

static void
gtk_header_bar_compute_size_for_opposing_orientation (GtkWidget *widget,
                                                      gint       avail_size,
                                                      gint      *minimum_size,
                                                      gint      *natural_size)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (widget);
764
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
765 766 767 768 769 770 771
  Child *child;
  GList *children;
  gint nvis_children;
  gint computed_minimum = 0;
  gint computed_natural = 0;
  GtkRequestedSize *sizes;
  GtkPackType packing;
772
  gint size = 0;
Matthias Clasen's avatar
Matthias Clasen committed
773 774 775 776 777
  gint i;
  gint child_size;
  gint child_minimum;
  gint child_natural;
  GtkBorder css_borders;
778
  gint center_min, center_nat;
Matthias Clasen's avatar
Matthias Clasen committed
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804

  nvis_children = count_visible_children (bar);

  if (nvis_children <= 0)
    return;

  sizes = g_newa (GtkRequestedSize, nvis_children);

  /* Retrieve desired size for visible children */
  for (i = 0, children = priv->children; children; children = children->next)
    {
      child = children->data;

      if (gtk_widget_get_visible (child->widget))
        {
          gtk_widget_get_preferred_width (child->widget,
                                          &sizes[i].minimum_size,
                                          &sizes[i].natural_size);

          size -= sizes[i].minimum_size;
          sizes[i].data = child;
          i += 1;
        }
    }

  /* Bring children up to size first */
805
  size = gtk_distribute_natural_allocation (MAX (0, avail_size), nvis_children, sizes);
Matthias Clasen's avatar
Matthias Clasen committed
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838

  /* Allocate child positions. */
  for (packing = GTK_PACK_START; packing <= GTK_PACK_END; ++packing)
    {
      for (i = 0, children = priv->children; children; children = children->next)
        {
          child = children->data;

          /* If widget is not visible, skip it. */
          if (!gtk_widget_get_visible (child->widget))
            continue;

          /* If widget is packed differently skip it, but still increment i,
           * since widget is visible and will be handled in next loop
           * iteration.
           */
          if (child->pack_type != packing)
            {
              i++;
              continue;
            }

          child_size = sizes[i].minimum_size;

          gtk_widget_get_preferred_height_for_width (child->widget,
                                                     child_size, &child_minimum, &child_natural);

          computed_minimum = MAX (computed_minimum, child_minimum);
          computed_natural = MAX (computed_natural, child_natural);
        }
      i += 1;
    }

839
  center_min = center_nat = 0;
840
  if (priv->label_box != NULL)
841 842
    {
      gtk_widget_get_preferred_height (priv->label_sizing_box,
843
                                       &center_min, &center_nat);
844 845 846 847 848 849
    }

  if (priv->custom_title != NULL &&
      gtk_widget_get_visible (priv->custom_title))
    {
      gtk_widget_get_preferred_height (priv->custom_title,
850
                                       &center_min, &center_nat);
851 852
    }

853
  if (priv->titlebar_start_box != NULL)
854
    {
855
      gtk_widget_get_preferred_height (priv->titlebar_start_box,
856 857 858 859 860
                                       &child_minimum, &child_natural);
      computed_minimum = MAX (computed_minimum, child_minimum);
      computed_natural = MAX (computed_natural, child_natural);
    }

861
  if (priv->titlebar_end_box != NULL)
862
    {
863
      gtk_widget_get_preferred_height (priv->titlebar_end_box,
864 865 866 867 868
                                       &child_minimum, &child_natural);
      computed_minimum = MAX (computed_minimum, child_minimum);
      computed_natural = MAX (computed_natural, child_natural);
    }

Matthias Clasen's avatar
Matthias Clasen committed
869 870
  get_css_padding_and_border (widget, &css_borders);

871 872 873 874 875
  /* We don't enforce css borders on the center widget, to make
   * title/subtitle combinations fit without growing the header
   */
  computed_minimum = MAX (center_min, computed_minimum + css_borders.top + css_borders.bottom);
  computed_natural = MAX (center_nat, computed_natural + css_borders.top + css_borders.bottom);
Matthias Clasen's avatar
Matthias Clasen committed
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922

  if (minimum_size)
    *minimum_size = computed_minimum;

  if (natural_size)
    *natural_size = computed_natural;
}

static void
gtk_header_bar_get_preferred_width (GtkWidget *widget,
                                    gint      *minimum_size,
                                    gint      *natural_size)
{
  gtk_header_bar_get_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
}

static void
gtk_header_bar_get_preferred_height (GtkWidget *widget,
                                     gint      *minimum_size,
                                     gint      *natural_size)
{
  gtk_header_bar_get_size (widget, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
}

static void
gtk_header_bar_get_preferred_width_for_height (GtkWidget *widget,
                                               gint       height,
                                               gint      *minimum_width,
                                               gint      *natural_width)
{
  gtk_header_bar_compute_size_for_orientation (widget, height, minimum_width, natural_width);
}

static void
gtk_header_bar_get_preferred_height_for_width (GtkWidget *widget,
                                               gint       width,
                                               gint      *minimum_height,
                                               gint      *natural_height)
{
  gtk_header_bar_compute_size_for_opposing_orientation (widget, width, minimum_height, natural_height);
}

static void
gtk_header_bar_size_allocate (GtkWidget     *widget,
                              GtkAllocation *allocation)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (widget);
923
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
924 925 926 927 928
  GtkRequestedSize *sizes;
  gint width, height;
  gint nvis_children;
  gint title_minimum_size;
  gint title_natural_size;
929
  gint start_width, end_width;
Matthias Clasen's avatar
Matthias Clasen committed
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
  gint side[2];
  GList *l;
  gint i;
  Child *child;
  GtkPackType packing;
  GtkAllocation child_allocation;
  gint x;
  gint child_size;
  GtkTextDirection direction;
  GtkBorder css_borders;

  gtk_widget_set_allocation (widget, allocation);

  direction = gtk_widget_get_direction (widget);
  nvis_children = count_visible_children (bar);
  sizes = g_newa (GtkRequestedSize, nvis_children);

  get_css_padding_and_border (widget, &css_borders);
948 949
  width = allocation->width - nvis_children * priv->spacing - css_borders.left - css_borders.right;
  height = allocation->height - css_borders.top - css_borders.bottom;
Matthias Clasen's avatar
Matthias Clasen committed
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965

  i = 0;
  for (l = priv->children; l; l = l->next)
    {
      child = l->data;
      if (!gtk_widget_get_visible (child->widget))
        continue;

      gtk_widget_get_preferred_width_for_height (child->widget,
                                                 height,
                                                 &sizes[i].minimum_size,
                                                 &sizes[i].natural_size);
      width -= sizes[i].minimum_size;
      i++;
    }

966 967 968
  title_minimum_size = 0;
  title_natural_size = 0;

969 970
  if (priv->custom_title &&
      gtk_widget_get_visible (priv->custom_title))
Matthias Clasen's avatar
Matthias Clasen committed
971 972 973 974 975 976
    {
      gtk_widget_get_preferred_width_for_height (priv->custom_title,
                                                 height,
                                                 &title_minimum_size,
                                                 &title_natural_size);
    }
977 978

  if (priv->label_box != NULL)
Matthias Clasen's avatar
Matthias Clasen committed
979
    {
980
      gtk_widget_get_preferred_width_for_height (priv->label_box,
Matthias Clasen's avatar
Matthias Clasen committed
981 982 983 984 985 986
                                                 height,
                                                 &title_minimum_size,
                                                 &title_natural_size);
    }
  width -= title_natural_size;

987 988
  start_width = 0;
  if (priv->titlebar_start_box != NULL)
989 990
    {
      gint min, nat;
991
      gtk_widget_get_preferred_width_for_height (priv->titlebar_start_box,
992 993
                                                 height,
                                                 &min, &nat);
994
      start_width = nat + priv->spacing;
995
    }
996
  width -= start_width;
997

998 999
  end_width = 0;
  if (priv->titlebar_end_box != NULL)
1000 1001
    {
      gint min, nat;
1002
      gtk_widget_get_preferred_width_for_height (priv->titlebar_end_box,
1003 1004
                                                 height,
                                                 &min, &nat);
1005
      end_width = nat + priv->spacing;
1006
    }
1007
  width -= end_width;
1008

Matthias Clasen's avatar
Matthias Clasen committed
1009 1010 1011 1012 1013
  width = gtk_distribute_natural_allocation (MAX (0, width), nvis_children, sizes);

  side[0] = side[1] = 0;
  for (packing = GTK_PACK_START; packing <= GTK_PACK_END; packing++)
    {
1014
      child_allocation.y = allocation->y + css_borders.top;
Matthias Clasen's avatar
Matthias Clasen committed
1015 1016
      child_allocation.height = height;
      if (packing == GTK_PACK_START)
1017
        x = allocation->x + css_borders.left + start_width;
Matthias Clasen's avatar
Matthias Clasen committed
1018
      else
1019
        x = allocation->x + allocation->width - end_width - css_borders.right;
Matthias Clasen's avatar
Matthias Clasen committed
1020

1021 1022
      i = 0;
      for (l = priv->children; l != NULL; l = l->next)
Matthias Clasen's avatar
Matthias Clasen committed
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
        {
          child = l->data;
          if (!gtk_widget_get_visible (child->widget))
            continue;

          if (child->pack_type != packing)
            goto next;

          child_size = sizes[i].minimum_size;

          child_allocation.width = child_size;

          if (packing == GTK_PACK_START)
            {
              child_allocation.x = x;
              x += child_size;
              x += priv->spacing;
            }
          else
            {
              x -= child_size;
              child_allocation.x = x;
              x -= priv->spacing;
            }

          side[packing] += child_size + priv->spacing;

          if (direction == GTK_TEXT_DIR_RTL)
            child_allocation.x = allocation->x + allocation->width - (child_allocation.x - allocation->x) - child_allocation.width;

          gtk_widget_size_allocate (child->widget, &child_allocation);

        next:
1056
          i++;
Matthias Clasen's avatar
Matthias Clasen committed
1057 1058 1059
        }
    }

1060 1061
  side[GTK_PACK_START] += start_width;
  side[GTK_PACK_END] += end_width;
1062

1063 1064 1065 1066 1067
  /* We don't enforce css borders on the center widget, to make
   * title/subtitle combinations fit without growing the header
   */
  child_allocation.y = allocation->y;
  child_allocation.height = allocation->height;
Matthias Clasen's avatar
Matthias Clasen committed
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088

  width = MAX (side[0], side[1]);

  if (allocation->width - 2 * width >= title_natural_size)
    child_size = MIN (title_natural_size, allocation->width - 2 * width);
  else if (allocation->width - side[0] - side[1] >= title_natural_size)
    child_size = MIN (title_natural_size, allocation->width - side[0] - side[1]);
  else
    child_size = allocation->width - side[0] - side[1];

  child_allocation.x = allocation->x + (allocation->width - child_size) / 2;
  child_allocation.width = child_size;

  if (allocation->x + side[0] > child_allocation.x)
    child_allocation.x = allocation->x + side[0];
  else if (allocation->x + allocation->width - side[1] < child_allocation.x + child_allocation.width)
    child_allocation.x = allocation->x + allocation->width - side[1] - child_allocation.width;

  if (direction == GTK_TEXT_DIR_RTL)
    child_allocation.x = allocation->x + allocation->width - (child_allocation.x - allocation->x) - child_allocation.width;

1089 1090
  if (priv->custom_title != NULL &&
      gtk_widget_get_visible (priv->custom_title))
Matthias Clasen's avatar
Matthias Clasen committed
1091
    gtk_widget_size_allocate (priv->custom_title, &child_allocation);
1092 1093

  if (priv->label_box != NULL)
1094
    gtk_widget_size_allocate (priv->label_box, &child_allocation);
1095

1096 1097 1098
  child_allocation.y = allocation->y + css_borders.top;
  child_allocation.height = height;

1099
  if (priv->titlebar_start_box)
1100
    {
1101
      gboolean left = (direction == GTK_TEXT_DIR_LTR);
1102
      if (left)
1103
        child_allocation.x = allocation->x + css_borders.left;
1104
      else
1105 1106
        child_allocation.x = allocation->x + allocation->width - css_borders.right - start_width + priv->spacing;
      child_allocation.width = start_width - priv->spacing;
1107
      gtk_widget_size_allocate (priv->titlebar_start_box, &child_allocation);
1108
    }
1109

1110
  if (priv->titlebar_end_box)
1111
    {
1112
      gboolean left = (direction != GTK_TEXT_DIR_LTR);
1113 1114 1115
      if (left)
        child_allocation.x = allocation->x + css_borders.left;
      else
1116 1117
        child_allocation.x = allocation->x + allocation->width - css_borders.right - end_width + priv->spacing;
      child_allocation.width = end_width - priv->spacing;
1118
      gtk_widget_size_allocate (priv->titlebar_end_box, &child_allocation);
1119
    }
Matthias Clasen's avatar
Matthias Clasen committed
1120 1121 1122 1123 1124
}

/**
 * gtk_header_bar_set_title:
 * @bar: a #GtkHeaderBar
1125
 * @title: (allow-none): a title, or %NULL
Matthias Clasen's avatar
Matthias Clasen committed
1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
 *
 * Sets the title of the #GtkHeaderBar. The title should help a user
 * identify the current view. A good title should not include the
 * application name.
 *
 * Since: 3.10
 */
void
gtk_header_bar_set_title (GtkHeaderBar *bar,
                          const gchar  *title)
{
1137
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
1138
  gchar *new_title;
Matthias Clasen's avatar
Matthias Clasen committed
1139 1140 1141 1142 1143 1144 1145

  g_return_if_fail (GTK_IS_HEADER_BAR (bar));

  new_title = g_strdup (title);
  g_free (priv->title);
  priv->title = new_title;

1146
  if (priv->title_label != NULL)
1147
    {
1148
      gtk_label_set_label (GTK_LABEL (priv->title_label), priv->title);
1149 1150
      gtk_widget_queue_resize (GTK_WIDGET (bar));
    }
Matthias Clasen's avatar
Matthias Clasen committed
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160

  g_object_notify (G_OBJECT (bar), "title");
}

/**
 * gtk_header_bar_get_title:
 * @bar: a #GtkHeaderBar
 *
 * Retrieves the title of the header. See gtk_header_bar_set_title().
 *
1161
 * Returns: the title of the header, or %NULL if none has
1162
 *    been set explicitly. The returned string is owned by the widget
Matthias Clasen's avatar
Matthias Clasen committed
1163 1164 1165 1166 1167 1168 1169
 *    and must not be modified or freed.
 *
 * Since: 3.10
 */
const gchar *
gtk_header_bar_get_title (GtkHeaderBar *bar)
{
1170 1171
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);

Matthias Clasen's avatar
Matthias Clasen committed
1172 1173
  g_return_val_if_fail (GTK_IS_HEADER_BAR (bar), NULL);

1174
  return priv->title;
Matthias Clasen's avatar
Matthias Clasen committed
1175 1176
}

1177 1178 1179
/**
 * gtk_header_bar_set_subtitle:
 * @bar: a #GtkHeaderBar
1180
 * @subtitle: (allow-none): a subtitle, or %NULL
1181 1182 1183 1184
 *
 * Sets the subtitle of the #GtkHeaderBar. The title should give a user
 * an additional detail to help him identify the current view.
 *
1185 1186 1187
 * Note that GtkHeaderBar by default reserves room for the subtitle,
 * even if none is currently set. If this is not desired, set the
 * #GtkHeaderBar:has-subtitle property to %FALSE.
1188
 *
1189 1190 1191 1192 1193 1194
 * Since: 3.10
 */
void
gtk_header_bar_set_subtitle (GtkHeaderBar *bar,
                             const gchar  *subtitle)
{
1195
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
  gchar *new_subtitle;

  g_return_if_fail (GTK_IS_HEADER_BAR (bar));

  new_subtitle = g_strdup (subtitle);
  g_free (priv->subtitle);
  priv->subtitle = new_subtitle;

  if (priv->subtitle_label != NULL)
    {
      gtk_label_set_label (GTK_LABEL (priv->subtitle_label), priv->subtitle);
1207
      gtk_widget_set_visible (priv->subtitle_label, priv->subtitle && priv->subtitle[0]);
1208 1209 1210
      gtk_widget_queue_resize (GTK_WIDGET (bar));
    }

1211
  gtk_widget_set_visible (priv->subtitle_sizing_label, priv->has_subtitle || (priv->subtitle && priv->subtitle[0]));
1212

1213 1214 1215 1216 1217 1218 1219 1220 1221
  g_object_notify (G_OBJECT (bar), "subtitle");
}

/**
 * gtk_header_bar_get_subtitle:
 * @bar: a #GtkHeaderBar
 *
 * Retrieves the subtitle of the header. See gtk_header_bar_set_subtitle().
 *
1222
 * Returns: the subtitle of the header, or %NULL if none has
1223
 *    been set explicitly. The returned string is owned by the widget
1224 1225 1226 1227 1228 1229 1230
 *    and must not be modified or freed.
 *
 * Since: 3.10
 */
const gchar *
gtk_header_bar_get_subtitle (GtkHeaderBar *bar)
{
1231 1232
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);

1233 1234
  g_return_val_if_fail (GTK_IS_HEADER_BAR (bar), NULL);

1235
  return priv->subtitle;
1236 1237
}

Matthias Clasen's avatar
Matthias Clasen committed
1238 1239 1240 1241 1242
/**
 * gtk_header_bar_set_custom_title:
 * @bar: a #GtkHeaderBar
 * @title_widget: (allow-none): a custom widget to use for a title
 *
1243 1244 1245 1246 1247
 * Sets a custom title for the #GtkHeaderBar.
 *
 * The title should help a user identify the current view. This
 * supersedes any title set by gtk_header_bar_set_title() or
 * gtk_header_bar_set_subtitle(). To achieve the same style as
1248
 * the builtin title and subtitle, use the “title” and “subtitle”
1249 1250 1251 1252
 * style classes.
 *
 * You should set the custom title to %NULL, for the header title
 * label to be visible again.
Matthias Clasen's avatar
Matthias Clasen committed
1253 1254 1255 1256 1257 1258 1259
 *
 * Since: 3.10
 */
void
gtk_header_bar_set_custom_title (GtkHeaderBar *bar,
                                 GtkWidget    *title_widget)
{
1260
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277

  g_return_if_fail (GTK_IS_HEADER_BAR (bar));
  if (title_widget)
    g_return_if_fail (GTK_IS_WIDGET (title_widget));

  /* No need to do anything if the custom widget stays the same */
  if (priv->custom_title == title_widget)
    return;

  if (priv->custom_title)
    {
      GtkWidget *custom = priv->custom_title;

      priv->custom_title = NULL;
      gtk_widget_unparent (custom);
    }

1278
  if (title_widget != NULL)
Matthias Clasen's avatar
Matthias Clasen committed
1279
    {
1280
      priv->custom_title = title_widget;
Matthias Clasen's avatar
Matthias Clasen committed
1281 1282 1283

      gtk_widget_set_parent (priv->custom_title, GTK_WIDGET (bar));
      gtk_widget_set_valign (priv->custom_title, GTK_ALIGN_CENTER);
1284

1285
      if (priv->label_box != NULL)
1286
        {
1287
          GtkWidget *label_box = priv->label_box;
1288

1289 1290 1291 1292
          priv->label_box = NULL;
          priv->title_label = NULL;
          priv->subtitle_label = NULL;
          gtk_widget_unparent (label_box);
1293 1294
        }

Matthias Clasen's avatar
Matthias Clasen committed
1295 1296 1297
    }
  else
    {
1298 1299
      if (priv->label_box == NULL)
        construct_label_box (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
    }

  gtk_widget_queue_resize (GTK_WIDGET (bar));

  g_object_notify (G_OBJECT (bar), "custom-title");
}

/**
 * gtk_header_bar_get_custom_title:
 * @bar: a #GtkHeaderBar
 *
 * Retrieves the custom title widget of the header. See
 * gtk_header_bar_set_custom_title().
 *
1314
 * Returns: (transfer none): the custom title widget
1315
 *    of the header, or %NULL if none has been set explicitly.
Matthias Clasen's avatar
Matthias Clasen committed
1316 1317 1318 1319 1320 1321
 *
 * Since: 3.10
 */
GtkWidget *
gtk_header_bar_get_custom_title (GtkHeaderBar *bar)
{
1322 1323
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);

Matthias Clasen's avatar
Matthias Clasen committed
1324 1325
  g_return_val_if_fail (GTK_IS_HEADER_BAR (bar), NULL);

1326
  return priv->custom_title;
Matthias Clasen's avatar
Matthias Clasen committed
1327 1328
}

1329 1330 1331
static void
gtk_header_bar_finalize (GObject *object)
{
1332
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (GTK_HEADER_BAR (object));
1333

1334 1335
  g_free (priv->title);
  g_free (priv->subtitle);
1336
  g_free (priv->decoration_layout);
1337 1338 1339 1340

  G_OBJECT_CLASS (gtk_header_bar_parent_class)->finalize (object);
}

Matthias Clasen's avatar
Matthias Clasen committed
1341 1342 1343 1344 1345 1346 1347
static void
gtk_header_bar_get_property (GObject    *object,
                             guint       prop_id,
                             GValue     *value,
                             GParamSpec *pspec)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (object);
1348
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1349 1350 1351 1352 1353 1354 1355

  switch (prop_id)
    {
    case PROP_TITLE:
      g_value_set_string (value, priv->title);
      break;

1356 1357 1358 1359
    case PROP_SUBTITLE:
      g_value_set_string (value, priv->subtitle);
      break;

Matthias Clasen's avatar
Matthias Clasen committed
1360 1361 1362 1363 1364 1365 1366 1367
    case PROP_CUSTOM_TITLE:
      g_value_set_object (value, priv->custom_title);
      break;

    case PROP_SPACING:
      g_value_set_int (value, priv->spacing);
      break;

1368 1369 1370 1371
    case PROP_SHOW_CLOSE_BUTTON:
      g_value_set_boolean (value, gtk_header_bar_get_show_close_button (bar));
      break;

1372 1373 1374 1375
    case PROP_HAS_SUBTITLE:
      g_value_set_boolean (value, gtk_header_bar_get_has_subtitle (bar));
      break;

1376 1377 1378 1379 1380 1381 1382 1383
    case PROP_DECORATION_LAYOUT:
      g_value_set_string (value, gtk_header_bar_get_decoration_layout (bar));
      break;

    case PROP_DECORATION_LAYOUT_SET:
      g_value_set_boolean (value, priv->decoration_layout_set);
      break;

Matthias Clasen's avatar
Matthias Clasen committed
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_header_bar_set_property (GObject      *object,
                             guint         prop_id,
                             const GValue *value,
                             GParamSpec   *pspec)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (object);
1397
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1398 1399 1400 1401 1402 1403 1404

  switch (prop_id)
    {
    case PROP_TITLE:
      gtk_header_bar_set_title (bar, g_value_get_string (value));
      break;

1405 1406 1407 1408
    case PROP_SUBTITLE:
      gtk_header_bar_set_subtitle (bar, g_value_get_string (value));
      break;

Matthias Clasen's avatar
Matthias Clasen committed
1409 1410 1411 1412 1413 1414 1415 1416 1417
    case PROP_CUSTOM_TITLE:
      gtk_header_bar_set_custom_title (bar, g_value_get_object (value));
      break;

    case PROP_SPACING:
      priv->spacing = g_value_get_int (value);
      gtk_widget_queue_resize (GTK_WIDGET (bar));
      break;

1418 1419 1420 1421
    case PROP_SHOW_CLOSE_BUTTON:
      gtk_header_bar_set_show_close_button (bar, g_value_get_boolean (value));
      break;

1422 1423 1424 1425
    case PROP_HAS_SUBTITLE:
      gtk_header_bar_set_has_subtitle (bar, g_value_get_boolean (value));
      break;

1426 1427 1428 1429 1430 1431 1432 1433
    case PROP_DECORATION_LAYOUT:
      gtk_header_bar_set_decoration_layout (bar, g_value_get_string (value));
      break;

    case PROP_DECORATION_LAYOUT_SET:
      priv->decoration_layout_set = g_value_get_boolean (value);
      break;

Matthias Clasen's avatar
Matthias Clasen committed
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_header_bar_pack (GtkHeaderBar *bar,
                     GtkWidget    *widget,
                     GtkPackType   pack_type)
{
1445
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1446 1447 1448 1449 1450 1451 1452 1453
  Child *child;

  g_return_if_fail (gtk_widget_get_parent (widget) == NULL);

  child = g_new (Child, 1);
  child->widget = widget;
  child->pack_type = pack_type;

1454
  priv->children = g_list_append (priv->children, child);
Matthias Clasen's avatar
Matthias Clasen committed
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473

  gtk_widget_freeze_child_notify (widget);
  gtk_widget_set_parent (widget, GTK_WIDGET (bar));
  gtk_widget_child_notify (widget, "pack-type");
  gtk_widget_child_notify (widget, "position");
  gtk_widget_thaw_child_notify (widget);
}

static void
gtk_header_bar_add (GtkContainer *container,
                    GtkWidget    *child)
{
  gtk_header_bar_pack (GTK_HEADER_BAR (container), child, GTK_PACK_START);
}

static GList *
find_child_link (GtkHeaderBar *bar,
                 GtkWidget    *widget)
{
1474
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1475 1476 1477
  GList *l;
  Child *child;

1478
  for (l = priv->children; l; l = l->next)
Matthias Clasen's avatar
Matthias Clasen committed
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
    {
      child = l->data;
      if (child->widget == widget)
        return l;
    }

  return NULL;
}

static void
gtk_header_bar_remove (GtkContainer *container,
                       GtkWidget    *widget)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (container);
1493
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1494 1495 1496 1497 1498 1499 1500 1501
  GList *l;
  Child *child;

  l = find_child_link (bar, widget);
  if (l)
    {
      child = l->data;
      gtk_widget_unparent (child->widget);
1502
      priv->children = g_list_delete_link (priv->children, l);
Matthias Clasen's avatar
Matthias Clasen committed
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
      g_free (child);
      gtk_widget_queue_resize (GTK_WIDGET (container));
    }
}

static void
gtk_header_bar_forall (GtkContainer *container,
                       gboolean      include_internals,
                       GtkCallback   callback,
                       gpointer      callback_data)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (container);
1515
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
  Child *child;
  GList *children;

  children = priv->children;
  while (children)
    {
      child = children->data;
      children = children->next;
      if (child->pack_type == GTK_PACK_START)
        (* callback) (child->widget, callback_data);
    }

1528 1529 1530
  if (priv->custom_title != NULL)
    (* callback) (priv->custom_title, callback_data);

1531 1532
  if (include_internals && priv->label_box != NULL)
    (* callback) (priv->label_box, callback_data);
Matthias Clasen's avatar
Matthias Clasen committed
1533

1534 1535
  if (include_internals && priv->titlebar_start_box != NULL)
    (* callback) (priv->titlebar_start_box, callback_data);
1536

1537 1538
  if (include_internals && priv->titlebar_end_box != NULL)
    (* callback) (priv->titlebar_end_box, callback_data);
1539

Matthias Clasen's avatar
Matthias Clasen committed
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562
  children = priv->children;
  while (children)
    {
      child = children->data;
      children = children->next;
      if (child->pack_type == GTK_PACK_END)
        (* callback) (child->widget, callback_data);
    }
}

static GType
gtk_header_bar_child_type (GtkContainer *container)
{
  return GTK_TYPE_WIDGET;
}

static void
gtk_header_bar_get_child_property (GtkContainer *container,
                                   GtkWidget    *widget,
                                   guint         property_id,
                                   GValue       *value,
                                   GParamSpec   *pspec)
{
1563 1564
  GtkHeaderBar *bar = GTK_HEADER_BAR (container);
  GtkHeaderBarPrivate *priv = gtk_header_bar_get_instance_private (bar);
Matthias Clasen's avatar
Matthias Clasen committed
1565 1566 1567
  GList *l;
  Child *child;

1568
  l = find_child_link (bar, widget);
Matthias Clasen's avatar
Matthias Clasen committed
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
  if (l == NULL)
    {
      g_param_value_set_default (pspec, value);
      return;
    }

  child = l->data;

  switch (property_id)
    {
    case CHILD_PROP_PACK_TYPE:
      g_value_set_enum (value, child->pack_type);
      break;

    case CHILD_PROP_POSITION:
1584
      g_value_set_int (value, g_list_position (priv->children, l));
Matthias Clasen's avatar
Matthias Clasen committed
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686
      break;

    default:
      GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
      break;
    }
}

static void
gtk_header_bar_set_child_property (GtkContainer *container,
                                   GtkWidget    *widget,
                                   guint         property_id,
                                   const GValue *value,
                                   GParamSpec   *pspec)
{
  GList *l;
  Child *child;

  l = find_child_link (GTK_HEADER_BAR (container), widget);
  child = l->data;

  switch (property_id)
    {
    case CHILD_PROP_PACK_TYPE:
      child->pack_type = g_value_get_enum (value);
      break;
    default:
      GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID (container, property_id, pspec);
      break;
    }
}

static GtkWidgetPath *
gtk_header_bar_get_path_for_child (GtkContainer *container,
                                   GtkWidget    *child)
{
  GtkHeaderBar *bar = GTK_HEADER_BAR (container);
  GtkWidgetPath *path, *sibling_path;
  GList *list, *children;

  path = _gtk_widget_create_path (GTK_WIDGET (container));

  if (gtk_widget_get_visible (child))
    {
      gint i, position;

      sibling_path = gtk_widget_path_new ();

      /* get_all_children works in reverse (!) visible order */
      children = _gtk_container_get_all_children (container);
      if (gtk_widget_get_direction (GTK_WIDGET (bar)) == GTK_TEXT_DIR_LTR)
        children = g_list_reverse (children);

      position = -1;
      i = 0;
      for (list = children; list; list = list->next)
        {
          if (!gtk_widget_get_visible (list->data))
            continue;

          gtk_widget_path_append_for_widget (sibling_path, list->data);

          if (list->data == child)
            position = i;
          i++;
        }
      g_list_free (children);

      if (position >= 0)
        gtk_widget_path_append_with_siblings (path, sibling_path, position);
      else
        gtk_widget_path_append_for_widget (path, child);

      gtk_widget_path_unref (sibling_path);
    }
  else
    gtk_widget_path_append_for_widget (path, child);