gtkcellrenderer.c 16.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* 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.
 */

#include "gtkcellrenderer.h"
21
#include "gtkintl.h"
22 23 24

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


enum {
  PROP_ZERO,
37
  PROP_CAN_ACTIVATE,
38
  PROP_CAN_EDIT,
39
  PROP_VISIBLE,
40 41 42
  PROP_XALIGN,
  PROP_YALIGN,
  PROP_XPAD,
43
  PROP_YPAD,
44 45
  PROP_WIDTH,
  PROP_HEIGHT,
46 47
  PROP_IS_EXPANDER,
  PROP_IS_EXPANDED,
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
};


GtkType
gtk_cell_renderer_get_type (void)
{
  static GtkType cell_type = 0;

  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),
	0,
        (GInstanceInitFunc) gtk_cell_renderer_init,
      };

71
      cell_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkCellRenderer", &cell_info, 0);
72 73 74 75 76 77 78 79
    }

  return cell_type;
}

static void
gtk_cell_renderer_init (GtkCellRenderer *cell)
{
80
  cell->can_activate = FALSE;
81
  cell->can_edit = FALSE;
82
  cell->visible = TRUE;
83 84
  cell->width = -1;
  cell->height = -1;
85 86
  cell->xalign = 0.5;
  cell->yalign = 0.5;
87 88
  cell->xpad = 0;
  cell->ypad = 0;
89 90 91 92 93 94 95
}

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

96 97
  object_class->get_property = gtk_cell_renderer_get_property;
  object_class->set_property = gtk_cell_renderer_set_property;
98 99 100 101

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

102 103 104 105 106 107 108 109 110
  g_object_class_install_property (object_class,
				   PROP_CAN_ACTIVATE,
				   g_param_spec_boolean ("can_activate",
							 _("can_activate"),
							 _("Cell can get activate events."),
							 FALSE,
							 G_PARAM_READABLE |
							 G_PARAM_WRITABLE));

111 112 113 114 115 116 117 118 119
  g_object_class_install_property (object_class,
				   PROP_CAN_EDIT,
				   g_param_spec_boolean ("can_edit",
							 _("can_edit"),
							 _("Cell supports CellEditable interface."),
							 FALSE,
							 G_PARAM_READABLE |
							 G_PARAM_WRITABLE));
  
120 121 122 123 124 125 126 127
  g_object_class_install_property (object_class,
				   PROP_VISIBLE,
				   g_param_spec_boolean ("visible",
							 _("visible"),
							 _("Display the cell"),
							 TRUE,
							 G_PARAM_READABLE |
							 G_PARAM_WRITABLE));
128

129 130 131 132 133 134 135 136 137 138
  g_object_class_install_property (object_class,
				   PROP_XALIGN,
				   g_param_spec_float ("xalign",
						       _("xalign"),
						       _("The x-align."),
						       0.0,
						       1.0,
						       0.0,
						       G_PARAM_READABLE |
						       G_PARAM_WRITABLE));
139

140 141 142 143 144 145 146 147 148 149
  g_object_class_install_property (object_class,
				   PROP_YALIGN,
				   g_param_spec_float ("yalign",
						       _("yalign"),
						       _("The y-align."),
						       0.0,
						       1.0,
						       0.5,
						       G_PARAM_READABLE |
						       G_PARAM_WRITABLE));
150

151 152 153 154 155 156 157 158 159 160
  g_object_class_install_property (object_class,
				   PROP_XPAD,
				   g_param_spec_uint ("xpad",
						      _("xpad"),
						      _("The xpad."),
						      0,
						      100,
						      2,
						      G_PARAM_READABLE |
						      G_PARAM_WRITABLE));
161

162 163 164 165 166 167 168 169 170 171
  g_object_class_install_property (object_class,
				   PROP_YPAD,
				   g_param_spec_uint ("ypad",
						      _("ypad"),
						      _("The ypad."),
						      0,
						      100,
						      2,
						      G_PARAM_READABLE |
						      G_PARAM_WRITABLE));
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193

  g_object_class_install_property (object_class,
				   PROP_WIDTH,
				   g_param_spec_int ("width",
						     _("width"),
						     _("The fixed width."),
						     -1,
						     100,
						     -1,
						     G_PARAM_READABLE |
						     G_PARAM_WRITABLE));

  g_object_class_install_property (object_class,
				   PROP_HEIGHT,
				   g_param_spec_int ("height",
						     _("height"),
						     _("The fixed height."),
						     -1,
						     100,
						     -1,
						     G_PARAM_READABLE |
						     G_PARAM_WRITABLE));
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212

  g_object_class_install_property (object_class,
				   PROP_IS_EXPANDER,
				   g_param_spec_boolean ("is_expander",
							 _("Is Expander"),
							 _("Row has children."),
							 FALSE,
							 G_PARAM_READABLE |
							 G_PARAM_WRITABLE));


  g_object_class_install_property (object_class,
				   PROP_IS_EXPANDED,
				   g_param_spec_boolean ("is_expanded",
							 _("Is Expanded"),
							 _("Row is an expander row, and is expanded"),
							 FALSE,
							 G_PARAM_READABLE |
							 G_PARAM_WRITABLE));
213 214 215
}

static void
216 217 218
gtk_cell_renderer_get_property (GObject     *object,
				guint        param_id,
				GValue      *value,
Tim Janik's avatar
Tim Janik committed
219
				GParamSpec  *pspec)
220 221 222 223 224
{
  GtkCellRenderer *cell = GTK_CELL_RENDERER (object);

  switch (param_id)
    {
225 226 227
    case PROP_CAN_ACTIVATE:
      g_value_set_boolean (value, cell->can_activate);
      break;
228 229 230
    case PROP_CAN_EDIT:
      g_value_set_boolean (value, cell->can_edit);
      break;
231 232 233
    case PROP_VISIBLE:
      g_value_set_boolean (value, cell->visible);
      break;
234 235 236 237 238 239 240
    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:
241
      g_value_set_uint (value, cell->xpad);
242 243
      break;
    case PROP_YPAD:
244
      g_value_set_uint (value, cell->ypad);
245
      break;
246 247 248 249 250 251
    case PROP_WIDTH:
      g_value_set_int (value, cell->width);
      break;
    case PROP_HEIGHT:
      g_value_set_int (value, cell->height);
      break;
252 253 254 255 256 257
    case PROP_IS_EXPANDER:
      g_value_set_int (value, cell->is_expander);
      break;
    case PROP_IS_EXPANDED:
      g_value_set_int (value, cell->is_expanded);
      break;
258
    default:
259
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
260 261 262 263 264 265
      break;
    }

}

static void
266 267 268
gtk_cell_renderer_set_property (GObject      *object,
				guint         param_id,
				const GValue *value,
Tim Janik's avatar
Tim Janik committed
269
				GParamSpec   *pspec)
270 271 272 273 274
{
  GtkCellRenderer *cell = GTK_CELL_RENDERER (object);

  switch (param_id)
    {
275 276 277
    case PROP_CAN_ACTIVATE:
      cell->can_activate = g_value_get_boolean (value);
      g_object_notify (object, "can_activate");
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
      /* can_activate and can_edit are mutually exclusive */
      if (cell->can_activate && cell->can_edit)
	{
	  cell->can_edit = FALSE;
	  g_object_notify (object, "can_edit");
	}
      break;
    case PROP_CAN_EDIT:
      cell->can_edit = g_value_get_boolean (value);
      g_object_notify (object, "can_edit");
      /* can_activate and can_edit are mutually exclusive */
      if (cell->can_activate && cell->can_edit)
	{
	  cell->can_activate = FALSE;
	  g_object_notify (object, "can_activate");
	}
294
      break;
295 296 297 298
    case PROP_VISIBLE:
      cell->visible = g_value_get_boolean (value);
      g_object_notify (object, "visible");
      break;
299 300
    case PROP_XALIGN:
      cell->xalign = g_value_get_float (value);
301
      g_object_notify (object, "xalign");
302 303 304
      break;
    case PROP_YALIGN:
      cell->yalign = g_value_get_float (value);
305
      g_object_notify (object, "yalign");
306 307
      break;
    case PROP_XPAD:
308
      cell->xpad = g_value_get_uint (value);
309
      g_object_notify (object, "xpad");
310 311
      break;
    case PROP_YPAD:
312
      cell->ypad = g_value_get_uint (value);
313
      g_object_notify (object, "ypad");
314
      break;
315 316 317 318 319 320 321 322
    case PROP_WIDTH:
      cell->width = g_value_get_int (value);
      g_object_notify (object, "width");
      break;
    case PROP_HEIGHT:
      cell->height = g_value_get_int (value);
      g_object_notify (object, "height");
      break;
323 324 325 326 327 328 329 330
    case PROP_IS_EXPANDER:
      cell->is_expander = g_value_get_boolean (value);
      g_object_notify (object, "is_expander");
      break;
    case PROP_IS_EXPANDED:
      cell->is_expanded = g_value_get_boolean (value);
      g_object_notify (object, "is_expanded");
      break;
331
    default:
332
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
333 334 335 336
      break;
    }
}

337 338 339 340
/**
 * gtk_cell_renderer_get_size:
 * @cell: a #GtkCellRenderer
 * @widget: the widget the renderer is rendering to
341 342 343
 * @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
344 345
 * @width: location to return width needed to render a cell, or %NULL
 * @height: location to return height needed to render a cell, or %NULL
346 347 348 349 350
 *
 * 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
 * offsets (if set) of the cell relative to this location.
351
 **/
352 353
void
gtk_cell_renderer_get_size (GtkCellRenderer *cell,
354 355 356 357 358 359
			    GtkWidget       *widget,
			    GdkRectangle    *cell_area,
			    gint            *x_offset,
			    gint            *y_offset,
			    gint            *width,
			    gint            *height)
360
{
361 362 363
  gint *real_width = NULL;
  gint *real_height = NULL;

364 365 366
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
  g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);

367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
  if (width)
    {
      if (cell->width == -1)
	real_width = width;
      else
	*width = cell->width;
    }
  if (height)
    {
      if (cell->height == -1)
	real_height = height;
      else
	*height = cell->height;
    }

  if (real_width || real_height)
    GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell, widget, cell_area, x_offset, y_offset, real_width, real_height);
384 385
}

Havoc Pennington's avatar
Havoc Pennington committed
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
/**
 * 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
 *
 * Invokes the virtual render function of the #GtkCellRenderer. The
 * three passed-in rectangles are areas of @window. Most renderers
 * will draw to @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. Cell renderers can use the @background_area to draw custom expanders, for
 * example. @expose_area is a clip rectangle.
405
 *
Havoc Pennington's avatar
Havoc Pennington committed
406
 **/
407
void
Havoc Pennington's avatar
Havoc Pennington committed
408 409 410 411 412 413 414
gtk_cell_renderer_render (GtkCellRenderer     *cell,
			  GdkWindow           *window,
			  GtkWidget           *widget,
			  GdkRectangle        *background_area,
			  GdkRectangle        *cell_area,
			  GdkRectangle        *expose_area,
			  GtkCellRendererState flags)
415 416
{
  /* It's actually okay to pass in a NULL cell, as we run into that
417 418
   * a lot
   */
419 420 421 422 423 424 425 426 427 428 429 430 431 432
  if (cell == NULL)
    return;
  g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
  g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);

  GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
					      window,
					      widget,
					      background_area,
					      cell_area,
					      expose_area,
					      flags);
}

433
/**
434
 * gtk_cell_renderer_activate:
435 436 437 438 439 440 441
 * @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
 * @background_area: background area as passed to gtk_cell_renderer_render()
 * @cell_area: cell area as passed to gtk_cell_renderer_render()
 * @flags: render flags
442
 *
443 444 445
 * 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.
446
 *
447 448
 * Return value: %TRUE if the event was consumed/handled
 **/
449
gboolean
450 451 452 453 454 455 456
gtk_cell_renderer_activate (GtkCellRenderer      *cell,
			    GdkEvent             *event,
			    GtkWidget            *widget,
			    gchar                *path,
			    GdkRectangle         *background_area,
			    GdkRectangle         *cell_area,
			    GtkCellRendererState  flags)
457 458
{
  g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
459 460

  if (! cell->can_activate)
461 462
    return FALSE;

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
  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
 * @background_area: background area as passed to gtk_cell_renderer_render()
 * @cell_area: cell area as passed to gtk_cell_renderer_render()
 * @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,
				 gchar                *path,
				 GdkRectangle         *background_area,
				 GdkRectangle         *cell_area,
				 GtkCellRendererState  flags)

{
  g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);

  if (! cell->can_edit)
    return NULL;

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

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

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
/**
 * 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
534
  if ((width != cell->width) || (height != cell->height))
535
    {
Hans Breuer's avatar
Hans Breuer committed
536
      g_object_freeze_notify (G_OBJECT (cell));
537

Hans Breuer's avatar
Hans Breuer committed
538 539 540 541 542 543 544 545 546 547 548 549 550
      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));
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
    }
}

/**
 * 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;
}