gtkrevealer.c 33.2 KB
Newer Older
Matthias Clasen's avatar
Matthias Clasen committed
1 2
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/*
3
 * Copyright 2013, 2015 Red Hat, Inc.
Matthias Clasen's avatar
Matthias Clasen committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Author: Alexander Larsson <alexl@redhat.com>
20
 *         Carlos Soriano <csoriano@gnome.org>
Matthias Clasen's avatar
Matthias Clasen committed
21 22 23 24 25 26 27
 */

#include "config.h"
#include "gtkrevealer.h"
#include <gdk/gdk.h>
#include "gtktypebuiltins.h"
#include "gtkprivate.h"
28
#include "gtksettingsprivate.h"
29
#include "gtkprogresstrackerprivate.h"
Matthias Clasen's avatar
Matthias Clasen committed
30
#include "gtkintl.h"
31 32

#include "fallback-c89.c"
Matthias Clasen's avatar
Matthias Clasen committed
33

34 35 36 37 38 39 40 41 42 43 44 45
/**
 * SECTION:gtkrevealer
 * @Short_description: Hide and show with animation
 * @Title: GtkRevealer
 * @See_also: #GtkExpander
 *
 * The GtkRevealer widget is a container which animates
 * the transition of its child from invisible to visible.
 *
 * The style of transition can be controlled with
 * gtk_revealer_set_transition_type().
 *
46
 * These animations respect the #GtkSettings:gtk-enable-animations
47 48
 * setting.
 *
49 50 51 52
 * # CSS nodes
 *
 * GtkRevealer has a single CSS node with name revealer.
 *
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
 * The GtkRevealer widget was added in GTK+ 3.10.
 */

/**
 * GtkRevealerTransitionType:
 * @GTK_REVEALER_TRANSITION_TYPE_NONE: No transition
 * @GTK_REVEALER_TRANSITION_TYPE_CROSSFADE: Fade in
 * @GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT: Slide in from the left
 * @GTK_REVEALER_TRANSITION_TYPE_SLIDE_LEFT: Slide in from the right
 * @GTK_REVEALER_TRANSITION_TYPE_SLIDE_UP: Slide in from the bottom
 * @GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN: Slide in from the top
 *
 * These enumeration values describe the possible transitions
 * when the child of a #GtkRevealer widget is shown or hidden.
 */

Matthias Clasen's avatar
Matthias Clasen committed
69 70 71 72 73
enum  {
  PROP_0,
  PROP_TRANSITION_TYPE,
  PROP_TRANSITION_DURATION,
  PROP_REVEAL_CHILD,
74 75
  PROP_CHILD_REVEALED,
  LAST_PROP
Matthias Clasen's avatar
Matthias Clasen committed
76 77
};

78
typedef struct {
Matthias Clasen's avatar
Matthias Clasen committed
79 80 81 82 83 84 85 86 87 88 89
  GtkRevealerTransitionType transition_type;
  guint transition_duration;

  GdkWindow* bin_window;
  GdkWindow* view_window;

  gdouble current_pos;
  gdouble source_pos;
  gdouble target_pos;

  guint tick_id;
90
  GtkProgressTracker tracker;
91
} GtkRevealerPrivate;
Matthias Clasen's avatar
Matthias Clasen committed
92

93
static GParamSpec *props[LAST_PROP] = { NULL, };
Matthias Clasen's avatar
Matthias Clasen committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119

static void     gtk_revealer_real_realize                        (GtkWidget     *widget);
static void     gtk_revealer_real_unrealize                      (GtkWidget     *widget);
static void     gtk_revealer_real_add                            (GtkContainer  *widget,
                                                                  GtkWidget     *child);
static void     gtk_revealer_real_size_allocate                  (GtkWidget     *widget,
                                                                  GtkAllocation *allocation);
static void     gtk_revealer_real_map                            (GtkWidget     *widget);
static void     gtk_revealer_real_unmap                          (GtkWidget     *widget);
static gboolean gtk_revealer_real_draw                           (GtkWidget     *widget,
                                                                  cairo_t       *cr);
static void     gtk_revealer_real_get_preferred_height           (GtkWidget     *widget,
                                                                  gint          *minimum_height,
                                                                  gint          *natural_height);
static void     gtk_revealer_real_get_preferred_height_for_width (GtkWidget     *widget,
                                                                  gint           width,
                                                                  gint          *minimum_height,
                                                                  gint          *natural_height);
static void     gtk_revealer_real_get_preferred_width            (GtkWidget     *widget,
                                                                  gint          *minimum_width,
                                                                  gint          *natural_width);
static void     gtk_revealer_real_get_preferred_width_for_height (GtkWidget     *widget,
                                                                  gint           height,
                                                                  gint          *minimum_width,
                                                                  gint          *natural_width);

120
G_DEFINE_TYPE_WITH_PRIVATE (GtkRevealer, gtk_revealer, GTK_TYPE_BIN)
Matthias Clasen's avatar
Matthias Clasen committed
121

122 123 124 125 126 127 128 129 130 131 132 133 134 135
static void
gtk_revealer_get_padding (GtkRevealer *revealer,
                          GtkBorder   *padding)
{
  GtkWidget *widget = GTK_WIDGET (revealer);
  GtkStyleContext *context;
  GtkStateFlags state;

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

  gtk_style_context_get_padding (context, state, padding);
}

Matthias Clasen's avatar
Matthias Clasen committed
136 137 138
static void
gtk_revealer_init (GtkRevealer *revealer)
{
139
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153

  priv->transition_type = GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN;
  priv->transition_duration = 250;
  priv->current_pos = 0.0;
  priv->target_pos = 0.0;

  gtk_widget_set_has_window ((GtkWidget*) revealer, TRUE);
  gtk_widget_set_redraw_on_allocate ((GtkWidget*) revealer, FALSE);
}

static void
gtk_revealer_finalize (GObject *obj)
{
  GtkRevealer *revealer = GTK_REVEALER (obj);
154
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

  if (priv->tick_id != 0)
    gtk_widget_remove_tick_callback (GTK_WIDGET (revealer), priv->tick_id);
  priv->tick_id = 0;

  G_OBJECT_CLASS (gtk_revealer_parent_class)->finalize (obj);
}

static void
gtk_revealer_get_property (GObject    *object,
                           guint       property_id,
                           GValue     *value,
                           GParamSpec *pspec)
{
  GtkRevealer *revealer = GTK_REVEALER (object);

  switch (property_id)
   {
    case PROP_TRANSITION_TYPE:
      g_value_set_enum (value, gtk_revealer_get_transition_type (revealer));
      break;
    case PROP_TRANSITION_DURATION:
      g_value_set_uint (value, gtk_revealer_get_transition_duration (revealer));
      break;
    case PROP_REVEAL_CHILD:
      g_value_set_boolean (value, gtk_revealer_get_reveal_child (revealer));
      break;
    case PROP_CHILD_REVEALED:
      g_value_set_boolean (value, gtk_revealer_get_child_revealed (revealer));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
gtk_revealer_set_property (GObject      *object,
                           guint         property_id,
                           const GValue *value,
                           GParamSpec   *pspec)
{
  GtkRevealer *revealer = GTK_REVEALER (object);

  switch (property_id)
    {
    case PROP_TRANSITION_TYPE:
      gtk_revealer_set_transition_type (revealer, g_value_get_enum (value));
      break;
    case PROP_TRANSITION_DURATION:
      gtk_revealer_set_transition_duration (revealer, g_value_get_uint (value));
      break;
    case PROP_REVEAL_CHILD:
      gtk_revealer_set_reveal_child (revealer, g_value_get_boolean (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
      break;
    }
}

static void
gtk_revealer_class_init (GtkRevealerClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS(klass);
  GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);

  object_class->get_property = gtk_revealer_get_property;
  object_class->set_property = gtk_revealer_set_property;
  object_class->finalize = gtk_revealer_finalize;

  widget_class->realize = gtk_revealer_real_realize;
  widget_class->unrealize = gtk_revealer_real_unrealize;
  widget_class->size_allocate = gtk_revealer_real_size_allocate;
  widget_class->map = gtk_revealer_real_map;
  widget_class->unmap = gtk_revealer_real_unmap;
  widget_class->draw = gtk_revealer_real_draw;
  widget_class->get_preferred_height = gtk_revealer_real_get_preferred_height;
  widget_class->get_preferred_height_for_width = gtk_revealer_real_get_preferred_height_for_width;
  widget_class->get_preferred_width = gtk_revealer_real_get_preferred_width;
  widget_class->get_preferred_width_for_height = gtk_revealer_real_get_preferred_width_for_height;

  container_class->add = gtk_revealer_real_add;

240 241 242 243 244 245
  props[PROP_TRANSITION_TYPE] =
    g_param_spec_enum ("transition-type",
                       P_("Transition type"),
                       P_("The type of animation used to transition"),
                       GTK_TYPE_REVEALER_TRANSITION_TYPE,
                       GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN,
246
                       GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_EXPLICIT_NOTIFY);
247 248 249 250 251 252

  props[PROP_TRANSITION_DURATION] =
    g_param_spec_uint ("transition-duration",
                       P_("Transition duration"),
                       P_("The animation duration, in milliseconds"),
                       0, G_MAXUINT, 250,
253
                       GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_EXPLICIT_NOTIFY);
254 255 256 257 258 259

  props[PROP_REVEAL_CHILD] =
    g_param_spec_boolean ("reveal-child",
                          P_("Reveal Child"),
                          P_("Whether the container should reveal the child"),
                          FALSE,
260
                          GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_EXPLICIT_NOTIFY);
261 262 263 264 265 266 267 268 269

  props[PROP_CHILD_REVEALED] =
    g_param_spec_boolean ("child-revealed",
                          P_("Child Revealed"),
                          P_("Whether the child is revealed and the animation target reached"),
                          FALSE,
                          G_PARAM_READABLE);

  g_object_class_install_properties (object_class, LAST_PROP, props);
270 271

  gtk_widget_class_set_css_name (widget_class, "revealer");
Matthias Clasen's avatar
Matthias Clasen committed
272 273
}

274 275 276 277 278 279 280 281 282
/**
 * gtk_revealer_new:
 *
 * Creates a new #GtkRevealer.
 *
 * Returns: a newly created #GtkRevealer
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
283 284 285 286 287 288
GtkWidget *
gtk_revealer_new (void)
{
  return g_object_new (GTK_TYPE_REVEALER, NULL);
}

289 290 291
static GtkRevealerTransitionType
effective_transition (GtkRevealer *revealer)
{
292
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
293 294 295 296 297 298 299 300 301 302 303 304

  if (gtk_widget_get_direction (GTK_WIDGET (revealer)) == GTK_TEXT_DIR_RTL)
    {
      if (priv->transition_type == GTK_REVEALER_TRANSITION_TYPE_SLIDE_LEFT)
        return GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT;
      else if (priv->transition_type == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
        return GTK_REVEALER_TRANSITION_TYPE_SLIDE_LEFT;
    }

  return priv->transition_type;
}

Matthias Clasen's avatar
Matthias Clasen committed
305 306 307 308 309 310
static void
gtk_revealer_get_child_allocation (GtkRevealer   *revealer,
                                   GtkAllocation *allocation,
                                   GtkAllocation *child_allocation)
{
  GtkWidget *child;
311
  GtkRevealerTransitionType transition;
312 313
  GtkBorder padding;
  gint vertical_padding, horizontal_padding;
Matthias Clasen's avatar
Matthias Clasen committed
314 315 316 317

  g_return_if_fail (revealer != NULL);
  g_return_if_fail (allocation != NULL);

318 319 320 321 322
  /* See explanation on gtk_revealer_real_size_allocate */
  gtk_revealer_get_padding (revealer, &padding);
  vertical_padding = padding.top + padding.bottom;
  horizontal_padding = padding.left + padding.right;

Matthias Clasen's avatar
Matthias Clasen committed
323 324
  child_allocation->x = 0;
  child_allocation->y = 0;
325 326
  child_allocation->width = 0;
  child_allocation->height = 0;
Matthias Clasen's avatar
Matthias Clasen committed
327 328 329 330

  child = gtk_bin_get_child (GTK_BIN (revealer));
  if (child != NULL && gtk_widget_get_visible (child))
    {
331 332 333
      transition = effective_transition (revealer);
      if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_LEFT ||
          transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
334
        gtk_widget_get_preferred_width_for_height (child, MAX (0, allocation->height - vertical_padding), NULL,
Matthias Clasen's avatar
Matthias Clasen committed
335 336
                                                   &child_allocation->width);
      else
337
        gtk_widget_get_preferred_height_for_width (child, MAX (0, allocation->width - horizontal_padding), NULL,
Matthias Clasen's avatar
Matthias Clasen committed
338 339
                                                   &child_allocation->height);
    }
340

341 342
  child_allocation->width = MAX (child_allocation->width, allocation->width - horizontal_padding);
  child_allocation->height = MAX (child_allocation->height, allocation->height - vertical_padding);
Matthias Clasen's avatar
Matthias Clasen committed
343 344 345 346 347 348
}

static void
gtk_revealer_real_realize (GtkWidget *widget)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
349
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
350 351 352 353 354
  GtkAllocation allocation;
  GdkWindowAttr attributes = { 0 };
  GdkWindowAttributesType attributes_mask;
  GtkAllocation child_allocation;
  GtkWidget *child;
355
  GtkRevealerTransitionType transition;
356
  GtkBorder padding;
Matthias Clasen's avatar
Matthias Clasen committed
357 358 359 360 361 362 363 364 365 366 367 368 369

  gtk_widget_set_realized (widget, TRUE);

  gtk_widget_get_allocation (widget, &allocation);

  attributes.x = allocation.x;
  attributes.y = allocation.y;
  attributes.width = allocation.width;
  attributes.height = allocation.height;
  attributes.window_type = GDK_WINDOW_CHILD;
  attributes.wclass = GDK_INPUT_OUTPUT;
  attributes.visual = gtk_widget_get_visual (widget);
  attributes.event_mask =
370
    gtk_widget_get_events (widget);
Matthias Clasen's avatar
Matthias Clasen committed
371 372 373 374 375 376 377 378 379 380
  attributes_mask = (GDK_WA_X | GDK_WA_Y) | GDK_WA_VISUAL;

  priv->view_window =
    gdk_window_new (gtk_widget_get_parent_window ((GtkWidget*) revealer),
                    &attributes, attributes_mask);
  gtk_widget_set_window (widget, priv->view_window);
  gtk_widget_register_window (widget, priv->view_window);

  gtk_revealer_get_child_allocation (revealer, &allocation, &child_allocation);

381
  gtk_revealer_get_padding (revealer, &padding);
Matthias Clasen's avatar
Matthias Clasen committed
382 383 384 385 386
  attributes.x = 0;
  attributes.y = 0;
  attributes.width = child_allocation.width;
  attributes.height = child_allocation.height;

387
  /* See explanation on gtk_revealer_real_size_allocate */
388 389
  transition = effective_transition (revealer);
  if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN)
390 391 392 393
    {
      attributes.y = allocation.height - child_allocation.height - padding.bottom;
      attributes.x = padding.left;
    }
394
  else if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
395 396 397 398 399 400 401 402 403
    {
      attributes.y = padding.top;
      attributes.x = allocation.width - child_allocation.width - padding.right;
    }
 else
   {
     attributes.y = padding.top;
     attributes.x = padding.left;
   }
Matthias Clasen's avatar
Matthias Clasen committed
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

  priv->bin_window =
    gdk_window_new (priv->view_window, &attributes, attributes_mask);
  gtk_widget_register_window (widget, priv->bin_window);

  child = gtk_bin_get_child (GTK_BIN (revealer));
  if (child != NULL)
    gtk_widget_set_parent_window (child, priv->bin_window);

  gdk_window_show (priv->bin_window);
}

static void
gtk_revealer_real_unrealize (GtkWidget *widget)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
420
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
421 422 423 424 425 426 427 428 429 430 431 432 433

  gtk_widget_unregister_window (widget, priv->bin_window);
  gdk_window_destroy (priv->bin_window);
  priv->view_window = NULL;

  GTK_WIDGET_CLASS (gtk_revealer_parent_class)->unrealize (widget);
}

static void
gtk_revealer_real_add (GtkContainer *container,
                       GtkWidget    *child)
{
  GtkRevealer *revealer = GTK_REVEALER (container);
434
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
435 436 437 438 439 440 441 442 443 444 445 446 447 448

  g_return_if_fail (child != NULL);

  gtk_widget_set_parent_window (child, priv->bin_window);
  gtk_widget_set_child_visible (child, priv->current_pos != 0.0);

  GTK_CONTAINER_CLASS (gtk_revealer_parent_class)->add (container, child);
}

static void
gtk_revealer_real_size_allocate (GtkWidget     *widget,
                                 GtkAllocation *allocation)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
449
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
450 451 452 453
  GtkAllocation child_allocation;
  GtkWidget *child;
  gboolean window_visible;
  int bin_x, bin_y;
454
  GtkRevealerTransitionType transition;
455
  GtkBorder padding;
Matthias Clasen's avatar
Matthias Clasen committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478

  g_return_if_fail (allocation != NULL);

  gtk_widget_set_allocation (widget, allocation);
  gtk_revealer_get_child_allocation (revealer, allocation, &child_allocation);

  child = gtk_bin_get_child (GTK_BIN (revealer));
  if (child != NULL && gtk_widget_get_visible (child))
    gtk_widget_size_allocate (child, &child_allocation);

  if (gtk_widget_get_realized (widget))
    {
      if (gtk_widget_get_mapped (widget))
        {
          window_visible = allocation->width > 0 && allocation->height > 0;

          if (!window_visible && gdk_window_is_visible (priv->view_window))
            gdk_window_hide (priv->view_window);

          if (window_visible && !gdk_window_is_visible (priv->view_window))
            gdk_window_show (priv->view_window);
        }

479 480
      /* The view window will follow the revealer allocation, which is modified
       * along the animation */
Matthias Clasen's avatar
Matthias Clasen committed
481 482 483 484
      gdk_window_move_resize (priv->view_window,
                              allocation->x, allocation->y,
                              allocation->width, allocation->height);

485
      gtk_revealer_get_padding (revealer, &padding);
Matthias Clasen's avatar
Matthias Clasen committed
486 487
      bin_x = 0;
      bin_y = 0;
488

489
      transition = effective_transition (revealer);
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
      /* The child allocation is fixed (it is not modified by the animation),
       * and it's origin is relative to the bin_window.
       * The bin_window has the same allocation as the child, and then the bin_window
       * deals with the relative positioning with respect to the revealer taking
       * into account the paddings of the revealer.
       *
       * For most of transitions, the bin_window moves along with the revealer,
       * as its allocation changes.
       * However for GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN
       * we need to first move the bin_window upwards and then slide it down in
       * the revealer.
       * Otherwise the child would appear as static and the revealer will allocate
       * following the animation, clipping the child.
       * To calculate the correct y position for this case:
       * allocation->height - child_allocation.height is the relative position
       * towards the revealer taking into account the animation progress with
       * both vertical paddings added, therefore we need to substract the part
       * that we don't want to take into account for the y position, which
       * in this case is the bottom padding.
       *
       * The same special treatment is needed for GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT.
       */
512
      if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN)
513 514 515 516
        {
          bin_y = allocation->height - child_allocation.height - padding.bottom;
          bin_x = padding.left;
        }
517
      else if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
518 519 520 521 522 523 524 525 526
        {
          bin_y = padding.top;
          bin_x = allocation->width - child_allocation.width - padding.right;
        }
     else
       {
         bin_x = padding.left;
         bin_y = padding.top;
       }
Matthias Clasen's avatar
Matthias Clasen committed
527 528 529 530 531 532 533 534 535 536 537

      gdk_window_move_resize (priv->bin_window,
                              bin_x, bin_y,
                              child_allocation.width, child_allocation.height);
    }
}

static void
gtk_revealer_set_position (GtkRevealer *revealer,
                           gdouble      pos)
{
538
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
539 540
  gboolean new_visible;
  GtkWidget *child;
541
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556

  priv->current_pos = pos;

  /* We check target_pos here too, because we want to ensure we set
   * child_visible immediately when starting a reveal operation
   * otherwise the child widgets will not be properly realized
   * after the reveal returns.
   */
  new_visible = priv->current_pos != 0.0 || priv->target_pos != 0.0;

  child = gtk_bin_get_child (GTK_BIN (revealer));
  if (child != NULL &&
      new_visible != gtk_widget_get_child_visible (child))
    gtk_widget_set_child_visible (child, new_visible);

557 558
  transition = effective_transition (revealer);
  if (transition == GTK_REVEALER_TRANSITION_TYPE_CROSSFADE)
559 560 561 562 563 564 565 566
    {
      gtk_widget_set_opacity (GTK_WIDGET (revealer), priv->current_pos);
      gtk_widget_queue_draw (GTK_WIDGET (revealer));
    }
  else
    {
      gtk_widget_queue_resize (GTK_WIDGET (revealer));
    }
Matthias Clasen's avatar
Matthias Clasen committed
567 568

  if (priv->current_pos == priv->target_pos)
569
    g_object_notify_by_pspec (G_OBJECT (revealer), props[PROP_CHILD_REVEALED]);
Matthias Clasen's avatar
Matthias Clasen committed
570 571 572
}

static gboolean
573
gtk_revealer_animate_cb (GtkWidget     *widget,
Matthias Clasen's avatar
Matthias Clasen committed
574 575 576
                         GdkFrameClock *frame_clock,
                         gpointer       user_data)
{
577
  GtkRevealer *revealer = GTK_REVEALER (widget);
578
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
579
  gdouble ease;
Matthias Clasen's avatar
Matthias Clasen committed
580

581 582 583 584 585 586 587
  gtk_progress_tracker_advance_frame (&priv->tracker,
                                      gdk_frame_clock_get_frame_time (frame_clock));
  ease = gtk_progress_tracker_get_ease_out_cubic (&priv->tracker, FALSE);
  gtk_revealer_set_position (revealer,
                             priv->source_pos + (ease * (priv->target_pos - priv->source_pos)));

  if (gtk_progress_tracker_get_state (&priv->tracker) == GTK_PROGRESS_STATE_AFTER)
Matthias Clasen's avatar
Matthias Clasen committed
588 589 590 591 592 593 594 595 596 597 598 599
    {
      priv->tick_id = 0;
      return FALSE;
    }

  return TRUE;
}

static void
gtk_revealer_start_animation (GtkRevealer *revealer,
                              gdouble      target)
{
600
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
601
  GtkWidget *widget = GTK_WIDGET (revealer);
602
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
603 604 605 606 607

  if (priv->target_pos == target)
    return;

  priv->target_pos = target;
608
  g_object_notify_by_pspec (G_OBJECT (revealer), props[PROP_REVEAL_CHILD]);
Matthias Clasen's avatar
Matthias Clasen committed
609

610
  transition = effective_transition (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
611 612
  if (gtk_widget_get_mapped (widget) &&
      priv->transition_duration != 0 &&
613
      transition != GTK_REVEALER_TRANSITION_TYPE_NONE &&
614
      gtk_settings_get_enable_animations (gtk_widget_get_settings (widget)))
Matthias Clasen's avatar
Matthias Clasen committed
615 616 617 618
    {
      priv->source_pos = priv->current_pos;
      if (priv->tick_id == 0)
        priv->tick_id =
619
          gtk_widget_add_tick_callback (widget, gtk_revealer_animate_cb, revealer, NULL);
620 621 622 623
      gtk_progress_tracker_start (&priv->tracker,
                                  priv->transition_duration * 1000,
                                  0,
                                  1.0);
Matthias Clasen's avatar
Matthias Clasen committed
624 625 626 627 628 629 630 631 632 633
    }
  else
    {
      gtk_revealer_set_position (revealer, target);
    }
}

static void
gtk_revealer_stop_animation (GtkRevealer *revealer)
{
634
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
635 636 637 638 639
  if (priv->current_pos != priv->target_pos)
    {
      priv->current_pos = priv->target_pos;
      g_object_notify_by_pspec (G_OBJECT (revealer), props[PROP_CHILD_REVEALED]);
    }
Matthias Clasen's avatar
Matthias Clasen committed
640 641 642 643 644 645 646 647 648 649 650
  if (priv->tick_id != 0)
    {
      gtk_widget_remove_tick_callback (GTK_WIDGET (revealer), priv->tick_id);
      priv->tick_id = 0;
    }
}

static void
gtk_revealer_real_map (GtkWidget *widget)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
651
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
  GtkAllocation allocation;

  if (!gtk_widget_get_mapped (widget))
    {
      gtk_widget_get_allocation (widget, &allocation);

      if (allocation.width > 0 && allocation.height > 0)
        gdk_window_show (priv->view_window);
    }

  GTK_WIDGET_CLASS (gtk_revealer_parent_class)->map (widget);
}

static void
gtk_revealer_real_unmap (GtkWidget *widget)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);

  GTK_WIDGET_CLASS (gtk_revealer_parent_class)->unmap (widget);

  gtk_revealer_stop_animation (revealer);
}

static gboolean
gtk_revealer_real_draw (GtkWidget *widget,
                        cairo_t   *cr)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
680
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
681 682 683 684

  if (gtk_cairo_should_draw_window (cr, priv->bin_window))
    GTK_WIDGET_CLASS (gtk_revealer_parent_class)->draw (widget, cr);

685
  return GDK_EVENT_PROPAGATE;
Matthias Clasen's avatar
Matthias Clasen committed
686 687
}

688 689 690 691 692 693 694 695 696 697 698 699
/**
 * gtk_revealer_set_reveal_child:
 * @revealer: a #GtkRevealer
 * @reveal_child: %TRUE to reveal the child
 *
 * Tells the #GtkRevealer to reveal or conceal its child.
 *
 * The transition will be animated with the current
 * transition type of @revealer.
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
700 701 702 703 704 705 706 707 708 709 710 711
void
gtk_revealer_set_reveal_child (GtkRevealer *revealer,
                               gboolean     reveal_child)
{
  g_return_if_fail (GTK_IS_REVEALER (revealer));

  if (reveal_child)
    gtk_revealer_start_animation (revealer, 1.0);
  else
    gtk_revealer_start_animation (revealer, 0.0);
}

712 713
/**
 * gtk_revealer_get_reveal_child:
Matthias Clasen's avatar
Matthias Clasen committed
714
 * @revealer: a #GtkRevealer
715 716 717 718 719 720 721 722 723
 *
 * Returns whether the child is currently
 * revealed. See gtk_revealer_set_reveal_child().
 *
 * This function returns %TRUE as soon as the transition
 * is to the revealed state is started. To learn whether
 * the child is fully revealed (ie the transition is completed),
 * use gtk_revealer_get_child_revealed().
 *
724
 * Returns: %TRUE if the child is revealed.
725 726 727
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
728 729 730
gboolean
gtk_revealer_get_reveal_child (GtkRevealer *revealer)
{
731 732
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
733 734
  g_return_val_if_fail (GTK_IS_REVEALER (revealer), FALSE);

735
  return priv->target_pos != 0.0;
Matthias Clasen's avatar
Matthias Clasen committed
736 737
}

738 739 740 741 742 743 744
/**
 * gtk_revealer_get_child_revealed:
 * @revealer: a #GtkRevealer
 *
 * Returns whether the child is fully revealed, ie wether
 * the transition to the revealed state is completed.
 *
745
 * Returns: %TRUE if the child is fully revealed
746 747 748
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
749 750 751
gboolean
gtk_revealer_get_child_revealed (GtkRevealer *revealer)
{
752 753
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
  gboolean animation_finished = (priv->target_pos == priv->current_pos);
Matthias Clasen's avatar
Matthias Clasen committed
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
  gboolean reveal_child = gtk_revealer_get_reveal_child (revealer);

  if (animation_finished)
    return reveal_child;
  else
    return !reveal_child;
}

/* These all report only the natural size, ignoring the minimal size,
 * because its not really possible to allocate the right size during
 * animation if the child size can change (without the child
 * re-arranging itself during the animation).
 */

static void
769 770 771 772 773
set_height_with_paddings (GtkRevealer *revealer,
                          gint         preferred_minimum_height,
                          gint         preferred_natural_height,
                          gint        *minimum_height_out,
                          gint        *natural_height_out)
Matthias Clasen's avatar
Matthias Clasen committed
774
{
775
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
776 777
  gint minimum_height;
  gint natural_height;
778
  GtkRevealerTransitionType transition;
779 780
  GtkBorder padding;
  gint vertical_padding;
Matthias Clasen's avatar
Matthias Clasen committed
781

782 783 784 785
  gtk_revealer_get_padding (revealer, &padding);
  vertical_padding = padding.top + padding.bottom;
  minimum_height = preferred_minimum_height + vertical_padding;
  natural_height = preferred_natural_height + vertical_padding;
Matthias Clasen's avatar
Matthias Clasen committed
786

787
  transition = effective_transition (revealer);
788 789
  if (transition == GTK_REVEALER_TRANSITION_TYPE_NONE ||
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_UP ||
790
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN)
791 792 793 794 795
    {
      /* Padding are included in the animation */
      minimum_height = round (minimum_height * priv->current_pos);
      natural_height = round (natural_height * priv->current_pos);
    }
Matthias Clasen's avatar
Matthias Clasen committed
796

797
  *minimum_height_out = MIN (minimum_height, natural_height);
798
  *natural_height_out = natural_height;
Matthias Clasen's avatar
Matthias Clasen committed
799 800
}

801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
static void
gtk_revealer_real_get_preferred_height (GtkWidget *widget,
                                        gint      *minimum_height_out,
                                        gint      *natural_height_out)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
  gint minimum_height;
  gint natural_height;

  GTK_WIDGET_CLASS (gtk_revealer_parent_class)->get_preferred_height (widget, &minimum_height, &natural_height);

  set_height_with_paddings (revealer, minimum_height, natural_height,
                            minimum_height_out, natural_height_out);
}

Matthias Clasen's avatar
Matthias Clasen committed
816 817 818 819 820 821 822 823 824 825 826 827
static void
gtk_revealer_real_get_preferred_height_for_width (GtkWidget *widget,
                                                  gint       width,
                                                  gint      *minimum_height_out,
                                                  gint      *natural_height_out)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
  gint minimum_height;
  gint natural_height;

  GTK_WIDGET_CLASS (gtk_revealer_parent_class)->get_preferred_height_for_width (widget, width, &minimum_height, &natural_height);

828 829
  set_height_with_paddings (revealer, minimum_height, natural_height,
                            minimum_height_out, natural_height_out);
Matthias Clasen's avatar
Matthias Clasen committed
830 831 832
}

static void
833 834 835 836 837
set_width_with_paddings (GtkRevealer *revealer,
                         gint         preferred_minimum_width,
                         gint         preferred_natural_width,
                         gint        *minimum_width_out,
                         gint        *natural_width_out)
Matthias Clasen's avatar
Matthias Clasen committed
838
{
839
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
840 841
  gint minimum_width;
  gint natural_width;
842
  GtkRevealerTransitionType transition;
843 844
  GtkBorder padding;
  gint horizontal_padding;
Matthias Clasen's avatar
Matthias Clasen committed
845

846 847
  gtk_revealer_get_padding (revealer, &padding);
  horizontal_padding = padding.left + padding.right;
848 849
  minimum_width = preferred_minimum_width + horizontal_padding;
  natural_width = preferred_natural_width + horizontal_padding;
Matthias Clasen's avatar
Matthias Clasen committed
850

851
  transition = effective_transition (revealer);
852 853
  if (transition == GTK_REVEALER_TRANSITION_TYPE_NONE ||
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_LEFT ||
854
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
855 856 857 858 859
    {
      /* Paddings are included in the animation */
      minimum_width = round (minimum_width * priv->current_pos);
      natural_width = round (natural_width * priv->current_pos);
    }
Matthias Clasen's avatar
Matthias Clasen committed
860

861
  *minimum_width_out = MIN (minimum_width, natural_width);
862
  *natural_width_out = natural_width;
Matthias Clasen's avatar
Matthias Clasen committed
863 864
}

865 866 867 868 869 870 871 872 873 874 875 876 877 878
static void
gtk_revealer_real_get_preferred_width (GtkWidget *widget,
                                       gint      *minimum_width_out,
                                       gint      *natural_width_out)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
  gint minimum_width;
  gint natural_width;

  GTK_WIDGET_CLASS (gtk_revealer_parent_class)->get_preferred_width (widget, &minimum_width, &natural_width);
  set_width_with_paddings (revealer, minimum_width, natural_width,
                           minimum_width_out, natural_width_out);
}

Matthias Clasen's avatar
Matthias Clasen committed
879 880 881 882 883 884 885 886 887 888 889 890
static void
gtk_revealer_real_get_preferred_width_for_height (GtkWidget *widget,
                                                  gint       height,
                                                  gint      *minimum_width_out,
                                                  gint      *natural_width_out)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
  gint minimum_width;
  gint natural_width;

  GTK_WIDGET_CLASS (gtk_revealer_parent_class)->get_preferred_width_for_height (widget, height, &minimum_width, &natural_width);

891 892
  set_width_with_paddings (revealer, minimum_width, natural_width,
                           minimum_width_out, natural_width_out);
Matthias Clasen's avatar
Matthias Clasen committed
893 894
}

895 896 897 898 899 900 901 902 903 904 905
/**
 * gtk_revealer_get_transition_duration:
 * @revealer: a #GtkRevealer
 *
 * Returns the amount of time (in milliseconds) that
 * transitions will take.
 *
 * Returns: the transition duration
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
906 907 908
guint
gtk_revealer_get_transition_duration (GtkRevealer *revealer)
{
909 910
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
911 912
  g_return_val_if_fail (GTK_IS_REVEALER (revealer), 0);

913
  return priv->transition_duration;
Matthias Clasen's avatar
Matthias Clasen committed
914 915
}

916 917 918 919 920 921 922 923 924
/**
 * gtk_revealer_set_transition_duration:
 * @revealer: a #GtkRevealer
 * @duration: the new duration, in milliseconds
 *
 * Sets the duration that transitions will take.
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
925 926 927 928
void
gtk_revealer_set_transition_duration (GtkRevealer *revealer,
                                      guint        value)
{
929 930
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
931 932
  g_return_if_fail (GTK_IS_REVEALER (revealer));

933 934 935
  if (priv->transition_duration == value)
    return;

936
  priv->transition_duration = value;
937
  g_object_notify_by_pspec (G_OBJECT (revealer), props[PROP_TRANSITION_DURATION]);
Matthias Clasen's avatar
Matthias Clasen committed
938 939
}

940 941 942 943 944 945 946
/**
 * gtk_revealer_get_transition_type:
 * @revealer: a #GtkRevealer
 *
 * Gets the type of animation that will be used
 * for transitions in @revealer.
 *
947
 * Returns: the current transition type of @revealer
948 949 950
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
951 952 953
GtkRevealerTransitionType
gtk_revealer_get_transition_type (GtkRevealer *revealer)
{
954 955
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
956 957
  g_return_val_if_fail (GTK_IS_REVEALER (revealer), GTK_REVEALER_TRANSITION_TYPE_NONE);

958
  return priv->transition_type;
Matthias Clasen's avatar
Matthias Clasen committed
959 960
}

961
/**
962 963
 * gtk_revealer_set_transition_type:
 * @revealer: a #GtkRevealer
964 965 966 967 968 969 970 971
 * @transition: the new transition type
 *
 * Sets the type of animation that will be used for
 * transitions in @revealer. Available types include
 * various kinds of fades and slides.
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
972 973 974 975
void
gtk_revealer_set_transition_type (GtkRevealer               *revealer,
                                  GtkRevealerTransitionType  transition)
{
976 977
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
978 979
  g_return_if_fail (GTK_IS_REVEALER (revealer));

980 981 982
  if (priv->transition_type == transition)
    return;

983
  priv->transition_type = transition;
Matthias Clasen's avatar
Matthias Clasen committed
984
  gtk_widget_queue_resize (GTK_WIDGET (revealer));
985
  g_object_notify_by_pspec (G_OBJECT (revealer), props[PROP_TRANSITION_TYPE]);
Matthias Clasen's avatar
Matthias Clasen committed
986
}