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 gboolean 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_set_has_window (GTK_WIDGET (event_box), TRUE);
 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_get_has_window (GTK_WIDGET (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 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_get_has_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           gtk_widget_set_has_window (widget, visible_window);
 257
 258           gtk_widget_realize (widget);
 259
 260           if (visible)
 261             gtk_widget_show (widget);
 262         }
 263       else
 264         {
 265           gtk_widget_set_has_window (widget, visible_window);
 266         }
 267
 268       if (GTK_WIDGET_VISIBLE (widget))
 269         gtk_widget_queue_resize (widget);
 270
 271       g_object_notify (G_OBJECT (event_box), "visible-window");
 272     }
 273 }
 274
 275 /**
 276  * gtk_event_box_get_above_child:
 277  * @event_box: a #GtkEventBox
 278  *
 279  * Returns whether the event box window is above or below the
 280  * windows of its child. See gtk_event_box_set_above_child() for
 281  * details.
 282  *
 283  * Return value: %TRUE if the event box window is above the window
 284  * of its child.
 285  *
 286  * Since: 2.4
 287  **/
 288 gboolean
 289 gtk_event_box_get_above_child (GtkEventBox *event_box)
 290 {
 291   GtkEventBoxPrivate *priv;
 292
 293   g_return_val_if_fail (GTK_IS_EVENT_BOX (event_box), FALSE);
 294
 295   priv = GTK_EVENT_BOX_GET_PRIVATE (event_box);
 296
 297   return priv->above_child;
 298 }
 299
 300 /**
 301  * gtk_event_box_set_above_child:
 302  * @event_box: a #GtkEventBox
 303  * @above_child: %TRUE if the event box window is above the windows of its child
 304  *
 305  * Set whether the event box window is positioned above the windows of its child,
 306  * as opposed to below it. If the window is above, all events inside the
 307  * event box will go to the event box. If the window is below, events
 308  * in windows of child widgets will first got to that widget, and then
 309  * to its parents.
 310  *
 311  * The default is to keep the window below the child.
 312  *
 313  * Since: 2.4
 314  **/
 315 void
 316 gtk_event_box_set_above_child (GtkEventBox *event_box,
 317                                gboolean above_child)
 318 {
 319   GtkWidget *widget;
 320   GtkEventBoxPrivate *priv;
 321
 322   g_return_if_fail (GTK_IS_EVENT_BOX (event_box));
 323
 324   widget = GTK_WIDGET (event_box);
 325   priv = GTK_EVENT_BOX_GET_PRIVATE (event_box);
 326
 327   above_child = above_child != FALSE;
 328
 329   if (priv->above_child != above_child)
 330     {
 331       priv->above_child = above_child;
 332
 333       if (GTK_WIDGET_REALIZED (widget))
 334         {
 335           if (!gtk_widget_get_has_window (widget))
 336             {
 337               if (above_child)
 338                 gdk_window_raise (priv->event_window);
 339               else
 340                 gdk_window_lower (priv->event_window);
 341             }
 342           else
 343             {
 344               gboolean visible = GTK_WIDGET_VISIBLE (widget);
 345
 346               if (visible)
 347                 gtk_widget_hide (widget);
 348
 349               gtk_widget_unrealize (widget);
 350
 351               gtk_widget_realize (widget);
 352
 353               if (visible)
 354                 gtk_widget_show (widget);
 355             }
 356         }
 357
 358       if (GTK_WIDGET_VISIBLE (widget))
 359         gtk_widget_queue_resize (widget);
 360
 361       g_object_notify (G_OBJECT (event_box), "above-child");
 362     }
 363 }
 364
 365
 366 static void
 367 gtk_event_box_realize (GtkWidget *widget)
 368 {
 369   GdkWindowAttr attributes;
 370   gint attributes_mask;
 371   gint border_width;
 372   GtkEventBoxPrivate *priv;
 373   gboolean visible_window;
 374
 375   GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
 376
 377   border_width = GTK_CONTAINER (widget)->border_width;
 378
 379   attributes.x = widget->allocation.x + border_width;
 380   attributes.y = widget->allocation.y + border_width;
 381   attributes.width = widget->allocation.width - 2*border_width;
 382   attributes.height = widget->allocation.height - 2*border_width;
 383   attributes.window_type = GDK_WINDOW_CHILD;
 384   attributes.event_mask = gtk_widget_get_events (widget)
 385                         | GDK_BUTTON_MOTION_MASK
 386                         | GDK_BUTTON_PRESS_MASK
 387                         | GDK_BUTTON_RELEASE_MASK
 388                         | GDK_EXPOSURE_MASK
 389                         | GDK_ENTER_NOTIFY_MASK
 390                         | GDK_LEAVE_NOTIFY_MASK;
 391
 392   priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 393
 394   visible_window = gtk_widget_get_has_window (widget);
 395   if (visible_window)
 396     {
 397       attributes.visual = gtk_widget_get_visual (widget);
 398       attributes.colormap = gtk_widget_get_colormap (widget);
 399       attributes.wclass = GDK_INPUT_OUTPUT;
 400
 401       attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
 402
 403       widget->window = gdk_window_new (gtk_widget_get_parent_window (widget),
 404                                        &attributes, attributes_mask);
 405       gdk_window_set_user_data (widget->window, widget);
 406     }
 407   else
 408     {
 409       widget->window = gtk_widget_get_parent_window (widget);
 410       g_object_ref (widget->window);
 411     }
 412
 413   if (!visible_window || priv->above_child)
 414     {
 415       attributes.wclass = GDK_INPUT_ONLY;
 416       if (!visible_window)
 417         attributes_mask = GDK_WA_X | GDK_WA_Y;
 418       else
 419         attributes_mask = 0;
 420
 421       priv->event_window = gdk_window_new (widget->window,
 422                                            &attributes, attributes_mask);
 423       gdk_window_set_user_data (priv->event_window, widget);
 424     }
 425
 426
 427   widget->style = gtk_style_attach (widget->style, widget->window);
 428
 429   if (visible_window)
 430     gtk_style_set_background (widget->style, widget->window, GTK_STATE_NORMAL);
 431 }
 432
 433 static void
 434 gtk_event_box_unrealize (GtkWidget *widget)
 435 {
 436   GtkEventBoxPrivate *priv;
 437
 438   priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 439
 440   if (priv->event_window != NULL)
 441     {
 442       gdk_window_set_user_data (priv->event_window, NULL);
 443       gdk_window_destroy (priv->event_window);
 444       priv->event_window = NULL;
 445     }
 446
 447   GTK_WIDGET_CLASS (gtk_event_box_parent_class)->unrealize (widget);
 448 }
 449
 450 static void
 451 gtk_event_box_map (GtkWidget *widget)
 452 {
 453   GtkEventBoxPrivate *priv;
 454
 455   priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 456
 457   if (priv->event_window != NULL && !priv->above_child)
 458     gdk_window_show (priv->event_window);
 459
 460   GTK_WIDGET_CLASS (gtk_event_box_parent_class)->map (widget);
 461
 462   if (priv->event_window != NULL && priv->above_child)
 463     gdk_window_show (priv->event_window);
 464 }
 465
 466 static void
 467 gtk_event_box_unmap (GtkWidget *widget)
 468 {
 469   GtkEventBoxPrivate *priv;
 470
 471   priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 472
 473   if (priv->event_window != NULL)
 474     gdk_window_hide (priv->event_window);
 475
 476   GTK_WIDGET_CLASS (gtk_event_box_parent_class)->unmap (widget);
 477 }
 478
 479
 480
 481 static void
 482 gtk_event_box_size_request (GtkWidget      *widget,
 483                             GtkRequisition *requisition)
 484 {
 485   GtkBin *bin = GTK_BIN (widget);
 486
 487   requisition->width = GTK_CONTAINER (widget)->border_width * 2;
 488   requisition->height = GTK_CONTAINER (widget)->border_width * 2;
 489
 490   if (bin->child && GTK_WIDGET_VISIBLE (bin->child))
 491     {
 492       GtkRequisition child_requisition;
 493
 494       gtk_widget_size_request (bin->child, &child_requisition);
 495
 496       requisition->width += child_requisition.width;
 497       requisition->height += child_requisition.height;
 498     }
 499 }
 500
 501 static void
 502 gtk_event_box_size_allocate (GtkWidget     *widget,
 503                              GtkAllocation *allocation)
 504 {
 505   GtkBin *bin;
 506   GtkAllocation child_allocation;
 507   GtkEventBoxPrivate *priv;
 508
 509   widget->allocation = *allocation;
 510   bin = GTK_BIN (widget);
 511
 512   if (!gtk_widget_get_has_window (widget))
 513     {
 514       child_allocation.x = allocation->x + GTK_CONTAINER (widget)->border_width;
 515       child_allocation.y = allocation->y + GTK_CONTAINER (widget)->border_width;
 516     }
 517   else
 518     {
 519       child_allocation.x = 0;
 520       child_allocation.y = 0;
 521     }
 522   child_allocation.width = MAX (allocation->width - GTK_CONTAINER (widget)->border_width * 2, 0);
 523   child_allocation.height = MAX (allocation->height - GTK_CONTAINER (widget)->border_width * 2, 0);
 524
 525   if (GTK_WIDGET_REALIZED (widget))
 526     {
 527       priv = GTK_EVENT_BOX_GET_PRIVATE (widget);
 528
 529       if (priv->event_window != NULL)
 530         gdk_window_move_resize (priv->event_window,
 531                                 child_allocation.x,
 532                                 child_allocation.y,
 533                                 child_allocation.width,
 534                                 child_allocation.height);
 535
 536       if (gtk_widget_get_has_window (widget))
 537         gdk_window_move_resize (widget->window,
 538                                 allocation->x + GTK_CONTAINER (widget)->border_width,
 539                                 allocation->y + GTK_CONTAINER (widget)->border_width,
 540                                 child_allocation.width,
 541                                 child_allocation.height);
 542     }
 543
 544   if (bin->child)
 545     gtk_widget_size_allocate (bin->child, &child_allocation);
 546 }
 547
 548 static void
 549 gtk_event_box_paint (GtkWidget    *widget,
 550                      GdkRectangle *area)
 551 {
 552   if (!gtk_widget_get_app_paintable (widget))
 553     gtk_paint_flat_box (widget->style, widget->window,
 554                         widget->state, GTK_SHADOW_NONE,
 555                         area, widget, "eventbox",
 556                         0, 0, -1, -1);
 557 }
 558
 559 static gboolean
 560 gtk_event_box_expose (GtkWidget      *widget,
 561                      GdkEventExpose *event)
 562 {
 563   if (gtk_widget_is_drawable (widget))
 564     {
 565       if (gtk_widget_get_has_window (widget))
 566         gtk_event_box_paint (widget, &event->area);
 567
 568       GTK_WIDGET_CLASS (gtk_event_box_parent_class)->expose_event (widget, event);
 569     }
 570
 571   return FALSE;
 572 }
 573
 574 #define __GTK_EVENT_BOX_C__
 575 #include "gtkaliasdef.c"