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

#include "config.h"
#include "gtkrevealer.h"
#include <gdk/gdk.h>
#include "gtktypebuiltins.h"
#include "gtkprivate.h"
#include "gtkintl.h"
29 30

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

32 33 34 35 36 37 38 39 40 41 42 43
/**
 * 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().
 *
44
 * These animations respect the #GtkSettings:gtk-enable-animations
45 46
 * setting.
 *
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
 * 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
63 64 65 66 67
enum  {
  PROP_0,
  PROP_TRANSITION_TYPE,
  PROP_TRANSITION_DURATION,
  PROP_REVEAL_CHILD,
68 69
  PROP_CHILD_REVEALED,
  LAST_PROP
Matthias Clasen's avatar
Matthias Clasen committed
70 71
};

72
typedef struct {
Matthias Clasen's avatar
Matthias Clasen committed
73 74 75 76 77 78 79 80 81 82 83 84 85
  GtkRevealerTransitionType transition_type;
  guint transition_duration;

  GdkWindow* bin_window;
  GdkWindow* view_window;

  gdouble current_pos;
  gdouble source_pos;
  gdouble target_pos;

  guint tick_id;
  gint64 start_time;
  gint64 end_time;
86
} GtkRevealerPrivate;
Matthias Clasen's avatar
Matthias Clasen committed
87

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

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_style_updated                  (GtkWidget     *widget);
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);

116
G_DEFINE_TYPE_WITH_PRIVATE (GtkRevealer, gtk_revealer, GTK_TYPE_BIN)
Matthias Clasen's avatar
Matthias Clasen committed
117 118 119 120

static void
gtk_revealer_init (GtkRevealer *revealer)
{
121
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
122 123 124 125 126 127 128 129 130 131 132 133 134 135

  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);
136
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 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

  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->style_updated = gtk_revealer_real_style_updated;
  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;

223 224 225 226 227 228
  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,
229
                       GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_EXPLICIT_NOTIFY);
230 231 232 233 234 235

  props[PROP_TRANSITION_DURATION] =
    g_param_spec_uint ("transition-duration",
                       P_("Transition duration"),
                       P_("The animation duration, in milliseconds"),
                       0, G_MAXUINT, 250,
236
                       GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_EXPLICIT_NOTIFY);
237 238 239 240 241 242

  props[PROP_REVEAL_CHILD] =
    g_param_spec_boolean ("reveal-child",
                          P_("Reveal Child"),
                          P_("Whether the container should reveal the child"),
                          FALSE,
243
                          GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_EXPLICIT_NOTIFY);
244 245 246 247 248 249 250 251 252

  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);
Matthias Clasen's avatar
Matthias Clasen committed
253 254
}

255 256 257 258 259 260 261 262 263
/**
 * gtk_revealer_new:
 *
 * Creates a new #GtkRevealer.
 *
 * Returns: a newly created #GtkRevealer
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
264 265 266 267 268 269
GtkWidget *
gtk_revealer_new (void)
{
  return g_object_new (GTK_TYPE_REVEALER, NULL);
}

270 271 272
static GtkRevealerTransitionType
effective_transition (GtkRevealer *revealer)
{
273
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
274 275 276 277 278 279 280
  gboolean animations_enabled;

  g_object_get (gtk_widget_get_settings (GTK_WIDGET (revealer)),
                "gtk-enable-animations", &animations_enabled,
                NULL);
  if (!animations_enabled)
    return GTK_REVEALER_TRANSITION_TYPE_NONE;
281 282 283 284 285 286 287 288 289 290 291 292

  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
293 294 295 296 297 298
static void
gtk_revealer_get_child_allocation (GtkRevealer   *revealer,
                                   GtkAllocation *allocation,
                                   GtkAllocation *child_allocation)
{
  GtkWidget *child;
299
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
300 301 302 303 304 305

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

  child_allocation->x = 0;
  child_allocation->y = 0;
306 307
  child_allocation->width = 0;
  child_allocation->height = 0;
Matthias Clasen's avatar
Matthias Clasen committed
308 309 310 311

  child = gtk_bin_get_child (GTK_BIN (revealer));
  if (child != NULL && gtk_widget_get_visible (child))
    {
312 313 314
      transition = effective_transition (revealer);
      if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_LEFT ||
          transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
315
        gtk_widget_get_preferred_width_for_height (child, allocation->height, NULL,
Matthias Clasen's avatar
Matthias Clasen committed
316 317
                                                   &child_allocation->width);
      else
318
        gtk_widget_get_preferred_height_for_width (child, allocation->width, NULL,
Matthias Clasen's avatar
Matthias Clasen committed
319 320
                                                   &child_allocation->height);
    }
321 322 323

  child_allocation->width = MAX (child_allocation->width, allocation->width);
  child_allocation->height = MAX (child_allocation->height, allocation->height);
Matthias Clasen's avatar
Matthias Clasen committed
324 325 326 327 328 329
}

static void
gtk_revealer_real_realize (GtkWidget *widget)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
330
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
331 332 333 334 335 336
  GtkAllocation allocation;
  GdkWindowAttr attributes = { 0 };
  GdkWindowAttributesType attributes_mask;
  GtkAllocation child_allocation;
  GtkWidget *child;
  GtkStyleContext *context;
337
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366

  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 =
    gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
  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);

  attributes.x = 0;
  attributes.y = 0;
  attributes.width = child_allocation.width;
  attributes.height = child_allocation.height;

367 368
  transition = effective_transition (revealer);
  if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN)
Matthias Clasen's avatar
Matthias Clasen committed
369
    attributes.y = allocation.height - child_allocation.height;
370
  else if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
Matthias Clasen's avatar
Matthias Clasen committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
    attributes.x = allocation.width - child_allocation.width;

  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);

  context = gtk_widget_get_style_context (widget);
  gtk_style_context_set_background (context, priv->view_window);
  gtk_style_context_set_background (context, priv->bin_window);
  gdk_window_show (priv->bin_window);
}

static void
gtk_revealer_real_unrealize (GtkWidget *widget)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
391
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
392 393 394 395 396 397 398 399 400 401 402 403 404

  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);
405
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
406 407 408 409 410 411 412 413 414 415 416 417 418

  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_style_updated (GtkWidget *widget)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
419
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
  GtkStyleContext* context;

  GTK_WIDGET_CLASS (gtk_revealer_parent_class)->style_updated (widget);

  if (gtk_widget_get_realized (widget))
    {
      context = gtk_widget_get_style_context (widget);
      gtk_style_context_set_background (context, priv->bin_window);
      gtk_style_context_set_background (context, priv->view_window);
    }
}

static void
gtk_revealer_real_size_allocate (GtkWidget     *widget,
                                 GtkAllocation *allocation)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
437
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
438 439 440 441
  GtkAllocation child_allocation;
  GtkWidget *child;
  gboolean window_visible;
  int bin_x, bin_y;
442
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471

  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);
        }

      gdk_window_move_resize (priv->view_window,
                              allocation->x, allocation->y,
                              allocation->width, allocation->height);

      bin_x = 0;
      bin_y = 0;
472 473
      transition = effective_transition (revealer);
      if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN)
Matthias Clasen's avatar
Matthias Clasen committed
474
        bin_y = allocation->height - child_allocation.height;
475
      else if (transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
Matthias Clasen's avatar
Matthias Clasen committed
476 477 478 479 480 481 482 483 484 485 486 487
        bin_x = allocation->width - child_allocation.width;

      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)
{
488
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
489 490
  gboolean new_visible;
  GtkWidget *child;
491
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506

  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);

507 508
  transition = effective_transition (revealer);
  if (transition == GTK_REVEALER_TRANSITION_TYPE_CROSSFADE)
509 510 511 512 513 514 515 516
    {
      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
517 518

  if (priv->current_pos == priv->target_pos)
519
    g_object_notify_by_pspec (G_OBJECT (revealer), props[PROP_CHILD_REVEALED]);
Matthias Clasen's avatar
Matthias Clasen committed
520 521
}

522 523 524 525 526
/* From clutter-easing.c, based on Robert Penner's
 * infamous easing equations, MIT license.
 */
static double
ease_out_cubic (double t)
Matthias Clasen's avatar
Matthias Clasen committed
527
{
528 529
  double p = t - 1;
  return p * p * p + 1;
Matthias Clasen's avatar
Matthias Clasen committed
530 531 532 533 534 535
}

static void
gtk_revealer_animate_step (GtkRevealer *revealer,
                           gint64       now)
{
536
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
537 538 539
  gdouble t;

  if (now < priv->end_time)
540 541 542 543
    t = (now - priv->start_time) / (gdouble) (priv->end_time - priv->start_time);
  else
    t = 1.0;
  t = ease_out_cubic (t);
Matthias Clasen's avatar
Matthias Clasen committed
544 545 546 547 548 549

  gtk_revealer_set_position (revealer,
                            priv->source_pos + (t * (priv->target_pos - priv->source_pos)));
}

static gboolean
550
gtk_revealer_animate_cb (GtkWidget     *widget,
Matthias Clasen's avatar
Matthias Clasen committed
551 552 553
                         GdkFrameClock *frame_clock,
                         gpointer       user_data)
{
554
  GtkRevealer *revealer = GTK_REVEALER (widget);
555
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
  gint64 now;

  now = gdk_frame_clock_get_frame_time (frame_clock);
  gtk_revealer_animate_step (revealer, now);
  if (priv->current_pos == priv->target_pos)
    {
      priv->tick_id = 0;
      return FALSE;
    }

  return TRUE;
}

static void
gtk_revealer_start_animation (GtkRevealer *revealer,
                              gdouble      target)
{
573
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
574
  GtkWidget *widget = GTK_WIDGET (revealer);
575
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
576 577 578 579 580

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

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

583
  transition = effective_transition (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
584 585
  if (gtk_widget_get_mapped (widget) &&
      priv->transition_duration != 0 &&
586
      transition != GTK_REVEALER_TRANSITION_TYPE_NONE)
Matthias Clasen's avatar
Matthias Clasen committed
587 588 589 590 591 592
    {
      priv->source_pos = priv->current_pos;
      priv->start_time = gdk_frame_clock_get_frame_time (gtk_widget_get_frame_clock (widget));
      priv->end_time = priv->start_time + (priv->transition_duration * 1000);
      if (priv->tick_id == 0)
        priv->tick_id =
593
          gtk_widget_add_tick_callback (widget, gtk_revealer_animate_cb, revealer, NULL);
Matthias Clasen's avatar
Matthias Clasen committed
594 595 596 597 598 599 600 601 602 603 604
      gtk_revealer_animate_step (revealer, priv->start_time);
    }
  else
    {
      gtk_revealer_set_position (revealer, target);
    }
}

static void
gtk_revealer_stop_animation (GtkRevealer *revealer)
{
605
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
606 607 608 609 610 611 612 613 614 615 616 617 618

  priv->current_pos = priv->target_pos;
  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);
619
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
  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_revealer_start_animation (revealer, priv->target_pos);
    }

  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);
650
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
651 652 653 654 655 656 657

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

  return TRUE;
}

658 659 660 661 662 663 664 665 666 667 668 669
/**
 * 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
670 671 672 673 674 675 676 677 678 679 680 681
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);
}

682 683
/**
 * gtk_revealer_get_reveal_child:
Matthias Clasen's avatar
Matthias Clasen committed
684
 * @revealer: a #GtkRevealer
685 686 687 688 689 690 691 692 693
 *
 * 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().
 *
694
 * Returns: %TRUE if the child is revealed.
695 696 697
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
698 699 700
gboolean
gtk_revealer_get_reveal_child (GtkRevealer *revealer)
{
701 702
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
703 704
  g_return_val_if_fail (GTK_IS_REVEALER (revealer), FALSE);

705
  return priv->target_pos != 0.0;
Matthias Clasen's avatar
Matthias Clasen committed
706 707
}

708 709 710 711 712 713 714
/**
 * 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.
 *
715
 * Returns: %TRUE if the child is fully revealed
716 717 718
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
719 720 721
gboolean
gtk_revealer_get_child_revealed (GtkRevealer *revealer)
{
722 723
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
  gboolean animation_finished = (priv->target_pos == priv->current_pos);
Matthias Clasen's avatar
Matthias Clasen committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
  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
gtk_revealer_real_get_preferred_height (GtkWidget *widget,
                                        gint      *minimum_height_out,
                                        gint      *natural_height_out)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
744
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
745 746
  gint minimum_height;
  gint natural_height;
747
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
748 749 750

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

751
  transition = effective_transition (revealer);
752 753
  if (transition == GTK_REVEALER_TRANSITION_TYPE_NONE ||
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_UP ||
754
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN)
Matthias Clasen's avatar
Matthias Clasen committed
755 756
    natural_height = round (natural_height * priv->current_pos);

757
  minimum_height = MIN (minimum_height, natural_height);
Matthias Clasen's avatar
Matthias Clasen committed
758

759 760
  *minimum_height_out = minimum_height;
  *natural_height_out = natural_height;
Matthias Clasen's avatar
Matthias Clasen committed
761 762 763 764 765 766 767 768 769
}

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);
770
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
771 772
  gint minimum_height;
  gint natural_height;
773
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
774 775 776

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

777
  transition = effective_transition (revealer);
778 779
  if (transition == GTK_REVEALER_TRANSITION_TYPE_NONE ||
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_UP ||
780
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_DOWN)
Matthias Clasen's avatar
Matthias Clasen committed
781 782
    natural_height = round (natural_height * priv->current_pos);

783
  minimum_height = MIN (minimum_height, natural_height);
Matthias Clasen's avatar
Matthias Clasen committed
784

785 786
  *minimum_height_out = minimum_height;
  *natural_height_out = natural_height;
Matthias Clasen's avatar
Matthias Clasen committed
787 788 789 790 791 792 793 794
}

static void
gtk_revealer_real_get_preferred_width (GtkWidget *widget,
                                       gint      *minimum_width_out,
                                       gint      *natural_width_out)
{
  GtkRevealer *revealer = GTK_REVEALER (widget);
795
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
796 797
  gint minimum_width;
  gint natural_width;
798
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
799 800 801

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

802
  transition = effective_transition (revealer);
803 804
  if (transition == GTK_REVEALER_TRANSITION_TYPE_NONE ||
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_LEFT ||
805
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
Matthias Clasen's avatar
Matthias Clasen committed
806 807
    natural_width = round (natural_width * priv->current_pos);

808
  minimum_width = MIN (minimum_width, natural_width);
Matthias Clasen's avatar
Matthias Clasen committed
809

810 811
  *minimum_width_out = minimum_width;
  *natural_width_out = natural_width;
Matthias Clasen's avatar
Matthias Clasen committed
812 813 814 815 816 817 818 819 820
}

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);
821
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);
Matthias Clasen's avatar
Matthias Clasen committed
822 823
  gint minimum_width;
  gint natural_width;
824
  GtkRevealerTransitionType transition;
Matthias Clasen's avatar
Matthias Clasen committed
825 826 827

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

828
  transition = effective_transition (revealer);
829 830
  if (transition == GTK_REVEALER_TRANSITION_TYPE_NONE ||
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_LEFT ||
831
      transition == GTK_REVEALER_TRANSITION_TYPE_SLIDE_RIGHT)
Matthias Clasen's avatar
Matthias Clasen committed
832 833
    natural_width = round (natural_width * priv->current_pos);

834
  minimum_width = MIN (minimum_width, natural_width);
Matthias Clasen's avatar
Matthias Clasen committed
835

836 837
  *minimum_width_out = minimum_width;
  *natural_width_out = natural_width;
Matthias Clasen's avatar
Matthias Clasen committed
838 839
}

840 841 842 843 844 845 846 847 848 849 850
/**
 * 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
851 852 853
guint
gtk_revealer_get_transition_duration (GtkRevealer *revealer)
{
854 855
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
856 857
  g_return_val_if_fail (GTK_IS_REVEALER (revealer), 0);

858
  return priv->transition_duration;
Matthias Clasen's avatar
Matthias Clasen committed
859 860
}

861 862 863 864 865 866 867 868 869
/**
 * 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
870 871 872 873
void
gtk_revealer_set_transition_duration (GtkRevealer *revealer,
                                      guint        value)
{
874 875
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
876 877
  g_return_if_fail (GTK_IS_REVEALER (revealer));

878 879 880
  if (priv->transition_duration == value)
    return;

881
  priv->transition_duration = value;
882
  g_object_notify_by_pspec (G_OBJECT (revealer), props[PROP_TRANSITION_DURATION]);
Matthias Clasen's avatar
Matthias Clasen committed
883 884
}

885 886 887 888 889 890 891
/**
 * gtk_revealer_get_transition_type:
 * @revealer: a #GtkRevealer
 *
 * Gets the type of animation that will be used
 * for transitions in @revealer.
 *
892
 * Returns: the current transition type of @revealer
893 894 895
 *
 * Since: 3.10
 */
Matthias Clasen's avatar
Matthias Clasen committed
896 897 898
GtkRevealerTransitionType
gtk_revealer_get_transition_type (GtkRevealer *revealer)
{
899 900
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
901 902
  g_return_val_if_fail (GTK_IS_REVEALER (revealer), GTK_REVEALER_TRANSITION_TYPE_NONE);

903
  return priv->transition_type;
Matthias Clasen's avatar
Matthias Clasen committed
904 905
}

906
/**
907 908
 * gtk_revealer_set_transition_type:
 * @revealer: a #GtkRevealer
909 910 911 912 913 914 915 916
 * @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
917 918 919 920
void
gtk_revealer_set_transition_type (GtkRevealer               *revealer,
                                  GtkRevealerTransitionType  transition)
{
921 922
  GtkRevealerPrivate *priv = gtk_revealer_get_instance_private (revealer);

Matthias Clasen's avatar
Matthias Clasen committed
923 924
  g_return_if_fail (GTK_IS_REVEALER (revealer));

925 926 927
  if (priv->transition_type == transition)
    return;

928
  priv->transition_type = transition;
Matthias Clasen's avatar
Matthias Clasen committed
929
  gtk_widget_queue_resize (GTK_WIDGET (revealer));
930
  g_object_notify_by_pspec (G_OBJECT (revealer), props[PROP_TRANSITION_TYPE]);
Matthias Clasen's avatar
Matthias Clasen committed
931
}