Pileus Git - ~andy/gtk/blob - gtk/gtkeventbox.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 #include "gtkeventbox.h"
  29 #include "gtkprivate.h"
  30 #include "gtkintl.h"
  31 #include "gtkalias.h"
  32
  33 typedef struct
  34 {
  35   gboolean above_child;
  36   GdkWindow *event_window;
  37 } GtkEventBoxPrivate;
  38
  39 enum {
  40   PROP_0,
  41   PROP_VISIBLE_WINDOW,
  42   PROP_ABOVE_CHILD
  43 };
  44
  45
  46 #define GTK_EVENT_BOX_GET_PRIVATE(obj)  G_TYPE_INSTANCE_GET_PRIVATE((obj), GTK_TYPE_EVENT_BOX, GtkEventBoxPrivate)
  47
  48 static void gtk_event_box_realize       (GtkWidget        *widget);
  49 static void gtk_event_box_unrealize     (GtkWidget        *widget);
  50 static void gtk_event_box_map           (GtkWidget        *widget);
  51 static void gtk_event_box_unmap         (GtkWidget        *widget);
  52 static void gtk_event_box_size_request  (GtkWidget        *widget,
  53                                          GtkRequisition   *requisition);
  54 static void gtk_event_box_size_allocate (GtkWidget        *widget,
  55                                          GtkAllocation    *allocation);
  56 static void gtk_event_box_paint         (GtkWidget        *widget,
  57                                          GdkRectangle     *area);
  58 static gint gtk_event_box_expose        (GtkWidget        *widget,
  59                                          GdkEventExpose   *event);
  60 static void gtk_event_box_set_property  (GObject          *object,
  61                                          guint             prop_id,
  62                                          const GValue     *value,
  63                                          GParamSpec       *pspec);
  64 static void gtk_event_box_get_property  (GObject          *object,
  65                                          guint             prop_id,
  66                                          GValue           *value,
  67                                          GParamSpec       *pspec);
  68
  69 G_DEFINE_TYPE (GtkEventBox, gtk_event_box, GTK_TYPE_BIN);
  70
  71 static void
  72 gtk_event_box_class_init (GtkEventBoxClass *class)
  73 {
  74   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
  75   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
  76
  77   gobject_class->set_property = gtk_event_box_set_property;
  78   gobject_class->get_property = gtk_event_box_get_property;
  79
  80   widget_class->realize = gtk_event_box_realize;
  81   widget_class->unrealize = gtk_event_box_unrealize;
  82   widget_class->map = gtk_event_box_map;
  83   widget_class->unmap = gtk_event_box_unmap;
  84   widget_class->size_request = gtk_event_box_size_request;
  85   widget_class->size_allocate = gtk_event_box_size_allocate;
  86   widget_class->expose_event = gtk_event_box_expose;
  87
  88   g_object_class_install_property (gobject_class,
  89                                    PROP_VISIBLE_WINDOW,
  90                                    g_param_spec_boolean ("visible-window",
  91                                                         P_("Visible Window"),
  92                                                         P_("Whether the event box is visible, as opposed to invisible and only used to trap events."),
  93                                                         TRUE,
  94                                                         GTK_PARAM_READWRITE));
  95   g_object_class_install_property (gobject_class,
  96                                    PROP_ABOVE_CHILD,
  97                                    g_param_spec_boolean ("above-child",
  98                                                         P_("Above child"),
  99                                                         P_("Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it."),
 100                                                         FALSE,
 101                                                         GTK_PARAM_READWRITE));
 102
 103   g_type_class_add_private (class, sizeof (GtkEventBoxPrivate));
 104 }
 105
 106 static void
 107 gtk_event_box_init (GtkEventBox *event_box)
 108 {
 109   GtkEventBoxPrivate *priv;
 110
 111   GTK_WIDGET_UNSET_FLAGS (event_box, GTK_NO_WINDOW);
 112
 113   priv = GTK_EVENT_BOX_GET_PRIVATE (event_box);
 114   priv->above_child = FALSE;
 115 }
 116
 117 GtkWidget*
 118 gtk_event_box_new (void)
 119 {
 120   return g_object_new (GTK_TYPE_EVENT_BOX, NULL);
 121 }
 122
 123 static void
 124 gtk_event_box_set_property (GObject      *object,
 125                             guint         prop_id,
 126                             const GValue *value,
 127                             GParamSpec   *pspec)
 128 {
 129   GtkEventBox *event_box;
 130
 131   event_box = GTK_EVENT_BOX (object);
 132
 133   switch (prop_id)
 134     {
 135     case PROP_VISIBLE_WINDOW:
 136       gtk_event_box_set_visible_window (event_box, g_value_get_boolean (value));
 137       break;
 138     case PROP_ABOVE_CHILD:
 139       gtk_event_box_set_above_child (event_box, g_value_get_boolean (value));
 140       break;
 141     default:
 142       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 143       break;
 144     }
 145 }
 146
 147 static void
 148 gtk_event_box_get_property (GObject     *object,
 149                             guint        prop_id,
 150                             GValue      *value,
 151                             GParamSpec  *pspec)
 152 {
 153   GtkEventBox *event_box;
 154
 155   event_box = GTK_EVENT_BOX (object);
 156
 157   switch (prop_id)
 158     {
 159     case PROP_VISIBLE_WINDOW:
 160       g_value_set_boolean (value, gtk_event_box_get_visible_window (event_box));
 161       break;
 162     case PROP_ABOVE_CHILD:
 163       g_value_set_boolean (value, gtk_event_box_get_above_child (event_box));
 164       break;
 165     default:
 166       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 167       break;
 168     }
 169 }
 170
 171 /**
 172  * gtk_event_box_get_visible_window:
 173  * @event_box: a #GtkEventBox
 174  *
 175  * Returns whether the event box has a visible window.
 176  * See gtk_event_box_set_visible_window() for details.
 177  *
 178  * Return value: %TRUE if the event box window is visible
 179  *
 180  * Since: 2.4
 181  **/
 182 gboolean
 183 gtk_event_box_get_visible_window (GtkEventBox *event_box)
 184 {
 185   g_return_val_if_fail (GTK_IS_EVENT_BOX (event_box), FALSE);
 186
 187   return !GTK_WIDGET_NO_WINDOW (event_box);
 188 }
 189
 190 /**
 191  * gtk_event_box_set_visible_window:
 192  * @event_box: a #GtkEventBox
 193  * @visible_window: boolean value
 194  *
 195  * Set whether the event box uses a visible or invisible child
 196  * window. The default is to use visible windows.
 197  *
 198  * In an invisible window event box, the window that that the
 199  * event box creates is a %GDK_INPUT_ONLY window, which
 200  * means that it is invisible and only serves to receive
 201  * events.
 202  *
 203  * A visible window event box creates a visible (%GDK_INPUT_OUTPUT)
 204  * window that acts as the parent window for all the widgets
 205  * contained in the event box.
 206  *
 207  * You should generally make your event box invisible if
 208  * you just want to trap events. Creating a visible window
 209  * may cause artifacts that are visible to the user, especially
 210  * if the user is using a theme with gradients or pixmaps.
 211  *
 212  * The main reason to create a non input-only event box is if
 213  * you want to set the background to a different color or
 214  * draw on it.
 215  *
 216  * <note><para>
 217  * There is one unexpected issue for an invisible event box that has its
 218  * window below the child. (See gtk_event_box_set_above_child().)
 219  * Since the input-only window is not an ancestor window of any windows
 220  * that descendent widgets of the event box create, events on these
 221  * windows aren't propagated up by the windowing system, but only by GTK+.
 222  * The practical effect of this is if an event isn't in the event
 223  * mask for the descendant window (see gtk_widget_add_events()),
 224  * it won't be received by the event box.
 225  * </para><para>
 226  * This problem doesn't occur for visible event boxes, because in
 227  * that case, the event box window is actually the ancestor of the
 228  * descendant windows, not just at the same place on the screen.
 229  * </para></note>
 230  *
 231  * Since: 2.4
 232  **/
 233 void
 234 gtk_event_box_set_visible_window (GtkEventBox *event_box,
 235                                   gboolean visible_window)
 236 {
 237   GtkWidget *widget;
 238
 239   g_return_if_fail (GTK_IS_EVENT_BOX (event_box));
 240
 241   widget = GTK_WIDGET (event_box);
 242
 243   visible_window = visible_window != FALSE;
 244
 245   if (visible_window != !GTK_WIDGET_NO_WINDOW (widget))
 246     {
 247       if (GTK_WIDGET_REALIZED (widget))
 248         {
 249           gboolean visible = GTK_WIDGET_VISIBLE (widget);
 250
 251           if (visible)
 252             gtk_widget_hide (widget);
 253
 254           gtk_widget_unrealize (widget);
 255
 256           if (visible_window)
 257             GTK_WIDGET_UNSET_FLAGS (widget, GTK_NO_WINDOW);
 258           else
 259             GTK_WIDGET_SET_FLAGS (widget, GTK_NO_WINDOW);
 260
 261           gtk_widget_realize (widget);
 262
 263           if (visible)
 264             gtk_widget_show (widget);
 265         }
 266       else
 267         {
 268           if (visible_window)
 269             GTK_WIDGET_UNSET_FLAGS (widget, GTK_NO_WINDOW);
 270           else
 271             GTK_WIDGET_SET_FLAGS (widget, GTK_NO_WINDOW);
 272         }
 273
 274       if (GTK_WIDGET_VISIBLE (widget))
 275         gtk_widget_queue_resize (widget);
 276
 277       g_object_notify (G_OBJECT (event_box), "visible-window");
 278     }
 279 }
 280
 281 /**
 282  * gtk_event_box_get_above_child:
 283  * @event_box: a #GtkEventBox
 284  *
 285  * Returns whether the event box window is above or below the
 286  * windows of its child. See gtk_event_box_set_above_child() for
 287  * details.
 288  *
 289  * Return value: %TRUE if the event box window is above the window
 290  * of its child.
 291  *
 292  * Since: 2.4
 293  **/
 294 gboolean
 295 gtk_event_box_get_above_child (GtkEventBox *event_box)
 296 {
 297   GtkEventBoxPrivate *priv;
 298
 299   g_return_val_if_fail (GTK_IS_EVENT_BOX (event_box), FALSE);
 300
 301   priv = GTK_EVENT_BOX_GET_PRIVATE (event_box);
 302
 303   return priv->above_child;
 304 }
 305
 306 /**
 307  * gtk_event_box_set_above_child:
 308  * @event_box: a #GtkEventBox
 309  * @above_child: %TRUE if the event box window is above the windows of its child
 310  *
 311  * Set whether the event box window is positioned above the windows of its child,
 312  * as opposed to below it. If the window is above, all events inside the
 313  * event box will go to the event box. If the window is below, events
 314  * in windows of child widgets will first got to that widget, and then
 315  * to its parents.
 316  *
 317  * The default is to keep the window below the child.
 318  *
 319  * Since: 2.4
 320  **/
 321 void
 322 gtk_event_box_set_above_child (GtkEventBox *event_box,
 323                                gboolean above_child)
 324 {
 325   GtkWidget *widget;
 326   GtkEventBoxPrivate *priv;
 327
 328   g_return_if_fail (GTK_IS_EVENT_BOX (event_box));
 329
 330   widget = GTK_WIDGET (event_box);
 331   priv = GTK_EVENT_BOX_GET_PRIVATE (event_box);
 332
 333   above_child = above_child != FALSE;
 334
 335   if (priv->above_child != above_child)
 336     {
 337       priv->above_child = above_child;
 338
 339       if (GTK_WIDGET_REALIZED (widget))
 340         {
 341           if (GTK_WIDGET_NO_WINDOW (widget))
 342             {
 343               if (above_child)
 344                 gdk_window_raise (priv->event_window);
 345               else
 346                 gdk_window_lower (priv->event_window);
 347             }
 348           else
 349             {
 350               gboolean visible = GTK_WIDGET_VISIBLE (widget);
 351
 352               if (visible)
 353                 gtk_widget_hide (widget);
 354
 355               gtk_widget_unrealize (widget);
 356
 357               gtk_widget_realize (widget);
 358
 359               if (visible)
 360                 gtk_widget_show (widget);
 361             }
 362         }
 363
 364       if (GTK_WIDGET_VISIBLE (widget))
 365         gtk_widget_queue_resize (widget);
 366
 367       g_object_notify (G_OBJECT (event_box), "above-child");
 368     }
 369 }
 370
 371
 372
 373 static void
 374 gtk_event_box_realize (GtkWidget *widget)
 375 {
 376   GdkWindowAttr attributes;
 377   gint attributes_mask;
 378   gint border_width;
 379   GtkEventBoxPrivate *priv;
 380   gboolean visible_window;
 381
 382   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
 383
 384   border_width = GTK_CONTAINER (widget)->border_width;
 385
 386   attributes.x = widget->allocation.x + border_width;
 387   attributes.y = widget->allocation.y + border_width;
 388   attributes.width = widget->allocation.width - 2*border_width;
 389   attributes.height = widget->allocation.height - 2*border_width;
 390   attributes.window_type = GDK_WINDOW_CHILD;
 391   attributes.event_mask = gtk_widget_get_events (widget)
 392                         | GDK_BUTTON_MOTION_MASK
 393                         | GDK_BUTTON_PRESS_MASK
 394                         | GDK_BUTTON_RELEASE_MASK
 395                         | GDK_EXPOSURE_MASK
 396                         | GDK_ENTER_NOTIFY_MASK
 397                         | GDK_LEAVE_NOTIFY_MASK;
 398
 399   priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 400
 401   visible_window = !GTK_WIDGET_NO_WINDOW (widget);
 402   if (visible_window)
 403     {
 404       attributes.visual = gtk_widget_get_visual (widget);
 405       attributes.colormap = gtk_widget_get_colormap (widget);
 406       attributes.wclass = GDK_INPUT_OUTPUT;
 407
 408       attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
 409
 410       widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
 411                                        &attributes, attributes_mask);
 412       gdk_window_set_user_data (widget->window, widget);
 413     }
 414   else
 415     {
 416       widget->window = gtk_widget_get_parent_window (widget);
 417       g_object_ref (widget->window);
 418     }
 419
 420   if (!visible_window || priv->above_child)
 421     {
 422       attributes.wclass = GDK_INPUT_ONLY;
 423       attributes_mask = GDK_WA_X | GDK_WA_Y;
 424
 425       priv->event_window = gdk_window_new (widget->window,
 426                                            &attributes, attributes_mask);
 427       gdk_window_set_user_data (priv->event_window, widget);
 428     }
 429
 430
 431   widget->style = gtk_style_attach (widget->style, widget->window);
 432
 433   if (visible_window)
 434     gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
 435 }
 436
 437 static void
 438 gtk_event_box_unrealize (GtkWidget *widget)
 439 {
 440   GtkEventBoxPrivate *priv;
 441
 442   priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 443
 444   if (priv->event_window != NULL)
 445     {
 446       gdk_window_set_user_data (priv->event_window, NULL);
 447       gdk_window_destroy (priv->event_window);
 448       priv->event_window = NULL;
 449     }
 450
 451   if (GTK_WIDGET_CLASS (gtk_event_box_parent_class)->unrealize)
 452     (* GTK_WIDGET_CLASS (gtk_event_box_parent_class)->unrealize) (widget);
 453 }
 454
 455 static void
 456 gtk_event_box_map (GtkWidget *widget)
 457 {
 458   GtkEventBoxPrivate *priv;
 459
 460   priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 461
 462   if (priv->event_window != NULL && !priv->above_child)
 463     gdk_window_show (priv->event_window);
 464
 465   (* GTK_WIDGET_CLASS (gtk_event_box_parent_class)->map) (widget);
 466
 467   if (priv->event_window != NULL && priv->above_child)
 468     gdk_window_show (priv->event_window);
 469 }
 470
 471 static void
 472 gtk_event_box_unmap (GtkWidget *widget)
 473 {
 474   GtkEventBoxPrivate *priv;
 475
 476   priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 477
 478   if (priv->event_window != NULL)
 479     gdk_window_hide (priv->event_window);
 480
 481   (* GTK_WIDGET_CLASS (gtk_event_box_parent_class)->unmap) (widget);
 482 }
 483
 484
 485
 486 static void
 487 gtk_event_box_size_request (GtkWidget      *widget,
 488                             GtkRequisition *requisition)
 489 {
 490   GtkBin *bin = GTK_BIN (widget);
 491
 492   requisition->width = GTK_CONTAINER (widget)->border_width * 2;
 493   requisition->height = GTK_CONTAINER (widget)->border_width * 2;
 494
 495   if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
 496     {
 497       GtkRequisition child_requisition;
 498
 499       gtk_widget_size_request (bin->child, &child_requisition);
 500
 501       requisition->width += child_requisition.width;
 502       requisition->height += child_requisition.height;
 503     }
 504 }
 505
 506 static void
 507 gtk_event_box_size_allocate (GtkWidget     *widget,
 508                              GtkAllocation *allocation)
 509 {
 510   GtkBin *bin;
 511   GtkAllocation child_allocation;
 512   GtkEventBoxPrivate *priv;
 513
 514   widget->allocation = *allocation;
 515   bin = GTK_BIN (widget);
 516
 517   if (GTK_WIDGET_NO_WINDOW (widget))
 518     {
 519       child_allocation.x = allocation->x + GTK_CONTAINER (widget)->border_width;
 520       child_allocation.y = allocation->y + GTK_CONTAINER (widget)->border_width;
 521     }
 522   else
 523     {
 524       child_allocation.x = 0;
 525       child_allocation.y = 0;
 526     }
 527   child_allocation.width = MAX (allocation->width - GTK_CONTAINER (widget)->border_width * 2, 0);
 528   child_allocation.height = MAX (allocation->height - GTK_CONTAINER (widget)->border_width * 2, 0);
 529
 530   if (GTK_WIDGET_REALIZED (widget))
 531     {
 532       priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 533
 534       if (priv->event_window != NULL)
 535         gdk_window_move_resize (priv->event_window,
 536                                 child_allocation.x,
 537                                 child_allocation.y,
 538                                 child_allocation.width,
 539                                 child_allocation.height);
 540
 541       if (!GTK_WIDGET_NO_WINDOW (widget))
 542         gdk_window_move_resize (widget->window,
 543                                 allocation->x + GTK_CONTAINER (widget)->border_width,
 544                                 allocation->y + GTK_CONTAINER (widget)->border_width,
 545                                 child_allocation.width,
 546                                 child_allocation.height);
 547     }
 548
 549   if (bin->child)
 550     gtk_widget_size_allocate (bin->child, &child_allocation);
 551 }
 552
 553 static void
 554 gtk_event_box_paint (GtkWidget    *widget,
 555                      GdkRectangle *area)
 556 {
 557   if (!GTK_WIDGET_APP_PAINTABLE (widget))
 558     gtk_paint_flat_box (widget->style, widget->window,
 559                         widget->state, GTK_SHADOW_NONE,
 560                         area, widget, "eventbox",
 561                         0, 0, -1, -1);
 562 }
 563
 564 static gint
 565 gtk_event_box_expose (GtkWidget      *widget,
 566                      GdkEventExpose *event)
 567 {
 568   if (GTK_WIDGET_DRAWABLE (widget))
 569     {
 570       if (!GTK_WIDGET_NO_WINDOW (widget))
 571         gtk_event_box_paint (widget, &event->area);
 572
 573       (* GTK_WIDGET_CLASS (gtk_event_box_parent_class)->expose_event) (widget, event);
 574     }
 575
 576   return FALSE;
 577 }
 578
 579 #define __GTK_EVENT_BOX_C__
 580 #include "gtkaliasdef.c"