gtkexpander.c 54.7 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10 11 12 13 14 15
 *
 * Copyright (C) 2003 Sun Microsystems, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
Javier Jardón's avatar
Javier Jardón committed
16
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17 18
 *
 * Authors:
19 20 21 22 23 24 25 26 27 28
 *      Mark McLoughlin <mark@skynet.ie>
 */

/**
 * SECTION:gtkexpander
 * @Short_description: A container which can hide its child
 * @Title: GtkExpander
 *
 * A #GtkExpander allows the user to hide or show its child by clicking
 * on an expander triangle similar to the triangles used in a #GtkTreeView.
29
 *
30 31 32 33
 * Normally you use an expander as you would use any other descendant
 * of #GtkBin; you create the child widget and use gtk_container_add()
 * to add it to the expander. When the expander is toggled, it will take
 * care of showing and hiding the child automatically.
34
 *
35
 * # Special Usage
36
 *
37 38 39 40 41 42 43
 * There are situations in which you may prefer to show and hide the
 * expanded widget yourself, such as when you want to actually create
 * the widget at expansion time. In this case, create a #GtkExpander
 * but do not add a child to it. The expander widget has an
 * #GtkExpander:expanded property which can be used to monitor
 * its expansion state. You should watch this property with a signal
 * connection as follows:
44
 *
45
 * |[<!-- language="C" -->
46 47 48 49 50 51 52 53 54 55 56
 * static void
 * expander_callback (GObject    *object,
 *                    GParamSpec *param_spec,
 *                    gpointer    user_data)
 * {
 *   GtkExpander *expander;
 *
 *   expander = GTK_EXPANDER (object);
 *
 *   if (gtk_expander_get_expanded (expander))
 *     {
57
 *       // Show or create widgets
58 59 60
 *     }
 *   else
 *     {
61
 *       // Hide or destroy widgets
62 63
 *     }
 * }
64 65 66 67 68 69 70 71 72 73
 *
 * static void
 * create_expander (void)
 * {
 *   GtkWidget *expander = gtk_expander_new_with_mnemonic ("_More Options");
 *   g_signal_connect (expander, "notify::expanded",
 *                     G_CALLBACK (expander_callback), NULL);
 *
 *   // ...
 * }
74
 * ]|
75
 *
76
 * # GtkExpander as GtkBuildable
77
 *
78 79 80 81
 * The GtkExpander implementation of the GtkBuildable interface supports
 * placing a child in the label position by specifying “label” as the
 * “type” attribute of a <child> element. A normal content child can be
 * specified without specifying a <child> type attribute.
82 83
 *
 * An example of a UI definition fragment with GtkExpander:
84
 * |[
85 86 87 88 89 90 91 92
 * <object class="GtkExpander">
 *   <child type="label">
 *     <object class="GtkLabel" id="expander-label"/>
 *   </child>
 *   <child>
 *     <object class="GtkEntry" id="expander-content"/>
 *   </child>
 * </object>
93
 * ]|
94 95 96 97 98
 *
 * # CSS nodes
 *
 * |[<!-- language="plain" -->
 * expander
99 100
 * ├── title
 * │   ├── arrow
101 102
 * │   ╰── <label widget>
 * ╰── <child>
103 104
 * ]|
 *
105
 * GtkExpander has three CSS nodes, the main node with the name expander,
106 107
 * a subnode with name title and node below it with name arrow. The arrow of an
 * expander that is showing its child gets the :checked pseudoclass added to it.
108 109
 */

110
#include "config.h"
111

112
#include <string.h>
113

114 115 116
#include "gtkexpander.h"

#include "gtklabel.h"
117
#include "gtkbuildable.h"
118 119 120 121 122
#include "gtkcontainer.h"
#include "gtkmarshalers.h"
#include "gtkmain.h"
#include "gtkintl.h"
#include "gtkprivate.h"
123
#include "gtkdnd.h"
124
#include "a11y/gtkexpanderaccessible.h"
125
#include "gtkstylecontextprivate.h"
126
#include "gtkcsscustomgadgetprivate.h"
127
#include "gtkboxgadgetprivate.h"
128
#include "gtkbuiltiniconprivate.h"
129
#include "gtkwidgetprivate.h"
130
#include "gtkcontainerprivate.h"
131 132 133 134


#define DEFAULT_EXPANDER_SIZE 10
#define DEFAULT_EXPANDER_SPACING 2
135
#define TIMEOUT_EXPAND 500
136 137 138 139 140 141 142

enum
{
  PROP_0,
  PROP_EXPANDED,
  PROP_LABEL,
  PROP_USE_UNDERLINE,
143
  PROP_USE_MARKUP,
Soeren Sandmann's avatar
Soeren Sandmann committed
144
  PROP_SPACING,
145
  PROP_LABEL_WIDGET,
146 147
  PROP_LABEL_FILL,
  PROP_RESIZE_TOPLEVEL
148 149 150 151 152 153
};

struct _GtkExpanderPrivate
{
  GtkWidget        *label_widget;
  GdkWindow        *event_window;
154

155 156 157
  GtkCssGadget     *gadget;
  GtkCssGadget     *title_gadget;
  GtkCssGadget     *arrow_gadget;
158

159
  GtkGesture       *multipress_gesture;
160 161
  gint              spacing;

162
  guint             expand_timer;
163

164 165 166 167 168
  guint             expanded        : 1;
  guint             use_underline   : 1;
  guint             use_markup      : 1;
  guint             prelight        : 1;
  guint             label_fill      : 1;
169
  guint             resize_toplevel : 1;
170 171 172
};

static void gtk_expander_set_property (GObject          *object,
173 174 175
                                       guint             prop_id,
                                       const GValue     *value,
                                       GParamSpec       *pspec);
176
static void gtk_expander_get_property (GObject          *object,
177 178 179
                                       guint             prop_id,
                                       GValue           *value,
                                       GParamSpec       *pspec);
180

181
static void     gtk_expander_destroy        (GtkWidget        *widget);
182 183 184
static void     gtk_expander_realize        (GtkWidget        *widget);
static void     gtk_expander_unrealize      (GtkWidget        *widget);
static void     gtk_expander_size_allocate  (GtkWidget        *widget,
185
                                             GtkAllocation    *allocation);
186 187
static void     gtk_expander_map            (GtkWidget        *widget);
static void     gtk_expander_unmap          (GtkWidget        *widget);
188
static gboolean gtk_expander_draw           (GtkWidget        *widget,
189
                                             cairo_t          *cr);
190

191
static gboolean gtk_expander_enter_notify   (GtkWidget        *widget,
192
                                             GdkEventCrossing *event);
193
static gboolean gtk_expander_leave_notify   (GtkWidget        *widget,
194
                                             GdkEventCrossing *event);
195
static gboolean gtk_expander_focus          (GtkWidget        *widget,
196
                                             GtkDirectionType  direction);
197
static gboolean gtk_expander_drag_motion    (GtkWidget        *widget,
198 199 200 201
                                             GdkDragContext   *context,
                                             gint              x,
                                             gint              y,
                                             guint             time);
202
static void     gtk_expander_drag_leave     (GtkWidget        *widget,
203 204
                                             GdkDragContext   *context,
                                             guint             time);
205 206

static void gtk_expander_add    (GtkContainer *container,
207
                                 GtkWidget    *widget);
208
static void gtk_expander_remove (GtkContainer *container,
209
                                 GtkWidget    *widget);
210
static void gtk_expander_forall (GtkContainer *container,
211 212 213
                                 gboolean        include_internals,
                                 GtkCallback     callback,
                                 gpointer        callback_data);
214 215 216

static void gtk_expander_activate (GtkExpander *expander);

217

218 219
/* GtkBuildable */
static void gtk_expander_buildable_init           (GtkBuildableIface *iface);
220
static void gtk_expander_buildable_add_child      (GtkBuildable *buildable,
221 222 223
                                                   GtkBuilder   *builder,
                                                   GObject      *child,
                                                   const gchar  *type);
224

225

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
/* GtkWidget      */
static void  gtk_expander_get_preferred_width             (GtkWidget           *widget,
                                                           gint                *minimum_size,
                                                           gint                *natural_size);
static void  gtk_expander_get_preferred_height            (GtkWidget           *widget,
                                                           gint                *minimum_size,
                                                           gint                *natural_size);
static void  gtk_expander_get_preferred_height_for_width  (GtkWidget           *layout,
                                                           gint                 width,
                                                           gint                *minimum_height,
                                                           gint                *natural_height);
static void  gtk_expander_get_preferred_width_for_height  (GtkWidget           *layout,
                                                           gint                 width,
                                                           gint                *minimum_height,
                                                           gint                *natural_height);
241 242 243 244
static void gtk_expander_state_flags_changed (GtkWidget        *widget,
                                              GtkStateFlags     previous_state);
static void gtk_expander_direction_changed   (GtkWidget        *widget,
                                              GtkTextDirection  previous_direction);
245

246 247 248 249 250 251 252
/* Gestures */
static void     gesture_multipress_released_cb (GtkGestureMultiPress *gesture,
                                                gint                  n_press,
                                                gdouble               x,
                                                gdouble               y,
                                                GtkExpander          *expander);

253
G_DEFINE_TYPE_WITH_CODE (GtkExpander, gtk_expander, GTK_TYPE_BIN,
254
                         G_ADD_PRIVATE (GtkExpander)
255 256
                         G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
                                                gtk_expander_buildable_init))
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271

static void
gtk_expander_class_init (GtkExpanderClass *klass)
{
  GObjectClass *gobject_class;
  GtkWidgetClass *widget_class;
  GtkContainerClass *container_class;

  gobject_class   = (GObjectClass *) klass;
  widget_class    = (GtkWidgetClass *) klass;
  container_class = (GtkContainerClass *) klass;

  gobject_class->set_property = gtk_expander_set_property;
  gobject_class->get_property = gtk_expander_get_property;

272
  widget_class->destroy              = gtk_expander_destroy;
273 274 275 276 277
  widget_class->realize              = gtk_expander_realize;
  widget_class->unrealize            = gtk_expander_unrealize;
  widget_class->size_allocate        = gtk_expander_size_allocate;
  widget_class->map                  = gtk_expander_map;
  widget_class->unmap                = gtk_expander_unmap;
278
  widget_class->draw                 = gtk_expander_draw;
279 280 281
  widget_class->enter_notify_event   = gtk_expander_enter_notify;
  widget_class->leave_notify_event   = gtk_expander_leave_notify;
  widget_class->focus                = gtk_expander_focus;
282 283
  widget_class->drag_motion          = gtk_expander_drag_motion;
  widget_class->drag_leave           = gtk_expander_drag_leave;
284 285 286 287
  widget_class->get_preferred_width            = gtk_expander_get_preferred_width;
  widget_class->get_preferred_height           = gtk_expander_get_preferred_height;
  widget_class->get_preferred_height_for_width = gtk_expander_get_preferred_height_for_width;
  widget_class->get_preferred_width_for_height = gtk_expander_get_preferred_width_for_height;
288 289
  widget_class->state_flags_changed  = gtk_expander_state_flags_changed;
  widget_class->direction_changed  = gtk_expander_direction_changed;
290 291 292 293 294 295 296 297

  container_class->add    = gtk_expander_add;
  container_class->remove = gtk_expander_remove;
  container_class->forall = gtk_expander_forall;

  klass->activate = gtk_expander_activate;

  g_object_class_install_property (gobject_class,
298 299 300 301 302
                                   PROP_EXPANDED,
                                   g_param_spec_boolean ("expanded",
                                                         P_("Expanded"),
                                                         P_("Whether the expander has been opened to reveal the child widget"),
                                                         FALSE,
303
                                                         GTK_PARAM_READWRITE|G_PARAM_CONSTRUCT|G_PARAM_EXPLICIT_NOTIFY));
304 305

  g_object_class_install_property (gobject_class,
306 307 308 309 310
                                   PROP_LABEL,
                                   g_param_spec_string ("label",
                                                        P_("Label"),
                                                        P_("Text of the expander's label"),
                                                        NULL,
311
                                                        GTK_PARAM_READWRITE|G_PARAM_CONSTRUCT));
312 313

  g_object_class_install_property (gobject_class,
314 315 316 317 318
                                   PROP_USE_UNDERLINE,
                                   g_param_spec_boolean ("use-underline",
                                                         P_("Use underline"),
                                                         P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
                                                         FALSE,
319
                                                         GTK_PARAM_READWRITE|G_PARAM_CONSTRUCT|G_PARAM_EXPLICIT_NOTIFY));
320

321
  g_object_class_install_property (gobject_class,
322 323 324 325 326
                                   PROP_USE_MARKUP,
                                   g_param_spec_boolean ("use-markup",
                                                         P_("Use markup"),
                                                         P_("The text of the label includes XML markup. See pango_parse_markup()"),
                                                         FALSE,
327
                                                         GTK_PARAM_READWRITE|G_PARAM_CONSTRUCT|G_PARAM_EXPLICIT_NOTIFY));
328

329 330 331 332 333 334 335 336 337
  /**
   * GtkExpander:spacing:
   *
   * Space to put between the label and the child when the
   * expander is expanded.
   *
   * Deprecated: 3.20: This property is deprecated and ignored.
   *     Use margins on the child instead.
   */
338
  g_object_class_install_property (gobject_class,
339 340 341 342 343 344 345
                                   PROP_SPACING,
                                   g_param_spec_int ("spacing",
                                                     P_("Spacing"),
                                                     P_("Space to put between the label and the child"),
                                                     0,
                                                     G_MAXINT,
                                                     0,
346
                                                     GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY|G_PARAM_DEPRECATED));
347 348

  g_object_class_install_property (gobject_class,
349 350 351 352 353 354
                                   PROP_LABEL_WIDGET,
                                   g_param_spec_object ("label-widget",
                                                        P_("Label widget"),
                                                        P_("A widget to display in place of the usual expander label"),
                                                        GTK_TYPE_WIDGET,
                                                        GTK_PARAM_READWRITE));
355

356
  g_object_class_install_property (gobject_class,
357 358 359 360 361
                                   PROP_LABEL_FILL,
                                   g_param_spec_boolean ("label-fill",
                                                         P_("Label fill"),
                                                         P_("Whether the label widget should fill all available horizontal space"),
                                                         FALSE,
362
                                                         GTK_PARAM_READWRITE|G_PARAM_CONSTRUCT|G_PARAM_EXPLICIT_NOTIFY));
363

364 365 366 367 368 369 370 371 372 373 374
  /**
   * GtkExpander:resize-toplevel:
   *
   * When this property is %TRUE, the expander will resize the toplevel
   * widget containing the expander upon expanding and collapsing.
   *
   * Since: 3.2
   */
  g_object_class_install_property (gobject_class,
                                   PROP_RESIZE_TOPLEVEL,
                                   g_param_spec_boolean ("resize-toplevel",
Rachid BM's avatar
Rachid BM committed
375
                                                         P_("Resize toplevel"),
376 377
                                                         P_("Whether the expander will resize the toplevel window upon expanding and collapsing"),
                                                         FALSE,
378
                                                         GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
379

380 381 382 383 384 385 386
  /**
   * GtkExpander:expander-size:
   *
   * The size of the expander arrow.
   *
   * Deprecated: 3.20: Use CSS min-width and min-height instead.
   */
387
  gtk_widget_class_install_style_property (widget_class,
388 389 390 391 392 393
                                           g_param_spec_int ("expander-size",
                                                             P_("Expander Size"),
                                                             P_("Size of the expander arrow"),
                                                             0,
                                                             G_MAXINT,
                                                             DEFAULT_EXPANDER_SIZE,
394
                                                             GTK_PARAM_READABLE|G_PARAM_DEPRECATED));
395

396 397 398 399 400 401 402 403
  /**
   * GtkExpander:expander-spacing:
   *
   * Spaing around the expander arrow.
   *
   * Deprecated: 3.20: Use CSS margins instead, the value of this
   *    style property is ignored.
   */
404
  gtk_widget_class_install_style_property (widget_class,
405 406 407 408 409 410
                                           g_param_spec_int ("expander-spacing",
                                                             P_("Indicator Spacing"),
                                                             P_("Spacing around expander arrow"),
                                                             0,
                                                             G_MAXINT,
                                                             DEFAULT_EXPANDER_SPACING,
411
                                                             GTK_PARAM_READABLE|G_PARAM_DEPRECATED));
412 413

  widget_class->activate_signal =
414
    g_signal_new (I_("activate"),
415 416 417 418
                  G_TYPE_FROM_CLASS (gobject_class),
                  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
                  G_STRUCT_OFFSET (GtkExpanderClass, activate),
                  NULL, NULL,
419
                  NULL,
420
                  G_TYPE_NONE, 0);
421 422

  gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_EXPANDER_ACCESSIBLE);
423 424 425
  gtk_widget_class_set_css_name (widget_class, "expander");
}

426 427 428 429
static void
gtk_expander_init (GtkExpander *expander)
{
  GtkExpanderPrivate *priv;
430
  GtkCssNode *widget_node;
431

432
  expander->priv = priv = gtk_expander_get_instance_private (expander);
433

434
  gtk_widget_set_can_focus (GTK_WIDGET (expander), TRUE);
435
  gtk_widget_set_has_window (GTK_WIDGET (expander), FALSE);
436 437 438 439 440 441 442

  priv->label_widget = NULL;
  priv->event_window = NULL;
  priv->spacing = 0;

  priv->expanded = FALSE;
  priv->use_underline = FALSE;
443
  priv->use_markup = FALSE;
444
  priv->prelight = FALSE;
445
  priv->label_fill = FALSE;
446
  priv->expand_timer = 0;
447
  priv->resize_toplevel = 0;
448

449
  widget_node = gtk_widget_get_css_node (GTK_WIDGET (expander));
450 451 452 453 454 455 456
  priv->gadget = gtk_box_gadget_new_for_node (widget_node, GTK_WIDGET (expander));
  gtk_box_gadget_set_orientation (GTK_BOX_GADGET (priv->gadget), GTK_ORIENTATION_VERTICAL);
  priv->title_gadget = gtk_box_gadget_new ("title",
                                           GTK_WIDGET (expander),
                                           priv->gadget,
                                           NULL);
  gtk_box_gadget_set_orientation (GTK_BOX_GADGET (priv->title_gadget), GTK_ORIENTATION_HORIZONTAL);
457
  gtk_box_gadget_set_draw_focus (GTK_BOX_GADGET (priv->title_gadget), TRUE);
458
  gtk_box_gadget_insert_gadget (GTK_BOX_GADGET (priv->gadget), -1, priv->title_gadget, FALSE, GTK_ALIGN_START);
459

460 461 462 463 464 465
  priv->arrow_gadget = gtk_builtin_icon_new ("arrow",
                                             GTK_WIDGET (expander),
                                             priv->title_gadget,
                                             NULL);
  gtk_css_gadget_add_class (priv->arrow_gadget, GTK_STYLE_CLASS_HORIZONTAL);
  gtk_builtin_icon_set_default_size_property (GTK_BUILTIN_ICON (priv->arrow_gadget), "expander-size");
466

467
  gtk_box_gadget_insert_gadget (GTK_BOX_GADGET (priv->title_gadget), -1, priv->arrow_gadget, FALSE, GTK_ALIGN_CENTER);
468

469 470
  gtk_drag_dest_set (GTK_WIDGET (expander), 0, NULL, 0, 0);
  gtk_drag_dest_set_track_motion (GTK_WIDGET (expander), TRUE);
471 472 473 474 475 476 477 478 479 480

  priv->multipress_gesture = gtk_gesture_multi_press_new (GTK_WIDGET (expander));
  gtk_gesture_single_set_button (GTK_GESTURE_SINGLE (priv->multipress_gesture),
                                 GDK_BUTTON_PRIMARY);
  gtk_gesture_single_set_touch_only (GTK_GESTURE_SINGLE (priv->multipress_gesture),
                                     FALSE);
  g_signal_connect (priv->multipress_gesture, "released",
                    G_CALLBACK (gesture_multipress_released_cb), expander);
  gtk_event_controller_set_propagation_phase (GTK_EVENT_CONTROLLER (priv->multipress_gesture),
                                              GTK_PHASE_BUBBLE);
481 482
}

483
static void
484
gtk_expander_buildable_add_child (GtkBuildable  *buildable,
485 486 487
                                  GtkBuilder    *builder,
                                  GObject       *child,
                                  const gchar   *type)
488 489 490 491 492 493 494 495 496 497 498 499
{
  if (!type)
    gtk_container_add (GTK_CONTAINER (buildable), GTK_WIDGET (child));
  else if (strcmp (type, "label") == 0)
    gtk_expander_set_label_widget (GTK_EXPANDER (buildable), GTK_WIDGET (child));
  else
    GTK_BUILDER_WARN_INVALID_CHILD_TYPE (GTK_EXPANDER (buildable), type);
}

static void
gtk_expander_buildable_init (GtkBuildableIface *iface)
{
500
  iface->add_child = gtk_expander_buildable_add_child;
501 502
}

503 504
static void
gtk_expander_set_property (GObject      *object,
505 506 507
                           guint         prop_id,
                           const GValue *value,
                           GParamSpec   *pspec)
508 509
{
  GtkExpander *expander = GTK_EXPANDER (object);
510

511 512 513 514 515 516 517 518 519 520 521
  switch (prop_id)
    {
    case PROP_EXPANDED:
      gtk_expander_set_expanded (expander, g_value_get_boolean (value));
      break;
    case PROP_LABEL:
      gtk_expander_set_label (expander, g_value_get_string (value));
      break;
    case PROP_USE_UNDERLINE:
      gtk_expander_set_use_underline (expander, g_value_get_boolean (value));
      break;
522 523 524
    case PROP_USE_MARKUP:
      gtk_expander_set_use_markup (expander, g_value_get_boolean (value));
      break;
Soeren Sandmann's avatar
Soeren Sandmann committed
525
    case PROP_SPACING:
526 527 528 529 530
      gtk_expander_set_spacing (expander, g_value_get_int (value));
      break;
    case PROP_LABEL_WIDGET:
      gtk_expander_set_label_widget (expander, g_value_get_object (value));
      break;
531 532 533
    case PROP_LABEL_FILL:
      gtk_expander_set_label_fill (expander, g_value_get_boolean (value));
      break;
534 535 536
    case PROP_RESIZE_TOPLEVEL:
      gtk_expander_set_resize_toplevel (expander, g_value_get_boolean (value));
      break;
537 538 539 540 541 542 543 544
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_expander_get_property (GObject    *object,
545 546 547
                           guint       prop_id,
                           GValue     *value,
                           GParamSpec *pspec)
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
{
  GtkExpander *expander = GTK_EXPANDER (object);
  GtkExpanderPrivate *priv = expander->priv;

  switch (prop_id)
    {
    case PROP_EXPANDED:
      g_value_set_boolean (value, priv->expanded);
      break;
    case PROP_LABEL:
      g_value_set_string (value, gtk_expander_get_label (expander));
      break;
    case PROP_USE_UNDERLINE:
      g_value_set_boolean (value, priv->use_underline);
      break;
563 564 565
    case PROP_USE_MARKUP:
      g_value_set_boolean (value, priv->use_markup);
      break;
Soeren Sandmann's avatar
Soeren Sandmann committed
566
    case PROP_SPACING:
567 568 569 570
      g_value_set_int (value, priv->spacing);
      break;
    case PROP_LABEL_WIDGET:
      g_value_set_object (value,
571 572
                          priv->label_widget ?
                          G_OBJECT (priv->label_widget) : NULL);
573
      break;
574 575 576
    case PROP_LABEL_FILL:
      g_value_set_boolean (value, priv->label_fill);
      break;
577 578 579
    case PROP_RESIZE_TOPLEVEL:
      g_value_set_boolean (value, gtk_expander_get_resize_toplevel (expander));
      break;
580 581 582 583 584 585
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

586
static void
587
gtk_expander_destroy (GtkWidget *widget)
588
{
589 590
  GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;

591
  if (priv->expand_timer)
592
    {
593 594
      g_source_remove (priv->expand_timer);
      priv->expand_timer = 0;
595
    }
596

597 598
  g_clear_object (&priv->multipress_gesture);

599 600
  GTK_WIDGET_CLASS (gtk_expander_parent_class)->destroy (widget);

601 602 603
  g_clear_object (&priv->arrow_gadget);
  g_clear_object (&priv->title_gadget);
  g_clear_object (&priv->gadget);
604 605 606 607 608
}

static void
gtk_expander_realize (GtkWidget *widget)
{
609
  GtkAllocation title_allocation;
610 611 612 613 614 615
  GtkExpanderPrivate *priv;
  GdkWindow *window;
  GdkWindowAttr attributes;
  gint attributes_mask;

  priv = GTK_EXPANDER (widget)->priv;
616

617
  gtk_css_gadget_get_border_allocation (priv->title_gadget, &title_allocation, NULL);
618

619
  attributes.window_type = GDK_WINDOW_CHILD;
620 621 622 623
  attributes.x = title_allocation.x;
  attributes.y = title_allocation.y;
  attributes.width = title_allocation.width;
  attributes.height = title_allocation.height;
624
  attributes.wclass = GDK_INPUT_ONLY;
625 626 627 628 629
  attributes.event_mask = gtk_widget_get_events (widget)
                          | GDK_BUTTON_PRESS_MASK
                          | GDK_BUTTON_RELEASE_MASK
                          | GDK_ENTER_NOTIFY_MASK
                          | GDK_LEAVE_NOTIFY_MASK;
630 631 632

  attributes_mask = GDK_WA_X | GDK_WA_Y;

633 634 635
  window = gtk_widget_get_parent_window (widget);
  gtk_widget_set_window (widget, window);
  g_object_ref (window);
636 637

  priv->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
638
                                       &attributes, attributes_mask);
639
  gtk_widget_register_window (widget, priv->event_window);
640

641
  gtk_gesture_set_window (priv->multipress_gesture, priv->event_window);
642
  gtk_widget_set_realized (widget, TRUE);
643 644 645 646 647 648 649 650 651
}

static void
gtk_expander_unrealize (GtkWidget *widget)
{
  GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;

  if (priv->event_window)
    {
652
      gtk_gesture_set_window (priv->multipress_gesture, NULL);
653
      gtk_widget_unregister_window (widget, priv->event_window);
654 655 656 657
      gdk_window_destroy (priv->event_window);
      priv->event_window = NULL;
    }

Matthias Clasen's avatar
Matthias Clasen committed
658
  GTK_WIDGET_CLASS (gtk_expander_parent_class)->unrealize (widget);
659 660 661 662
}

static void
gtk_expander_size_allocate (GtkWidget     *widget,
663
                            GtkAllocation *allocation)
664
{
665
  GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;
666 667 668 669
  GtkAllocation clip;

  gtk_widget_set_allocation (widget, allocation);

670
  gtk_css_gadget_allocate (priv->gadget,
671 672 673 674 675 676 677
                           allocation,
                           gtk_widget_get_allocated_baseline (widget),
                           &clip);

  gtk_widget_set_clip (widget, &clip);

  if (gtk_widget_get_realized (widget))
678
    {
679
      GtkAllocation title_allocation;
680

681 682 683 684
      gtk_css_gadget_get_border_allocation (priv->title_gadget, &title_allocation, NULL);
      gdk_window_move_resize (priv->event_window,
                              title_allocation.x, title_allocation.y,
                              title_allocation.width, title_allocation.height);
685 686 687 688 689 690 691 692 693 694 695
    }
}

static void
gtk_expander_map (GtkWidget *widget)
{
  GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;

  if (priv->label_widget)
    gtk_widget_map (priv->label_widget);

Matthias Clasen's avatar
Matthias Clasen committed
696
  GTK_WIDGET_CLASS (gtk_expander_parent_class)->map (widget);
697 698 699 700 701 702 703 704 705 706 707 708 709

  if (priv->event_window)
    gdk_window_show (priv->event_window);
}

static void
gtk_expander_unmap (GtkWidget *widget)
{
  GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;

  if (priv->event_window)
    gdk_window_hide (priv->event_window);

Matthias Clasen's avatar
Matthias Clasen committed
710
  GTK_WIDGET_CLASS (gtk_expander_parent_class)->unmap (widget);
711 712 713 714 715 716

  if (priv->label_widget)
    gtk_widget_unmap (priv->label_widget);
}

static gboolean
717
gtk_expander_draw (GtkWidget *widget,
718
                   cairo_t   *cr)
719
{
720 721 722 723 724
  gtk_css_gadget_draw (GTK_EXPANDER (widget)->priv->gadget, cr);

  return FALSE;
}

725
static void
726 727 728 729 730
gesture_multipress_released_cb (GtkGestureMultiPress *gesture,
                                gint                  n_press,
                                gdouble               x,
                                gdouble               y,
                                GtkExpander          *expander)
731
{
732 733
  if (expander->priv->prelight)
    gtk_widget_activate (GTK_WIDGET (expander));
734 735 736 737 738
}

static void
gtk_expander_redraw_expander (GtkExpander *expander)
{
739 740
  GtkAllocation allocation;
  GtkWidget *widget = GTK_WIDGET (expander);
741

742
  if (gtk_widget_get_realized (widget))
743 744 745 746
    {
      gtk_widget_get_allocation (widget, &allocation);
      gdk_window_invalidate_rect (gtk_widget_get_window (widget), &allocation, FALSE);
    }
747 748
}

749
static void
750
update_node_state (GtkExpander *expander)
751 752 753 754 755 756 757 758 759 760 761
{
  GtkExpanderPrivate *priv = expander->priv;
  GtkStateFlags state;

  state = gtk_widget_get_state_flags (GTK_WIDGET (expander));

  if (priv->prelight)
    state |= GTK_STATE_FLAG_PRELIGHT;
  else
    state &= ~GTK_STATE_FLAG_PRELIGHT;

762
  gtk_css_gadget_set_state (priv->title_gadget, state);
763

764 765 766 767 768
  if (priv->expanded)
    state |= GTK_STATE_FLAG_CHECKED;
  else
    state &= ~GTK_STATE_FLAG_CHECKED;

769
  gtk_css_gadget_set_state (priv->arrow_gadget, state);
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
}

static void
gtk_expander_state_flags_changed (GtkWidget     *widget,
                                  GtkStateFlags  previous_state)
{
  update_node_state (GTK_EXPANDER (widget));

  GTK_WIDGET_CLASS (gtk_expander_parent_class)->state_flags_changed (widget, previous_state);
}

static void
gtk_expander_direction_changed (GtkWidget        *widget,
                                GtkTextDirection  previous_direction)
{
785
  GtkExpanderPrivate *priv = GTK_EXPANDER (widget)->priv;
786
  GtkAlign align;
787 788

  gtk_box_gadget_reverse_children (GTK_BOX_GADGET (priv->title_gadget));
789

790 791
  align = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL ? GTK_ALIGN_END : GTK_ALIGN_START;
  gtk_box_gadget_remove_gadget (GTK_BOX_GADGET (priv->gadget), priv->title_gadget);
792
  gtk_box_gadget_insert_gadget (GTK_BOX_GADGET (priv->gadget), 0, priv->title_gadget, FALSE, align);
793

794 795
  gtk_box_gadget_set_allocate_reverse (GTK_BOX_GADGET (priv->title_gadget),
                                       gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL);
796 797
  gtk_box_gadget_set_align_reverse (GTK_BOX_GADGET (priv->title_gadget),
                                    gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL);
798

799
  GTK_WIDGET_CLASS (gtk_expander_parent_class)->direction_changed (widget, previous_direction);
800 801
}

802 803
static gboolean
gtk_expander_enter_notify (GtkWidget        *widget,
804
                           GdkEventCrossing *event)
805 806 807
{
  GtkExpander *expander = GTK_EXPANDER (widget);

808
  if (event->window == expander->priv->event_window &&
809 810 811
      event->detail != GDK_NOTIFY_INFERIOR)
    {
      expander->priv->prelight = TRUE;
812

813
      update_node_state (expander);
814

815
      if (expander->priv->label_widget)
816 817 818
        gtk_widget_set_state_flags (expander->priv->label_widget,
                                    GTK_STATE_FLAG_PRELIGHT,
                                    FALSE);
819

820 821 822 823 824 825 826 827
      gtk_expander_redraw_expander (expander);
    }

  return FALSE;
}

static gboolean
gtk_expander_leave_notify (GtkWidget        *widget,
828
                           GdkEventCrossing *event)
829 830 831
{
  GtkExpander *expander = GTK_EXPANDER (widget);

832
  if (event->window == expander->priv->event_window &&
833 834 835
      event->detail != GDK_NOTIFY_INFERIOR)
    {
      expander->priv->prelight = FALSE;
836

837
      update_node_state (expander);
838

839
      if (expander->priv->label_widget)
840 841
        gtk_widget_unset_state_flags (expander->priv->label_widget,
                                      GTK_STATE_FLAG_PRELIGHT);
842

843 844 845 846 847 848
      gtk_expander_redraw_expander (expander);
    }

  return FALSE;
}

849 850 851 852 853 854 855 856 857 858 859 860 861 862
static gboolean
expand_timeout (gpointer data)
{
  GtkExpander *expander = GTK_EXPANDER (data);
  GtkExpanderPrivate *priv = expander->priv;

  priv->expand_timer = 0;
  gtk_expander_set_expanded (expander, TRUE);

  return FALSE;
}

static gboolean
gtk_expander_drag_motion (GtkWidget        *widget,
863 864 865 866
                          GdkDragContext   *context,
                          gint              x,
                          gint              y,
                          guint             time)
867 868 869 870 871 872
{
  GtkExpander *expander = GTK_EXPANDER (widget);
  GtkExpanderPrivate *priv = expander->priv;

  if (!priv->expanded && !priv->expand_timer)
    {
873
      priv->expand_timer = gdk_threads_add_timeout (TIMEOUT_EXPAND, (GSourceFunc) expand_timeout, expander);
874
      g_source_set_name_by_id (priv->expand_timer, "[gtk+] expand_timeout");
875 876 877 878 879 880 881
    }

  return TRUE;
}

static void
gtk_expander_drag_leave (GtkWidget      *widget,
882 883
                         GdkDragContext *context,
                         guint           time)
884 885 886 887 888 889 890 891 892 893 894
{
  GtkExpander *expander = GTK_EXPANDER (widget);
  GtkExpanderPrivate *priv = expander->priv;

  if (priv->expand_timer)
    {
      g_source_remove (priv->expand_timer);
      priv->expand_timer = 0;
    }
}

895 896 897 898 899 900 901 902 903 904
typedef enum
{
  FOCUS_NONE,
  FOCUS_WIDGET,
  FOCUS_LABEL,
  FOCUS_CHILD
} FocusSite;

static gboolean
focus_current_site (GtkExpander      *expander,
905
                    GtkDirectionType  direction)
906 907 908
{
  GtkWidget *current_focus;

909
  current_focus = gtk_container_get_focus_child (GTK_CONTAINER (expander));
910 911 912 913 914 915 916 917 918

  if (!current_focus)
    return FALSE;

  return gtk_widget_child_focus (current_focus, direction);
}

static gboolean
focus_in_site (GtkExpander      *expander,
919 920
               FocusSite         site,
               GtkDirectionType  direction)
921 922 923 924 925 926 927 928
{
  switch (site)
    {
    case FOCUS_WIDGET:
      gtk_widget_grab_focus (GTK_WIDGET (expander));
      return TRUE;
    case FOCUS_LABEL:
      if (expander->priv->label_widget)
929
        return gtk_widget_child_focus (expander->priv->label_widget, direction);
930
      else
931
        return FALSE;
932 933
    case FOCUS_CHILD:
      {
934
        GtkWidget *child = gtk_bin_get_child (GTK_BIN (expander));
935

936 937 938 939
        if (child && gtk_widget_get_child_visible (child))
          return gtk_widget_child_focus (child, direction);
        else
          return FALSE;
940 941 942 943 944 945 946 947 948 949 950
      }
    case FOCUS_NONE:
      break;
    }

  g_assert_not_reached ();
  return FALSE;
}

static FocusSite
get_next_site (GtkExpander      *expander,
951 952
               FocusSite         site,
               GtkDirectionType  direction)
953 954 955 956 957 958 959 960 961
{
  gboolean ltr;

  ltr = gtk_widget_get_direction (GTK_WIDGET (expander)) != GTK_TEXT_DIR_RTL;

  switch (site)
    {
    case FOCUS_NONE:
      switch (direction)
962 963 964 965 966 967 968 969 970 971
        {
        case GTK_DIR_TAB_BACKWARD:
        case GTK_DIR_LEFT:
        case GTK_DIR_UP:
          return FOCUS_CHILD;
        case GTK_DIR_TAB_FORWARD:
        case GTK_DIR_DOWN:
        case GTK_DIR_RIGHT:
          return FOCUS_WIDGET;
        }
972
      break;
973 974
    case FOCUS_WIDGET:
      switch (direction)
975 976 977 978 979 980 981 982 983 984 985 986
        {
        case GTK_DIR_TAB_BACKWARD:
        case GTK_DIR_UP:
          return FOCUS_NONE;
        case GTK_DIR_LEFT:
          return ltr ? FOCUS_NONE : FOCUS_LABEL;
        case GTK_DIR_TAB_FORWARD:
        case GTK_DIR_DOWN:
          return FOCUS_LABEL;
        case GTK_DIR_RIGHT:
          return ltr ? FOCUS_LABEL : FOCUS_NONE;
        }
987
      break;
988 989
    case FOCUS_LABEL:
      switch (direction)
990 991 992 993 994 995 996 997 998 999 1000 1001
        {
        case GTK_DIR_TAB_BACKWARD:
        case GTK_DIR_UP:
          return FOCUS_WIDGET;
        case GTK_DIR_LEFT:
          return ltr ? FOCUS_WIDGET : FOCUS_CHILD;
        case GTK_DIR_TAB_FORWARD:
        case GTK_DIR_DOWN:
          return FOCUS_CHILD;
        case GTK_DIR_RIGHT:
          return ltr ? FOCUS_CHILD : FOCUS_WIDGET;
        }
1002
      break;
1003 1004
    case FOCUS_CHILD:
      switch (direction)
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
        {
        case GTK_DIR_TAB_BACKWARD:
        case GTK_DIR_LEFT:
        case GTK_DIR_UP:
          return FOCUS_LABEL;
        case GTK_DIR_TAB_FORWARD:
        case GTK_DIR_DOWN:
        case GTK_DIR_RIGHT:
          return FOCUS_NONE;
        }
1015
      break;
1016 1017 1018 1019 1020 1021
    }

  g_assert_not_reached ();
  return FOCUS_NONE;
}

1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
static void
gtk_expander_resize_toplevel (GtkExpander *expander)
{
  GtkExpanderPrivate *priv = expander->priv;
  GtkWidget *child = gtk_bin_get_child (GTK_BIN (expander));

  if (child && priv->resize_toplevel &&
      gtk_widget_get_realized (GTK_WIDGET (expander)))
    {
      GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (expander));

1033 1034
      if (toplevel && GTK_IS_WINDOW (toplevel) &&
          gtk_widget_get_realized (toplevel))
1035
        {
1036 1037
          int toplevel_width, toplevel_height;
          int child_height;
1038

1039 1040
          gtk_widget_get_preferred_height (child, &child_height, NULL);
          gtk_window_get_size (GTK_WINDOW (toplevel), &toplevel_width, &toplevel_height);
1041 1042

          if (priv->expanded)
1043
            toplevel_height += child_height;
1044
          else
1045
            toplevel_height -= child_height;
1046 1047

          gtk_window_resize (GTK_WINDOW (toplevel),
1048 1049
                             toplevel_width,
                             toplevel_height);
1050 1051 1052 1053
        }
    }
}

1054 1055
static gboolean
gtk_expander_focus (GtkWidget        *widget,
1056
                    GtkDirectionType  direction)
1057 1058
{
  GtkExpander *expander = GTK_EXPANDER (widget);
1059

1060 1061 1062 1063 1064
  if (!focus_current_site (expander, direction))
    {
      GtkWidget *old_focus_child;
      gboolean widget_is_focus;
      FocusSite site = FOCUS_NONE;
1065

1066
      widget_is_focus = gtk_widget_is_focus (widget);
1067
      old_focus_child = gtk_container_get_focus_child (GTK_CONTAINER (widget));
1068

1069
      if (old_focus_child && old_focus_child == expander->priv->label_widget)
1070
        site = FOCUS_LABEL;
1071
      else if (old_focus_child)
1072
        site = FOCUS_CHILD;
1073
      else if (widget_is_focus)
1074
        site = FOCUS_WIDGET;
1075 1076

      while ((site = get_next_site (expander, site, direction)) != FOCUS_NONE)
1077 1078 1079 1080
        {
          if (focus_in_site (expander, site, direction))
            return TRUE;
        }
1081 1082 1083 1084 1085 1086 1087

      return FALSE;
    }

  return TRUE;
}

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
static void
gtk_expander_update_child_mapped (GtkExpander *expander,
                                  GtkWidget   *child)
{
  /* If collapsing, we must unmap the child, as gtk_box_gadget_remove() does
   * not, so otherwise the child is not drawn but still consumes input in-place.
   */

  if (expander->priv->expanded &&
      gtk_widget_get_realized (child) &&
      gtk_widget_get_visible (child))
    {
      gtk_widget_map (child);
    }
  else
    {
      gtk_widget_unmap (child);
    }
}

1108 1109
static void
gtk_expander_add (GtkContainer *container,
1110
                  GtkWidget    *widget)
1111
{
1112 1113
  GtkExpander *expander = GTK_EXPANDER (container);

Matthias Clasen's avatar
Matthias Clasen committed
1114
  GTK_CONTAINER_CLASS (gtk_expander_parent_class)->add (container, widget);
1115 1116

  gtk_widget_queue_resize (GTK_WIDGET (container));
1117 1118 1119

  if (expander->priv->expanded)
    gtk_box_gadget_insert_widget (GTK_BOX_GADGET (expander->priv->gadget), -1, widget);
1120 1121

  gtk_expander_update_child_mapped (expander, widget);
1122 1123 1124 1125
}

static void
gtk_expander_remove (GtkContainer *container,
1126
                     GtkWidget    *widget)
1127 1128 1129 1130 1131 1132
{
  GtkExpander *expander = GTK_EXPANDER (container);

  if (GTK_EXPANDER (expander)->priv->label_widget == widget)
    gtk_expander_set_label_widget (expander, NULL);
  else
1133 1134 1135 1136
    {
      gtk_box_gadget_remove_widget (GTK_BOX_GADGET (expander->priv->gadget), widget);
      GTK_CONTAINER_CLASS (gtk_expander_parent_class)->remove (container, widget);
    }
1137 1138 1139 1140
}

static void
gtk_expander_forall (GtkContainer *container,
1141 1142 1143
                     gboolean      include_internals,
                     GtkCallback   callback,
                     gpointer      callback_data)
1144 1145 1146
{
  GtkBin *bin = GTK_BIN (container);
  GtkExpanderPrivate *priv = GTK_EXPANDER (container)->priv;
Javier Jardón's avatar
Javier Jardón committed
1147
  GtkWidget *child;
1148

Javier Jardón's avatar
Javier Jardón committed
1149 1150 1151
  child = gtk_bin_get_child (bin);
  if (child)
    (* callback) (child, callback_data);
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162

  if (priv->label_widget)
    (* callback) (priv->label_widget, callback_data);
}

static void
gtk_expander_activate (GtkExpander *expander)
{
  gtk_expander_set_expanded (expander, !expander->priv->expanded);
}

1163
static void
1164 1165 1166
gtk_expander_get_preferred_width (GtkWidget *widget,
                                  gint      *minimum_size,
                                  gint      *natural_size)
1167
{
1168 1169 1170 1171 1172
  gtk_css_gadget_get_preferred_size (GTK_EXPANDER (widget)->priv->gadget,
                                     GTK_ORIENTATION_HORIZONTAL,
                                     -1,
                                     minimum_size, natural_size,
                                     NULL, NULL);
1173 1174 1175
}

static void
1176 1177 1178
gtk_expander_get_preferred_height (GtkWidget *widget,
                                   gint      *minimum_size,
                                   gint      *natural_size)
1179
{
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
  gtk_css_gadget_get_preferred_size (GTK_EXPANDER (widget)->priv->gadget,
                                     GTK_ORIENTATION_VERTICAL,
                                     -1,
                                     minimum_size, natural_size,
                                     NULL, NULL);
}

static void
gtk_expander_get_preferred_width_for_height (GtkWidget *widget,
                                             gint       height,
                                             gint      *minimum_size,
                                             gint      *natural_size)
{
  gtk_css_gadget_get_preferred_size (GTK_EXPANDER (widget)->priv->gadget,
                                     GTK_ORIENTATION_HORIZONTAL,
                                     height,
                                     minimum_size, natural_size,
                                     NULL, NULL);
}

static void
gtk_expander_get_preferred_height_for_width (GtkWidget *widget,
                                             gint       width,
                                             gint      *minimum_size,
                                             gint      *natural_size)
{
  gtk_css_gadget_get_preferred_size (GTK_EXPANDER (widget)->priv->gadget,
                                     GTK_ORIENTATION_VERTICAL,
                                     width,
                                     minimum_size, natural_size,
                                     NULL, NULL);
}

Matthias Clasen's avatar
Matthias Clasen committed
1213 1214
/**
 * gtk_expander_new:
1215
 * @label: (nullable): the text of the label
1216
 *
Matthias Clasen's avatar
Matthias Clasen committed
1217
 * Creates a new expander using @label as the text of the label.
1218
 *
1219
 * Returns: a new #GtkExpander widget.
Matthias Clasen's avatar
Matthias Clasen committed
1220 1221
 *
 * Since: 2.4
1222
 */
1223 1224 1225 1226 1227 1228
GtkWidget *
gtk_expander_new (const gchar *label)
{
  return g_object_new (GTK_TYPE_EXPANDER, "label", label, NULL);
}

Matthias Clasen's avatar
Matthias Clasen committed
1229 1230
/**
 * gtk_expander_new_with_mnemonic:
1231
 * @label: (nullable): the text of the label with an underscore
1232
 *     in front of the mnemonic character
1233
 *
Matthias Clasen's avatar
Matthias Clasen committed
1234 1235
 * Creates a new expander using @label as the text of the label.
 * If characters in @label are preceded by an underscore, they are underlined.
1236
 * If you need a literal underscore character in a label, use “__” (two
1237
 * underscores). The first underlined character represents a keyboard
Matthias Clasen's avatar
Matthias Clasen committed
1238 1239
 * accelerator called a mnemonic.
 * Pressing Alt and that key activates the button.
1240
 *
1241
 * Returns: a new #GtkExpander widget.
Matthias Clasen's avatar
Matthias Clasen committed
1242 1243
 *
 * Since: 2.4
1244
 */
1245 1246 1247 1248
GtkWidget *
gtk_expander_new_with_mnemonic (const gchar *label)
{
  return g_object_new (GTK_TYPE_EXPANDER,
1249 1250 1251
                       "label", label,
                       "use-underline", TRUE,
                       NULL);
1252 1253 1254 1255 1256 1257 1258
}

/**
 * gtk_expander_set_expanded:
 * @expander: a #GtkExpander
 * @expanded: whether the child widget is revealed
 *
Matthias Clasen's avatar
Matthias Clasen committed
1259 1260
 * Sets the state of the expander. Set to %TRUE, if you want
 * the child widget to be revealed, and %FALSE if you want the
1261
 * child widget to be hidden.
Matthias Clasen's avatar
Matthias Clasen committed
1262 1263
 *
 * Since: 2.4
1264
 */
1265 1266
void
gtk_expander_set_expanded (GtkExpander *expander,
1267
                           gboolean     expanded)
1268 1269
{
  GtkExpanderPrivate *priv;
Javier Jardón's avatar
Javier Jardón committed
1270
  GtkWidget *child;
1271 1272 1273 1274 1275 1276 1277

  g_return_if_fail (GTK_IS_EXPANDER (expander));

  priv = expander->priv;

  expanded = expanded != FALSE;

1278 1279
  if (priv->expanded == expanded)
    return;
1280

1281
  priv->expanded = expanded;
1282

1283
  update_node_state (expander);
1284

1285
  child = gtk_bin_get_child (GTK_BIN (expander));
1286

1287 1288
  if (child)
    {
1289 1290 1291 1292 1293
      if (priv->expanded)
        gtk_box_gadget_insert_widget (GTK_BOX_GADGET (priv->gadget), 1, child);
      else
        gtk_box_gadget_remove_widget (GTK_BOX_GADGET (priv->gadget), child);

1294 1295
      gtk_widget_queue_resize (GTK_WIDGET (expander));
      gtk_expander_resize_toplevel (expander);
1296 1297

      gtk_expander_update_child_mapped (expander, child);
1298
    }
1299 1300

  g_object_notify (G_OBJECT (expander), "expanded");
1301 1302 1303 1304 1305 1306
}

/**
 * gtk_expander_get_expanded:
 * @expander:a #GtkExpander
 *
Matthias Clasen's avatar
Matthias Clasen committed
1307
 * Queries a #GtkExpander and returns its current state. Returns %TRUE
1308 1309 1310 1311
 * if the child widget is revealed.
 *
 * See gtk_expander_set_expanded().
 *
1312
 * Returns: the current state of the expander
Matthias Clasen's avatar
Matthias Clasen committed
1313 1314
 *
 * Since: 2.4
1315
 */
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
gboolean
gtk_expander_get_expanded (GtkExpander *expander)
{
  g_return_val_if_fail (GTK_IS_EXPANDER (expander), FALSE);

  return expander->priv->expanded;
}

/**
 * gtk_expander_set_spacing:
 * @expander: a #GtkExpander
1327
 * @spacing: distance between the expander and child in pixels
1328
 *
1329 1330
 * Sets the spacing field of @expander, which is the number of
 * pixels to place between expander and the child.
Matthias Clasen's avatar
Matthias Clasen committed
1331 1332
 *
 * Since: 2.4
1333 1334
 *
 * Deprecated: 3.20: Use margins on the child instead.
1335
 */
1336 1337
void
gtk_expander_set_spacing (GtkExpander *expander,
1338
                          gint         spacing)
1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
{
  g_return_if_fail (GTK_IS_EXPANDER (expander));
  g_return_if_fail (spacing >= 0);

  if (expander->priv->spacing != spacing)
    {
      expander->priv->spacing = spacing;

      gtk_widget_queue_resize (GTK_WIDGET (expander));

      g_object_notify (G_OBJECT (expander), "spacing");
    }
}

/**
 * gtk_expander_get_spacing:
 * @expander: a #GtkExpander
 *
 * Gets the value set by gtk_expander_set_spacing().
 *
1359
 * Returns: spacing between the expander and child
Matthias Clasen's avatar
Matthias Clasen committed
1360 1361
 *
 * Since: 2.4
1362 1363
 *
 * Deprecated: 3.20: Use margins on the child instead.
1364
 */
1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
gint
gtk_expander_get_spacing (GtkExpander *expander)
{
  g_return_val_if_fail (GTK_IS_EXPANDER (expander), 0);

  return expander->priv->spacing;
}

/**
 * gtk_expander_set_label:
 * @expander: a #GtkExpander
1376
 * @label: (nullable): a string
1377 1378 1379 1380
 *
 * Sets the text of the label of the expander to @label.
 *
 * This will also clear any previously set labels.
Matthias Clasen's avatar
Matthias Clasen committed
1381 1382
 *
 * Since: 2.4
1383
 */
1384 1385
void
gtk_expander_set_label (GtkExpander *expander,
1386
                        const gchar *label)
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
{
  g_return_if_fail (GTK_IS_EXPANDER (expander));

  if (!label)
    {
      gtk_expander_set_label_widget (expander, NULL);
    }
  else
    {
      GtkWidget *child;

      child = gtk_label_new (label);
      gtk_label_set_use_underline (GTK_LABEL (child), expander->priv->use_underline);
1400
      gtk_label_set_use_markup (GTK_LABEL (child), expander->priv->use_markup);
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412
      gtk_widget_show (child);

      gtk_expander_set_label_widget (expander, child);
    }

  g_object_notify (G_OBJECT (expander), "label");
}

/**
 * gtk_expander_get_label:
 * @expander: a #GtkExpander
 *
1413 1414 1415 1416 1417
 * Fetches the text from a label widget including any embedded
 * underlines indicating mnemonics and Pango markup, as set by
 * gtk_expander_set_label(). If the label text has not been set the
 * return value will be %NULL. This will be the case if you create an
 * empty button with gtk_button_new() to use as a container.
1418
 *
1419 1420 1421 1422 1423 1424
 * Note that this function behaved differently in versions prior to
 * 2.14 and used to return the label text stripped of embedded
 * underlines indicating mnemonics and Pango markup. This problem can
 * be avoided by fetching the label text directly from the label
 * widget.
 *
1425
 * Returns: (nullable): The text of the label widget. This string is owned
1426
 *     by the widget and must not be modified or freed.
Matthias Clasen's avatar
Matthias Clasen committed
1427 1428
 *
 * Since: 2.4
1429
 */
1430
const gchar *
1431 1432 1433 1434 1435 1436 1437 1438
gtk_expander_get_label (GtkExpander *expander)
{
  GtkExpanderPrivate *priv;

  g_return_val_if_fail (GTK_IS_EXPANDER (expander), NULL);

  priv = expander->priv;

1439
  if (GTK_IS_LABEL (priv->label_widget))
1440
    return gtk_label_get_label (GTK_LABEL (priv->label_widget));
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451
  else
    return NULL;
}

/**
 * gtk_expander_set_use_underline:
 * @expander: a #GtkExpander
 * @use_underline: %TRUE if underlines in the text indicate mnemonics
 *
 * If true, an underline in the text of the expander label indicates
 * the next character should be used for the mnemonic accelerator key.
Matthias Clasen's avatar
Matthias Clasen committed
1452 1453
 *
 * Since: 2.4
1454
 */
1455 1456
void
gtk_expander_set_use_underline (GtkExpander *expander,
1457
                                gboolean     use_underline)
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469