gtkmodelbutton.c 38.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/*
 * Copyright © 2014 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the licence, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Matthias Clasen
 */

#include "config.h"

#include "gtkmodelbutton.h"

#include "gtkbutton.h"
#include "gtkbuttonprivate.h"
#include "gtkwidgetprivate.h"
#include "gtkmenutrackeritem.h"
#include "gtkimage.h"
#include "gtklabel.h"
#include "gtkbox.h"
31
#include "gtkrender.h"
32 33
#include "gtkstylecontext.h"
#include "gtktypebuiltins.h"
34 35
#include "gtkstack.h"
#include "gtkpopover.h"
36
#include "gtkintl.h"
37
#include "gtkcssnodeprivate.h"
38
#include "gtkcsscustomgadgetprivate.h"
39 40
#include "gtkbuiltiniconprivate.h"
#include "gtkcsstypesprivate.h"
41
#include "gtkstylecontextprivate.h"
42
#include "gtkcontainerprivate.h"
43

Matthias Clasen's avatar
Matthias Clasen committed
44 45 46 47 48 49 50
/**
 * SECTION:gtkmodelbutton
 * @Short_description: A button that uses a GAction as model
 * @Title: GtkModelButton
 *
 * GtkModelButton is a button class that can use a #GAction as its model.
 * In contrast to #GtkToggleButton or #GtkRadioButton, which can also
51
 * be backed by a #GAction via the #GtkActionable:action-name property,
Matthias Clasen's avatar
Matthias Clasen committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
 * GtkModelButton will adapt its appearance according to the kind of
 * action it is backed by, and appear either as a plain, check or
 * radio button.
 *
 * Model buttons are used when popovers from a menu model with
 * gtk_popover_new_from_model(); they can also be used manually in
 * a #GtkPopoverMenu.
 *
 * When the action is specified via the #GtkActionable:action-name
 * and #GtkActionable:action-target properties, the role of the button
 * (i.e. whether it is a plain, check or radio button) is determined by
 * the type of the action and doesn't have to be explicitly specified
 * with the #GtkModelButton:role property.
 *
 * The content of the button is specified by the #GtkModelButton:text
 * and #GtkModelButton:icon properties.
 *
 * The appearance of model buttons can be influenced with the
 * #GtkModelButton:centered and #GtkModelButton:iconic properties.
 *
 * Model buttons have built-in support for submenus in #GtkPopoverMenu.
 * To make a GtkModelButton that opens a submenu when activated, set
 * the #GtkModelButton:menu-name property. To make a button that goes
 * back to the parent menu, you should set the #GtkModelButton:inverted
 * property to place the submenu indicator at the opposite side.
 *
 * # Example
 *
 * |[
 * <object class="GtkPopoverMenu">
 *   <child>
 *     <object class="GtkBox">
 *       <property name="visible">True</property>
 *       <property name="margin">10</property>
 *       <child>
 *         <object class="GtkModelButton">
 *           <property name="visible">True</property>
 *           <property name="action-name">view.cut</property>
 *           <property name="text" translatable="yes">Cut</property>
 *         </object>
 *       </child>
 *       <child>
 *         <object class="GtkModelButton">
 *           <property name="visible">True</property>
 *           <property name="action-name">view.copy</property>
 *           <property name="text" translatable="yes">Copy</property>
 *         </object>
 *       </child>
 *       <child>
 *         <object class="GtkModelButton">
 *           <property name="visible">True</property>
 *           <property name="action-name">view.paste</property>
 *           <property name="text" translatable="yes">Paste</property>
 *         </object>
 *       </child>
 *     </object>
 *   </child>
 * </object>
 * ]|
111 112 113 114 115
 *
 * # CSS nodes
 *
 * |[<!-- language="plain" -->
 * modelbutton
116
 * ├── <child>
117 118 119 120 121
 * ╰── check
 * ]|
 *
 * |[<!-- language="plain" -->
 * modelbutton
122
 * ├── <child>
123 124 125 126 127
 * ╰── radio
 * ]|
 *
 * |[<!-- language="plain" -->
 * modelbutton
128
 * ├── <child>
129 130 131 132 133 134 135 136 137
 * ╰── arrow
 * ]|
 *
 * GtkModelButton has a main CSS node with name modelbutton, and a subnode,
 * which will have the name check, radio or arrow, depending on the role
 * of the button and whether it has a menu name set.
 *
 * The subnode is positioned before or after the content nodes and gets the
 * .left or .right style class, depending on where it is located.
138 139 140 141 142 143 144 145 146 147
 *
 * |[<!-- language="plain" -->
 * button.model
 * ├── <child>
 * ╰── check
 * ]|
 *
 * Iconic model buttons (see #GtkModelButton::iconic) change the name of
 * their main node to button and add a .model style class to it. The indicator
 * subnode is invisible in this case.
Matthias Clasen's avatar
Matthias Clasen committed
148 149
 */

150 151 152
struct _GtkModelButton
{
  GtkButton parent_instance;
Matthias Clasen's avatar
Matthias Clasen committed
153

154 155 156
  GtkWidget *box;
  GtkWidget *image;
  GtkWidget *label;
157 158
  GtkCssGadget *gadget;
  GtkCssGadget *indicator_gadget;
159
  gboolean active;
160
  gboolean centered;
161
  gboolean inverted;
162
  gboolean iconic;
163
  gchar *menu_name;
164
  GtkButtonRole role;
165 166 167 168 169 170 171 172 173
};

typedef GtkButtonClass GtkModelButtonClass;

G_DEFINE_TYPE (GtkModelButton, gtk_model_button, GTK_TYPE_BUTTON)

enum
{
  PROP_0,
174
  PROP_ROLE,
175 176
  PROP_ICON,
  PROP_TEXT,
177
  PROP_ACTIVE,
178
  PROP_MENU_NAME,
179
  PROP_INVERTED,
180
  PROP_CENTERED,
181 182
  PROP_ICONIC,
  LAST_PROPERTY
183 184
};

185 186
static GParamSpec *properties[LAST_PROPERTY] = { NULL, };

187 188 189 190 191 192 193 194 195
static gboolean
indicator_is_left (GtkWidget *widget)
{
  GtkModelButton *button = GTK_MODEL_BUTTON (widget);

  return ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL && !button->inverted) ||
          (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR && button->inverted));
}

196 197 198 199
static void
gtk_model_button_update_state (GtkModelButton *button)
{
  GtkStateFlags state;
200
  GtkCssImageBuiltinType image_type = GTK_CSS_IMAGE_BUILTIN_NONE;
201 202 203

  state = gtk_widget_get_state_flags (GTK_WIDGET (button));

204 205
  gtk_css_node_set_state (gtk_css_gadget_get_node (button->gadget), state);

206 207 208 209 210 211 212 213 214 215 216 217 218 219
  if (button->role == GTK_BUTTON_ROLE_CHECK)
    {
      if (button->active && !button->menu_name)
        {
          state &= ~GTK_STATE_FLAG_CHECKED;
          image_type = GTK_CSS_IMAGE_BUILTIN_CHECK_CHECKED;
        }
      else
        {
          state |= GTK_STATE_FLAG_CHECKED;
          image_type = GTK_CSS_IMAGE_BUILTIN_CHECK;
        }
    }
  if (button->role == GTK_BUTTON_ROLE_RADIO)
220 221
    {
      if (button->active && !button->menu_name)
222 223 224 225 226 227 228 229 230
        {
          state &= ~GTK_STATE_FLAG_CHECKED;
          image_type = GTK_CSS_IMAGE_BUILTIN_OPTION_CHECKED;
        }
      else
        {
          state |= GTK_STATE_FLAG_CHECKED;
          image_type = GTK_CSS_IMAGE_BUILTIN_OPTION;
        }
231 232 233 234 235
    }

  if (button->menu_name)
    {
      if (indicator_is_left (GTK_WIDGET (button)))
236
        image_type = GTK_CSS_IMAGE_BUILTIN_ARROW_LEFT;
237
      else
238
        image_type = GTK_CSS_IMAGE_BUILTIN_ARROW_RIGHT;
239
    }
240

241
  gtk_builtin_icon_set_image (GTK_BUILTIN_ICON (button->indicator_gadget), image_type);
242
  gtk_css_node_set_state (gtk_css_gadget_get_node (button->indicator_gadget), state);
243 244
}

245 246 247
static void
update_node_ordering (GtkModelButton *button)
{
248
  GtkCssNode *widget_node, *indicator_node, *node;
249 250

  widget_node = gtk_widget_get_css_node (GTK_WIDGET (button));
251
  indicator_node = gtk_css_gadget_get_node (button->indicator_gadget);
252 253 254

  if (indicator_is_left (GTK_WIDGET (button)))
    {
255 256
      gtk_css_gadget_add_class (button->indicator_gadget, GTK_STYLE_CLASS_LEFT);
      gtk_css_gadget_remove_class (button->indicator_gadget, GTK_STYLE_CLASS_RIGHT);
257 258

      node = gtk_css_node_get_first_child (widget_node);
259 260
      if (node != indicator_node)
        gtk_css_node_insert_before (widget_node, indicator_node, node);
261 262 263
    }
  else
    {
264 265
      gtk_css_gadget_remove_class (button->indicator_gadget, GTK_STYLE_CLASS_LEFT);
      gtk_css_gadget_add_class (button->indicator_gadget, GTK_STYLE_CLASS_RIGHT);
266 267

      node = gtk_css_node_get_last_child (widget_node);
268 269
      if (node != indicator_node)
        gtk_css_node_insert_after (widget_node, indicator_node, node);
270 271 272
    }
}

273 274 275 276 277
static void
gtk_model_button_state_flags_changed (GtkWidget     *widget,
                                      GtkStateFlags  previous_flags)
{
  gtk_model_button_update_state (GTK_MODEL_BUTTON (widget));
278 279

  GTK_WIDGET_CLASS (gtk_model_button_parent_class)->state_flags_changed (widget, previous_flags);
280
}
281

282
static void
283 284 285 286 287 288 289 290 291 292 293 294 295
gtk_model_button_direction_changed (GtkWidget        *widget,
                                    GtkTextDirection  previous_dir)
{
  GtkModelButton *button = GTK_MODEL_BUTTON (widget);

  gtk_model_button_update_state (button);
  update_node_ordering (button);

  GTK_WIDGET_CLASS (gtk_model_button_parent_class)->direction_changed (widget, previous_dir);
}

static void
update_node_name (GtkModelButton *button)
296 297 298
{
  AtkObject *accessible;
  AtkRole a11y_role;
299 300 301
  const gchar *indicator_name;
  gboolean indicator_visible;
  GtkCssNode *indicator_node;
302 303

  accessible = gtk_widget_get_accessible (GTK_WIDGET (button));
304
  switch (button->role)
305
    {
306
    case GTK_BUTTON_ROLE_NORMAL:
307
      a11y_role = ATK_ROLE_PUSH_BUTTON;
308 309
      if (button->menu_name)
        {
310 311
          indicator_name = I_("arrow");
          indicator_visible = TRUE;
312 313 314
        }
      else
        {
315 316
          indicator_name = I_("check");
          indicator_visible = FALSE;
317
        }
318 319
      break;

320
    case GTK_BUTTON_ROLE_CHECK:
321
      a11y_role = ATK_ROLE_CHECK_BOX;
322 323
      indicator_name = I_("check");
      indicator_visible = TRUE;
324 325
      break;

326
    case GTK_BUTTON_ROLE_RADIO:
327
      a11y_role = ATK_ROLE_RADIO_BUTTON;
328 329
      indicator_name = I_("radio");
      indicator_visible = TRUE;
330 331 332 333 334 335
      break;

    default:
      g_assert_not_reached ();
    }

336 337 338
  if (button->iconic)
    indicator_visible = FALSE;

339
  atk_object_set_role (accessible, a11y_role);
340 341 342 343

  indicator_node = gtk_css_gadget_get_node (button->indicator_gadget);
  gtk_css_node_set_name (indicator_node, indicator_name);
  gtk_css_node_set_visible (indicator_node, indicator_visible);
344 345 346 347 348 349 350 351 352 353 354 355
}

static void
gtk_model_button_set_role (GtkModelButton *button,
                           GtkButtonRole   role)
{
  if (role == button->role)
    return;

  button->role = role;

  update_node_name (button);
356 357 358 359

  gtk_model_button_update_state (button);
  gtk_widget_queue_draw (GTK_WIDGET (button));
  g_object_notify_by_pspec (G_OBJECT (button), properties[PROP_ROLE]);
360 361
}

362 363 364 365 366 367 368 369 370
static void
update_visibility (GtkModelButton *button)
{
  gboolean has_icon;
  gboolean has_text;

  has_icon = gtk_image_get_storage_type (GTK_IMAGE (button->image)) != GTK_IMAGE_EMPTY;
  has_text = gtk_label_get_text (GTK_LABEL (button->label))[0] != '\0';

371
  gtk_widget_set_visible (button->image, has_icon && (button->iconic || !has_text));
372 373 374
  gtk_widget_set_visible (button->label, has_text && (!button->iconic || !has_icon));
}

375 376 377 378 379
static void
gtk_model_button_set_icon (GtkModelButton *button,
                           GIcon          *icon)
{
  gtk_image_set_from_gicon (GTK_IMAGE (button->image), icon, GTK_ICON_SIZE_MENU);
380
  update_visibility (button);
381
  g_object_notify_by_pspec (G_OBJECT (button), properties[PROP_ICON]);
382 383 384 385 386 387
}

static void
gtk_model_button_set_text (GtkModelButton *button,
                           const gchar    *text)
{
388 389
  gtk_label_set_text_with_mnemonic (GTK_LABEL (button->label), text);
  update_visibility (button);
390
  g_object_notify_by_pspec (G_OBJECT (button), properties[PROP_TEXT]);
391 392 393
}

static void
394 395
gtk_model_button_set_active (GtkModelButton *button,
                             gboolean        active)
396
{
397 398 399
  if (button->active == active)
    return;

400
  button->active = active;
401
  gtk_model_button_update_state (button);
402
  gtk_widget_queue_draw (GTK_WIDGET (button));
403
  g_object_notify_by_pspec (G_OBJECT (button), properties[PROP_ACTIVE]);
404 405
}

406 407 408 409 410 411
static void
gtk_model_button_set_menu_name (GtkModelButton *button,
                                const gchar    *menu_name)
{
  g_free (button->menu_name);
  button->menu_name = g_strdup (menu_name);
412 413

  update_node_name (button);
414
  gtk_model_button_update_state (button);
415

416
  gtk_widget_queue_resize (GTK_WIDGET (button));
417
  g_object_notify_by_pspec (G_OBJECT (button), properties[PROP_MENU_NAME]);
418 419
}

420 421 422 423
static void
gtk_model_button_set_inverted (GtkModelButton *button,
                               gboolean        inverted)
{
424 425 426
  if (button->inverted == inverted)
    return;

427
  button->inverted = inverted;
428 429
  gtk_model_button_update_state (button);
  update_node_ordering (button);
430
  gtk_widget_queue_resize (GTK_WIDGET (button));
431
  g_object_notify_by_pspec (G_OBJECT (button), properties[PROP_INVERTED]);
432 433 434 435
}

static void
gtk_model_button_set_centered (GtkModelButton *button,
436
                               gboolean        centered)
437
{
438 439 440
  if (button->centered == centered)
    return;

441 442
  button->centered = centered;
  gtk_widget_set_halign (button->box, button->centered ? GTK_ALIGN_CENTER : GTK_ALIGN_FILL);
443
  gtk_widget_queue_draw (GTK_WIDGET (button));
444
  g_object_notify_by_pspec (G_OBJECT (button), properties[PROP_CENTERED]);
445 446
}

447 448 449 450
static void
gtk_model_button_set_iconic (GtkModelButton *button,
                             gboolean        iconic)
{
451
  GtkCssNode *widget_node;
452
  GtkCssNode *indicator_node;
453

454 455 456
  if (button->iconic == iconic)
    return;

457
  button->iconic = iconic;
458

459
  widget_node = gtk_widget_get_css_node (GTK_WIDGET (button));
460
  indicator_node = gtk_css_gadget_get_node (button->indicator_gadget);
461 462
  if (iconic)
    {
463
      gtk_css_node_set_name (widget_node, I_("button"));
464
      gtk_css_gadget_add_class (button->gadget, "model");
465
      gtk_css_gadget_add_class (button->gadget, "image-button");
466
      gtk_button_set_relief (GTK_BUTTON (button), GTK_RELIEF_NORMAL);
467
      gtk_css_node_set_visible (indicator_node, FALSE);
468 469 470
    }
  else
    {
471
      gtk_css_node_set_name (widget_node, I_("modelbutton"));
472
      gtk_css_gadget_remove_class (button->gadget, "model");
473
      gtk_css_gadget_remove_class (button->gadget, "image-button");
474
      gtk_button_set_relief (GTK_BUTTON (button), GTK_RELIEF_NONE);
475 476 477
      gtk_css_node_set_visible (indicator_node,
                                button->role != GTK_BUTTON_ROLE_NORMAL ||
                                button->menu_name == NULL);
478 479 480 481
    }

  update_visibility (button);
  gtk_widget_queue_resize (GTK_WIDGET (button));
482
  g_object_notify_by_pspec (G_OBJECT (button), properties[PROP_ICONIC]);
483 484
}

485 486 487 488 489 490 491 492 493 494
static void
gtk_model_button_get_property (GObject    *object,
                               guint       prop_id,
                               GValue     *value,
                               GParamSpec *pspec)
{
  GtkModelButton *button = GTK_MODEL_BUTTON (object);

  switch (prop_id)
    {
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
    case PROP_ROLE:
      g_value_set_enum (value, button->role);
      break;

    case PROP_ICON:
      {
        GIcon *icon;
        gtk_image_get_gicon (GTK_IMAGE (button->image), &icon, NULL);
        g_value_set_object (value, icon);
      }
      break;

    case PROP_TEXT:
      g_value_set_string (value, gtk_label_get_text (GTK_LABEL (button->label)));
      break;

511 512 513 514
    case PROP_ACTIVE:
      g_value_set_boolean (value, button->active);
      break;

515 516 517 518
    case PROP_MENU_NAME:
      g_value_set_string (value, button->menu_name);
      break;

519 520 521 522 523 524 525 526 527 528 529 530
    case PROP_INVERTED:
      g_value_set_boolean (value, button->inverted);
      break;

    case PROP_CENTERED:
      g_value_set_boolean (value, button->centered);
      break;

    case PROP_ICONIC:
      g_value_set_boolean (value, button->iconic);
      break;

531 532 533 534 535
    default:
      g_assert_not_reached ();
    }
}

536 537 538 539 540 541 542 543 544 545
static void
gtk_model_button_set_property (GObject      *object,
                               guint         prop_id,
                               const GValue *value,
                               GParamSpec   *pspec)
{
  GtkModelButton *button = GTK_MODEL_BUTTON (object);

  switch (prop_id)
    {
546 547
    case PROP_ROLE:
      gtk_model_button_set_role (button, g_value_get_enum (value));
548 549 550 551 552 553 554 555 556 557
      break;

    case PROP_ICON:
      gtk_model_button_set_icon (button, g_value_get_object (value));
      break;

    case PROP_TEXT:
      gtk_model_button_set_text (button, g_value_get_string (value));
      break;

558 559
    case PROP_ACTIVE:
      gtk_model_button_set_active (button, g_value_get_boolean (value));
560 561
      break;

562 563 564 565
    case PROP_MENU_NAME:
      gtk_model_button_set_menu_name (button, g_value_get_string (value));
      break;

566 567 568 569 570 571 572 573
    case PROP_INVERTED:
      gtk_model_button_set_inverted (button, g_value_get_boolean (value));
      break;

    case PROP_CENTERED:
      gtk_model_button_set_centered (button, g_value_get_boolean (value));
      break;

574 575 576 577
    case PROP_ICONIC:
      gtk_model_button_set_iconic (button, g_value_get_boolean (value));
      break;

578 579 580 581 582
    default:
      g_assert_not_reached ();
    }
}

583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
static gboolean
has_sibling_with_indicator (GtkWidget *button)
{
  GtkWidget *parent;
  gboolean has_indicator;
  GList *children, *l;
  GtkModelButton *sibling;

  has_indicator = FALSE;

  parent = gtk_widget_get_parent (button);
  children = gtk_container_get_children (GTK_CONTAINER (parent));

  for (l = children; l; l = l->next)
    {
      sibling = l->data;

      if (!GTK_IS_MODEL_BUTTON (sibling))
        continue;

      if (!gtk_widget_is_visible (GTK_WIDGET (sibling)))
        continue;

      if (!sibling->centered &&
607
          (sibling->menu_name || sibling->role != GTK_BUTTON_ROLE_NORMAL))
608 609 610 611 612 613 614 615 616 617 618 619 620 621
        {
          has_indicator = TRUE;
          break;
        }
    }

  g_list_free (children);

  return has_indicator;
}

static gboolean
needs_indicator (GtkModelButton *button)
{
622
  if (button->role != GTK_BUTTON_ROLE_NORMAL)
623 624 625 626 627
    return TRUE;

  return has_sibling_with_indicator (GTK_WIDGET (button));
}

628 629 630 631 632 633
static void
gtk_model_button_get_preferred_width_for_height (GtkWidget *widget,
                                                 gint       height,
                                                 gint      *minimum,
                                                 gint      *natural)
{
634
  GtkCssGadget *gadget;
635

636 637
  if (GTK_MODEL_BUTTON (widget)->iconic)
    gadget = GTK_BUTTON (widget)->priv->gadget;
638
  else
639
    gadget = GTK_MODEL_BUTTON (widget)->gadget;
640

641 642 643 644 645
  gtk_css_gadget_get_preferred_size (gadget,
                                     GTK_ORIENTATION_HORIZONTAL,
                                     height,
                                     minimum, natural,
                                     NULL, NULL);
646 647 648 649 650 651 652
}

static void
gtk_model_button_get_preferred_width (GtkWidget *widget,
                                      gint      *minimum,
                                      gint      *natural)
{
653 654 655 656 657 658 659 660 661 662 663 664
  GtkCssGadget *gadget;

  if (GTK_MODEL_BUTTON (widget)->iconic)
    gadget = GTK_BUTTON (widget)->priv->gadget;
  else
    gadget = GTK_MODEL_BUTTON (widget)->gadget;

  gtk_css_gadget_get_preferred_size (gadget,
                                     GTK_ORIENTATION_HORIZONTAL,
                                     -1,
                                     minimum, natural,
                                     NULL, NULL);
665 666 667
}

static void
Matthias Clasen's avatar
Matthias Clasen committed
668 669 670 671 672 673
gtk_model_button_get_preferred_height_and_baseline_for_width (GtkWidget *widget,
                                                              gint       width,
                                                              gint      *minimum,
                                                              gint      *natural,
                                                              gint      *minimum_baseline,
                                                              gint      *natural_baseline)
674
{
675 676 677 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 704 705 706 707 708 709 710 711 712 713 714
  GtkCssGadget *gadget;

  if (GTK_MODEL_BUTTON (widget)->iconic)
    gadget = GTK_BUTTON (widget)->priv->gadget;
  else
    gadget = GTK_MODEL_BUTTON (widget)->gadget;

  gtk_css_gadget_get_preferred_size (gadget,
                                     GTK_ORIENTATION_VERTICAL,
                                     width,
                                     minimum, natural,
                                     minimum_baseline, natural_baseline);
}

static void
gtk_model_button_get_preferred_height_for_width (GtkWidget *widget,
                                                 gint       width,
                                                 gint      *minimum,
                                                 gint      *natural)
{
  GtkCssGadget *gadget;

  if (GTK_MODEL_BUTTON (widget)->iconic)
    gadget = GTK_BUTTON (widget)->priv->gadget;
  else
    gadget = GTK_MODEL_BUTTON (widget)->gadget;

  gtk_css_gadget_get_preferred_size (gadget,
                                     GTK_ORIENTATION_VERTICAL,
                                     width,
                                     minimum, natural,
                                     NULL, NULL);
}

static void
gtk_model_button_get_preferred_height (GtkWidget *widget,
                                       gint      *minimum,
                                       gint      *natural)
{
  GtkCssGadget *gadget;
715

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
  if (GTK_MODEL_BUTTON (widget)->iconic)
    gadget = GTK_BUTTON (widget)->priv->gadget;
  else
    gadget = GTK_MODEL_BUTTON (widget)->gadget;

  gtk_css_gadget_get_preferred_size (gadget,
                                     GTK_ORIENTATION_VERTICAL,
                                     -1,
                                     minimum, natural,
                                     NULL, NULL);
}

static void
gtk_model_button_measure (GtkCssGadget   *gadget,
                          GtkOrientation  orientation,
                          int             for_size,
                          int            *minimum,
                          int            *natural,
                          int            *minimum_baseline,
                          int            *natural_baseline,
                          gpointer        data)
{
  GtkWidget *widget;
  GtkModelButton *button;
  GtkWidget *child;

  widget = gtk_css_gadget_get_owner (gadget);
  button = GTK_MODEL_BUTTON (widget);
744
  child = gtk_bin_get_child (GTK_BIN (widget));
745 746

  if (orientation == GTK_ORIENTATION_HORIZONTAL)
747
    {
748 749 750 751 752 753 754
      gint check_min, check_nat;

      gtk_css_gadget_get_preferred_size (button->indicator_gadget,
                                         GTK_ORIENTATION_HORIZONTAL,
                                         -1,
                                         &check_min, &check_nat,
                                         NULL, NULL);
755

756
      if (child && gtk_widget_get_visible (child))
757
        {
758 759 760 761 762 763 764 765 766 767
          _gtk_widget_get_preferred_size_for_size (child,
                                                   GTK_ORIENTATION_HORIZONTAL,
                                                   for_size,
                                                   minimum, natural,
                                                   minimum_baseline, natural_baseline);
        }
      else
        {
          *minimum = 0;
          *natural = 0;
768
        }
769

770 771
      if (button->centered)
        {
772 773
          *minimum += 2 * check_min;
          *natural += 2 * check_nat;
774 775 776
        }
      else if (needs_indicator (button))
        {
777 778
          *minimum += check_min;
          *natural += check_nat;
779
        }
780 781 782
    }
  else
    {
783 784 785 786 787 788 789 790 791
      gint check_min, check_nat;

      gtk_css_gadget_get_preferred_size (button->indicator_gadget,
                                         GTK_ORIENTATION_VERTICAL,
                                         -1,
                                         &check_min, &check_nat,
                                         NULL, NULL);

      if (child && gtk_widget_get_visible (child))
792
        {
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
          gint child_min, child_nat;
          gint child_min_baseline = -1, child_nat_baseline = -1;

          if (for_size > -1)
            {
              if (button->centered)
                for_size -= 2 * check_nat;
              else if (needs_indicator (button))
                for_size -= check_nat;
            }

          gtk_widget_get_preferred_height_and_baseline_for_width (child, for_size,
                                                                  &child_min, &child_nat,
                                                                  &child_min_baseline, &child_nat_baseline);

          if (button->centered)
            {
              *minimum = MAX (2 * check_min, child_min);
              *natural = MAX (2 * check_nat, child_nat);
            }
          else if (needs_indicator (button))
            {
              *minimum = MAX (check_min, child_min);
              *natural = MAX (check_nat, child_nat);
            }
          else
            {
              *minimum = child_min;
              *natural = child_nat;
            }

          if (minimum_baseline && child_min_baseline >= 0)
            *minimum_baseline = child_min_baseline + (*minimum - child_min) / 2;
          if (natural_baseline && child_nat_baseline >= 0)
            *natural_baseline = child_nat_baseline + (*natural - child_nat) / 2;
828 829 830
        }
      else
        {
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
          if (button->centered)
            {
              *minimum = 2 * check_min;
              *natural = 2 * check_nat;
            }
          else if (needs_indicator (button))
            {
              *minimum = check_min;
              *natural = check_nat;
            }
          else
            {
              *minimum = 0;
              *natural = 0;
            }
846
        }
847 848 849 850
    }
}

static void
851 852
gtk_model_button_size_allocate (GtkWidget     *widget,
                                GtkAllocation *allocation)
853
{
854 855
  GtkCssGadget *gadget;
  GdkRectangle clip;
856

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
  if (GTK_MODEL_BUTTON (widget)->iconic)
    gadget = GTK_BUTTON (widget)->priv->gadget;
  else
    gadget = GTK_MODEL_BUTTON (widget)->gadget;

  gtk_widget_set_allocation (widget, allocation);

  if (gtk_widget_get_realized (widget))
    gdk_window_move_resize (gtk_button_get_event_window (GTK_BUTTON (widget)),
                            allocation->x, allocation->y,
                            allocation->width, allocation->height);

  gtk_css_gadget_allocate (gadget,
                           allocation,
                           gtk_widget_get_allocated_baseline (widget),
                           &clip);

  gtk_widget_set_clip (widget, &clip);
875 876 877
}

static void
878 879 880 881 882
gtk_model_button_allocate (GtkCssGadget        *gadget,
                           const GtkAllocation *allocation,
                           int                  baseline,
                           GtkAllocation       *out_clip,
                           gpointer             unused)
883
{
884 885
  GtkWidget *widget;
  GtkModelButton *button;
886 887 888 889
  PangoContext *pango_context;
  PangoFontMetrics *metrics;
  GtkAllocation child_allocation;
  GtkWidget *child;
890 891 892 893
  gint spacing;
  gint check_min_width, check_nat_width;
  gint check_min_height, check_nat_height;
  GdkRectangle check_clip;
894

895 896 897
  widget = gtk_css_gadget_get_owner (gadget);
  button = GTK_MODEL_BUTTON (widget);
  child = gtk_bin_get_child (GTK_BIN (widget));
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 923 924 925
  spacing = 0;

  gtk_css_gadget_get_preferred_size (button->indicator_gadget,
                                     GTK_ORIENTATION_HORIZONTAL,
                                     -1,
                                     &check_min_width, &check_nat_width,
                                     NULL, NULL);
  gtk_css_gadget_get_preferred_size (button->indicator_gadget,
                                     GTK_ORIENTATION_VERTICAL,
                                     -1,
                                     &check_min_height, &check_nat_height,
                                     NULL, NULL);

  if (indicator_is_left (widget))
    child_allocation.x = allocation->x + spacing;
  else
    child_allocation.x = allocation->x + allocation->width - check_nat_width - spacing;
  child_allocation.y = allocation->y + (allocation->height - check_nat_height) / 2;
  child_allocation.width = check_nat_width;
  child_allocation.height = check_nat_height;

  gtk_css_gadget_allocate (button->indicator_gadget,
                           &child_allocation,
                           baseline,
                           &check_clip);

926 927
  if (child && gtk_widget_get_visible (child))
    {
928
      GtkBorder border = { 0, };
929

930
      if (button->centered)
931
        {
932 933
          border.left = check_nat_width;
          border.right = check_nat_width;
934
        }
935 936 937
      else if (needs_indicator (button))
        {
          if (indicator_is_left (widget))
938
            border.left += check_nat_width;
939
          else
940
            border.right += check_nat_width;
941
        }
942

943 944 945 946 947 948 949 950
      child_allocation.x = allocation->x + border.left;
      child_allocation.y = allocation->y + border.top;
      child_allocation.width = allocation->width - border.left - border.right;
      child_allocation.height = allocation->height - border.top - border.bottom;

      baseline = gtk_widget_get_allocated_baseline (widget);
      if (baseline != -1)
        baseline -= border.top;
951

952 953 954 955 956 957 958 959 960 961 962
      gtk_widget_size_allocate_with_baseline (child, &child_allocation, baseline);
    }

  pango_context = gtk_widget_get_pango_context (widget);
  metrics = pango_context_get_metrics (pango_context,
                                       pango_context_get_font_description (pango_context),
                                       pango_context_get_language (pango_context));
  GTK_BUTTON (button)->priv->baseline_align =
    (double)pango_font_metrics_get_ascent (metrics) /
    (pango_font_metrics_get_ascent (metrics) + pango_font_metrics_get_descent (metrics));
  pango_font_metrics_unref (metrics);
963 964 965

  gtk_container_get_children_clip (GTK_CONTAINER (widget), out_clip);
  gdk_rectangle_union (out_clip, &check_clip, out_clip);
966 967 968 969 970 971
}

static gint
gtk_model_button_draw (GtkWidget *widget,
                       cairo_t   *cr)
{
972
  GtkCssGadget *gadget;
973

974 975 976 977
  if (GTK_MODEL_BUTTON (widget)->iconic)
    gadget = GTK_BUTTON (widget)->priv->gadget;
  else
    gadget = GTK_MODEL_BUTTON (widget)->gadget;
978

979
  gtk_css_gadget_draw (gadget, cr);
980

981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
  return FALSE;
}

static gboolean
gtk_model_button_render (GtkCssGadget *gadget,
                         cairo_t      *cr,
                         int           x,
                         int           y,
                         int           width,
                         int           height,
                         gpointer      data)
{
  GtkWidget *widget;
  GtkModelButton *button;
  GtkWidget *child;

  widget = gtk_css_gadget_get_owner (gadget);
  button = GTK_MODEL_BUTTON (widget);

1000 1001 1002 1003 1004 1005
  if (gtk_css_node_get_visible (gtk_css_gadget_get_node (button->indicator_gadget)))
    {
      cairo_save (cr);
      gtk_css_gadget_draw (button->indicator_gadget, cr);
      cairo_restore (cr);
    }
1006 1007 1008 1009 1010

  child = gtk_bin_get_child (GTK_BIN (widget));
  if (child)
    gtk_container_propagate_draw (GTK_CONTAINER (widget), child, cr);

1011
  return gtk_widget_has_visible_focus (widget);
1012 1013
}

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
static void
gtk_model_button_destroy (GtkWidget *widget)
{
  GtkModelButton *model_button = GTK_MODEL_BUTTON (widget);

  g_clear_pointer (&model_button->menu_name, g_free);

  GTK_WIDGET_CLASS (gtk_model_button_parent_class)->destroy (widget);
}

1024 1025 1026 1027
static void
gtk_model_button_clicked (GtkButton *button)
{
  GtkModelButton *model_button = GTK_MODEL_BUTTON (button);
1028

1029 1030 1031 1032 1033 1034 1035 1036
  if (model_button->menu_name != NULL)
    {
      GtkWidget *stack;

      stack = gtk_widget_get_ancestor (GTK_WIDGET (button), GTK_TYPE_STACK);
      if (stack != NULL)
        gtk_stack_set_visible_child_name (GTK_STACK (stack), model_button->menu_name);
    }
1037
  else if (model_button->role == GTK_BUTTON_ROLE_NORMAL)
1038 1039 1040 1041 1042 1043 1044 1045 1046
    {
      GtkWidget *popover;

      popover = gtk_widget_get_ancestor (GTK_WIDGET (button), GTK_TYPE_POPOVER);
      if (popover != NULL)
        gtk_widget_hide (popover);
    }
}

1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
static void
gtk_model_button_finalize (GObject *object)
{
  GtkModelButton *button = GTK_MODEL_BUTTON (object);

  g_clear_object (&button->indicator_gadget);
  g_clear_object (&button->gadget);

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

1058 1059 1060 1061 1062
static void
gtk_model_button_class_init (GtkModelButtonClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
1063
  GtkButtonClass *button_class = GTK_BUTTON_CLASS (class);
1064

1065
  object_class->finalize = gtk_model_button_finalize;
1066
  object_class->get_property = gtk_model_button_get_property;
1067 1068 1069 1070 1071 1072 1073 1074 1075
  object_class->set_property = gtk_model_button_set_property;

  widget_class->get_preferred_width = gtk_model_button_get_preferred_width;
  widget_class->get_preferred_width_for_height = gtk_model_button_get_preferred_width_for_height;
  widget_class->get_preferred_height = gtk_model_button_get_preferred_height;
  widget_class->get_preferred_height_for_width = gtk_model_button_get_preferred_height_for_width;
  widget_class->get_preferred_height_and_baseline_for_width = gtk_model_button_get_preferred_height_and_baseline_for_width;
  widget_class->size_allocate = gtk_model_button_size_allocate;
  widget_class->draw = gtk_model_button_draw;
1076
  widget_class->destroy = gtk_model_button_destroy;
1077
  widget_class->state_flags_changed = gtk_model_button_state_flags_changed;
1078
  widget_class->direction_changed = gtk_model_button_direction_changed;
1079

1080 1081
  button_class->clicked = gtk_model_button_clicked;

Matthias Clasen's avatar
Matthias Clasen committed
1082 1083 1084 1085 1086 1087 1088 1089 1090
  /**
   * GtkModelButton:role:
   *
   * Specifies whether the button is a plain, check or radio button.
   * When #GtkActionable:action-name is set, the role will be determined
   * from the action and does not have to be set explicitly.
   *
   * Since: 3.16
   */
1091
  properties[PROP_ROLE] =
Matthias Clasen's avatar
Matthias Clasen committed
1092 1093 1094
    g_param_spec_enum ("role",
                       P_("Role"),
                       P_("The role of this button"),
1095 1096 1097
                       GTK_TYPE_BUTTON_ROLE,
                       GTK_BUTTON_ROLE_NORMAL,
                       G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
Matthias Clasen's avatar
Matthias Clasen committed
1098 1099 1100 1101 1102 1103 1104 1105 1106

  /**
   * GtkModelButton:icon:
   *
   * A #GIcon that will be used if iconic appearance for the button is
   * desired.
   *
   * Since: 3.16
   */
1107
  properties[PROP_ICON] = 
Matthias Clasen's avatar
Matthias Clasen committed
1108 1109 1110
    g_param_spec_object ("icon",
                         P_("Icon"),
                         P_("The icon"),
1111 1112
                         G_TYPE_ICON,
                         G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
Matthias Clasen's avatar
Matthias Clasen committed
1113 1114 1115 1116 1117 1118 1119 1120

  /**
   * GtkModelButton:text:
   *
   * The label for the button.
   *
   * Since: 3.16
   */
1121
  properties[PROP_TEXT] =
Matthias Clasen's avatar
Matthias Clasen committed
1122 1123 1124
    g_param_spec_string ("text",
                         P_("Text"),
                         P_("The text"),
1125
                         "",
1126
                         G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
Matthias Clasen's avatar
Matthias Clasen committed
1127 1128 1129 1130 1131 1132 1133 1134 1135

  /**
   * GtkModelButton:active:
   *
   * The state of the button. This is reflecting the state of the associated
   * #GAction.
   *
   * Since: 3.16
   */
1136
  properties[PROP_ACTIVE] =
Matthias Clasen's avatar
Matthias Clasen committed
1137 1138 1139
    g_param_spec_boolean ("active",
                          P_("Active"),
                          P_("Active"),
1140 1141
                          FALSE,
                          G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
Matthias Clasen's avatar
Matthias Clasen committed
1142 1143 1144 1145 1146 1147 1148 1149 1150

  /**
   * GtkModelButton:menu-name:
   *
   * The name of a submenu to open when the button is activated.
   * If this is set, the button should not have an action associated with it.
   *
   * Since: 3.16
   */
1151
  properties[PROP_MENU_NAME] =
Matthias Clasen's avatar
Matthias Clasen committed
1152 1153 1154
    g_param_spec_string ("menu-name",
                         P_("Menu name"),
                         P_("The name of the menu to open"),
1155 1156
                         NULL,
                         G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
Matthias Clasen's avatar
Matthias Clasen committed
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166

  /**
   * GtkModelButton:inverted:
   *
   * Whether to show the submenu indicator at the opposite side than normal.
   * This property should be set for model buttons that 'go back' to a parent
   * menu.
   *
   * Since: 3.16
   */
1167
  properties[PROP_INVERTED] =
Matthias Clasen's avatar
Matthias Clasen committed
1168 1169 1170
    g_param_spec_boolean ("inverted",
                          P_("Inverted"),
                          P_("Whether the menu is a parent"),
1171 1172
                          FALSE,
                          G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
Matthias Clasen's avatar
Matthias Clasen committed
1173 1174 1175 1176 1177 1178 1179 1180 1181

  /**
   * GtkModelButton:centered:
   *
   * Wether to render the button contents centered instead of left-aligned.
   * This property should be set for title-like items.
   *
   * Since: 3.16
   */
1182
  properties[PROP_CENTERED] =
Matthias Clasen's avatar
Matthias Clasen committed
1183 1184 1185
    g_param_spec_boolean ("centered",
                          P_("Centered"),
                          P_("Whether to center the contents"),
1186 1187
                          FALSE,
                          G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
Matthias Clasen's avatar
Matthias Clasen committed
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197

  /**
   * GtkModelButton:iconic:
   *
   * If this property is set, the button will show an icon if one is set.
   * If no icon is set, the text will be used. This is typically used for
   * horizontal sections of linked buttons.
   *
   * Since: 3.16
   */
1198
  properties[PROP_ICONIC] =
Matthias Clasen's avatar
Matthias Clasen committed
1199 1200 1201
    g_param_spec_boolean ("iconic",
                          P_("Iconic"),
                          P_("Whether to prefer the icon over text"),
1202
                          FALSE,
1203 1204
                          G_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY | G_PARAM_STATIC_STRINGS);
  g_object_class_install_properties (object_class, LAST_PROPERTY, properties);
1205 1206

  gtk_widget_class_set_accessible_role (GTK_WIDGET_CLASS (class), ATK_ROLE_PUSH_BUTTON);
1207 1208 1209
  gtk_widget_class_set_css_name (GTK_WIDGET_CLASS (class), "modelbutton");
}

1210 1211 1212
static void
gtk_model_button_init (GtkModelButton *button)
{
1213 1214
  GtkCssNode *widget_node;

1215
  button->role = GTK_BUTTON_ROLE_NORMAL;
1216 1217
  gtk_button_set_relief (GTK_BUTTON (button), GTK_RELIEF_NONE);
  button->box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6);
Matthias Clasen's avatar
Matthias Clasen committed
1218 1219 1220 1221
  gtk_widget_set_margin_start (button->box, 12);
  gtk_widget_set_margin_end (button->box, 12);
  gtk_widget_set_margin_top (button->box, 3);
  gtk_widget_set_margin_bottom (button->box, 3);
1222 1223 1224
  gtk_widget_set_halign (button->box, GTK_ALIGN_FILL);
  gtk_widget_show (button->box);
  button->image = gtk_image_new ();
1225
  gtk_widget_set_no_show_all (button->image, TRUE);
1226
  g_object_set (button->image, "margin", 4, NULL);
1227
  button->label = gtk_label_new ("");
1228
  gtk_widget_set_no_show_all (button->label, TRUE);
1229 1230 1231
  gtk_container_add (GTK_CONTAINER (button->box), button->image);
  gtk_container_add (GTK_CONTAINER (button->box), button->label);
  gtk_container_add (GTK_CONTAINER (button), button->box);
1232 1233

  widget_node = gtk_widget_get_css_node (GTK_WIDGET (button));
1234 1235 1236 1237 1238 1239 1240
  button->gadget = gtk_css_custom_gadget_new_for_node (widget_node,
                                                       GTK_WIDGET (button),
                                                       gtk_model_button_measure,
                                                       gtk_model_button_allocate,
                                                       gtk_model_button_render,
                                                       NULL,
                                                       NULL);
1241 1242 1243 1244 1245 1246
  button->indicator_gadget = gtk_builtin_icon_new ("check",
                                                   GTK_WIDGET (button),
                                                   button->gadget,
                                                   NULL);
  gtk_builtin_icon_set_default_size (GTK_BUILTIN_ICON (button->indicator_gadget), 16);
  update_node_ordering (button);
1247
  gtk_css_node_set_visible (gtk_css_gadget_get_node (button->indicator_gadget), FALSE);
1248 1249
}

1250 1251 1252 1253 1254 1255 1256 1257 1258
/**
 * gtk_model_button_new:
 *
 * Creates a new GtkModelButton.
 *
 * Returns: the newly created #GtkModelButton widget
 *
 * Since: 3.16
 */
1259 1260 1261 1262 1263
GtkWidget *
gtk_model_button_new (void)
{
  return g_object_new (GTK_TYPE_MODEL_BUTTON, NULL);
}