gtkseparatortoolitem.c 15.5 KB
Newer Older
1 2
/* gtkseparatortoolitem.c
 *
Anders Carlsson's avatar
Anders Carlsson committed
3
 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

22
#include "config.h"
23 24 25
#include "gtkseparatormenuitem.h"
#include "gtkseparatortoolitem.h"
#include "gtkintl.h"
26
#include "gtktoolbar.h"
27
#include "gtkprivate.h"
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

/**
 * SECTION:gtkseparatortoolitem
 * @Short_description: A toolbar item that separates groups of other
 *   toolbar items
 * @Title: GtkSeparatorToolItem
 * @See_also: #GtkToolbar, #GtkRadioToolButton
 *
 * A #GtkSeparatorItem is a #GtkToolItem that separates groups of other
 * #GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will
 * often look like a vertical line on horizontally docked toolbars.
 *
 * If the #GtkToolbar child property "expand" is %TRUE and the property
 * #GtkSeparatorToolItem:draw is %FALSE, a #GtkSeparatorToolItem will act as
 * a "spring" that forces other items to the ends of the toolbar.
 *
 * Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem.
 */

47 48
#define MENU_ID "gtk-separator-tool-item-menu-id"

49 50
struct _GtkSeparatorToolItemPrivate
{
51
  GdkWindow *event_window;
52 53 54
  guint draw : 1;
};

55 56 57 58 59 60 61
enum {
  PROP_0,
  PROP_DRAW
};

static gboolean gtk_separator_tool_item_create_menu_proxy (GtkToolItem               *item);
static void     gtk_separator_tool_item_set_property      (GObject                   *object,
62 63 64 65 66 67 68
                                                           guint                      prop_id,
                                                           const GValue              *value,
                                                           GParamSpec                *pspec);
static void     gtk_separator_tool_item_get_property      (GObject                   *object,
                                                           guint                      prop_id,
                                                           GValue                    *value,
                                                           GParamSpec                *pspec);
69 70 71 72 73 74
static void     gtk_separator_tool_item_get_preferred_width (GtkWidget               *widget,
                                                           gint                      *minimum,
                                                           gint                      *natural);
static void     gtk_separator_tool_item_get_preferred_height (GtkWidget              *widget,
                                                           gint                      *minimum,
                                                           gint                      *natural);
75 76
static void     gtk_separator_tool_item_size_allocate     (GtkWidget                 *widget,
                                                           GtkAllocation             *allocation);
77 78
static gboolean gtk_separator_tool_item_draw              (GtkWidget                 *widget,
                                                           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 83 84 85 86 87
static void     gtk_separator_tool_item_realize           (GtkWidget                 *widget);
static void     gtk_separator_tool_item_unrealize         (GtkWidget                 *widget);
static void     gtk_separator_tool_item_map               (GtkWidget                 *widget);
static void     gtk_separator_tool_item_unmap             (GtkWidget                 *widget);
static gboolean gtk_separator_tool_item_button_event      (GtkWidget                 *widget,
                                                           GdkEventButton            *event);
88 89


Matthias Clasen's avatar
Matthias Clasen committed
90
G_DEFINE_TYPE (GtkSeparatorToolItem, gtk_separator_tool_item, GTK_TYPE_TOOL_ITEM)
91

92 93 94
static gint
get_space_size (GtkToolItem *tool_item)
{
95
  gint space_size = _gtk_toolbar_get_default_space_size();
96 97 98 99
  GtkWidget *parent;

  parent = gtk_widget_get_parent (GTK_WIDGET (tool_item));

100 101 102
  if (GTK_IS_TOOLBAR (parent))
    {
      gtk_widget_style_get (parent,
103 104
                            "space-size", &space_size,
                            NULL);
105
    }
106
  
107 108
  return space_size;
}
109 110 111 112

static void
gtk_separator_tool_item_class_init (GtkSeparatorToolItemClass *class)
{
113
  GObjectClass *object_class;
114 115
  GtkContainerClass *container_class;
  GtkToolItemClass *toolitem_class;
116
  GtkWidgetClass *widget_class;
117 118
  
  object_class = (GObjectClass *)class;
119 120
  container_class = (GtkContainerClass *)class;
  toolitem_class = (GtkToolItemClass *)class;
121
  widget_class = (GtkWidgetClass *)class;
122

123 124
  object_class->set_property = gtk_separator_tool_item_set_property;
  object_class->get_property = gtk_separator_tool_item_get_property;
125 126
  widget_class->get_preferred_width = gtk_separator_tool_item_get_preferred_width;
  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 130 131 132 133 134 135
  widget_class->realize = gtk_separator_tool_item_realize;
  widget_class->unrealize = gtk_separator_tool_item_unrealize;
  widget_class->map = gtk_separator_tool_item_map;
  widget_class->unmap = gtk_separator_tool_item_unmap;
  widget_class->button_press_event = gtk_separator_tool_item_button_event;
  widget_class->button_release_event = gtk_separator_tool_item_button_event;

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 142 143 144 145 146
                                   PROP_DRAW,
                                   g_param_spec_boolean ("draw",
                                                         P_("Draw"),
                                                         P_("Whether the separator is drawn, or just blank"),
                                                         TRUE,
                                                         GTK_PARAM_READWRITE));
147
  
148

149 150 151 152
  g_type_class_add_private (object_class, sizeof (GtkSeparatorToolItemPrivate));
}

static void
153
gtk_separator_tool_item_init (GtkSeparatorToolItem *separator_item)
154
{
155 156 157
  separator_item->priv = G_TYPE_INSTANCE_GET_PRIVATE (separator_item,
                                                      GTK_TYPE_SEPARATOR_TOOL_ITEM,
                                                      GtkSeparatorToolItemPrivate);
158
  separator_item->priv->draw = TRUE;
159 160

  gtk_widget_set_has_window (GTK_WIDGET (separator_item), FALSE);
161 162 163 164
}

static void
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 171 172 173 174 175 176 177 178 179 180 181
static gboolean
gtk_separator_tool_item_create_menu_proxy (GtkToolItem *item)
{
  GtkWidget *menu_item = NULL;
  
  menu_item = gtk_separator_menu_item_new();
  
  gtk_tool_item_set_proxy_menu_item (item, MENU_ID, menu_item);
  
  return TRUE;
}

182 183
static void
gtk_separator_tool_item_set_property (GObject      *object,
184 185 186
                                      guint         prop_id,
                                      const GValue *value,
                                      GParamSpec   *pspec)
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
{
  GtkSeparatorToolItem *item = GTK_SEPARATOR_TOOL_ITEM (object);
  
  switch (prop_id)
    {
    case PROP_DRAW:
      gtk_separator_tool_item_set_draw (item, g_value_get_boolean (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
gtk_separator_tool_item_get_property (GObject      *object,
203 204 205
                                      guint         prop_id,
                                      GValue       *value,
                                      GParamSpec   *pspec)
206 207 208 209 210 211 212 213 214 215 216 217 218 219
{
  GtkSeparatorToolItem *item = GTK_SEPARATOR_TOOL_ITEM (object);
  
  switch (prop_id)
    {
    case PROP_DRAW:
      g_value_set_boolean (value, gtk_separator_tool_item_get_draw (item));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

220
static void
221 222 223 224
gtk_separator_tool_item_get_preferred_size (GtkWidget      *widget,
                                            GtkOrientation  orientation,
                                            gint           *minimum,
                                            gint           *natural)
225
{
226 227
  if (gtk_tool_item_get_orientation (GTK_TOOL_ITEM (widget)) == orientation)
    *minimum = *natural = get_space_size (GTK_TOOL_ITEM (widget));
228
  else
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
    *minimum = *natural = 1;
}

static void
gtk_separator_tool_item_get_preferred_width (GtkWidget *widget,
                                             gint      *minimum,
                                             gint      *natural)
{
  gtk_separator_tool_item_get_preferred_size (widget,
                                              GTK_ORIENTATION_HORIZONTAL,
                                              minimum,
                                              natural);
}

static void
gtk_separator_tool_item_get_preferred_height (GtkWidget *widget,
                                              gint      *minimum,
                                              gint      *natural)
{
  gtk_separator_tool_item_get_preferred_size (widget,
                                              GTK_ORIENTATION_VERTICAL,
                                              minimum,
                                              natural);
252 253
}

254 255 256 257 258 259 260
static void
gtk_separator_tool_item_size_allocate (GtkWidget     *widget,
                                       GtkAllocation *allocation)
{
  GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
  GtkSeparatorToolItemPrivate *priv = separator->priv;

261
  gtk_widget_set_allocation (widget, allocation);
262 263 264

  if (gtk_widget_get_realized (widget))
    gdk_window_move_resize (priv->event_window,
265 266 267 268
                            allocation->x,
                            allocation->y,
                            allocation->width,
                            allocation->height);
269 270 271 272 273 274

}

static void
gtk_separator_tool_item_realize (GtkWidget *widget)
{
275
  GtkAllocation allocation;
276 277
  GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
  GtkSeparatorToolItemPrivate *priv = separator->priv;
278
  GdkWindow *window;
279 280 281 282 283
  GdkWindowAttr attributes;
  gint attributes_mask;

  gtk_widget_set_realized (widget, TRUE);

284 285
  gtk_widget_get_allocation (widget, &allocation);

286
  attributes.window_type = GDK_WINDOW_CHILD;
287 288 289 290
  attributes.x = allocation.x;
  attributes.y = allocation.y;
  attributes.width = allocation.width;
  attributes.height = allocation.height;
291 292 293 294 295 296 297
  attributes.wclass = GDK_INPUT_ONLY;
  attributes.visual = gtk_widget_get_visual (widget);
  attributes.event_mask = gtk_widget_get_events (widget) |
                          GDK_BUTTON_PRESS_MASK |
                          GDK_BUTTON_RELEASE_MASK;
  attributes_mask = GDK_WA_X | GDK_WA_Y;

298 299 300
  window = gtk_widget_get_parent_window (widget);
  gtk_widget_set_window (widget, window);
  g_object_ref (window);
301 302 303 304 305

  priv->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
                                       &attributes, attributes_mask);
  gdk_window_set_user_data (priv->event_window, widget);

306
  gtk_widget_style_attach (widget);
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
}

static void
gtk_separator_tool_item_unrealize (GtkWidget *widget)
{
  GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
  GtkSeparatorToolItemPrivate *priv = separator->priv;

  if (priv->event_window)
    {
      gdk_window_set_user_data (priv->event_window, NULL);
      gdk_window_destroy (priv->event_window);
      priv->event_window = NULL;
    }

  GTK_WIDGET_CLASS (gtk_separator_tool_item_parent_class)->unrealize (widget);
}

static void
gtk_separator_tool_item_map (GtkWidget *widget)
{
  GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
  GtkSeparatorToolItemPrivate *priv = separator->priv;

  GTK_WIDGET_CLASS (gtk_separator_tool_item_parent_class)->map (widget);

  if (priv->event_window)
    gdk_window_show (priv->event_window);
}

static void
gtk_separator_tool_item_unmap (GtkWidget *widget)
{
  GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
  GtkSeparatorToolItemPrivate *priv = separator->priv;

  if (priv->event_window)
    gdk_window_hide (priv->event_window);

  GTK_WIDGET_CLASS (gtk_separator_tool_item_parent_class)->unmap (widget);
}

static gboolean
gtk_separator_tool_item_button_event (GtkWidget      *widget,
                                      GdkEventButton *event)
{
  GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
  GtkSeparatorToolItemPrivate *priv = separator->priv;

  /* We want window dragging to work on empty toolbar areas,
   * so we only eat button events on visible separators
   */
  return priv->draw;
}

362
static gboolean
363 364
gtk_separator_tool_item_draw (GtkWidget *widget,
                              cairo_t   *cr)
365
{
366
  GtkAllocation allocation;
367
  GtkToolbar *toolbar = NULL;
368 369
  GtkSeparatorToolItem *separator = GTK_SEPARATOR_TOOL_ITEM (widget);
  GtkSeparatorToolItemPrivate *priv = separator->priv;
370
  GtkWidget *parent;
371

372 373
  if (priv->draw)
    {
374 375 376
      parent = gtk_widget_get_parent (widget);
      if (GTK_IS_TOOLBAR (parent))
        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 387 388 389 390 391 392
/**
 * gtk_separator_tool_item_new:
 * 
 * Create a new #GtkSeparatorToolItem
 * 
 * Return value: the new #GtkSeparatorToolItem
 * 
 * Since: 2.4
Matthias Clasen's avatar
Matthias Clasen committed
393
 */
394 395 396 397
GtkToolItem *
gtk_separator_tool_item_new (void)
{
  GtkToolItem *self;
398
  
399
  self = g_object_new (GTK_TYPE_SEPARATOR_TOOL_ITEM,
400
                       NULL);
401 402 403
  
  return self;
}
404 405 406

/**
 * gtk_separator_tool_item_get_draw:
407
 * @item: a #GtkSeparatorToolItem 
408
 * 
Matthias Clasen's avatar
Matthias Clasen committed
409 410
 * Returns whether @item is drawn as a line, or just blank. 
 * See gtk_separator_tool_item_set_draw().
411
 * 
Matthias Clasen's avatar
Matthias Clasen committed
412
 * Return value: %TRUE if @item is drawn as a line, or just blank.
413 414
 * 
 * Since: 2.4
Matthias Clasen's avatar
Matthias Clasen committed
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
Matthias Clasen's avatar
Matthias Clasen committed
427
 * @draw: whether @item is drawn as a vertical line
428
 * 
Matthias Clasen's avatar
Matthias Clasen committed
429 430
 * Whether @item is drawn as a vertical line, or just blank.
 * Setting this to %FALSE along with gtk_tool_item_set_expand() is useful
431 432 433
 * to create an item that forces following items to the end of the toolbar.
 * 
 * Since: 2.4
Matthias Clasen's avatar
Matthias Clasen committed
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 442

  draw = draw != FALSE;

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