gtkseparatortoolitem.c 15.3 KB
Newer Older
1 2
/* gtkseparatortoolitem.c
 *
3
 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
4 5 6 7 8 9 10 11 12 13 14 15 16
 * 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
Javier Jardón's avatar
Javier Jardón committed
17
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 19
 */

20
#include "config.h"
21 22 23
#include "gtkseparatormenuitem.h"
#include "gtkseparatortoolitem.h"
#include "gtkintl.h"
24
#include "gtktoolbar.h"
25
#include "gtkprivate.h"
26 27 28 29 30 31 32 33

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

45 46
#define MENU_ID "gtk-separator-tool-item-menu-id"

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

53 54 55 56 57 58 59
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,
60 61 62 63 64 65 66
                                                           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);
67 68 69 70 71 72
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);
73 74
static void     gtk_separator_tool_item_size_allocate     (GtkWidget                 *widget,
                                                           GtkAllocation             *allocation);
75 76
static gboolean gtk_separator_tool_item_draw              (GtkWidget                 *widget,
                                                           cairo_t                   *cr);
77
static void     gtk_separator_tool_item_add               (GtkContainer              *container,
78
                                                           GtkWidget                 *child);
79
static gint     get_space_size                            (GtkToolItem               *tool_item);
80 81 82 83 84 85
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);
86 87


88
G_DEFINE_TYPE_WITH_PRIVATE (GtkSeparatorToolItem, gtk_separator_tool_item, GTK_TYPE_TOOL_ITEM)
89

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

  parent = gtk_widget_get_parent (GTK_WIDGET (tool_item));

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

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

121 122
  object_class->set_property = gtk_separator_tool_item_set_property;
  object_class->get_property = gtk_separator_tool_item_get_property;
123 124
  widget_class->get_preferred_width = gtk_separator_tool_item_get_preferred_width;
  widget_class->get_preferred_height = gtk_separator_tool_item_get_preferred_height;
125
  widget_class->size_allocate = gtk_separator_tool_item_size_allocate;
126
  widget_class->draw = gtk_separator_tool_item_draw;
127 128 129 130 131 132 133
  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;

134
  toolitem_class->create_menu_proxy = gtk_separator_tool_item_create_menu_proxy;
135
  
136
  container_class->add = gtk_separator_tool_item_add;
137 138
  
  g_object_class_install_property (object_class,
139 140 141 142 143 144
                                   PROP_DRAW,
                                   g_param_spec_boolean ("draw",
                                                         P_("Draw"),
                                                         P_("Whether the separator is drawn, or just blank"),
                                                         TRUE,
                                                         GTK_PARAM_READWRITE));
145 146 147
}

static void
148
gtk_separator_tool_item_init (GtkSeparatorToolItem *separator_item)
149
{
150 151
  GtkStyleContext *context;

152
  separator_item->priv = gtk_separator_tool_item_get_instance_private (separator_item);
153
  separator_item->priv->draw = TRUE;
154 155

  gtk_widget_set_has_window (GTK_WIDGET (separator_item), FALSE);
156 157 158

  context = gtk_widget_get_style_context (GTK_WIDGET (separator_item));
  gtk_style_context_add_class (context, GTK_STYLE_CLASS_SEPARATOR);
159 160 161 162
}

static void
gtk_separator_tool_item_add (GtkContainer *container,
163
                             GtkWidget    *child)
164
{
165
  g_warning ("attempt to add a child to an GtkSeparatorToolItem");
166 167
}

168 169 170 171 172 173 174 175 176 177 178 179
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;
}

180 181
static void
gtk_separator_tool_item_set_property (GObject      *object,
182 183 184
                                      guint         prop_id,
                                      const GValue *value,
                                      GParamSpec   *pspec)
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
{
  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,
201 202 203
                                      guint         prop_id,
                                      GValue       *value,
                                      GParamSpec   *pspec)
204 205 206 207 208 209 210 211 212 213 214 215 216 217
{
  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;
    }
}

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

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

259
  gtk_widget_set_allocation (widget, allocation);
260 261 262

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

}

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

  gtk_widget_set_realized (widget, TRUE);

282 283
  gtk_widget_get_allocation (widget, &allocation);

284
  attributes.window_type = GDK_WINDOW_CHILD;
285 286 287 288
  attributes.x = allocation.x;
  attributes.y = allocation.y;
  attributes.width = allocation.width;
  attributes.height = allocation.height;
289 290 291 292 293 294 295
  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;

296 297 298
  window = gtk_widget_get_parent_window (widget);
  gtk_widget_set_window (widget, window);
  g_object_ref (window);
299 300 301

  priv->event_window = gdk_window_new (gtk_widget_get_parent_window (widget),
                                       &attributes, attributes_mask);
302
  gtk_widget_register_window (widget, priv->event_window);
303 304 305 306 307 308 309 310 311 312
}

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

  if (priv->event_window)
    {
313
      gtk_widget_unregister_window (widget, priv->event_window);
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
      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;
}

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

368 369
  if (priv->draw)
    {
370 371 372
      parent = gtk_widget_get_parent (widget);
      if (GTK_IS_TOOLBAR (parent))
        toolbar = GTK_TOOLBAR (parent);
373

374
      gtk_widget_get_allocation (widget, &allocation);
375
      _gtk_toolbar_paint_space_line (widget, toolbar, cr);
376
    }
377

378
  return FALSE;
379 380
}

381 382 383 384 385 386 387 388
/**
 * gtk_separator_tool_item_new:
 * 
 * Create a new #GtkSeparatorToolItem
 * 
 * Return value: the new #GtkSeparatorToolItem
 * 
 * Since: 2.4
Matthias Clasen's avatar
Matthias Clasen committed
389
 */
390 391 392 393
GtkToolItem *
gtk_separator_tool_item_new (void)
{
  GtkToolItem *self;
394
  
395
  self = g_object_new (GTK_TYPE_SEPARATOR_TOOL_ITEM,
396
                       NULL);
397 398 399
  
  return self;
}
400 401 402

/**
 * gtk_separator_tool_item_get_draw:
403
 * @item: a #GtkSeparatorToolItem 
404
 * 
Matthias Clasen's avatar
Matthias Clasen committed
405 406
 * Returns whether @item is drawn as a line, or just blank. 
 * See gtk_separator_tool_item_set_draw().
407
 * 
Matthias Clasen's avatar
Matthias Clasen committed
408
 * Return value: %TRUE if @item is drawn as a line, or just blank.
409 410
 * 
 * Since: 2.4
Matthias Clasen's avatar
Matthias Clasen committed
411
 */
412
gboolean
413
gtk_separator_tool_item_get_draw (GtkSeparatorToolItem *item)
414
{
415
  g_return_val_if_fail (GTK_IS_SEPARATOR_TOOL_ITEM (item), FALSE);
416
  
417
  return item->priv->draw;
418 419 420 421
}

/**
 * gtk_separator_tool_item_set_draw:
422
 * @item: a #GtkSeparatorToolItem
Matthias Clasen's avatar
Matthias Clasen committed
423
 * @draw: whether @item is drawn as a vertical line
424
 * 
Matthias Clasen's avatar
Matthias Clasen committed
425 426
 * Whether @item is drawn as a vertical line, or just blank.
 * Setting this to %FALSE along with gtk_tool_item_set_expand() is useful
427 428 429
 * to create an item that forces following items to the end of the toolbar.
 * 
 * Since: 2.4
Matthias Clasen's avatar
Matthias Clasen committed
430
 */
431
void
432
gtk_separator_tool_item_set_draw (GtkSeparatorToolItem *item,
433
                                  gboolean              draw)
434
{
435
  g_return_if_fail (GTK_IS_SEPARATOR_TOOL_ITEM (item));
436 437 438

  draw = draw != FALSE;

439
  if (draw != item->priv->draw)
440
    {
441
      item->priv->draw = draw;
442

443
      gtk_widget_queue_draw (GTK_WIDGET (item));
444

445
      g_object_notify (G_OBJECT (item), "draw");
446 447
    }
}