2
* Copyright (C) 2000 Red Hat, Inc. Jonathan Blandford
4
* This library is free software; you can redistribute it and/or
5
* modify it under the terms of the GNU Library General Public
6
* License as published by the Free Software Foundation; either
7
* version 2 of the License, or (at your option) any later version.
9
* This library is distributed in the hope that it will be useful,
10
* but WITHOUT ANY WARRANTY; without even the implied warranty of
11
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12
* Library General Public License for more details.
14
* You should have received a copy of the GNU Library General Public
15
* License along with this library; if not, write to the
16
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17
* Boston, MA 02111-1307, USA.
21
#include "gtkcellrenderer.h"
23
#include "gtkmarshalers.h"
24
#include "gtkprivate.h"
25
#include "gtktreeprivate.h"
28
static void gtk_cell_renderer_get_property (GObject *object,
32
static void gtk_cell_renderer_set_property (GObject *object,
36
static void set_cell_bg_color (GtkCellRenderer *cell,
40
#define GTK_CELL_RENDERER_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_CELL_RENDERER, GtkCellRendererPrivate))
42
typedef struct _GtkCellRendererPrivate GtkCellRendererPrivate;
43
struct _GtkCellRendererPrivate
45
GdkColor cell_background;
63
PROP_CELL_BACKGROUND_GDK,
64
PROP_CELL_BACKGROUND_SET
74
static guint cell_renderer_signals[LAST_SIGNAL] = { 0 };
76
G_DEFINE_ABSTRACT_TYPE (GtkCellRenderer, gtk_cell_renderer, GTK_TYPE_OBJECT)
79
gtk_cell_renderer_init (GtkCellRenderer *cell)
81
cell->mode = GTK_CELL_RENDERER_MODE_INERT;
89
cell->sensitive = TRUE;
90
cell->is_expander = FALSE;
91
cell->is_expanded = FALSE;
92
cell->editing = FALSE;
96
gtk_cell_renderer_class_init (GtkCellRendererClass *class)
98
GObjectClass *object_class = G_OBJECT_CLASS (class);
100
object_class->get_property = gtk_cell_renderer_get_property;
101
object_class->set_property = gtk_cell_renderer_set_property;
103
class->render = NULL;
104
class->get_size = NULL;
107
* GtkCellRenderer::editing-canceled:
108
* @renderer: the object which received the signal
110
* This signal gets emitted when the user cancels the process of editing a
111
* cell. For example, an editable cell renderer could be written to cancel
112
* editing when the user presses Escape.
114
* See also: gtk_cell_renderer_editing_canceled()
118
cell_renderer_signals[EDITING_CANCELED] =
119
g_signal_new (I_("editing-canceled"),
120
G_OBJECT_CLASS_TYPE (object_class),
122
G_STRUCT_OFFSET (GtkCellRendererClass, editing_canceled),
124
_gtk_marshal_VOID__VOID,
128
* GtkCellRenderer::editing-started:
129
* @renderer: the object which received the signal
130
* @editable: the #GtkCellEditable
131
* @path: the path identifying the edited cell
133
* This signal gets emitted when a cell starts to be edited.
134
* The indended use of this signal is to do special setup
135
* on @editable, e.g. adding a #GtkEntryCompletion or setting
136
* up additional columns in a #GtkComboBox.
138
* Note that GTK+ doesn't guarantee that cell renderers will
139
* continue to use the same kind of widget for editing in future
140
* releases, therefore you should check the type of @editable
141
* before doing any specific setup, as in the following example:
143
* <informalexample><programlisting>
145
* text_editing_started (GtkCellRenderer *cell,
146
* GtkCellEditable *editable,
150
* if (GTK_IS_ENTRY (editable))
152
* GtkEntry *entry = GTK_ENTRY (editable);
154
* /<!-- -->* ... create a GtkEntryCompletion *<!-- -->/
156
* gtk_entry_set_completion (entry, completion);
159
* </programlisting></informalexample>
163
cell_renderer_signals[EDITING_STARTED] =
164
g_signal_new (I_("editing-started"),
165
G_OBJECT_CLASS_TYPE (object_class),
167
G_STRUCT_OFFSET (GtkCellRendererClass, editing_started),
169
_gtk_marshal_VOID__OBJECT_STRING,
171
GTK_TYPE_CELL_EDITABLE,
174
g_object_class_install_property (object_class,
176
g_param_spec_enum ("mode",
178
P_("Editable mode of the CellRenderer"),
179
GTK_TYPE_CELL_RENDERER_MODE,
180
GTK_CELL_RENDERER_MODE_INERT,
181
GTK_PARAM_READWRITE));
183
g_object_class_install_property (object_class,
185
g_param_spec_boolean ("visible",
187
P_("Display the cell"),
189
GTK_PARAM_READWRITE));
190
g_object_class_install_property (object_class,
192
g_param_spec_boolean ("sensitive",
194
P_("Display the cell sensitive"),
196
GTK_PARAM_READWRITE));
198
g_object_class_install_property (object_class,
200
g_param_spec_float ("xalign",
206
GTK_PARAM_READWRITE));
208
g_object_class_install_property (object_class,
210
g_param_spec_float ("yalign",
216
GTK_PARAM_READWRITE));
218
g_object_class_install_property (object_class,
220
g_param_spec_uint ("xpad",
226
GTK_PARAM_READWRITE));
228
g_object_class_install_property (object_class,
230
g_param_spec_uint ("ypad",
236
GTK_PARAM_READWRITE));
238
g_object_class_install_property (object_class,
240
g_param_spec_int ("width",
242
P_("The fixed width"),
246
GTK_PARAM_READWRITE));
248
g_object_class_install_property (object_class,
250
g_param_spec_int ("height",
252
P_("The fixed height"),
256
GTK_PARAM_READWRITE));
258
g_object_class_install_property (object_class,
260
g_param_spec_boolean ("is-expander",
262
P_("Row has children"),
264
GTK_PARAM_READWRITE));
267
g_object_class_install_property (object_class,
269
g_param_spec_boolean ("is-expanded",
271
P_("Row is an expander row, and is expanded"),
273
GTK_PARAM_READWRITE));
275
g_object_class_install_property (object_class,
276
PROP_CELL_BACKGROUND,
277
g_param_spec_string ("cell-background",
278
P_("Cell background color name"),
279
P_("Cell background color as a string"),
281
GTK_PARAM_WRITABLE));
283
g_object_class_install_property (object_class,
284
PROP_CELL_BACKGROUND_GDK,
285
g_param_spec_boxed ("cell-background-gdk",
286
P_("Cell background color"),
287
P_("Cell background color as a GdkColor"),
289
GTK_PARAM_READWRITE));
292
#define ADD_SET_PROP(propname, propval, nick, blurb) g_object_class_install_property (object_class, propval, g_param_spec_boolean (propname, nick, blurb, FALSE, GTK_PARAM_READWRITE))
294
ADD_SET_PROP ("cell-background-set", PROP_CELL_BACKGROUND_SET,
295
P_("Cell background set"),
296
P_("Whether this tag affects the cell background color"));
298
g_type_class_add_private (object_class, sizeof (GtkCellRendererPrivate));
302
gtk_cell_renderer_get_property (GObject *object,
307
GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
308
GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (object);
313
g_value_set_enum (value, cell->mode);
316
g_value_set_boolean (value, cell->visible);
319
g_value_set_boolean (value, cell->sensitive);
322
g_value_set_float (value, cell->xalign);
325
g_value_set_float (value, cell->yalign);
328
g_value_set_uint (value, cell->xpad);
331
g_value_set_uint (value, cell->ypad);
334
g_value_set_int (value, cell->width);
337
g_value_set_int (value, cell->height);
339
case PROP_IS_EXPANDER:
340
g_value_set_boolean (value, cell->is_expander);
342
case PROP_IS_EXPANDED:
343
g_value_set_boolean (value, cell->is_expanded);
345
case PROP_CELL_BACKGROUND_GDK:
349
color.red = priv->cell_background.red;
350
color.green = priv->cell_background.green;
351
color.blue = priv->cell_background.blue;
353
g_value_set_boxed (value, &color);
356
case PROP_CELL_BACKGROUND_SET:
357
g_value_set_boolean (value, cell->cell_background_set);
359
case PROP_CELL_BACKGROUND:
361
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
368
gtk_cell_renderer_set_property (GObject *object,
373
GtkCellRenderer *cell = GTK_CELL_RENDERER (object);
378
cell->mode = g_value_get_enum (value);
381
cell->visible = g_value_get_boolean (value);
384
cell->sensitive = g_value_get_boolean (value);
387
cell->xalign = g_value_get_float (value);
390
cell->yalign = g_value_get_float (value);
393
cell->xpad = g_value_get_uint (value);
396
cell->ypad = g_value_get_uint (value);
399
cell->width = g_value_get_int (value);
402
cell->height = g_value_get_int (value);
404
case PROP_IS_EXPANDER:
405
cell->is_expander = g_value_get_boolean (value);
407
case PROP_IS_EXPANDED:
408
cell->is_expanded = g_value_get_boolean (value);
410
case PROP_CELL_BACKGROUND:
414
if (!g_value_get_string (value))
415
set_cell_bg_color (cell, NULL);
416
else if (gdk_color_parse (g_value_get_string (value), &color))
417
set_cell_bg_color (cell, &color);
419
g_warning ("Don't know color `%s'", g_value_get_string (value));
421
g_object_notify (object, "cell-background-gdk");
424
case PROP_CELL_BACKGROUND_GDK:
425
set_cell_bg_color (cell, g_value_get_boxed (value));
427
case PROP_CELL_BACKGROUND_SET:
428
cell->cell_background_set = g_value_get_boolean (value);
431
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
437
set_cell_bg_color (GtkCellRenderer *cell,
440
GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
444
if (!cell->cell_background_set)
446
cell->cell_background_set = TRUE;
447
g_object_notify (G_OBJECT (cell), "cell-background-set");
450
priv->cell_background.red = color->red;
451
priv->cell_background.green = color->green;
452
priv->cell_background.blue = color->blue;
456
if (cell->cell_background_set)
458
cell->cell_background_set = FALSE;
459
g_object_notify (G_OBJECT (cell), "cell-background-set");
465
* gtk_cell_renderer_get_size:
466
* @cell: a #GtkCellRenderer
467
* @widget: the widget the renderer is rendering to
468
* @cell_area: The area a cell will be allocated, or %NULL
469
* @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
470
* @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
471
* @width: location to return width needed to render a cell, or %NULL
472
* @height: location to return height needed to render a cell, or %NULL
474
* Obtains the width and height needed to render the cell. Used by view widgets
475
* to determine the appropriate size for the cell_area passed to
476
* gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the x and y
477
* offsets (if set) of the cell relative to this location. Please note that the
478
* values set in @width and @height, as well as those in @x_offset and @y_offset
479
* are inclusive of the xpad and ypad properties.
482
gtk_cell_renderer_get_size (GtkCellRenderer *cell,
484
GdkRectangle *cell_area,
490
gint *real_width = width;
491
gint *real_height = height;
493
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
494
g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->get_size != NULL);
496
if (width && cell->width != -1)
499
*width = cell->width;
501
if (height && cell->height != -1)
504
*height = cell->height;
507
GTK_CELL_RENDERER_GET_CLASS (cell)->get_size (cell,
517
* gtk_cell_renderer_render:
518
* @cell: a #GtkCellRenderer
519
* @window: a #GdkDrawable to draw to
520
* @widget: the widget owning @window
521
* @background_area: entire cell area (including tree expanders and maybe padding on the sides)
522
* @cell_area: area normally rendered by a cell renderer
523
* @expose_area: area that actually needs updating
524
* @flags: flags that affect rendering
526
* Invokes the virtual render function of the #GtkCellRenderer. The three
527
* passed-in rectangles are areas of @window. Most renderers will draw within
528
* @cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
529
* should be honored with respect to @cell_area. @background_area includes the
530
* blank space around the cell, and also the area containing the tree expander;
531
* so the @background_area rectangles for all cells tile to cover the entire
532
* @window. @expose_area is a clip rectangle.
536
gtk_cell_renderer_render (GtkCellRenderer *cell,
539
GdkRectangle *background_area,
540
GdkRectangle *cell_area,
541
GdkRectangle *expose_area,
542
GtkCellRendererState flags)
544
gboolean selected = FALSE;
545
GtkCellRendererPrivate *priv = GTK_CELL_RENDERER_GET_PRIVATE (cell);
547
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
548
g_return_if_fail (GTK_CELL_RENDERER_GET_CLASS (cell)->render != NULL);
550
selected = (flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED;
552
if (cell->cell_background_set && !selected)
554
cairo_t *cr = gdk_cairo_create (window);
556
gdk_cairo_rectangle (cr, background_area);
557
gdk_cairo_set_source_color (cr, &priv->cell_background);
563
GTK_CELL_RENDERER_GET_CLASS (cell)->render (cell,
573
* gtk_cell_renderer_activate:
574
* @cell: a #GtkCellRenderer
575
* @event: a #GdkEvent
576
* @widget: widget that received the event
577
* @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
578
* @background_area: background area as passed to @gtk_cell_renderer_render
579
* @cell_area: cell area as passed to @gtk_cell_renderer_render
580
* @flags: render flags
582
* Passes an activate event to the cell renderer for possible processing. Some
583
* cell renderers may use events; for example, #GtkCellRendererToggle toggles
584
* when it gets a mouse click.
586
* Return value: %TRUE if the event was consumed/handled
589
gtk_cell_renderer_activate (GtkCellRenderer *cell,
593
GdkRectangle *background_area,
594
GdkRectangle *cell_area,
595
GtkCellRendererState flags)
597
g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), FALSE);
599
if (cell->mode != GTK_CELL_RENDERER_MODE_ACTIVATABLE)
602
if (GTK_CELL_RENDERER_GET_CLASS (cell)->activate == NULL)
605
return GTK_CELL_RENDERER_GET_CLASS (cell)->activate (cell,
615
* gtk_cell_renderer_start_editing:
616
* @cell: a #GtkCellRenderer
617
* @event: a #GdkEvent
618
* @widget: widget that received the event
619
* @path: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
620
* @background_area: background area as passed to @gtk_cell_renderer_render
621
* @cell_area: cell area as passed to @gtk_cell_renderer_render
622
* @flags: render flags
624
* Passes an activate event to the cell renderer for possible processing.
626
* Return value: A new #GtkCellEditable, or %NULL
629
gtk_cell_renderer_start_editing (GtkCellRenderer *cell,
633
GdkRectangle *background_area,
634
GdkRectangle *cell_area,
635
GtkCellRendererState flags)
638
GtkCellEditable *editable;
640
g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell), NULL);
642
if (cell->mode != GTK_CELL_RENDERER_MODE_EDITABLE)
645
if (GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing == NULL)
648
editable = GTK_CELL_RENDERER_GET_CLASS (cell)->start_editing (cell,
657
cell_renderer_signals[EDITING_STARTED], 0,
660
cell->editing = TRUE;
666
* gtk_cell_renderer_set_fixed_size:
667
* @cell: A #GtkCellRenderer
668
* @width: the width of the cell renderer, or -1
669
* @height: the height of the cell renderer, or -1
671
* Sets the renderer size to be explicit, independent of the properties set.
674
gtk_cell_renderer_set_fixed_size (GtkCellRenderer *cell,
678
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
679
g_return_if_fail (width >= -1 && height >= -1);
681
if ((width != cell->width) || (height != cell->height))
683
g_object_freeze_notify (G_OBJECT (cell));
685
if (width != cell->width)
688
g_object_notify (G_OBJECT (cell), "width");
691
if (height != cell->height)
693
cell->height = height;
694
g_object_notify (G_OBJECT (cell), "height");
697
g_object_thaw_notify (G_OBJECT (cell));
702
* gtk_cell_renderer_get_fixed_size:
703
* @cell: A #GtkCellRenderer
704
* @width: location to fill in with the fixed width of the widget, or %NULL
705
* @height: location to fill in with the fixed height of the widget, or %NULL
707
* Fills in @width and @height with the appropriate size of @cell.
710
gtk_cell_renderer_get_fixed_size (GtkCellRenderer *cell,
714
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
717
(* width) = cell->width;
719
(* height) = cell->height;
723
* gtk_cell_renderer_editing_canceled:
724
* @cell: A #GtkCellRenderer
726
* Causes the cell renderer to emit the "editing-canceled" signal. This
727
* function is for use only by implementations of cell renderers that need to
728
* notify the client program that an editing process was canceled and the
729
* changes were not committed.
732
* Deprecated: 2.6: Use gtk_cell_renderer_stop_editing() instead
735
gtk_cell_renderer_editing_canceled (GtkCellRenderer *cell)
737
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
739
gtk_cell_renderer_stop_editing (cell, TRUE);
743
* gtk_cell_renderer_stop_editing:
744
* @cell: A #GtkCellRenderer
745
* @canceled: %TRUE if the editing has been canceled
747
* Informs the cell renderer that the editing is stopped.
748
* If @canceled is %TRUE, the cell renderer will emit the "editing-canceled"
749
* signal. This function should be called by cell renderer implementations
750
* in response to the "editing-done" signal of #GtkCellEditable.
755
gtk_cell_renderer_stop_editing (GtkCellRenderer *cell,
758
g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
762
cell->editing = FALSE;
764
g_signal_emit (cell, cell_renderer_signals[EDITING_CANCELED], 0);
768
#define __GTK_CELL_RENDERER_C__
769
#include "gtkaliasdef.c"