Pileus Git - ~andy/gtk/blob - gtk/gtkviewport.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include "config.h"
  28
  29 #include "gtkviewport.h"
  30
  31 #include "gtkintl.h"
  32 #include "gtkmarshalers.h"
  33 #include "gtkscrollable.h"
  34 #include "gtktypebuiltins.h"
  35 #include "gtkprivate.h"
  36
  37
  38 /**
  39  * SECTION:gtkviewport
  40  * @Short_description: An adapter which makes widgets scrollable
  41  * @Title: GtkViewport
  42  * @See_also:#GtkScrolledWindow, #GtkAdjustment
  43  *
  44  * The #GtkViewport widget acts as an adaptor class, implementing
  45  * scrollability for child widgets that lack their own scrolling
  46  * capabilities. Use #GtkViewport to scroll child widgets such as
  47  * #GtkTable, #GtkBox, and so on.
  48  *
  49  * If a widget has native scrolling abilities, such as #GtkTextView,
  50  * #GtkTreeView or #GtkIconview, it can be added to a #GtkScrolledWindow
  51  * with gtk_container_add(). If a widget does not, you must first add the
  52  * widget to a #GtkViewport, then add the viewport to the scrolled window.
  53  * The convenience function gtk_scrolled_window_add_with_viewport() does
  54  * exactly this, so you can ignore the presence of the viewport.
  55  *
  56  * The #GtkViewport will start scrolling content only if allocated less
  57  * than the child widget's minimum size in a given orientation.
  58  */
  59
  60 struct _GtkViewportPrivate
  61 {
  62   GtkAdjustment  *hadjustment;
  63   GtkAdjustment  *vadjustment;
  64   GtkShadowType   shadow_type;
  65
  66   GdkWindow      *bin_window;
  67   GdkWindow      *view_window;
  68
  69   /* GtkScrollablePolicy needs to be checked when
  70    * driving the scrollable adjustment values */
  71   guint hscroll_policy : 1;
  72   guint vscroll_policy : 1;
  73 };
  74
  75 enum {
  76   PROP_0,
  77   PROP_HADJUSTMENT,
  78   PROP_VADJUSTMENT,
  79   PROP_HSCROLL_POLICY,
  80   PROP_VSCROLL_POLICY,
  81   PROP_SHADOW_TYPE
  82 };
  83
  84
  85 static void gtk_viewport_finalize                 (GObject          *object);
  86 static void gtk_viewport_set_property             (GObject         *object,
  87                                                    guint            prop_id,
  88                                                    const GValue    *value,
  89                                                    GParamSpec      *pspec);
  90 static void gtk_viewport_get_property             (GObject         *object,
  91                                                    guint            prop_id,
  92                                                    GValue          *value,
  93                                                    GParamSpec      *pspec);
  94 static void gtk_viewport_destroy                  (GtkWidget        *widget);
  95 static void gtk_viewport_realize                  (GtkWidget        *widget);
  96 static void gtk_viewport_unrealize                (GtkWidget        *widget);
  97 static gint gtk_viewport_draw                     (GtkWidget        *widget,
  98                                                    cairo_t          *cr);
  99 static void gtk_viewport_add                      (GtkContainer     *container,
 100                                                    GtkWidget        *widget);
 101 static void gtk_viewport_size_allocate            (GtkWidget        *widget,
 102                                                    GtkAllocation    *allocation);
 103 static void gtk_viewport_adjustment_value_changed (GtkAdjustment    *adjustment,
 104                                                    gpointer          data);
 105 static void gtk_viewport_style_set                (GtkWidget        *widget,
 106                                                    GtkStyle         *previous_style);
 107
 108 static void gtk_viewport_get_preferred_width      (GtkWidget        *widget,
 109                                                    gint             *minimum_size,
 110                                                    gint             *natural_size);
 111 static void gtk_viewport_get_preferred_height     (GtkWidget        *widget,
 112                                                    gint             *minimum_size,
 113                                                    gint             *natural_size);
 114
 115
 116 G_DEFINE_TYPE_WITH_CODE (GtkViewport, gtk_viewport, GTK_TYPE_BIN,
 117                          G_IMPLEMENT_INTERFACE (GTK_TYPE_SCROLLABLE, NULL))
 118
 119 static void
 120 gtk_viewport_class_init (GtkViewportClass *class)
 121 {
 122   GObjectClass   *gobject_class;
 123   GtkWidgetClass *widget_class;
 124   GtkContainerClass *container_class;
 125
 126   gobject_class = G_OBJECT_CLASS (class);
 127   widget_class = (GtkWidgetClass*) class;
 128   container_class = (GtkContainerClass*) class;
 129
 130   gobject_class->finalize = gtk_viewport_finalize;
 131   gobject_class->set_property = gtk_viewport_set_property;
 132   gobject_class->get_property = gtk_viewport_get_property;
 133
 134   widget_class->destroy = gtk_viewport_destroy;
 135   widget_class->realize = gtk_viewport_realize;
 136   widget_class->unrealize = gtk_viewport_unrealize;
 137   widget_class->draw = gtk_viewport_draw;
 138   widget_class->size_allocate = gtk_viewport_size_allocate;
 139   widget_class->style_set = gtk_viewport_style_set;
 140   widget_class->get_preferred_width = gtk_viewport_get_preferred_width;
 141   widget_class->get_preferred_height = gtk_viewport_get_preferred_height;
 142
 143   container_class->add = gtk_viewport_add;
 144
 145   /* GtkScrollable implementation */
 146   g_object_class_override_property (gobject_class, PROP_HADJUSTMENT,    "hadjustment");
 147   g_object_class_override_property (gobject_class, PROP_VADJUSTMENT,    "vadjustment");
 148   g_object_class_override_property (gobject_class, PROP_HSCROLL_POLICY, "hscroll-policy");
 149   g_object_class_override_property (gobject_class, PROP_VSCROLL_POLICY, "vscroll-policy");
 150
 151   g_object_class_install_property (gobject_class,
 152                                    PROP_SHADOW_TYPE,
 153                                    g_param_spec_enum ("shadow-type",
 154                                                       P_("Shadow type"),
 155                                                       P_("Determines how the shadowed box around the viewport is drawn"),
 156                                                       GTK_TYPE_SHADOW_TYPE,
 157                                                       GTK_SHADOW_IN,
 158                                                       GTK_PARAM_READWRITE));
 159
 160   g_type_class_add_private (class, sizeof (GtkViewportPrivate));
 161 }
 162
 163 static void
 164 gtk_viewport_set_property (GObject         *object,
 165                            guint            prop_id,
 166                            const GValue    *value,
 167                            GParamSpec      *pspec)
 168 {
 169   GtkViewport *viewport;
 170
 171   viewport = GTK_VIEWPORT (object);
 172
 173   switch (prop_id)
 174     {
 175     case PROP_HADJUSTMENT:
 176       gtk_viewport_set_hadjustment (viewport, g_value_get_object (value));
 177       break;
 178     case PROP_VADJUSTMENT:
 179       gtk_viewport_set_vadjustment (viewport, g_value_get_object (value));
 180       break;
 181     case PROP_HSCROLL_POLICY:
 182       viewport->priv->hscroll_policy = g_value_get_enum (value);
 183       gtk_widget_queue_resize (GTK_WIDGET (viewport));
 184       break;
 185     case PROP_VSCROLL_POLICY:
 186       viewport->priv->vscroll_policy = g_value_get_enum (value);
 187       gtk_widget_queue_resize (GTK_WIDGET (viewport));
 188       break;
 189     case PROP_SHADOW_TYPE:
 190       gtk_viewport_set_shadow_type (viewport, g_value_get_enum (value));
 191       break;
 192     default:
 193       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 194       break;
 195     }
 196 }
 197
 198 static void
 199 gtk_viewport_get_property (GObject         *object,
 200                            guint            prop_id,
 201                            GValue          *value,
 202                            GParamSpec      *pspec)
 203 {
 204   GtkViewport *viewport = GTK_VIEWPORT (object);
 205   GtkViewportPrivate *priv = viewport->priv;
 206
 207   switch (prop_id)
 208     {
 209     case PROP_HADJUSTMENT:
 210       g_value_set_object (value, priv->hadjustment);
 211       break;
 212     case PROP_VADJUSTMENT:
 213       g_value_set_object (value, priv->vadjustment);
 214       break;
 215     case PROP_HSCROLL_POLICY:
 216       g_value_set_enum (value, priv->hscroll_policy);
 217       break;
 218     case PROP_VSCROLL_POLICY:
 219       g_value_set_enum (value, priv->vscroll_policy);
 220       break;
 221     case PROP_SHADOW_TYPE:
 222       g_value_set_enum (value, priv->shadow_type);
 223       break;
 224     default:
 225       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 226       break;
 227     }
 228 }
 229
 230 static void
 231 gtk_viewport_init (GtkViewport *viewport)
 232 {
 233   GtkViewportPrivate *priv;
 234
 235   viewport->priv = G_TYPE_INSTANCE_GET_PRIVATE (viewport,
 236                                                 GTK_TYPE_VIEWPORT,
 237                                                 GtkViewportPrivate);
 238   priv = viewport->priv;
 239
 240   gtk_widget_set_has_window (GTK_WIDGET (viewport), TRUE);
 241
 242   gtk_widget_set_redraw_on_allocate (GTK_WIDGET (viewport), FALSE);
 243   gtk_container_set_resize_mode (GTK_CONTAINER (viewport), GTK_RESIZE_QUEUE);
 244
 245   priv->shadow_type = GTK_SHADOW_IN;
 246   priv->view_window = NULL;
 247   priv->bin_window = NULL;
 248   priv->hadjustment = NULL;
 249   priv->vadjustment = NULL;
 250 }
 251
 252 /**
 253  * gtk_viewport_new:
 254  * @hadjustment: horizontal adjustment.
 255  * @vadjustment: vertical adjustment.
 256  * @returns: a new #GtkViewport.
 257  *
 258  * Creates a new #GtkViewport with the given adjustments.
 259  *
 260  **/
 261 GtkWidget*
 262 gtk_viewport_new (GtkAdjustment *hadjustment,
 263                   GtkAdjustment *vadjustment)
 264 {
 265   GtkWidget *viewport;
 266
 267   viewport = g_object_new (GTK_TYPE_VIEWPORT,
 268                              "hadjustment", hadjustment,
 269                              "vadjustment", vadjustment,
 270                              NULL);
 271
 272   return viewport;
 273 }
 274
 275 #define ADJUSTMENT_POINTER(viewport, orientation)         \
 276   (((orientation) == GTK_ORIENTATION_HORIZONTAL) ?        \
 277      &(viewport)->priv->hadjustment : &(viewport)->priv->vadjustment)
 278
 279 static void
 280 viewport_disconnect_adjustment (GtkViewport    *viewport,
 281                                 GtkOrientation  orientation)
 282 {
 283   GtkAdjustment **adjustmentp = ADJUSTMENT_POINTER (viewport, orientation);
 284
 285   if (*adjustmentp)
 286     {
 287       g_signal_handlers_disconnect_by_func (*adjustmentp,
 288                                             gtk_viewport_adjustment_value_changed,
 289                                             viewport);
 290       g_object_unref (*adjustmentp);
 291       *adjustmentp = NULL;
 292     }
 293 }
 294
 295 static void
 296 gtk_viewport_finalize (GObject *object)
 297 {
 298   GtkViewport *viewport = GTK_VIEWPORT (object);
 299
 300   viewport_disconnect_adjustment (viewport, GTK_ORIENTATION_HORIZONTAL);
 301   viewport_disconnect_adjustment (viewport, GTK_ORIENTATION_VERTICAL);
 302
 303   G_OBJECT_CLASS (gtk_viewport_parent_class)->finalize (object);
 304 }
 305
 306 static void
 307 gtk_viewport_destroy (GtkWidget *widget)
 308 {
 309   GtkViewport *viewport = GTK_VIEWPORT (widget);
 310
 311   viewport_disconnect_adjustment (viewport, GTK_ORIENTATION_HORIZONTAL);
 312   viewport_disconnect_adjustment (viewport, GTK_ORIENTATION_VERTICAL);
 313
 314   GTK_WIDGET_CLASS (gtk_viewport_parent_class)->destroy (widget);
 315 }
 316
 317 static void
 318 viewport_get_view_allocation (GtkViewport   *viewport,
 319                               GtkAllocation *view_allocation)
 320 {
 321   GtkViewportPrivate *priv = viewport->priv;
 322   GtkStyle *style;
 323   GtkWidget *widget = GTK_WIDGET (viewport);
 324   GtkAllocation allocation;
 325   guint border_width;
 326
 327   gtk_widget_get_allocation (widget, &allocation);
 328   border_width = gtk_container_get_border_width (GTK_CONTAINER (viewport));
 329
 330   view_allocation->x = 0;
 331   view_allocation->y = 0;
 332
 333   if (priv->shadow_type != GTK_SHADOW_NONE)
 334     {
 335       style = gtk_widget_get_style (widget);
 336       view_allocation->x = style->xthickness;
 337       view_allocation->y = style->ythickness;
 338     }
 339
 340   view_allocation->width = MAX (1, allocation.width - view_allocation->x * 2 - border_width * 2);
 341   view_allocation->height = MAX (1, allocation.height - view_allocation->y * 2 - border_width * 2);
 342 }
 343
 344 static void
 345 viewport_reclamp_adjustment (GtkAdjustment *adjustment,
 346                              gboolean      *value_changed)
 347 {
 348   gdouble value = adjustment->value;
 349
 350   value = CLAMP (value, 0, adjustment->upper - adjustment->page_size);
 351   if (value != adjustment->value)
 352     {
 353       adjustment->value = value;
 354       if (value_changed)
 355         *value_changed = TRUE;
 356     }
 357   else if (value_changed)
 358     *value_changed = FALSE;
 359 }
 360
 361 /**
 362  * gtk_viewport_get_hadjustment:
 363  * @viewport: a #GtkViewport.
 364  *
 365  * Returns the horizontal adjustment of the viewport.
 366  *
 367  * Return value: (transfer none): the horizontal adjustment of @viewport.
 368  *
 369  * Deprecated: 3.0: Use gtk_scrollable_get_hadjustment()
 370  **/
 371 GtkAdjustment*
 372 gtk_viewport_get_hadjustment (GtkViewport *viewport)
 373 {
 374   GtkViewportPrivate *priv;
 375
 376   g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
 377
 378   priv = viewport->priv;
 379
 380   if (!priv->hadjustment)
 381     gtk_viewport_set_hadjustment (viewport, NULL);
 382
 383   return priv->hadjustment;
 384 }
 385
 386 /**
 387  * gtk_viewport_get_vadjustment:
 388  * @viewport: a #GtkViewport.
 389  *
 390  * Returns the vertical adjustment of the viewport.
 391  *
 392  * Return value: (transfer none): the vertical adjustment of @viewport.
 393  *
 394  * Deprecated: 3.0: Use gtk_scrollable_get_vadjustment()
 395  **/
 396 GtkAdjustment*
 397 gtk_viewport_get_vadjustment (GtkViewport *viewport)
 398 {
 399   GtkViewportPrivate *priv;
 400
 401   g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
 402
 403   priv = viewport->priv;
 404
 405   if (!priv->vadjustment)
 406     gtk_viewport_set_vadjustment (viewport, NULL);
 407
 408   return priv->vadjustment;
 409 }
 410
 411 static void
 412 viewport_set_hadjustment_values (GtkViewport *viewport,
 413                                  gboolean    *value_changed)
 414 {
 415   GtkBin *bin = GTK_BIN (viewport);
 416   GtkAllocation view_allocation;
 417   GtkAdjustment *hadjustment = gtk_viewport_get_hadjustment (viewport);
 418   GtkWidget *child;
 419   gdouble old_page_size;
 420   gdouble old_upper;
 421   gdouble old_value;
 422
 423   viewport_get_view_allocation (viewport, &view_allocation);
 424
 425   old_page_size = hadjustment->page_size;
 426   old_upper = hadjustment->upper;
 427   old_value = hadjustment->value;
 428   hadjustment->page_size = view_allocation.width;
 429   hadjustment->step_increment = view_allocation.width * 0.1;
 430   hadjustment->page_increment = view_allocation.width * 0.9;
 431
 432   hadjustment->lower = 0;
 433
 434   child = gtk_bin_get_child (bin);
 435   if (child && gtk_widget_get_visible (child))
 436     {
 437       gint minimum_width, natural_width;
 438       gint scroll_height;
 439
 440       if (viewport->priv->vscroll_policy == GTK_SCROLL_MINIMUM)
 441         gtk_widget_get_preferred_height (child, &scroll_height, NULL);
 442       else
 443         gtk_widget_get_preferred_height (child, NULL, &scroll_height);
 444
 445       gtk_widget_get_preferred_width_for_height (child,
 446                                                  MAX (view_allocation.height, scroll_height),
 447                                                  &minimum_width,
 448                                                  &natural_width);
 449
 450       if (viewport->priv->hscroll_policy == GTK_SCROLL_MINIMUM)
 451         hadjustment->upper = MAX (minimum_width, view_allocation.width);
 452       else
 453         hadjustment->upper = MAX (natural_width, view_allocation.width);
 454     }
 455   else
 456     hadjustment->upper = view_allocation.width;
 457
 458   if (gtk_widget_get_direction (GTK_WIDGET (viewport)) == GTK_TEXT_DIR_RTL)
 459     {
 460       gdouble dist = old_upper - (old_value + old_page_size);
 461       hadjustment->value = hadjustment->upper - dist - hadjustment->page_size;
 462       viewport_reclamp_adjustment (hadjustment, value_changed);
 463       *value_changed = (old_value != hadjustment->value);
 464     }
 465   else
 466     viewport_reclamp_adjustment (hadjustment, value_changed);
 467 }
 468
 469 static void
 470 viewport_set_vadjustment_values (GtkViewport *viewport,
 471                                  gboolean    *value_changed)
 472 {
 473   GtkBin *bin = GTK_BIN (viewport);
 474   GtkAllocation view_allocation;
 475   GtkAdjustment *vadjustment = gtk_viewport_get_vadjustment (viewport);
 476   GtkWidget *child;
 477
 478   viewport_get_view_allocation (viewport, &view_allocation);
 479
 480   vadjustment->page_size = view_allocation.height;
 481   vadjustment->step_increment = view_allocation.height * 0.1;
 482   vadjustment->page_increment = view_allocation.height * 0.9;
 483
 484   vadjustment->lower = 0;
 485
 486   child = gtk_bin_get_child (bin);
 487   if (child && gtk_widget_get_visible (child))
 488     {
 489       gint minimum_height, natural_height;
 490       gint scroll_width;
 491
 492       if (viewport->priv->hscroll_policy == GTK_SCROLL_MINIMUM)
 493         gtk_widget_get_preferred_width (child, &scroll_width, NULL);
 494       else
 495         gtk_widget_get_preferred_width (child, NULL, &scroll_width);
 496
 497       gtk_widget_get_preferred_height_for_width (child,
 498                                                  MAX (view_allocation.width, scroll_width),
 499                                                  &minimum_height,
 500                                                  &natural_height);
 501
 502       if (viewport->priv->vscroll_policy == GTK_SCROLL_MINIMUM)
 503         vadjustment->upper = MAX (minimum_height, view_allocation.height);
 504       else
 505         vadjustment->upper = MAX (natural_height, view_allocation.height);
 506     }
 507   else
 508     vadjustment->upper = view_allocation.height;
 509
 510   viewport_reclamp_adjustment (vadjustment, value_changed);
 511 }
 512
 513 static void
 514 viewport_set_adjustment (GtkViewport    *viewport,
 515                          GtkOrientation  orientation,
 516                          GtkAdjustment  *adjustment)
 517 {
 518   GtkAdjustment **adjustmentp = ADJUSTMENT_POINTER (viewport, orientation);
 519   gboolean value_changed;
 520
 521   if (adjustment && adjustment == *adjustmentp)
 522     return;
 523
 524   if (!adjustment)
 525     adjustment = gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
 526   viewport_disconnect_adjustment (viewport, orientation);
 527   *adjustmentp = adjustment;
 528   g_object_ref_sink (adjustment);
 529
 530   if (orientation == GTK_ORIENTATION_HORIZONTAL)
 531     viewport_set_hadjustment_values (viewport, &value_changed);
 532   else
 533     viewport_set_vadjustment_values (viewport, &value_changed);
 534
 535   g_signal_connect (adjustment, "value-changed",
 536                     G_CALLBACK (gtk_viewport_adjustment_value_changed),
 537                     viewport);
 538
 539   gtk_adjustment_changed (adjustment);
 540
 541   if (value_changed)
 542     gtk_adjustment_value_changed (adjustment);
 543   else
 544     gtk_viewport_adjustment_value_changed (adjustment, viewport);
 545 }
 546
 547 /**
 548  * gtk_viewport_set_hadjustment:
 549  * @viewport: a #GtkViewport.
 550  * @adjustment: (allow-none): a #GtkAdjustment.
 551  *
 552  * Sets the horizontal adjustment of the viewport.
 553  *
 554  * Deprecated: 3.0: Use gtk_scrollable_set_hadjustment()
 555  **/
 556 void
 557 gtk_viewport_set_hadjustment (GtkViewport   *viewport,
 558                               GtkAdjustment *adjustment)
 559 {
 560   g_return_if_fail (GTK_IS_VIEWPORT (viewport));
 561   if (adjustment)
 562     g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
 563
 564   viewport_set_adjustment (viewport, GTK_ORIENTATION_HORIZONTAL, adjustment);
 565
 566   g_object_notify (G_OBJECT (viewport), "hadjustment");
 567 }
 568
 569 /**
 570  * gtk_viewport_set_vadjustment:
 571  * @viewport: a #GtkViewport.
 572  * @adjustment: (allow-none): a #GtkAdjustment.
 573  *
 574  * Sets the vertical adjustment of the viewport.
 575  *
 576  * Deprecated: 3.0: Use gtk_scrollable_set_vadjustment()
 577  **/
 578 void
 579 gtk_viewport_set_vadjustment (GtkViewport   *viewport,
 580                               GtkAdjustment *adjustment)
 581 {
 582   g_return_if_fail (GTK_IS_VIEWPORT (viewport));
 583   if (adjustment)
 584     g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
 585
 586   viewport_set_adjustment (viewport, GTK_ORIENTATION_VERTICAL, adjustment);
 587
 588   g_object_notify (G_OBJECT (viewport), "vadjustment");
 589 }
 590
 591 /**
 592  * gtk_viewport_set_shadow_type:
 593  * @viewport: a #GtkViewport.
 594  * @type: the new shadow type.
 595  *
 596  * Sets the shadow type of the viewport.
 597  **/
 598 void
 599 gtk_viewport_set_shadow_type (GtkViewport   *viewport,
 600                               GtkShadowType  type)
 601 {
 602   GtkViewportPrivate *priv;
 603   GtkAllocation allocation;
 604   GtkWidget *widget;
 605
 606   g_return_if_fail (GTK_IS_VIEWPORT (viewport));
 607
 608   widget = GTK_WIDGET (viewport);
 609   priv = viewport->priv;
 610
 611   if ((GtkShadowType) priv->shadow_type != type)
 612     {
 613       priv->shadow_type = type;
 614
 615       if (gtk_widget_get_visible (widget))
 616         {
 617           gtk_widget_get_allocation (widget, &allocation);
 618           gtk_widget_size_allocate (widget, &allocation);
 619           gtk_widget_set_allocation (widget, &allocation);
 620           gtk_widget_queue_draw (widget);
 621         }
 622
 623       g_object_notify (G_OBJECT (viewport), "shadow-type");
 624     }
 625 }
 626
 627 /**
 628  * gtk_viewport_get_shadow_type:
 629  * @viewport: a #GtkViewport
 630  *
 631  * Gets the shadow type of the #GtkViewport. See
 632  * gtk_viewport_set_shadow_type().
 633  *
 634  * Return value: the shadow type
 635  **/
 636 GtkShadowType
 637 gtk_viewport_get_shadow_type (GtkViewport *viewport)
 638 {
 639   g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), GTK_SHADOW_NONE);
 640
 641   return viewport->priv->shadow_type;
 642 }
 643
 644 /**
 645  * gtk_viewport_get_bin_window:
 646  * @viewport: a #GtkViewport
 647  *
 648  * Gets the bin window of the #GtkViewport.
 649  *
 650  * Return value: (transfer none): a #GdkWindow
 651  *
 652  * Since: 2.20
 653  **/
 654 GdkWindow*
 655 gtk_viewport_get_bin_window (GtkViewport *viewport)
 656 {
 657   g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
 658
 659   return viewport->priv->bin_window;
 660 }
 661
 662 /**
 663  * gtk_viewport_get_view_window:
 664  * @viewport: a #GtkViewport
 665  *
 666  * Gets the view window of the #GtkViewport.
 667  *
 668  * Return value: (transfer none): a #GdkWindow
 669  *
 670  * Since: 2.22
 671  **/
 672 GdkWindow*
 673 gtk_viewport_get_view_window (GtkViewport *viewport)
 674 {
 675   g_return_val_if_fail (GTK_IS_VIEWPORT (viewport), NULL);
 676
 677   return viewport->priv->view_window;
 678 }
 679
 680 static void
 681 gtk_viewport_realize (GtkWidget *widget)
 682 {
 683   GtkViewport *viewport = GTK_VIEWPORT (widget);
 684   GtkViewportPrivate *priv = viewport->priv;
 685   GtkBin *bin = GTK_BIN (widget);
 686   GtkAdjustment *hadjustment = gtk_viewport_get_hadjustment (viewport);
 687   GtkAdjustment *vadjustment = gtk_viewport_get_vadjustment (viewport);
 688   GtkAllocation allocation;
 689   GtkAllocation view_allocation;
 690   GtkStyle *style;
 691   GtkWidget *child;
 692   GdkWindow *window;
 693   GdkWindowAttr attributes;
 694   gint attributes_mask;
 695   gint event_mask;
 696   guint border_width;
 697
 698   border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
 699
 700   gtk_widget_set_realized (widget, TRUE);
 701
 702   gtk_widget_get_allocation (widget, &allocation);
 703
 704   attributes.x = allocation.x + border_width;
 705   attributes.y = allocation.y + border_width;
 706   attributes.width = allocation.width - border_width * 2;
 707   attributes.height = allocation.height - border_width * 2;
 708   attributes.window_type = GDK_WINDOW_CHILD;
 709   attributes.wclass = GDK_INPUT_OUTPUT;
 710   attributes.visual = gtk_widget_get_visual (widget);
 711
 712   event_mask = gtk_widget_get_events (widget) | GDK_EXPOSURE_MASK;
 713   /* We select on button_press_mask so that button 4-5 scrolls are trapped.
 714    */
 715   attributes.event_mask = event_mask | GDK_BUTTON_PRESS_MASK;
 716
 717   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
 718
 719   window = gdk_window_new (gtk_widget_get_parent_window (widget),
 720                            &attributes, attributes_mask);
 721   gtk_widget_set_window (widget, window);
 722   gdk_window_set_user_data (window, viewport);
 723
 724   viewport_get_view_allocation (viewport, &view_allocation);
 725
 726   attributes.x = view_allocation.x;
 727   attributes.y = view_allocation.y;
 728   attributes.width = view_allocation.width;
 729   attributes.height = view_allocation.height;
 730   attributes.event_mask = 0;
 731
 732   priv->view_window = gdk_window_new (window,
 733                                       &attributes, attributes_mask);
 734   gdk_window_set_user_data (priv->view_window, viewport);
 735
 736   attributes.x = - hadjustment->value;
 737   attributes.y = - vadjustment->value;
 738   attributes.width = hadjustment->upper;
 739   attributes.height = vadjustment->upper;
 740
 741   attributes.event_mask = event_mask;
 742
 743   priv->bin_window = gdk_window_new (priv->view_window, &attributes, attributes_mask);
 744   gdk_window_set_user_data (priv->bin_window, viewport);
 745
 746   child = gtk_bin_get_child (bin);
 747   if (child)
 748     gtk_widget_set_parent_window (child, priv->bin_window);
 749
 750   gtk_widget_style_attach (widget);
 751   style = gtk_widget_get_style (widget);
 752   gtk_style_set_background (style, window, GTK_STATE_NORMAL);
 753   gtk_style_set_background (style, priv->bin_window, GTK_STATE_NORMAL);
 754
 755   gdk_window_show (priv->bin_window);
 756   gdk_window_show (priv->view_window);
 757 }
 758
 759 static void
 760 gtk_viewport_unrealize (GtkWidget *widget)
 761 {
 762   GtkViewport *viewport = GTK_VIEWPORT (widget);
 763   GtkViewportPrivate *priv = viewport->priv;
 764
 765   gdk_window_set_user_data (priv->view_window, NULL);
 766   gdk_window_destroy (priv->view_window);
 767   priv->view_window = NULL;
 768
 769   gdk_window_set_user_data (priv->bin_window, NULL);
 770   gdk_window_destroy (priv->bin_window);
 771   priv->bin_window = NULL;
 772
 773   GTK_WIDGET_CLASS (gtk_viewport_parent_class)->unrealize (widget);
 774 }
 775
 776 static gint
 777 gtk_viewport_draw (GtkWidget *widget,
 778                    cairo_t   *cr)
 779 {
 780   GtkViewport *viewport = GTK_VIEWPORT (widget);
 781   GtkViewportPrivate *priv = viewport->priv;
 782   int x, y;
 783
 784   if (gtk_cairo_should_draw_window (cr, gtk_widget_get_window (widget)))
 785     {
 786       gtk_paint_shadow (gtk_widget_get_style (widget),
 787                         cr,
 788                         GTK_STATE_NORMAL, priv->shadow_type,
 789                         widget, "viewport",
 790                         0, 0,
 791                         gdk_window_get_width (gtk_widget_get_window (widget)),
 792                         gdk_window_get_height (gtk_widget_get_window (widget)));
 793     }
 794
 795   if (gtk_cairo_should_draw_window (cr, priv->view_window))
 796     {
 797       /* This is a cute hack to ensure the contents of bin_window are
 798        * restricted to where they are visible. We only need to do this
 799        * clipping when called via gtk_widget_draw() and not in expose
 800        * events. And when that happens every window (including this one)
 801        * should be drawn.
 802        */
 803       gdk_window_get_position (priv->view_window, &x, &y);
 804       cairo_rectangle (cr, x, y,
 805                        gdk_window_get_width (priv->view_window),
 806                        gdk_window_get_height (priv->view_window));
 807       cairo_clip (cr);
 808     }
 809
 810   if (gtk_cairo_should_draw_window (cr, priv->bin_window))
 811     {
 812       gdk_window_get_position (priv->bin_window, &x, &y);
 813       gtk_paint_flat_box (gtk_widget_get_style (widget), cr,
 814                           GTK_STATE_NORMAL, GTK_SHADOW_NONE,
 815                           widget, "viewportbin",
 816                           x, y,
 817                           gdk_window_get_width (priv->bin_window),
 818                           gdk_window_get_height (priv->bin_window));
 819
 820       GTK_WIDGET_CLASS (gtk_viewport_parent_class)->draw (widget, cr);
 821     }
 822
 823   return FALSE;
 824 }
 825
 826 static void
 827 gtk_viewport_add (GtkContainer *container,
 828                   GtkWidget    *child)
 829 {
 830   GtkBin *bin = GTK_BIN (container);
 831   GtkViewport *viewport = GTK_VIEWPORT (bin);
 832   GtkViewportPrivate *priv = viewport->priv;
 833
 834   g_return_if_fail (gtk_bin_get_child (bin) == NULL);
 835
 836   gtk_widget_set_parent_window (child, priv->bin_window);
 837
 838   GTK_CONTAINER_CLASS (gtk_viewport_parent_class)->add (container, child);
 839 }
 840
 841 static void
 842 gtk_viewport_size_allocate (GtkWidget     *widget,
 843                             GtkAllocation *allocation)
 844 {
 845   GtkAllocation widget_allocation;
 846   GtkViewport *viewport = GTK_VIEWPORT (widget);
 847   GtkViewportPrivate *priv = viewport->priv;
 848   GtkBin *bin = GTK_BIN (widget);
 849   guint border_width;
 850   gboolean hadjustment_value_changed, vadjustment_value_changed;
 851   GtkAdjustment *hadjustment = gtk_viewport_get_hadjustment (viewport);
 852   GtkAdjustment *vadjustment = gtk_viewport_get_vadjustment (viewport);
 853   GtkAllocation child_allocation;
 854   GtkWidget *child;
 855
 856   border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
 857
 858   /* If our size changed, and we have a shadow, queue a redraw on widget->window to
 859    * redraw the shadow correctly.
 860    */
 861   gtk_widget_get_allocation (widget, &widget_allocation);
 862   if (gtk_widget_get_mapped (widget) &&
 863       priv->shadow_type != GTK_SHADOW_NONE &&
 864       (widget_allocation.width != allocation->width ||
 865        widget_allocation.height != allocation->height))
 866     gdk_window_invalidate_rect (gtk_widget_get_window (widget), NULL, FALSE);
 867
 868   gtk_widget_set_allocation (widget, allocation);
 869
 870   viewport_set_hadjustment_values (viewport, &hadjustment_value_changed);
 871   viewport_set_vadjustment_values (viewport, &vadjustment_value_changed);
 872
 873   child_allocation.x = 0;
 874   child_allocation.y = 0;
 875   child_allocation.width = hadjustment->upper;
 876   child_allocation.height = vadjustment->upper;
 877   if (gtk_widget_get_realized (widget))
 878     {
 879       GtkAllocation view_allocation;
 880
 881       gdk_window_move_resize (gtk_widget_get_window (widget),
 882                               allocation->x + border_width,
 883                               allocation->y + border_width,
 884                               allocation->width - border_width * 2,
 885                               allocation->height - border_width * 2);
 886
 887       viewport_get_view_allocation (viewport, &view_allocation);
 888       gdk_window_move_resize (priv->view_window,
 889                               view_allocation.x,
 890                               view_allocation.y,
 891                               view_allocation.width,
 892                               view_allocation.height);
 893       gdk_window_move_resize (priv->bin_window,
 894                               - hadjustment->value,
 895                               - vadjustment->value,
 896                               child_allocation.width,
 897                               child_allocation.height);
 898     }
 899
 900   child = gtk_bin_get_child (bin);
 901   if (child && gtk_widget_get_visible (child))
 902     gtk_widget_size_allocate (child, &child_allocation);
 903
 904   gtk_adjustment_changed (hadjustment);
 905   gtk_adjustment_changed (vadjustment);
 906   if (hadjustment_value_changed)
 907     gtk_adjustment_value_changed (hadjustment);
 908   if (vadjustment_value_changed)
 909     gtk_adjustment_value_changed (vadjustment);
 910 }
 911
 912 static void
 913 gtk_viewport_adjustment_value_changed (GtkAdjustment *adjustment,
 914                                        gpointer       data)
 915 {
 916   GtkViewport *viewport = GTK_VIEWPORT (data);
 917   GtkViewportPrivate *priv = viewport->priv;
 918   GtkBin *bin = GTK_BIN (data);
 919   GtkWidget *child;
 920
 921   child = gtk_bin_get_child (bin);
 922   if (child && gtk_widget_get_visible (child) &&
 923       gtk_widget_get_realized (GTK_WIDGET (viewport)))
 924     {
 925       GtkAdjustment *hadjustment = gtk_viewport_get_hadjustment (viewport);
 926       GtkAdjustment *vadjustment = gtk_viewport_get_vadjustment (viewport);
 927       gint old_x, old_y;
 928       gint new_x, new_y;
 929
 930       gdk_window_get_position (priv->bin_window, &old_x, &old_y);
 931       new_x = - hadjustment->value;
 932       new_y = - vadjustment->value;
 933
 934       if (new_x != old_x || new_y != old_y)
 935         {
 936           gdk_window_move (priv->bin_window, new_x, new_y);
 937           gdk_window_process_updates (priv->bin_window, TRUE);
 938         }
 939     }
 940 }
 941
 942 static void
 943 gtk_viewport_style_set (GtkWidget *widget,
 944                         GtkStyle  *previous_style)
 945 {
 946    if (gtk_widget_get_realized (widget) &&
 947        gtk_widget_get_has_window (widget))
 948      {
 949         GtkStyle *style;
 950         GtkViewport *viewport = GTK_VIEWPORT (widget);
 951         GtkViewportPrivate *priv = viewport->priv;
 952
 953         style = gtk_widget_get_style (widget);
 954         gtk_style_set_background (style, priv->bin_window, GTK_STATE_NORMAL);
 955         gtk_style_set_background (style,
 956                                   gtk_widget_get_window (widget),
 957                                   gtk_widget_get_state (widget));
 958      }
 959 }
 960
 961
 962 static void
 963 gtk_viewport_get_preferred_size (GtkWidget      *widget,
 964                                  GtkOrientation  orientation,
 965                                  gint           *minimum_size,
 966                                  gint           *natural_size)
 967 {
 968   GtkViewport *viewport = GTK_VIEWPORT (widget);
 969   GtkViewportPrivate *priv = viewport->priv;
 970   GtkStyle  *style;
 971   GtkWidget *child;
 972   gint       child_min, child_nat;
 973   gint       minimum, natural;
 974
 975   child = gtk_bin_get_child (GTK_BIN (widget));
 976
 977   /* XXX This should probably be (border_width * 2); but GTK+ has
 978    * been doing this with a single border for a while now...
 979    */
 980   minimum = gtk_container_get_border_width (GTK_CONTAINER (widget));
 981
 982   if (priv->shadow_type != GTK_SHADOW_NONE)
 983     {
 984       style = gtk_widget_get_style (GTK_WIDGET (widget));
 985       if (orientation == GTK_ORIENTATION_HORIZONTAL)
 986           minimum += 2 * style->xthickness;
 987       else
 988           minimum += 2 * style->ythickness;
 989     }
 990
 991   natural = minimum;
 992
 993   if (child && gtk_widget_get_visible (child))
 994     {
 995       if (orientation == GTK_ORIENTATION_HORIZONTAL)
 996         gtk_widget_get_preferred_width (child, &child_min, &child_nat);
 997       else
 998         gtk_widget_get_preferred_height (child, &child_min, &child_nat);
 999
1000       minimum += child_min;
1001       natural += child_nat;
1002     }
1003
1004   if (minimum_size)
1005     *minimum_size = minimum;
1006
1007   if (natural_size)
1008     *natural_size = natural;
1009 }
1010
1011 static void
1012 gtk_viewport_get_preferred_width (GtkWidget *widget,
1013                                   gint      *minimum_size,
1014                                   gint      *natural_size)
1015 {
1016   gtk_viewport_get_preferred_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
1017 }
1018
1019 static void
1020 gtk_viewport_get_preferred_height (GtkWidget *widget,
1021                                    gint      *minimum_size,
1022                                    gint      *natural_size)
1023 {
1024   gtk_viewport_get_preferred_size (widget, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
1025 }