1 /* gtkcellrenderertext.c
2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
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.
23 #include "gtkcellrenderertext.h"
24 #include "gtkeditable.h"
26 #include "gtkmarshalers.h"
28 #include "gtktreeprivate.h"
30 static void gtk_cell_renderer_text_init (GtkCellRendererText *celltext);
31 static void gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class);
32 static void gtk_cell_renderer_text_finalize (GObject *object);
34 static void gtk_cell_renderer_text_get_property (GObject *object,
38 static void gtk_cell_renderer_text_set_property (GObject *object,
42 static void gtk_cell_renderer_text_get_size (GtkCellRenderer *cell,
44 GdkRectangle *cell_area,
49 static void gtk_cell_renderer_text_render (GtkCellRenderer *cell,
52 GdkRectangle *background_area,
53 GdkRectangle *cell_area,
54 GdkRectangle *expose_area,
55 GtkCellRendererState flags);
57 static GtkCellEditable *gtk_cell_renderer_text_start_editing (GtkCellRenderer *cell,
61 GdkRectangle *background_area,
62 GdkRectangle *cell_area,
63 GtkCellRendererState flags);
76 PROP_SINGLE_PARAGRAPH_MODE,
100 /* Whether-a-style-arg-is-set args */
111 PROP_STRIKETHROUGH_SET,
118 static gpointer parent_class;
119 static guint text_cell_renderer_signals [LAST_SIGNAL];
121 #define GTK_CELL_RENDERER_TEXT_PATH "gtk-cell-renderer-text-path"
123 #define GTK_CELL_RENDERER_TEXT_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_CELL_RENDERER_TEXT, GtkCellRendererTextPrivate))
125 typedef struct _GtkCellRendererTextPrivate GtkCellRendererTextPrivate;
126 struct _GtkCellRendererTextPrivate
128 guint single_paragraph : 1;
129 guint language_set : 1;
130 guint markup_set : 1;
131 guint ellipsize_set : 1;
134 PangoLanguage *language;
135 PangoEllipsizeMode ellipsize;
137 gulong populate_popup_id;
138 gulong entry_menu_popdown_timeout;
139 gboolean in_entry_menu;
146 gtk_cell_renderer_text_get_type (void)
148 static GType cell_text_type = 0;
152 static const GTypeInfo cell_text_info =
154 sizeof (GtkCellRendererTextClass),
155 NULL, /* base_init */
156 NULL, /* base_finalize */
157 (GClassInitFunc) gtk_cell_renderer_text_class_init,
158 NULL, /* class_finalize */
159 NULL, /* class_data */
160 sizeof (GtkCellRendererText),
162 (GInstanceInitFunc) gtk_cell_renderer_text_init,
166 g_type_register_static (GTK_TYPE_CELL_RENDERER, "GtkCellRendererText",
170 return cell_text_type;
174 gtk_cell_renderer_text_init (GtkCellRendererText *celltext)
176 GTK_CELL_RENDERER (celltext)->xalign = 0.0;
177 GTK_CELL_RENDERER (celltext)->yalign = 0.5;
178 GTK_CELL_RENDERER (celltext)->xpad = 2;
179 GTK_CELL_RENDERER (celltext)->ypad = 2;
180 celltext->fixed_height_rows = -1;
181 celltext->font = pango_font_description_new ();
185 gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class)
187 GObjectClass *object_class = G_OBJECT_CLASS (class);
188 GtkCellRendererClass *cell_class = GTK_CELL_RENDERER_CLASS (class);
190 parent_class = g_type_class_peek_parent (class);
192 object_class->finalize = gtk_cell_renderer_text_finalize;
194 object_class->get_property = gtk_cell_renderer_text_get_property;
195 object_class->set_property = gtk_cell_renderer_text_set_property;
197 cell_class->get_size = gtk_cell_renderer_text_get_size;
198 cell_class->render = gtk_cell_renderer_text_render;
199 cell_class->start_editing = gtk_cell_renderer_text_start_editing;
201 g_object_class_install_property (object_class,
203 g_param_spec_string ("text",
205 P_("Text to render"),
209 g_object_class_install_property (object_class,
211 g_param_spec_string ("markup",
213 P_("Marked up text to render"),
217 g_object_class_install_property (object_class,
219 g_param_spec_boxed ("attributes",
221 P_("A list of style attributes to apply to the text of the renderer"),
222 PANGO_TYPE_ATTR_LIST,
225 g_object_class_install_property (object_class,
226 PROP_SINGLE_PARAGRAPH_MODE,
227 g_param_spec_boolean ("single_paragraph_mode",
228 P_("Single Paragraph Mode"),
229 P_("Whether or not to keep all text in a single paragraph"),
234 g_object_class_install_property (object_class,
236 g_param_spec_string ("background",
237 P_("Background color name"),
238 P_("Background color as a string"),
242 g_object_class_install_property (object_class,
244 g_param_spec_boxed ("background_gdk",
245 P_("Background color"),
246 P_("Background color as a GdkColor"),
248 G_PARAM_READABLE | G_PARAM_WRITABLE));
250 g_object_class_install_property (object_class,
252 g_param_spec_string ("foreground",
253 P_("Foreground color name"),
254 P_("Foreground color as a string"),
258 g_object_class_install_property (object_class,
260 g_param_spec_boxed ("foreground_gdk",
261 P_("Foreground color"),
262 P_("Foreground color as a GdkColor"),
264 G_PARAM_READABLE | G_PARAM_WRITABLE));
267 g_object_class_install_property (object_class,
269 g_param_spec_boolean ("editable",
271 P_("Whether the text can be modified by the user"),
273 G_PARAM_READABLE | G_PARAM_WRITABLE));
275 g_object_class_install_property (object_class,
277 g_param_spec_string ("font",
279 P_("Font description as a string"),
281 G_PARAM_READABLE | G_PARAM_WRITABLE));
283 g_object_class_install_property (object_class,
285 g_param_spec_boxed ("font_desc",
287 P_("Font description as a PangoFontDescription struct"),
288 PANGO_TYPE_FONT_DESCRIPTION,
289 G_PARAM_READABLE | G_PARAM_WRITABLE));
292 g_object_class_install_property (object_class,
294 g_param_spec_string ("family",
296 P_("Name of the font family, e.g. Sans, Helvetica, Times, Monospace"),
298 G_PARAM_READABLE | G_PARAM_WRITABLE));
300 g_object_class_install_property (object_class,
302 g_param_spec_enum ("style",
307 G_PARAM_READABLE | G_PARAM_WRITABLE));
309 g_object_class_install_property (object_class,
311 g_param_spec_enum ("variant",
315 PANGO_VARIANT_NORMAL,
316 G_PARAM_READABLE | G_PARAM_WRITABLE));
318 g_object_class_install_property (object_class,
320 g_param_spec_int ("weight",
326 G_PARAM_READABLE | G_PARAM_WRITABLE));
328 g_object_class_install_property (object_class,
330 g_param_spec_enum ("stretch",
334 PANGO_STRETCH_NORMAL,
335 G_PARAM_READABLE | G_PARAM_WRITABLE));
337 g_object_class_install_property (object_class,
339 g_param_spec_int ("size",
345 G_PARAM_READABLE | G_PARAM_WRITABLE));
347 g_object_class_install_property (object_class,
349 g_param_spec_double ("size_points",
351 P_("Font size in points"),
355 G_PARAM_READABLE | G_PARAM_WRITABLE));
357 g_object_class_install_property (object_class,
359 g_param_spec_double ("scale",
361 P_("Font scaling factor"),
365 G_PARAM_READABLE | G_PARAM_WRITABLE));
367 g_object_class_install_property (object_class,
369 g_param_spec_int ("rise",
371 P_("Offset of text above the baseline (below the baseline if rise is negative)"),
375 G_PARAM_READABLE | G_PARAM_WRITABLE));
378 g_object_class_install_property (object_class,
380 g_param_spec_boolean ("strikethrough",
382 P_("Whether to strike through the text"),
384 G_PARAM_READABLE | G_PARAM_WRITABLE));
386 g_object_class_install_property (object_class,
388 g_param_spec_enum ("underline",
390 P_("Style of underline for this text"),
391 PANGO_TYPE_UNDERLINE,
392 PANGO_UNDERLINE_NONE,
393 G_PARAM_READABLE | G_PARAM_WRITABLE));
395 g_object_class_install_property (object_class,
397 g_param_spec_string ("language",
399 P_("The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If you don't understand this parameter, you probably don't need it"),
404 g_object_class_install_property (object_class,
406 g_param_spec_enum ("ellipsize",
408 P_("The preferred place to ellipsize the string, if the cell renderer does not have enough room to display the entire string, if at all"),
409 PANGO_TYPE_ELLIPSIZE_MODE,
410 PANGO_ELLIPSIZE_NONE,
413 /* Style props are set or not */
415 #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))
417 ADD_SET_PROP ("background_set", PROP_BACKGROUND_SET,
418 P_("Background set"),
419 P_("Whether this tag affects the background color"));
421 ADD_SET_PROP ("foreground_set", PROP_FOREGROUND_SET,
422 P_("Foreground set"),
423 P_("Whether this tag affects the foreground color"));
425 ADD_SET_PROP ("editable_set", PROP_EDITABLE_SET,
426 P_("Editability set"),
427 P_("Whether this tag affects text editability"));
429 ADD_SET_PROP ("family_set", PROP_FAMILY_SET,
430 P_("Font family set"),
431 P_("Whether this tag affects the font family"));
433 ADD_SET_PROP ("style_set", PROP_STYLE_SET,
434 P_("Font style set"),
435 P_("Whether this tag affects the font style"));
437 ADD_SET_PROP ("variant_set", PROP_VARIANT_SET,
438 P_("Font variant set"),
439 P_("Whether this tag affects the font variant"));
441 ADD_SET_PROP ("weight_set", PROP_WEIGHT_SET,
442 P_("Font weight set"),
443 P_("Whether this tag affects the font weight"));
445 ADD_SET_PROP ("stretch_set", PROP_STRETCH_SET,
446 P_("Font stretch set"),
447 P_("Whether this tag affects the font stretch"));
449 ADD_SET_PROP ("size_set", PROP_SIZE_SET,
451 P_("Whether this tag affects the font size"));
453 ADD_SET_PROP ("scale_set", PROP_SCALE_SET,
454 P_("Font scale set"),
455 P_("Whether this tag scales the font size by a factor"));
457 ADD_SET_PROP ("rise_set", PROP_RISE_SET,
459 P_("Whether this tag affects the rise"));
461 ADD_SET_PROP ("strikethrough_set", PROP_STRIKETHROUGH_SET,
462 P_("Strikethrough set"),
463 P_("Whether this tag affects strikethrough"));
465 ADD_SET_PROP ("underline_set", PROP_UNDERLINE_SET,
467 P_("Whether this tag affects underlining"));
469 ADD_SET_PROP ("language_set", PROP_LANGUAGE_SET,
471 P_("Whether this tag affects the language the text is rendered as"));
473 ADD_SET_PROP ("ellipsize_set", PROP_ELLIPSIZE_SET,
475 P_("Whether this tag affects the ellipsize mode"));
477 text_cell_renderer_signals [EDITED] =
478 g_signal_new ("edited",
479 G_OBJECT_CLASS_TYPE (object_class),
481 G_STRUCT_OFFSET (GtkCellRendererTextClass, edited),
483 _gtk_marshal_VOID__STRING_STRING,
488 g_type_class_add_private (object_class, sizeof (GtkCellRendererTextPrivate));
492 gtk_cell_renderer_text_finalize (GObject *object)
494 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (object);
495 GtkCellRendererTextPrivate *priv;
497 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (object);
499 pango_font_description_free (celltext->font);
502 g_free (celltext->text);
504 if (celltext->extra_attrs)
505 pango_attr_list_unref (celltext->extra_attrs);
508 g_object_unref (priv->language);
510 (* G_OBJECT_CLASS (parent_class)->finalize) (object);
514 get_property_font_set_mask (guint prop_id)
518 case PROP_FAMILY_SET:
519 return PANGO_FONT_MASK_FAMILY;
521 return PANGO_FONT_MASK_STYLE;
522 case PROP_VARIANT_SET:
523 return PANGO_FONT_MASK_VARIANT;
524 case PROP_WEIGHT_SET:
525 return PANGO_FONT_MASK_WEIGHT;
526 case PROP_STRETCH_SET:
527 return PANGO_FONT_MASK_STRETCH;
529 return PANGO_FONT_MASK_SIZE;
536 gtk_cell_renderer_text_get_property (GObject *object,
541 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (object);
542 GtkCellRendererTextPrivate *priv;
544 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (object);
549 g_value_set_string (value, celltext->text);
552 case PROP_ATTRIBUTES:
553 g_value_set_boxed (value, celltext->extra_attrs);
556 case PROP_SINGLE_PARAGRAPH_MODE:
557 g_value_set_boolean (value, priv->single_paragraph);
560 case PROP_BACKGROUND_GDK:
564 color.red = celltext->background.red;
565 color.green = celltext->background.green;
566 color.blue = celltext->background.blue;
568 g_value_set_boxed (value, &color);
572 case PROP_FOREGROUND_GDK:
576 color.red = celltext->foreground.red;
577 color.green = celltext->foreground.green;
578 color.blue = celltext->foreground.blue;
580 g_value_set_boxed (value, &color);
586 /* FIXME GValue imposes a totally gratuitous string copy
587 * here, we could just hand off string ownership
589 gchar *str = pango_font_description_to_string (celltext->font);
590 g_value_set_string (value, str);
596 g_value_set_boxed (value, celltext->font);
600 g_value_set_string (value, pango_font_description_get_family (celltext->font));
604 g_value_set_enum (value, pango_font_description_get_style (celltext->font));
608 g_value_set_enum (value, pango_font_description_get_variant (celltext->font));
612 g_value_set_int (value, pango_font_description_get_weight (celltext->font));
616 g_value_set_enum (value, pango_font_description_get_stretch (celltext->font));
620 g_value_set_int (value, pango_font_description_get_size (celltext->font));
623 case PROP_SIZE_POINTS:
624 g_value_set_double (value, ((double)pango_font_description_get_size (celltext->font)) / (double)PANGO_SCALE);
628 g_value_set_double (value, celltext->font_scale);
632 g_value_set_boolean (value, celltext->editable);
635 case PROP_STRIKETHROUGH:
636 g_value_set_boolean (value, celltext->strikethrough);
640 g_value_set_enum (value, celltext->underline_style);
644 g_value_set_int (value, celltext->rise);
648 g_value_set_string (value, pango_language_to_string (priv->language));
652 g_value_set_enum (value, priv->ellipsize);
655 case PROP_BACKGROUND_SET:
656 g_value_set_boolean (value, celltext->background_set);
659 case PROP_FOREGROUND_SET:
660 g_value_set_boolean (value, celltext->foreground_set);
663 case PROP_FAMILY_SET:
665 case PROP_VARIANT_SET:
666 case PROP_WEIGHT_SET:
667 case PROP_STRETCH_SET:
670 PangoFontMask mask = get_property_font_set_mask (param_id);
671 g_value_set_boolean (value, (pango_font_description_get_set_fields (celltext->font) & mask) != 0);
677 g_value_set_boolean (value, celltext->scale_set);
680 case PROP_EDITABLE_SET:
681 g_value_set_boolean (value, celltext->editable_set);
684 case PROP_STRIKETHROUGH_SET:
685 g_value_set_boolean (value, celltext->strikethrough_set);
688 case PROP_UNDERLINE_SET:
689 g_value_set_boolean (value, celltext->underline_set);
693 g_value_set_boolean (value, celltext->rise_set);
696 case PROP_LANGUAGE_SET:
697 g_value_set_boolean (value, priv->language_set);
700 case PROP_ELLIPSIZE_SET:
701 g_value_set_boolean (value, priv->ellipsize_set);
704 case PROP_BACKGROUND:
705 case PROP_FOREGROUND:
708 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
715 set_bg_color (GtkCellRendererText *celltext,
720 if (!celltext->background_set)
722 celltext->background_set = TRUE;
723 g_object_notify (G_OBJECT (celltext), "background_set");
726 celltext->background.red = color->red;
727 celltext->background.green = color->green;
728 celltext->background.blue = color->blue;
732 if (celltext->background_set)
734 celltext->background_set = FALSE;
735 g_object_notify (G_OBJECT (celltext), "background_set");
742 set_fg_color (GtkCellRendererText *celltext,
747 if (!celltext->foreground_set)
749 celltext->foreground_set = TRUE;
750 g_object_notify (G_OBJECT (celltext), "foreground_set");
753 celltext->foreground.red = color->red;
754 celltext->foreground.green = color->green;
755 celltext->foreground.blue = color->blue;
759 if (celltext->foreground_set)
761 celltext->foreground_set = FALSE;
762 g_object_notify (G_OBJECT (celltext), "foreground_set");
768 set_font_desc_fields (PangoFontDescription *desc,
769 PangoFontMask to_set)
771 PangoFontMask changed_mask = 0;
773 if (to_set & PANGO_FONT_MASK_FAMILY)
775 const char *family = pango_font_description_get_family (desc);
779 changed_mask |= PANGO_FONT_MASK_FAMILY;
782 pango_font_description_set_family (desc, family);
784 if (to_set & PANGO_FONT_MASK_STYLE)
785 pango_font_description_set_style (desc, pango_font_description_get_style (desc));
786 if (to_set & PANGO_FONT_MASK_VARIANT)
787 pango_font_description_set_variant (desc, pango_font_description_get_variant (desc));
788 if (to_set & PANGO_FONT_MASK_WEIGHT)
789 pango_font_description_set_weight (desc, pango_font_description_get_weight (desc));
790 if (to_set & PANGO_FONT_MASK_STRETCH)
791 pango_font_description_set_stretch (desc, pango_font_description_get_stretch (desc));
792 if (to_set & PANGO_FONT_MASK_SIZE)
794 gint size = pango_font_description_get_size (desc);
797 size = 10 * PANGO_SCALE;
798 changed_mask |= PANGO_FONT_MASK_SIZE;
801 pango_font_description_set_size (desc, size);
808 notify_set_changed (GObject *object,
809 PangoFontMask changed_mask)
811 if (changed_mask & PANGO_FONT_MASK_FAMILY)
812 g_object_notify (object, "family_set");
813 if (changed_mask & PANGO_FONT_MASK_STYLE)
814 g_object_notify (object, "style_set");
815 if (changed_mask & PANGO_FONT_MASK_VARIANT)
816 g_object_notify (object, "variant_set");
817 if (changed_mask & PANGO_FONT_MASK_WEIGHT)
818 g_object_notify (object, "weight_set");
819 if (changed_mask & PANGO_FONT_MASK_STRETCH)
820 g_object_notify (object, "stretch_set");
821 if (changed_mask & PANGO_FONT_MASK_SIZE)
822 g_object_notify (object, "size_set");
826 notify_fields_changed (GObject *object,
827 PangoFontMask changed_mask)
829 if (changed_mask & PANGO_FONT_MASK_FAMILY)
830 g_object_notify (object, "family");
831 if (changed_mask & PANGO_FONT_MASK_STYLE)
832 g_object_notify (object, "style");
833 if (changed_mask & PANGO_FONT_MASK_VARIANT)
834 g_object_notify (object, "variant");
835 if (changed_mask & PANGO_FONT_MASK_WEIGHT)
836 g_object_notify (object, "weight");
837 if (changed_mask & PANGO_FONT_MASK_STRETCH)
838 g_object_notify (object, "stretch");
839 if (changed_mask & PANGO_FONT_MASK_SIZE)
840 g_object_notify (object, "size");
844 set_font_description (GtkCellRendererText *celltext,
845 PangoFontDescription *font_desc)
847 GObject *object = G_OBJECT (celltext);
848 PangoFontDescription *new_font_desc;
849 PangoFontMask old_mask, new_mask, changed_mask, set_changed_mask;
852 new_font_desc = pango_font_description_copy (font_desc);
854 new_font_desc = pango_font_description_new ();
856 old_mask = pango_font_description_get_set_fields (celltext->font);
857 new_mask = pango_font_description_get_set_fields (new_font_desc);
859 changed_mask = old_mask | new_mask;
860 set_changed_mask = old_mask ^ new_mask;
862 pango_font_description_free (celltext->font);
863 celltext->font = new_font_desc;
865 g_object_freeze_notify (object);
867 g_object_notify (object, "font_desc");
868 g_object_notify (object, "font");
870 if (changed_mask & PANGO_FONT_MASK_FAMILY)
871 g_object_notify (object, "family");
872 if (changed_mask & PANGO_FONT_MASK_STYLE)
873 g_object_notify (object, "style");
874 if (changed_mask & PANGO_FONT_MASK_VARIANT)
875 g_object_notify (object, "variant");
876 if (changed_mask & PANGO_FONT_MASK_WEIGHT)
877 g_object_notify (object, "weight");
878 if (changed_mask & PANGO_FONT_MASK_STRETCH)
879 g_object_notify (object, "stretch");
880 if (changed_mask & PANGO_FONT_MASK_SIZE)
882 g_object_notify (object, "size");
883 g_object_notify (object, "size_points");
886 notify_set_changed (object, set_changed_mask);
888 g_object_thaw_notify (object);
892 gtk_cell_renderer_text_set_property (GObject *object,
897 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (object);
898 GtkCellRendererTextPrivate *priv;
900 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (object);
906 g_free (celltext->text);
908 if (priv->markup_set)
910 if (celltext->extra_attrs)
911 pango_attr_list_unref (celltext->extra_attrs);
912 celltext->extra_attrs = NULL;
913 priv->markup_set = FALSE;
916 celltext->text = g_strdup (g_value_get_string (value));
917 g_object_notify (object, "text");
920 case PROP_ATTRIBUTES:
921 if (celltext->extra_attrs)
922 pango_attr_list_unref (celltext->extra_attrs);
924 celltext->extra_attrs = g_value_get_boxed (value);
925 if (celltext->extra_attrs)
926 pango_attr_list_ref (celltext->extra_attrs);
932 GError *error = NULL;
933 PangoAttrList *attrs = NULL;
935 str = g_value_get_string (value);
936 if (str && !pango_parse_markup (str,
944 g_warning ("Failed to set cell text from markup due to error parsing markup: %s",
946 g_error_free (error);
951 g_free (celltext->text);
953 if (celltext->extra_attrs)
954 pango_attr_list_unref (celltext->extra_attrs);
956 celltext->text = text;
957 celltext->extra_attrs = attrs;
958 priv->markup_set = TRUE;
962 case PROP_SINGLE_PARAGRAPH_MODE:
963 priv->single_paragraph = g_value_get_boolean (value);
966 case PROP_BACKGROUND:
970 if (!g_value_get_string (value))
971 set_bg_color (celltext, NULL); /* reset to backgrounmd_set to FALSE */
972 else if (gdk_color_parse (g_value_get_string (value), &color))
973 set_bg_color (celltext, &color);
975 g_warning ("Don't know color `%s'", g_value_get_string (value));
977 g_object_notify (object, "background_gdk");
981 case PROP_FOREGROUND:
985 if (!g_value_get_string (value))
986 set_fg_color (celltext, NULL); /* reset to foreground_set to FALSE */
987 else if (gdk_color_parse (g_value_get_string (value), &color))
988 set_fg_color (celltext, &color);
990 g_warning ("Don't know color `%s'", g_value_get_string (value));
992 g_object_notify (object, "foreground_gdk");
996 case PROP_BACKGROUND_GDK:
997 /* This notifies the GObject itself. */
998 set_bg_color (celltext, g_value_get_boxed (value));
1001 case PROP_FOREGROUND_GDK:
1002 /* This notifies the GObject itself. */
1003 set_fg_color (celltext, g_value_get_boxed (value));
1008 PangoFontDescription *font_desc = NULL;
1011 name = g_value_get_string (value);
1014 font_desc = pango_font_description_from_string (name);
1016 set_font_description (celltext, font_desc);
1018 pango_font_description_free (font_desc);
1020 if (celltext->fixed_height_rows != -1)
1021 celltext->calc_fixed_height = TRUE;
1025 case PROP_FONT_DESC:
1026 set_font_description (celltext, g_value_get_boxed (value));
1028 if (celltext->fixed_height_rows != -1)
1029 celltext->calc_fixed_height = TRUE;
1038 case PROP_SIZE_POINTS:
1040 PangoFontMask old_set_mask = pango_font_description_get_set_fields (celltext->font);
1045 pango_font_description_set_family (celltext->font,
1046 g_value_get_string (value));
1049 pango_font_description_set_style (celltext->font,
1050 g_value_get_enum (value));
1053 pango_font_description_set_variant (celltext->font,
1054 g_value_get_enum (value));
1057 pango_font_description_set_weight (celltext->font,
1058 g_value_get_int (value));
1061 pango_font_description_set_stretch (celltext->font,
1062 g_value_get_enum (value));
1065 pango_font_description_set_size (celltext->font,
1066 g_value_get_int (value));
1067 g_object_notify (object, "size_points");
1069 case PROP_SIZE_POINTS:
1070 pango_font_description_set_size (celltext->font,
1071 g_value_get_double (value) * PANGO_SCALE);
1072 g_object_notify (object, "size");
1076 if (celltext->fixed_height_rows != -1)
1077 celltext->calc_fixed_height = TRUE;
1079 notify_set_changed (object, old_set_mask & pango_font_description_get_set_fields (celltext->font));
1080 g_object_notify (object, "font_desc");
1081 g_object_notify (object, "font");
1087 celltext->font_scale = g_value_get_double (value);
1088 celltext->scale_set = TRUE;
1089 if (celltext->fixed_height_rows != -1)
1090 celltext->calc_fixed_height = TRUE;
1091 g_object_notify (object, "scale_set");
1095 celltext->editable = g_value_get_boolean (value);
1096 celltext->editable_set = TRUE;
1097 if (celltext->editable)
1098 GTK_CELL_RENDERER (celltext)->mode = GTK_CELL_RENDERER_MODE_EDITABLE;
1100 GTK_CELL_RENDERER (celltext)->mode = GTK_CELL_RENDERER_MODE_INERT;
1101 g_object_notify (object, "editable_set");
1104 case PROP_STRIKETHROUGH:
1105 celltext->strikethrough = g_value_get_boolean (value);
1106 celltext->strikethrough_set = TRUE;
1107 g_object_notify (object, "strikethrough_set");
1110 case PROP_UNDERLINE:
1111 celltext->underline_style = g_value_get_enum (value);
1112 celltext->underline_set = TRUE;
1113 g_object_notify (object, "underline_set");
1118 celltext->rise = g_value_get_int (value);
1119 celltext->rise_set = TRUE;
1120 g_object_notify (object, "rise_set");
1121 if (celltext->fixed_height_rows != -1)
1122 celltext->calc_fixed_height = TRUE;
1126 priv->language_set = TRUE;
1128 g_object_unref (priv->language);
1129 priv->language = pango_language_from_string (g_value_get_string (value));
1130 g_object_notify (object, "language_set");
1133 case PROP_ELLIPSIZE:
1134 priv->ellipsize = g_value_get_enum (value);
1135 priv->ellipsize_set = TRUE;
1136 g_object_notify (object, "ellipsize_set");
1139 case PROP_BACKGROUND_SET:
1140 celltext->background_set = g_value_get_boolean (value);
1143 case PROP_FOREGROUND_SET:
1144 celltext->foreground_set = g_value_get_boolean (value);
1147 case PROP_FAMILY_SET:
1148 case PROP_STYLE_SET:
1149 case PROP_VARIANT_SET:
1150 case PROP_WEIGHT_SET:
1151 case PROP_STRETCH_SET:
1153 if (!g_value_get_boolean (value))
1155 pango_font_description_unset_fields (celltext->font,
1156 get_property_font_set_mask (param_id));
1160 PangoFontMask changed_mask;
1162 changed_mask = set_font_desc_fields (celltext->font,
1163 get_property_font_set_mask (param_id));
1164 notify_fields_changed (G_OBJECT (celltext), changed_mask);
1168 case PROP_SCALE_SET:
1169 celltext->scale_set = g_value_get_boolean (value);
1172 case PROP_EDITABLE_SET:
1173 celltext->editable_set = g_value_get_boolean (value);
1176 case PROP_STRIKETHROUGH_SET:
1177 celltext->strikethrough_set = g_value_get_boolean (value);
1180 case PROP_UNDERLINE_SET:
1181 celltext->underline_set = g_value_get_boolean (value);
1185 celltext->rise_set = g_value_get_boolean (value);
1188 case PROP_LANGUAGE_SET:
1189 priv->language_set = g_value_get_boolean (value);
1192 case PROP_ELLIPSIZE_SET:
1193 priv->ellipsize_set = g_value_get_enum (value);
1197 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
1203 * gtk_cell_renderer_text_new:
1205 * Creates a new #GtkCellRendererText. Adjust how text is drawn using
1206 * object properties. Object properties can be
1207 * set globally (with g_object_set()). Also, with #GtkTreeViewColumn,
1208 * you can bind a property to a value in a #GtkTreeModel. For example,
1209 * you can bind the "text" property on the cell renderer to a string
1210 * value in the model, thus rendering a different string in each row
1211 * of the #GtkTreeView
1213 * Return value: the new cell renderer
1216 gtk_cell_renderer_text_new (void)
1218 return g_object_new (GTK_TYPE_CELL_RENDERER_TEXT, NULL);
1222 add_attr (PangoAttrList *attr_list,
1223 PangoAttribute *attr)
1225 attr->start_index = 0;
1226 attr->end_index = G_MAXINT;
1228 pango_attr_list_insert (attr_list, attr);
1232 get_layout (GtkCellRendererText *celltext,
1234 gboolean will_render,
1235 GtkCellRendererState flags)
1237 PangoAttrList *attr_list;
1238 PangoLayout *layout;
1239 PangoUnderline uline;
1240 GtkCellRendererTextPrivate *priv;
1242 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (celltext);
1244 layout = gtk_widget_create_pango_layout (widget, celltext->text);
1246 if (celltext->extra_attrs)
1247 attr_list = pango_attr_list_copy (celltext->extra_attrs);
1249 attr_list = pango_attr_list_new ();
1251 pango_layout_set_single_paragraph_mode (layout, priv->single_paragraph);
1255 /* Add options that affect appearance but not size */
1257 /* note that background doesn't go here, since it affects
1258 * background_area not the PangoLayout area
1261 if (celltext->foreground_set)
1265 color = celltext->foreground;
1267 add_attr (attr_list,
1268 pango_attr_foreground_new (color.red, color.green, color.blue));
1271 if (celltext->strikethrough_set)
1272 add_attr (attr_list,
1273 pango_attr_strikethrough_new (celltext->strikethrough));
1276 add_attr (attr_list, pango_attr_font_desc_new (celltext->font));
1278 if (celltext->scale_set &&
1279 celltext->font_scale != 1.0)
1280 add_attr (attr_list, pango_attr_scale_new (celltext->font_scale));
1282 if (celltext->underline_set)
1283 uline = celltext->underline_style;
1285 uline = PANGO_UNDERLINE_NONE;
1287 if (priv->language_set)
1288 add_attr (attr_list, pango_attr_language_new (priv->language));
1290 if ((flags & GTK_CELL_RENDERER_PRELIT) == GTK_CELL_RENDERER_PRELIT)
1294 case PANGO_UNDERLINE_NONE:
1295 uline = PANGO_UNDERLINE_SINGLE;
1298 case PANGO_UNDERLINE_SINGLE:
1299 uline = PANGO_UNDERLINE_DOUBLE;
1307 if (uline != PANGO_UNDERLINE_NONE)
1308 add_attr (attr_list, pango_attr_underline_new (celltext->underline_style));
1310 if (celltext->rise_set)
1311 add_attr (attr_list, pango_attr_rise_new (celltext->rise));
1313 if (priv->ellipsize_set)
1314 pango_layout_set_ellipsize (layout, priv->ellipsize);
1316 pango_layout_set_ellipsize (layout, PANGO_ELLIPSIZE_NONE);
1318 pango_layout_set_attributes (layout, attr_list);
1319 pango_layout_set_width (layout, -1);
1321 pango_attr_list_unref (attr_list);
1327 gtk_cell_renderer_text_get_size (GtkCellRenderer *cell,
1329 GdkRectangle *cell_area,
1335 GtkCellRendererText *celltext = (GtkCellRendererText *) cell;
1336 PangoRectangle rect;
1337 PangoLayout *layout;
1338 GtkCellRendererTextPrivate *priv;
1340 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (cell);
1342 if (celltext->calc_fixed_height)
1344 PangoContext *context;
1345 PangoFontMetrics *metrics;
1346 PangoFontDescription *font_desc;
1349 font_desc = pango_font_description_copy (widget->style->font_desc);
1350 pango_font_description_merge (font_desc, celltext->font, TRUE);
1352 if (celltext->scale_set)
1353 pango_font_description_set_size (font_desc,
1354 celltext->font_scale * pango_font_description_get_size (font_desc));
1356 context = gtk_widget_get_pango_context (widget);
1358 metrics = pango_context_get_metrics (context,
1360 pango_context_get_language (context));
1361 row_height = (pango_font_metrics_get_ascent (metrics) +
1362 pango_font_metrics_get_descent (metrics));
1363 pango_font_metrics_unref (metrics);
1365 pango_font_description_free (font_desc);
1367 gtk_cell_renderer_set_fixed_size (cell,
1368 cell->width, 2*cell->ypad +
1369 celltext->fixed_height_rows * PANGO_PIXELS (row_height));
1373 *height = cell->height;
1376 celltext->calc_fixed_height = FALSE;
1381 layout = get_layout (celltext, widget, FALSE, 0);
1383 pango_layout_get_pixel_extents (layout, NULL, &rect);
1386 *height = GTK_CELL_RENDERER (celltext)->ypad * 2 + rect.height;
1388 /* The minimum size for ellipsized labels is ~ 3 chars */
1391 if (priv->ellipsize)
1393 PangoContext *context;
1394 PangoFontMetrics *metrics;
1397 context = pango_layout_get_context (layout);
1398 metrics = pango_context_get_metrics (context, widget->style->font_desc, NULL);
1400 char_width = pango_font_metrics_get_approximate_char_width (metrics);
1401 pango_font_metrics_unref (metrics);
1403 *width += (PANGO_PIXELS (char_width) * 3);
1407 *width = GTK_CELL_RENDERER (celltext)->xpad * 2 + rect.width;
1415 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
1416 *x_offset = (1.0 - cell->xalign) * (cell_area->width - rect.width - (2 * cell->xpad));
1418 *x_offset = cell->xalign * (cell_area->width - rect.width - (2 * cell->xpad));
1420 if (priv->ellipsize)
1421 *x_offset = MAX(*x_offset, 0);
1425 *y_offset = cell->yalign * (cell_area->height - rect.height - (2 * cell->ypad));
1426 *y_offset = MAX (*y_offset, 0);
1430 g_object_unref (layout);
1434 gtk_cell_renderer_text_render (GtkCellRenderer *cell,
1435 GdkDrawable *window,
1437 GdkRectangle *background_area,
1438 GdkRectangle *cell_area,
1439 GdkRectangle *expose_area,
1440 GtkCellRendererState flags)
1443 GtkCellRendererText *celltext = (GtkCellRendererText *) cell;
1444 PangoLayout *layout;
1448 GtkCellRendererTextPrivate *priv;
1450 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (cell);
1452 layout = get_layout (celltext, widget, TRUE, flags);
1454 gtk_cell_renderer_text_get_size (cell, widget, cell_area, &x_offset, &y_offset, NULL, NULL);
1456 if (!cell->sensitive)
1458 state = GTK_STATE_INSENSITIVE;
1460 else if ((flags & GTK_CELL_RENDERER_SELECTED) == GTK_CELL_RENDERER_SELECTED)
1462 if (GTK_WIDGET_HAS_FOCUS (widget))
1463 state = GTK_STATE_SELECTED;
1465 state = GTK_STATE_ACTIVE;
1467 else if ((flags & GTK_CELL_RENDERER_PRELIT) == GTK_CELL_RENDERER_PRELIT &&
1468 GTK_WIDGET_STATE (widget) == GTK_STATE_PRELIGHT)
1470 state = GTK_STATE_PRELIGHT;
1474 if (GTK_WIDGET_STATE (widget) == GTK_STATE_INSENSITIVE)
1475 state = GTK_STATE_INSENSITIVE;
1477 state = GTK_STATE_NORMAL;
1480 if (celltext->background_set && state != GTK_STATE_SELECTED)
1485 color.red = celltext->background.red;
1486 color.green = celltext->background.green;
1487 color.blue = celltext->background.blue;
1489 gc = gdk_gc_new (window);
1491 gdk_gc_set_rgb_fg_color (gc, &color);
1494 gdk_gc_set_clip_rectangle (gc, expose_area);
1495 gdk_draw_rectangle (window,
1500 background_area->width,
1501 background_area->height);
1503 gdk_gc_set_clip_rectangle (gc, NULL);
1504 g_object_unref (gc);
1507 if (priv->ellipsize)
1508 pango_layout_set_width (layout,
1509 (cell_area->width - x_offset - 2 * cell->xpad) * PANGO_SCALE);
1511 pango_layout_set_width (layout, -1);
1513 gtk_paint_layout (widget->style,
1520 cell_area->x + x_offset + cell->xpad,
1521 cell_area->y + y_offset + cell->ypad,
1524 g_object_unref (layout);
1528 gtk_cell_renderer_text_editing_done (GtkCellEditable *entry,
1532 const gchar *new_text;
1533 GtkCellRendererTextPrivate *priv;
1535 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (data);
1539 if (priv->focus_out_id > 0)
1541 g_signal_handler_disconnect (entry, priv->focus_out_id);
1542 priv->focus_out_id = 0;
1545 if (priv->populate_popup_id > 0)
1547 g_signal_handler_disconnect (entry, priv->populate_popup_id);
1548 priv->populate_popup_id = 0;
1551 if (priv->entry_menu_popdown_timeout)
1553 g_source_remove (priv->entry_menu_popdown_timeout);
1554 priv->entry_menu_popdown_timeout = 0;
1557 if (GTK_ENTRY (entry)->editing_canceled)
1559 gtk_cell_renderer_editing_canceled (GTK_CELL_RENDERER (data));
1563 path = g_object_get_data (G_OBJECT (entry), GTK_CELL_RENDERER_TEXT_PATH);
1564 new_text = gtk_entry_get_text (GTK_ENTRY (entry));
1566 g_signal_emit (data, text_cell_renderer_signals[EDITED], 0, path, new_text);
1570 popdown_timeout (gpointer data)
1572 GtkCellRendererTextPrivate *priv;
1574 GDK_THREADS_ENTER ();
1576 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (data);
1578 priv->entry_menu_popdown_timeout = 0;
1580 if (!GTK_WIDGET_HAS_FOCUS (priv->entry))
1581 gtk_cell_renderer_text_editing_done (GTK_CELL_EDITABLE (priv->entry), data);
1583 GDK_THREADS_LEAVE ();
1589 gtk_cell_renderer_text_popup_unmap (GtkMenu *menu,
1592 GtkCellRendererTextPrivate *priv;
1594 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (data);
1596 priv->in_entry_menu = FALSE;
1598 if (priv->entry_menu_popdown_timeout)
1601 priv->entry_menu_popdown_timeout = g_timeout_add (500, popdown_timeout,
1606 gtk_cell_renderer_text_populate_popup (GtkEntry *entry,
1610 GtkCellRendererTextPrivate *priv;
1612 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (data);
1614 if (priv->entry_menu_popdown_timeout)
1616 g_source_remove (priv->entry_menu_popdown_timeout);
1617 priv->entry_menu_popdown_timeout = 0;
1620 priv->in_entry_menu = TRUE;
1622 g_signal_connect (menu, "unmap",
1623 G_CALLBACK (gtk_cell_renderer_text_popup_unmap), data);
1627 gtk_cell_renderer_text_focus_out_event (GtkWidget *entry,
1631 GtkCellRendererTextPrivate *priv;
1633 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (data);
1635 if (priv->in_entry_menu)
1638 gtk_cell_renderer_text_editing_done (GTK_CELL_EDITABLE (entry), data);
1640 /* entry needs focus-out-event */
1644 static GtkCellEditable *
1645 gtk_cell_renderer_text_start_editing (GtkCellRenderer *cell,
1649 GdkRectangle *background_area,
1650 GdkRectangle *cell_area,
1651 GtkCellRendererState flags)
1653 GtkCellRendererText *celltext;
1654 GtkCellRendererTextPrivate *priv;
1656 celltext = GTK_CELL_RENDERER_TEXT (cell);
1657 priv = GTK_CELL_RENDERER_TEXT_GET_PRIVATE (cell);
1659 /* If the cell isn't editable we return NULL. */
1660 if (celltext->editable == FALSE)
1663 priv->entry = g_object_new (GTK_TYPE_ENTRY,
1665 "xalign", cell->xalign,
1669 gtk_entry_set_text (GTK_ENTRY (priv->entry), celltext->text);
1670 g_object_set_data_full (G_OBJECT (priv->entry), GTK_CELL_RENDERER_TEXT_PATH, g_strdup (path), g_free);
1672 gtk_editable_select_region (GTK_EDITABLE (priv->entry), 0, -1);
1675 priv->in_entry_menu = FALSE;
1676 if (priv->entry_menu_popdown_timeout)
1678 g_source_remove (priv->entry_menu_popdown_timeout);
1679 priv->entry_menu_popdown_timeout = 0;
1682 g_signal_connect (priv->entry,
1684 G_CALLBACK (gtk_cell_renderer_text_editing_done),
1686 priv->focus_out_id = g_signal_connect (priv->entry, "focus_out_event",
1687 G_CALLBACK (gtk_cell_renderer_text_focus_out_event),
1689 priv->populate_popup_id =
1690 g_signal_connect (priv->entry, "populate_popup",
1691 G_CALLBACK (gtk_cell_renderer_text_populate_popup),
1694 gtk_widget_show (priv->entry);
1696 return GTK_CELL_EDITABLE (priv->entry);
1700 * gtk_cell_renderer_text_set_fixed_height_from_font:
1701 * @renderer: A #GtkCellRendererText
1702 * @number_of_rows: Number of rows of text each cell renderer is allocated, or -1
1704 * Sets the height of a renderer to explicitly be determined by the "font" and
1705 * "y_pad" property set on it. Further changes in these properties do not
1706 * affect the height, so they must be accompanied by a subsequent call to this
1707 * function. Using this function is unflexible, and should really only be used
1708 * if calculating the size of a cell is too slow (ie, a massive number of cells
1709 * displayed). If @number_of_rows is -1, then the fixed height is unset, and
1710 * the height is determined by the properties again.
1713 gtk_cell_renderer_text_set_fixed_height_from_font (GtkCellRendererText *renderer,
1714 gint number_of_rows)
1716 g_return_if_fail (GTK_IS_CELL_RENDERER_TEXT (renderer));
1717 g_return_if_fail (number_of_rows == -1 || number_of_rows > 0);
1719 if (number_of_rows == -1)
1721 gtk_cell_renderer_set_fixed_size (GTK_CELL_RENDERER (renderer),
1722 GTK_CELL_RENDERER (renderer)->width,
1727 renderer->fixed_height_rows = number_of_rows;
1728 renderer->calc_fixed_height = TRUE;