gtkcellrenderer.c 22.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* gtkcellrenderer.c
 * Copyright (C) 2000  Red Hat, Inc. Jonathan Blandford
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library 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.
 */

20
#include <config.h>
21
#include "gtkcellrenderer.h"
22
#include "gtkintl.h"
Federico Mena Quintero's avatar
Federico Mena Quintero committed
23
#include "gtkmarshalers.h"
24
#include "gtktreeprivate.h"
25 26 27

static void gtk_cell_renderer_init       (GtkCellRenderer      *cell);
static void gtk_cell_renderer_class_init (GtkCellRendererClass *class);
28 29 30
static void gtk_cell_renderer_get_property  (GObject              *object,
					     guint                 param_id,
					     GValue               *value,
Tim Janik's avatar
Tim Janik committed
31
					     GParamSpec           *pspec);
32 33 34
static void gtk_cell_renderer_set_property  (GObject              *object,
					     guint                 param_id,
					     const GValue         *value,
Tim Janik's avatar
Tim Janik committed
35
					     GParamSpec           *pspec);
36 37
static void set_cell_bg_color               (GtkCellRenderer      *cell,
					     GdkColor             *color);
38 39


40 41 42 43 44 45 46 47 48
#define GTK_CELL_RENDERER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRendererPrivate))

typedef struct _GtkCellRendererPrivate GtkCellRendererPrivate;
struct _GtkCellRendererPrivate
{
  GdkColor cell_background;
};


49 50
enum {
  PROP_ZERO,
51
  PROP_MODE,
52
  PROP_VISIBLE,
53
  PROP_SENSITIVE,
54 55 56
  PROP_XALIGN,
  PROP_YALIGN,
  PROP_XPAD,
57
  PROP_YPAD,
58 59
  PROP_WIDTH,
  PROP_HEIGHT,
60
  PROP_IS_EXPANDER,
61 62 63 64
  PROP_IS_EXPANDED,
  PROP_CELL_BACKGROUND,
  PROP_CELL_BACKGROUND_GDK,
  PROP_CELL_BACKGROUND_SET
65 66
};

Federico Mena Quintero's avatar
Federico Mena Quintero committed
67 68 69
/* Signal IDs */
enum {
  EDITING_CANCELED,
70
  EDITING_STARTED,
Federico Mena Quintero's avatar
Federico Mena Quintero committed
71 72 73 74 75 76
  LAST_SIGNAL
};

static guint cell_renderer_signals[LAST_SIGNAL] = { 0 };


Manish Singh's avatar
Manish Singh committed
77
GType
78 79
gtk_cell_renderer_get_type (void)
{
Manish Singh's avatar
Manish Singh committed
80
  static GType cell_type = 0;
81 82 83 84 85 86 87 88 89 90 91 92

  if (!cell_type)
    {
      static const GTypeInfo cell_info =
      {
        sizeof (GtkCellRendererClass),
	NULL,		/* base_init */
	NULL,		/* base_finalize */
        (GClassInitFunc) gtk_cell_renderer_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
        sizeof (GtkCellRenderer),
Manish Singh's avatar
Manish Singh committed
93
	0,		/* n_preallocs */
94
        (GInstanceInitFunc) gtk_cell_renderer_init,
Manish Singh's avatar
Manish Singh committed
95
	NULL,		/* value_table */
96 97
      };

98 99
      cell_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkCellRenderer", 
					  &cell_info, G_TYPE_FLAG_ABSTRACT);
100 101 102 103 104 105 106 107
    }

  return cell_type;
}

static void
gtk_cell_renderer_init (GtkCellRenderer *cell)
{
108
  cell->mode = GTK_CELL_RENDERER_MODE_INERT;
109
  cell->visible = TRUE;
110 111
  cell->width = -1;
  cell->height = -1;
112 113
  cell->xalign = 0.5;
  cell->yalign = 0.5;
114 115
  cell->xpad = 0;
  cell->ypad = 0;
116
  cell->sensitive = TRUE;
117 118
  cell->is_expander = FALSE;
  cell->is_expanded = FALSE;
119 120 121 122 123 124 125
}

static void
gtk_cell_renderer_class_init (GtkCellRendererClass *class)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class);

126 127
  object_class->get_property = gtk_cell_renderer_get_property;
  object_class->set_property = gtk_cell_renderer_set_property;
128 129 130 131

  class->render = NULL;
  class->get_size = NULL;

Federico Mena Quintero's avatar
Federico Mena Quintero committed
132 133
  /**
   * GtkCellRenderer::editing-canceled:
Matthias Clasen's avatar
Matthias Clasen committed
134
   * @renderer: the object which received the signal
Federico Mena Quintero's avatar
Federico Mena Quintero committed
135 136 137
   *
   * This signal gets emitted when the user cancels the process of editing a
   * cell.  For example, an editable cell renderer could be written to cancel
138
   * editing when the user presses Escape. 
Federico Mena Quintero's avatar
Federico Mena Quintero committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152
   *
   * See also: gtk_cell_renderer_editing_canceled()
   *
   * Since: 2.4
   */
  cell_renderer_signals[EDITING_CANCELED] =
    g_signal_new ("editing-canceled",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkCellRendererClass, editing_canceled),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
  /**
   * GtkCellRenderer::editing-started:
   * @renderer: the object which received the signal
   * @editable: the #GtkCellEditable
   * @path: the path identifying the edited cell
   *
   * This signal gets emitted when a cell starts to be edited.
   * The indended use of this signal is to do special setup
   * on @editable, e.g. adding a #GtkEntryCompletion or setting
   * up additional columns in a #GtkComboBox.
   *
   * Note that GTK+ doesn't guarantee that cell renderers will
   * continue to use the same kind of widget for editing in future
   * releases, therefore you should check the type of @editable
   * before doing any specific setup, as in the following example:
   *
   * <informalexample><programlisting>
   * static void
   * text_editing_started (GtkCellRenderer *cell,
   *                       GtkCellEditable *editable,
   *                       const gchar     *path,
   *                       gpointer         data)
   * {
   *   if (GTK_IS_ENTRY (editable)) 
   *     {
   *       GtkEntry *entry = GTK_ENTRY (editable);
179 180 181
   *       <!-- -->
   *       /<!-- -->* ... create a GtkEntryCompletion *<!-- -->/
   *       <!-- -->
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
   *       gtk_entry_set_completion (entry, completion);
   *     }
   * }
   * </programlisting></informalexample>
   *
   * Since: 2.6
   */
  cell_renderer_signals[EDITING_STARTED] =
    g_signal_new ("editing-started",
		  G_OBJECT_CLASS_TYPE (object_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkCellRendererClass, editing_started),
		  NULL, NULL,
		  _gtk_marshal_VOID__OBJECT_STRING,
		  G_TYPE_NONE, 2,
		  GTK_TYPE_CELL_EDITABLE,
		  G_TYPE_STRING);

200
  g_object_class_install_property (object_class,
201 202
				   PROP_MODE,
				   g_param_spec_enum ("mode",
203 204
						      P_("mode"),
						      P_("Editable mode of the CellRenderer"),
205 206 207 208
						      GTK_TYPE_CELL_RENDERER_MODE,
						      GTK_CELL_RENDERER_MODE_INERT,
						      G_PARAM_READABLE |
						      G_PARAM_WRITABLE));
209

210 211 212
  g_object_class_install_property (object_class,
				   PROP_VISIBLE,
				   g_param_spec_boolean ("visible",
213 214
							 P_("visible"),
							 P_("Display the cell"),
215
							 TRUE,
216 217 218 219 220 221 222 223
							 G_PARAM_READWRITE));
  g_object_class_install_property (object_class,
				   PROP_SENSITIVE,
				   g_param_spec_boolean ("sensitive",
							 P_("Sensitive"),
							 P_("Display the cell sensitive"),
							 TRUE,
							 G_PARAM_READWRITE));
224

225 226 227
  g_object_class_install_property (object_class,
				   PROP_XALIGN,
				   g_param_spec_float ("xalign",
228 229
						       P_("xalign"),
						       P_("The x-align"),
230 231
						       0.0,
						       1.0,
232
						       0.5,
233 234
						       G_PARAM_READABLE |
						       G_PARAM_WRITABLE));
235

236 237 238
  g_object_class_install_property (object_class,
				   PROP_YALIGN,
				   g_param_spec_float ("yalign",
239 240
						       P_("yalign"),
						       P_("The y-align"),
241 242 243 244 245
						       0.0,
						       1.0,
						       0.5,
						       G_PARAM_READABLE |
						       G_PARAM_WRITABLE));
246

247 248 249
  g_object_class_install_property (object_class,
				   PROP_XPAD,
				   g_param_spec_uint ("xpad",
250 251
						      P_("xpad"),
						      P_("The xpad"),
252
						      0,
253
						      G_MAXUINT,
254
						      0,
255 256
						      G_PARAM_READABLE |
						      G_PARAM_WRITABLE));
257

258 259 260
  g_object_class_install_property (object_class,
				   PROP_YPAD,
				   g_param_spec_uint ("ypad",
261 262
						      P_("ypad"),
						      P_("The ypad"),
263
						      0,
264
						      G_MAXUINT,
265
						      0,
266 267
						      G_PARAM_READABLE |
						      G_PARAM_WRITABLE));
268 269 270 271

  g_object_class_install_property (object_class,
				   PROP_WIDTH,
				   g_param_spec_int ("width",
272 273
						     P_("width"),
						     P_("The fixed width"),
274
						     -1,
275
						     G_MAXINT,
276 277 278 279 280 281 282
						     -1,
						     G_PARAM_READABLE |
						     G_PARAM_WRITABLE));

  g_object_class_install_property (object_class,
				   PROP_HEIGHT,
				   g_param_spec_int ("height",
283 284
						     P_("height"),
						     P_("The fixed height"),
285
						     -1,
286
						     G_MAXINT,
287 288 289
						     -1,
						     G_PARAM_READABLE |
						     G_PARAM_WRITABLE));
290 291 292 293

  g_object_class_install_property (object_class,
				   PROP_IS_EXPANDER,
				   g_param_spec_boolean ("is_expander",
294 295
							 P_("Is Expander"),
							 P_("Row has children"),
296 297 298 299 300 301 302 303
							 FALSE,
							 G_PARAM_READABLE |
							 G_PARAM_WRITABLE));


  g_object_class_install_property (object_class,
				   PROP_IS_EXPANDED,
				   g_param_spec_boolean ("is_expanded",
304 305
							 P_("Is Expanded"),
							 P_("Row is an expander row, and is expanded"),
306 307 308
							 FALSE,
							 G_PARAM_READABLE |
							 G_PARAM_WRITABLE));
309 310 311 312

  g_object_class_install_property (object_class,
				   PROP_CELL_BACKGROUND,
				   g_param_spec_string ("cell_background",
313 314
							P_("Cell background color name"),
							P_("Cell background color as a string"),
315 316 317 318 319 320
							NULL,
							G_PARAM_WRITABLE));

  g_object_class_install_property (object_class,
				   PROP_CELL_BACKGROUND_GDK,
				   g_param_spec_boxed ("cell_background_gdk",
321 322
						       P_("Cell background color"),
						       P_("Cell background color as a GdkColor"),
323 324 325 326 327 328 329
						       GDK_TYPE_COLOR,
						       G_PARAM_READABLE | G_PARAM_WRITABLE));


#define ADD_SET_PROP(propname, propval, nick, blurb) g_object_class_install_property (object_class, propval, g_param_spec_boolean (propname, nick, blurb, FALSE, G_PARAM_READABLE | G_PARAM_WRITABLE))

  ADD_SET_PROP ("cell_background_set", PROP_CELL_BACKGROUND_SET,
330 331
                P_("Cell background set"),
                P_("Whether this tag affects the cell background color"));
332 333

  g_type_class_add_private (object_class, sizeof (GtkCellRendererPrivate));
334 335 336
}

static void
337 338 339
gtk_cell_renderer_get_property (GObject     *object,
				guint        param_id,
				GValue      *value,
Tim Janik's avatar
Tim Janik committed
340
				GParamSpec  *pspec)
341 342
{
  GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
343
  GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (object);
344 345 346

  switch (param_id)
    {
347 348
    case PROP_MODE:
      g_value_set_enum (value, cell->mode);
349
      break;
350 351 352
    case PROP_VISIBLE:
      g_value_set_boolean (value, cell->visible);
      break;
353 354 355
    case PROP_SENSITIVE:
      g_value_set_boolean (value, cell->sensitive);
      break;
356 357 358 359 360 361 362
    case PROP_XALIGN:
      g_value_set_float (value, cell->xalign);
      break;
    case PROP_YALIGN:
      g_value_set_float (value, cell->yalign);
      break;
    case PROP_XPAD:
363
      g_value_set_uint (value, cell->xpad);
364 365
      break;
    case PROP_YPAD:
366
      g_value_set_uint (value, cell->ypad);
367
      break;
368 369 370 371 372 373
    case PROP_WIDTH:
      g_value_set_int (value, cell->width);
      break;
    case PROP_HEIGHT:
      g_value_set_int (value, cell->height);
      break;
374
    case PROP_IS_EXPANDER:
375
      g_value_set_boolean (value, cell->is_expander);
376 377
      break;
    case PROP_IS_EXPANDED:
378
      g_value_set_boolean (value, cell->is_expanded);
379
      break;
380 381 382 383
    case PROP_CELL_BACKGROUND_GDK:
      {
	GdkColor color;

384 385 386
	color.red = priv->cell_background.red;
	color.green = priv->cell_background.green;
	color.blue = priv->cell_background.blue;
387 388 389 390 391 392 393 394

	g_value_set_boxed (value, &color);
      }
      break;
    case PROP_CELL_BACKGROUND_SET:
      g_value_set_boolean (value, cell->cell_background_set);
      break;
    case PROP_CELL_BACKGROUND:
395
    default:
396
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
397 398 399 400 401 402
      break;
    }

}

static void
403 404 405
gtk_cell_renderer_set_property (GObject      *object,
				guint         param_id,
				const GValue *value,
Tim Janik's avatar
Tim Janik committed
406
				GParamSpec   *pspec)
407 408 409 410 411
{
  GtkCellRenderer *cell = GTK_CELL_RENDERER (object);

  switch (param_id)
    {
412 413
    case PROP_MODE:
      cell->mode = g_value_get_enum (value);
414
      break;
415 416 417
    case PROP_VISIBLE:
      cell->visible = g_value_get_boolean (value);
      break;
418 419 420
    case PROP_SENSITIVE:
      cell->sensitive = g_value_get_boolean (value);
      break;
421 422 423 424 425 426 427
    case PROP_XALIGN:
      cell->xalign = g_value_get_float (value);
      break;
    case PROP_YALIGN:
      cell->yalign = g_value_get_float (value);
      break;
    case PROP_XPAD:
428
      cell->xpad = g_value_get_uint (value);
429 430
      break;
    case PROP_YPAD:
431
      cell->ypad = g_value_get_uint (value);
432
      break;
433 434 435 436 437 438
    case PROP_WIDTH:
      cell->width = g_value_get_int (value);
      break;
    case PROP_HEIGHT:
      cell->height = g_value_get_int (value);
      break;
439 440 441 442 443 444
    case PROP_IS_EXPANDER:
      cell->is_expander = g_value_get_boolean (value);
      break;
    case PROP_IS_EXPANDED:
      cell->is_expanded = g_value_get_boolean (value);
      break;
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
    case PROP_CELL_BACKGROUND:
      {
	GdkColor color;

	if (!g_value_get_string (value))
	  set_cell_bg_color (cell, NULL);
	else if (gdk_color_parse (g_value_get_string (value), &color))
	  set_cell_bg_color (cell, &color);
	else
	  g_warning ("Don't know color `%s'", g_value_get_string (value));

	g_object_notify (object, "cell_background_gdk");
      }
      break;
    case PROP_CELL_BACKGROUND_GDK:
      set_cell_bg_color (cell, g_value_get_boxed (value));
      break;
    case PROP_CELL_BACKGROUND_SET:
      cell->cell_background_set = g_value_get_boolean (value);
      break;
465
    default:
466
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
467 468 469 470
      break;
    }
}

471 472 473 474
static void
set_cell_bg_color (GtkCellRenderer *cell,
		   GdkColor        *color)
{
475
  GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
476

477 478 479 480 481 482 483 484
  if (color)
    {
      if (!cell->cell_background_set)
        {
	  cell->cell_background_set = TRUE;
	  g_object_notify (G_OBJECT (cell), "cell_background_set");
	}

485 486 487
      priv->cell_background.red = color->red;
      priv->cell_background.green = color->green;
      priv->cell_background.blue = color->blue;
488 489 490 491 492 493 494 495 496 497 498
    }
  else
    {
      if (cell->cell_background_set)
        {
	  cell->cell_background_set = FALSE;
	  g_object_notify (G_OBJECT (cell), "cell_background_set");
	}
    }
}

499 500 501 502
/**
 * gtk_cell_renderer_get_size:
 * @cell: a #GtkCellRenderer
 * @widget: the widget the renderer is rendering to
503 504 505
 * @cell_area: The area a cell will be allocated, or %NULL
 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
506 507
 * @width: location to return width needed to render a cell, or %NULL
 * @height: location to return height needed to render a cell, or %NULL
508 509 510 511
 *
 * Obtains the width and height needed to render the cell. Used by view widgets
 * to determine the appropriate size for the cell_area passed to
 * gtk_cell_renderer_render().  If @cell_area is not %NULL, fills in the x and y
512 513 514
 * offsets (if set) of the cell relative to this location.  Please note that the
 * values set in @width and @height, as well as those in @x_offset and @y_offset
 * are inclusive of the xpad and ypad properties.
515
 **/
516 517
void
gtk_cell_renderer_get_size (GtkCellRenderer *cell,
518 519 520 521 522 523
			    GtkWidget       *widget,
			    GdkRectangle    *cell_area,
			    gint            *x_offset,
			    gint            *y_offset,
			    gint            *width,
			    gint            *height)
524
{
525 526
  gint *real_width = width;
  gint *real_height = height;
527

528 529 530
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
  g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);

531
  if (width && cell->width != -1)
532
    {
533 534
      real_width = NULL;
      *width = cell->width;
535
    }
536
  if (height && cell->height != -1)
537
    {
538 539
      real_height = NULL;
      *height = cell->height;
540 541
    }

Manish Singh's avatar
Manish Singh committed
542 543 544 545 546 547 548
  GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell,
						widget,
						cell_area,
						x_offset,
						y_offset,
						real_width,
						real_height);
549 550
}

551 552 553 554 555 556 557 558 559 560
/**
 * gtk_cell_renderer_render:
 * @cell: a #GtkCellRenderer
 * @window: a #GdkDrawable to draw to
 * @widget: the widget owning @window
 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
 * @cell_area: area normally rendered by a cell renderer
 * @expose_area: area that actually needs updating
 * @flags: flags that affect rendering
 *
561 562 563 564 565 566 567
 * Invokes the virtual render function of the #GtkCellRenderer. The three
 * passed-in rectangles are areas of @window. Most renderers will draw within
 * @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
 * should be honored with respect to @cell_area. @background_area includes the
 * blank space around the cell, and also the area containing the tree expander;
 * so the @background_area rectangles for all cells tile to cover the entire
 * @window.  @expose_area is a clip rectangle.
568
 *
569
 **/
570
void
Havoc Pennington's avatar
Havoc Pennington committed
571 572 573 574 575 576 577
gtk_cell_renderer_render (GtkCellRenderer     *cell,
			  GdkWindow           *window,
			  GtkWidget           *widget,
			  GdkRectangle        *background_area,
			  GdkRectangle        *cell_area,
			  GdkRectangle        *expose_area,
			  GtkCellRendererState flags)
578
{
579
  gboolean selected = FALSE;
580
  GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
581

582 583 584
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
  g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);

585 586 587 588 589 590 591
  selected = (flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED;

  if (cell->cell_background_set && !selected)
    {
      GdkColor color;
      GdkGC *gc;

592 593 594
      color.red = priv->cell_background.red;
      color.green = priv->cell_background.green;
      color.blue = priv->cell_background.blue;
595 596 597 598 599 600

      gc = gdk_gc_new (window);
      gdk_gc_set_rgb_fg_color (gc, &color);
      gdk_draw_rectangle (window, gc, TRUE,
                          background_area->x, background_area->y,
                          background_area->width, background_area->height);
Manish Singh's avatar
Manish Singh committed
601
      g_object_unref (gc);
602 603
    }

604 605 606 607 608 609 610 611 612
  GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
					      window,
					      widget,
					      background_area,
					      cell_area,
					      expose_area,
					      flags);
}

613
/**
614
 * gtk_cell_renderer_activate:
615 616 617 618
 * @cell: a #GtkCellRenderer
 * @event: a #GdkEvent
 * @widget: widget that received the event
 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
619 620
 * @background_area: background area as passed to @gtk_cell_renderer_render
 * @cell_area: cell area as passed to @gtk_cell_renderer_render
621
 * @flags: render flags
622
 *
623 624 625
 * Passes an activate event to the cell renderer for possible processing.  Some
 * cell renderers may use events; for example, #GtkCellRendererToggle toggles
 * when it gets a mouse click.
626
 *
627 628
 * Return value: %TRUE if the event was consumed/handled
 **/
629
gboolean
630 631 632
gtk_cell_renderer_activate (GtkCellRenderer      *cell,
			    GdkEvent             *event,
			    GtkWidget            *widget,
633
			    const gchar          *path,
634 635 636
			    GdkRectangle         *background_area,
			    GdkRectangle         *cell_area,
			    GtkCellRendererState  flags)
637 638
{
  g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
639

640
  if (cell->mode != GTK_CELL_RENDERER_MODE_ACTIVATABLE)
641 642
    return FALSE;

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
  if (GTK_CELL_RENDERER_GET_CLASS (cell)->activate == NULL)
    return FALSE;

  return GTK_CELL_RENDERER_GET_CLASS (cell)->activate (cell,
						       event,
						       widget,
						       path,
						       background_area,
						       cell_area,
						       flags);
}

/**
 * gtk_cell_renderer_start_editing:
 * @cell: a #GtkCellRenderer
 * @event: a #GdkEvent
 * @widget: widget that received the event
 * @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
661 662
 * @background_area: background area as passed to @gtk_cell_renderer_render
 * @cell_area: cell area as passed to @gtk_cell_renderer_render
663 664 665 666 667 668 669 670 671 672
 * @flags: render flags
 * 
 * Passes an activate event to the cell renderer for possible processing.
 * 
 * Return value: A new #GtkCellEditable, or %NULL
 **/
GtkCellEditable *
gtk_cell_renderer_start_editing (GtkCellRenderer      *cell,
				 GdkEvent             *event,
				 GtkWidget            *widget,
673
				 const gchar          *path,
674 675 676 677 678
				 GdkRectangle         *background_area,
				 GdkRectangle         *cell_area,
				 GtkCellRendererState  flags)

{
679 680
  GtkCellEditable *editable;

681 682
  g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);

683
  if (cell->mode != GTK_CELL_RENDERER_MODE_EDITABLE)
684 685 686 687 688 689
    return NULL;

  if (GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing == NULL)
    return NULL;

  
690 691 692 693 694 695 696 697 698 699 700 701 702
  editable = GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing (cell,
								event,
								widget,
								path,
								background_area,
								cell_area,
								flags);

  g_signal_emit (cell, 
		 cell_renderer_signals[EDITING_STARTED], 0,
		 editable, path);

  return editable;
703 704
}

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
/**
 * gtk_cell_renderer_set_fixed_size:
 * @cell: A #GtkCellRenderer
 * @width: the width of the cell renderer, or -1
 * @height: the height of the cell renderer, or -1
 * 
 * Sets the renderer size to be explicit, independent of the properties set.
 **/
void
gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
				  gint             width,
				  gint             height)
{
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
  g_return_if_fail (width >= -1 && height >= -1);

Hans Breuer's avatar
Hans Breuer committed
721
  if ((width != cell->width) || (height != cell->height))
722
    {
Hans Breuer's avatar
Hans Breuer committed
723
      g_object_freeze_notify (G_OBJECT (cell));
724

Hans Breuer's avatar
Hans Breuer committed
725 726 727 728 729 730 731 732 733 734 735 736 737
      if (width != cell->width)
        {
          cell->width = width;
          g_object_notify (G_OBJECT (cell), "width");
        }

      if (height != cell->height)
        {
          cell->height = height;
          g_object_notify (G_OBJECT (cell), "height");
        }

      g_object_thaw_notify (G_OBJECT (cell));
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
    }
}

/**
 * gtk_cell_renderer_get_fixed_size:
 * @cell: A #GtkCellRenderer
 * @width: location to fill in with the fixed width of the widget, or %NULL
 * @height: location to fill in with the fixed height of the widget, or %NULL
 * 
 * Fills in @width and @height with the appropriate size of @cell.
 **/
void
gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
				  gint            *width,
				  gint            *height)
{
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

  if (width)
    (* width) = cell->width;
  if (height)
    (* height) = cell->height;
}
Federico Mena Quintero's avatar
Federico Mena Quintero committed
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779

/**
 * gtk_cell_renderer_editing_canceled:
 * @cell: A #GtkCellRenderer
 * 
 * Causes the cell renderer to emit the "editing-canceled" signal.  This
 * function is for use only by implementations of cell renderers that need to
 * notify the client program that an editing process was canceled and the
 * changes were not committed.
 *
 * Since: 2.4
 **/
void
gtk_cell_renderer_editing_canceled (GtkCellRenderer *cell)
{
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));

  g_signal_emit (cell, cell_renderer_signals[EDITING_CANCELED], 0);
}