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

   1 /* gtkseparatortoolitem.c
   2  *
   3  * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
   4  * Copyright (C) 2002 James Henstridge <james@daa.com.au>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #include "config.h"
  23 #include "gtkseparatormenuitem.h"
  24 #include "gtkseparatortoolitem.h"
  25 #include "gtkintl.h"
  26 #include "gtktoolbar.h"
  27 #include "gtkprivate.h"
  28
  29 /**
  30  * SECTION:gtkseparatortoolitem
  31  * @Short_description: A toolbar item that separates groups of other
  32  *   toolbar items
  33  * @Title: GtkSeparatorToolItem
  34  * @See_also: #GtkToolbar, #GtkRadioToolButton
  35  *
  36  * A #GtkSeparatorItem is a #GtkToolItem that separates groups of other
  37  * #GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will
  38  * often look like a vertical line on horizontally docked toolbars.
  39  *
  40  * If the #GtkToolbar child property "expand" is %TRUE and the property
  41  * #GtkSeparatorToolItem:draw is %FALSE, a #GtkSeparatorToolItem will act as
  42  * a "spring" that forces other items to the ends of the toolbar.
  43  *
  44  * Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem.
  45  */
  46
  47 #define MENU_ID "gtk-separator-tool-item-menu-id"
  48
  49 struct _GtkSeparatorToolItemPrivate
  50 {
  51   GdkWindow *event_window;
  52   guint draw : 1;
  53 };
  54
  55 enum {
  56   PROP_0,
  57   PROP_DRAW
  58 };
  59
  60 static gboolean gtk_separator_tool_item_create_menu_proxy (GtkToolItem               *item);
  61 static void     gtk_separator_tool_item_set_property      (GObject                   *object,
  62                                                            guint                      prop_id,
  63                                                            const GValue              *value,
  64                                                            GParamSpec                *pspec);
  65 static void     gtk_separator_tool_item_get_property      (GObject                   *object,
  66                                                            guint                      prop_id,
  67                                                            GValue                    *value,
  68                                                            GParamSpec                *pspec);
  69 static void     gtk_separator_tool_item_get_preferred_width (GtkWidget               *widget,
  70                                                            gint                      *minimum,
  71                                                            gint                      *natural);
  72 static void     gtk_separator_tool_item_get_preferred_height (GtkWidget              *widget,
  73                                                            gint                      *minimum,
  74                                                            gint                      *natural);
  75 static void     gtk_separator_tool_item_size_allocate     (GtkWidget                 *widget,
  76                                                            GtkAllocation             *allocation);
  77 static gboolean gtk_separator_tool_item_draw              (GtkWidget                 *widget,
  78                                                            cairo_t                   *cr);
  79 static void     gtk_separator_tool_item_add               (GtkContainer              *container,
  80                                                            GtkWidget                 *child);
  81 static gint     get_space_size                            (GtkToolItem               *tool_item);
  82 static void     gtk_separator_tool_item_realize           (GtkWidget                 *widget);
  83 static void     gtk_separator_tool_item_unrealize         (GtkWidget                 *widget);
  84 static void     gtk_separator_tool_item_map               (GtkWidget                 *widget);
  85 static void     gtk_separator_tool_item_unmap             (GtkWidget                 *widget);
  86 static gboolean gtk_separator_tool_item_button_event      (GtkWidget                 *widget,
  87                                                            GdkEventButton            *event);
  88
  89
  90 G_DEFINE_TYPE (GtkSeparatorToolItem, gtk_separator_tool_item, GTK_TYPE_TOOL_ITEM)
  91
  92 static gint
  93 get_space_size (GtkToolItem *tool_item)
  94 {
  95   gint space_size = _gtk_toolbar_get_default_space_size();
  96   GtkWidget *parent;
  97
  98   parent = gtk_widget_get_parent (GTK_WIDGET (tool_item));
  99
 100   if (GTK_IS_TOOLBAR (parent))
 101     {
 102       gtk_widget_style_get (parent,
 103                             "space-size", &space_size,
 104                             NULL);
 105     }
 106
 107   return space_size;
 108 }
 109
 110 static void
 111 gtk_separator_tool_item_class_init (GtkSeparatorToolItemClass *class)
 112 {
 113   GObjectClass *object_class;
 114   GtkContainerClass *container_class;
 115   GtkToolItemClass *toolitem_class;
 116   GtkWidgetClass *widget_class;
 117
 118   object_class = (GObjectClass *)class;
 119   container_class = (GtkContainerClass *)class;
 120   toolitem_class = (GtkToolItemClass *)class;
 121   widget_class = (GtkWidgetClass *)class;
 122
 123   object_class->set_property = gtk_separator_tool_item_set_property;
 124   object_class->get_property = gtk_separator_tool_item_get_property;
 125   widget_class->get_preferred_width = gtk_separator_tool_item_get_preferred_width;
 126   widget_class->get_preferred_height = gtk_separator_tool_item_get_preferred_height;
 127   widget_class->size_allocate = gtk_separator_tool_item_size_allocate;
 128   widget_class->draw = gtk_separator_tool_item_draw;
 129   widget_class->realize = gtk_separator_tool_item_realize;
 130   widget_class->unrealize = gtk_separator_tool_item_unrealize;
 131   widget_class->map = gtk_separator_tool_item_map;
 132   widget_class->unmap = gtk_separator_tool_item_unmap;
 133   widget_class->button_press_event = gtk_separator_tool_item_button_event;
 134   widget_class->button_release_event = gtk_separator_tool_item_button_event;
 135
 136   toolitem_class->create_menu_proxy = gtk_separator_tool_item_create_menu_proxy;
 137
 138   container_class->add = gtk_separator_tool_item_add;
 139
 140   g_object_class_install_property (object_class,
 141                                    PROP_DRAW,
 142                                    g_param_spec_boolean ("draw",
 143                                                          P_("Draw"),
 144                                                          P_("Whether the separator is drawn, or just blank"),
 145                                                          TRUE,
 146                                                          GTK_PARAM_READWRITE));
 147
 148
 149   g_type_class_add_private (object_class, sizeof (GtkSeparatorToolItemPrivate));
 150 }
 151
 152 static void
 153 gtk_separator_tool_item_init (GtkSeparatorToolItem *separator_item)
 154 {
 155   separator_item->priv = G_TYPE_INSTANCE_GET_PRIVATE (separator_item,
 156                                                       GTK_TYPE_SEPARATOR_TOOL_ITEM,
 157                                                       GtkSeparatorToolItemPrivate);
 158   separator_item->priv->draw = TRUE;
 159
 160   gtk_widget_set_has_window (GTK_WIDGET (separator_item), FALSE);
 161 }
 162
 163 static void
 164 gtk_separator_tool_item_add (GtkContainer *container,
 165                              GtkWidget    *child)
 166 {
 167   g_warning ("attempt to add a child to an GtkSeparatorToolItem");
 168 }
 169
 170 static gboolean
 171 gtk_separator_tool_item_create_menu_proxy (GtkToolItem *item)
 172 {
 173   GtkWidget *menu_item = NULL;
 174
 175   menu_item = gtk_separator_menu_item_new();
 176
 177   gtk_tool_item_set_proxy_menu_item (item, MENU_ID, menu_item);
 178
 179   return TRUE;
 180 }
 181
 182 static void
 183 gtk_separator_tool_item_set_property (GObject      *object,
 184                                       guint         prop_id,
 185                                       const GValue *value,
 186                                       GParamSpec   *pspec)
 187 {
 188   GtkSeparatorToolItem *item = GTK_SEPARATOR_TOOL_ITEM (object);
 189
 190   switch (prop_id)
 191     {
 192     case PROP_DRAW:
 193       gtk_separator_tool_item_set_draw (item, g_value_get_boolean (value));
 194       break;
 195     default:
 196       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 197       break;
 198     }
 199 }
 200
 201 static void
 202 gtk_separator_tool_item_get_property (GObject      *object,
 203                                       guint         prop_id,
 204                                       GValue       *value,
 205                                       GParamSpec   *pspec)
 206 {
 207   GtkSeparatorToolItem *item = GTK_SEPARATOR_TOOL_ITEM (object);
 208
 209   switch (prop_id)
 210     {
 211     case PROP_DRAW:
 212       g_value_set_boolean (value, gtk_separator_tool_item_get_draw (item));
 213       break;
 214     default:
 215       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 216       break;
 217     }
 218 }
 219
 220 static void
 221 gtk_separator_tool_item_get_preferred_size (GtkWidget      *widget,
 222                                             GtkOrientation  orientation,
 223                                             gint           *minimum,
 224                                             gint           *natural)
 225 {
 226   if (gtk_tool_item_get_orientation (GTK_TOOL_ITEM (widget)) == orientation)
 227     *minimum = *natural = get_space_size (GTK_TOOL_ITEM (widget));
 228   else
 229     *minimum = *natural = 1;
 230 }
 231
 232 static void
 233 gtk_separator_tool_item_get_preferred_width (GtkWidget *widget,
 234                                              gint      *minimum,
 235                                              gint      *natural)
 236 {
 237   gtk_separator_tool_item_get_preferred_size (widget,
 238                                               GTK_ORIENTATION_HORIZONTAL,
 239                                               minimum,
 240                                               natural);
 241 }
 242
 243 static void
 244 gtk_separator_tool_item_get_preferred_height (GtkWidget *widget,
 245                                               gint      *minimum,
 246                                               gint      *natural)
 247 {
 248   gtk_separator_tool_item_get_preferred_size (widget,
 249                                               GTK_ORIENTATION_VERTICAL,
 250                                               minimum,
 251                                               natural);
 252 }
 253
 254 static void
 255 gtk_separator_tool_item_size_allocate (GtkWidget     *widget,
 256                                        GtkAllocation *allocation)
 257 {
 258   GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
 259   GtkSeparatorToolItemPrivate *priv = separator->priv;
 260
 261   gtk_widget_set_allocation (widget, allocation);
 262
 263   if (gtk_widget_get_realized (widget))
 264     gdk_window_move_resize (priv->event_window,
 265                             allocation->x,
 266                             allocation->y,
 267                             allocation->width,
 268                             allocation->height);
 269
 270 }
 271
 272 static void
 273 gtk_separator_tool_item_realize (GtkWidget *widget)
 274 {
 275   GtkAllocation allocation;
 276   GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
 277   GtkSeparatorToolItemPrivate *priv = separator->priv;
 278   GdkWindow *window;
 279   GdkWindowAttr attributes;
 280   gint attributes_mask;
 281
 282   gtk_widget_set_realized (widget, TRUE);
 283
 284   gtk_widget_get_allocation (widget, &allocation);
 285
 286   attributes.window_type = GDK_WINDOW_CHILD;
 287   attributes.x = allocation.x;
 288   attributes.y = allocation.y;
 289   attributes.width = allocation.width;
 290   attributes.height = allocation.height;
 291   attributes.wclass = GDK_INPUT_ONLY;
 292   attributes.visual = gtk_widget_get_visual (widget);
 293   attributes.event_mask = gtk_widget_get_events (widget) |
 294                           GDK_BUTTON_PRESS_MASK |
 295                           GDK_BUTTON_RELEASE_MASK;
 296   attributes_mask = GDK_WA_X | GDK_WA_Y;
 297
 298   window = gtk_widget_get_parent_window (widget);
 299   gtk_widget_set_window (widget, window);
 300   g_object_ref (window);
 301
 302   priv->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
 303                                        &attributes, attributes_mask);
 304   gdk_window_set_user_data (priv->event_window, widget);
 305
 306   gtk_widget_style_attach (widget);
 307 }
 308
 309 static void
 310 gtk_separator_tool_item_unrealize (GtkWidget *widget)
 311 {
 312   GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
 313   GtkSeparatorToolItemPrivate *priv = separator->priv;
 314
 315   if (priv->event_window)
 316     {
 317       gdk_window_set_user_data (priv->event_window, NULL);
 318       gdk_window_destroy (priv->event_window);
 319       priv->event_window = NULL;
 320     }
 321
 322   GTK_WIDGET_CLASS (gtk_separator_tool_item_parent_class)->unrealize (widget);
 323 }
 324
 325 static void
 326 gtk_separator_tool_item_map (GtkWidget *widget)
 327 {
 328   GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
 329   GtkSeparatorToolItemPrivate *priv = separator->priv;
 330
 331   GTK_WIDGET_CLASS (gtk_separator_tool_item_parent_class)->map (widget);
 332
 333   if (priv->event_window)
 334     gdk_window_show (priv->event_window);
 335 }
 336
 337 static void
 338 gtk_separator_tool_item_unmap (GtkWidget *widget)
 339 {
 340   GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
 341   GtkSeparatorToolItemPrivate *priv = separator->priv;
 342
 343   if (priv->event_window)
 344     gdk_window_hide (priv->event_window);
 345
 346   GTK_WIDGET_CLASS (gtk_separator_tool_item_parent_class)->unmap (widget);
 347 }
 348
 349 static gboolean
 350 gtk_separator_tool_item_button_event (GtkWidget      *widget,
 351                                       GdkEventButton *event)
 352 {
 353   GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
 354   GtkSeparatorToolItemPrivate *priv = separator->priv;
 355
 356   /* We want window dragging to work on empty toolbar areas,
 357    * so we only eat button events on visible separators
 358    */
 359   return priv->draw;
 360 }
 361
 362 static gboolean
 363 gtk_separator_tool_item_draw (GtkWidget *widget,
 364                               cairo_t   *cr)
 365 {
 366   GtkAllocation allocation;
 367   GtkToolbar *toolbar = NULL;
 368   GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
 369   GtkSeparatorToolItemPrivate *priv = separator->priv;
 370   GtkWidget *parent;
 371
 372   if (priv->draw)
 373     {
 374       parent = gtk_widget_get_parent (widget);
 375       if (GTK_IS_TOOLBAR (parent))
 376         toolbar = GTK_TOOLBAR (parent);
 377
 378       gtk_widget_get_allocation (widget, &allocation);
 379       _gtk_toolbar_paint_space_line (widget, toolbar, cr);
 380     }
 381
 382   return FALSE;
 383 }
 384
 385 /**
 386  * gtk_separator_tool_item_new:
 387  *
 388  * Create a new #GtkSeparatorToolItem
 389  *
 390  * Return value: the new #GtkSeparatorToolItem
 391  *
 392  * Since: 2.4
 393  */
 394 GtkToolItem *
 395 gtk_separator_tool_item_new (void)
 396 {
 397   GtkToolItem *self;
 398
 399   self = g_object_new (GTK_TYPE_SEPARATOR_TOOL_ITEM,
 400                        NULL);
 401
 402   return self;
 403 }
 404
 405 /**
 406  * gtk_separator_tool_item_get_draw:
 407  * @item: a #GtkSeparatorToolItem
 408  *
 409  * Returns whether @item is drawn as a line, or just blank.
 410  * See gtk_separator_tool_item_set_draw().
 411  *
 412  * Return value: %TRUE if @item is drawn as a line, or just blank.
 413  *
 414  * Since: 2.4
 415  */
 416 gboolean
 417 gtk_separator_tool_item_get_draw (GtkSeparatorToolItem *item)
 418 {
 419   g_return_val_if_fail (GTK_IS_SEPARATOR_TOOL_ITEM (item), FALSE);
 420
 421   return item->priv->draw;
 422 }
 423
 424 /**
 425  * gtk_separator_tool_item_set_draw:
 426  * @item: a #GtkSeparatorToolItem
 427  * @draw: whether @item is drawn as a vertical line
 428  *
 429  * Whether @item is drawn as a vertical line, or just blank.
 430  * Setting this to %FALSE along with gtk_tool_item_set_expand() is useful
 431  * to create an item that forces following items to the end of the toolbar.
 432  *
 433  * Since: 2.4
 434  */
 435 void
 436 gtk_separator_tool_item_set_draw (GtkSeparatorToolItem *item,
 437                                   gboolean              draw)
 438 {
 439   g_return_if_fail (GTK_IS_SEPARATOR_TOOL_ITEM (item));
 440
 441   draw = draw != FALSE;
 442
 443   if (draw != item->priv->draw)
 444     {
 445       item->priv->draw = draw;
 446
 447       gtk_widget_queue_draw (GTK_WIDGET (item));
 448
 449       g_object_notify (G_OBJECT (item), "draw");
 450     }
 451 }