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.
22 #include "gtkcellrenderertext.h"
26 #include "gtkeditable.h"
28 #include "gtksizerequest.h"
29 #include "gtkmarshalers.h"
31 #include "gtkprivate.h"
32 #include "gtktreeprivate.h"
33 #include "a11y/gtktextcellaccessible.h"
37 * SECTION:gtkcellrenderertext
38 * @Short_description: Renders text in a cell
39 * @Title: GtkCellRendererText
41 * A #GtkCellRendererText renders a given text in its cell, using the font, color and
42 * style information provided by its properties. The text will be ellipsized if it is
43 * too long and the #GtkCellRendererText:ellipsize property allows it.
45 * If the #GtkCellRenderer:mode is %GTK_CELL_RENDERER_MODE_EDITABLE,
46 * the #GtkCellRendererText allows to edit its text using an entry.
50 static void gtk_cell_renderer_text_finalize (GObject *object);
52 static void gtk_cell_renderer_text_get_property (GObject *object,
56 static void gtk_cell_renderer_text_set_property (GObject *object,
60 static void gtk_cell_renderer_text_render (GtkCellRenderer *cell,
63 const GdkRectangle *background_area,
64 const GdkRectangle *cell_area,
65 GtkCellRendererState flags);
67 static GtkCellEditable *gtk_cell_renderer_text_start_editing (GtkCellRenderer *cell,
71 const GdkRectangle *background_area,
72 const GdkRectangle *cell_area,
73 GtkCellRendererState flags);
75 static void gtk_cell_renderer_text_get_preferred_width (GtkCellRenderer *cell,
79 static void gtk_cell_renderer_text_get_preferred_height (GtkCellRenderer *cell,
83 static void gtk_cell_renderer_text_get_preferred_height_for_width (GtkCellRenderer *cell,
87 gint *natural_height);
88 static void gtk_cell_renderer_text_get_aligned_area (GtkCellRenderer *cell,
90 GtkCellRendererState flags,
91 const GdkRectangle *cell_area,
92 GdkRectangle *aligned_area);
107 PROP_SINGLE_PARAGRAPH_MODE,
109 PROP_MAX_WIDTH_CHARS,
118 PROP_BACKGROUND_RGBA,
119 PROP_FOREGROUND_RGBA,
138 /* Whether-a-style-arg-is-set args */
149 PROP_STRIKETHROUGH_SET,
157 static guint text_cell_renderer_signals [LAST_SIGNAL];
159 #define GTK_CELL_RENDERER_TEXT_PATH "gtk-cell-renderer-text-path"
161 struct _GtkCellRendererTextPrivate
165 PangoAttrList *extra_attrs;
168 PangoAlignment align;
169 PangoEllipsizeMode ellipsize;
170 PangoFontDescription *font;
171 PangoLanguage *language;
172 PangoUnderline underline_style;
173 PangoWrapMode wrap_mode;
180 gint fixed_height_rows;
182 gint max_width_chars;
185 guint in_entry_menu : 1;
186 guint strikethrough : 1;
189 guint foreground_set : 1;
190 guint background_set : 1;
191 guint underline_set : 1;
193 guint strikethrough_set : 1;
194 guint editable_set : 1;
195 guint calc_fixed_height : 1;
196 guint single_paragraph : 1;
197 guint language_set : 1;
198 guint markup_set : 1;
199 guint ellipsize_set : 1;
203 gulong populate_popup_id;
204 gulong entry_menu_popdown_timeout;
207 G_DEFINE_TYPE (GtkCellRendererText, gtk_cell_renderer_text, GTK_TYPE_CELL_RENDERER)
210 gtk_cell_renderer_text_init (GtkCellRendererText *celltext)
212 GtkCellRendererTextPrivate *priv;
213 GtkCellRenderer *cell = GTK_CELL_RENDERER (celltext);
215 celltext->priv = G_TYPE_INSTANCE_GET_PRIVATE (celltext,
216 GTK_TYPE_CELL_RENDERER_TEXT,
217 GtkCellRendererTextPrivate);
218 priv = celltext->priv;
220 gtk_cell_renderer_set_alignment (cell, 0.0, 0.5);
221 gtk_cell_renderer_set_padding (cell, 2, 2);
222 priv->font_scale = 1.0;
223 priv->fixed_height_rows = -1;
224 priv->font = pango_font_description_new ();
226 priv->width_chars = -1;
227 priv->max_width_chars = -1;
228 priv->wrap_width = -1;
229 priv->wrap_mode = PANGO_WRAP_CHAR;
230 priv->align = PANGO_ALIGN_LEFT;
231 priv->align_set = FALSE;
235 gtk_cell_renderer_text_class_init (GtkCellRendererTextClass *class)
237 GObjectClass *object_class = G_OBJECT_CLASS (class);
238 GtkCellRendererClass *cell_class = GTK_CELL_RENDERER_CLASS (class);
240 object_class->finalize = gtk_cell_renderer_text_finalize;
242 object_class->get_property = gtk_cell_renderer_text_get_property;
243 object_class->set_property = gtk_cell_renderer_text_set_property;
245 cell_class->render = gtk_cell_renderer_text_render;
246 cell_class->start_editing = gtk_cell_renderer_text_start_editing;
247 cell_class->get_preferred_width = gtk_cell_renderer_text_get_preferred_width;
248 cell_class->get_preferred_height = gtk_cell_renderer_text_get_preferred_height;
249 cell_class->get_preferred_height_for_width = gtk_cell_renderer_text_get_preferred_height_for_width;
250 cell_class->get_aligned_area = gtk_cell_renderer_text_get_aligned_area;
252 g_object_class_install_property (object_class,
254 g_param_spec_string ("text",
256 P_("Text to render"),
258 GTK_PARAM_READWRITE));
260 g_object_class_install_property (object_class,
262 g_param_spec_string ("markup",
264 P_("Marked up text to render"),
266 GTK_PARAM_WRITABLE));
268 g_object_class_install_property (object_class,
270 g_param_spec_boxed ("attributes",
272 P_("A list of style attributes to apply to the text of the renderer"),
273 PANGO_TYPE_ATTR_LIST,
274 GTK_PARAM_READWRITE));
276 g_object_class_install_property (object_class,
277 PROP_SINGLE_PARAGRAPH_MODE,
278 g_param_spec_boolean ("single-paragraph-mode",
279 P_("Single Paragraph Mode"),
280 P_("Whether to keep all text in a single paragraph"),
282 GTK_PARAM_READWRITE));
285 g_object_class_install_property (object_class,
287 g_param_spec_string ("background",
288 P_("Background color name"),
289 P_("Background color as a string"),
291 GTK_PARAM_WRITABLE));
294 * GtkCellRendererText:background-gdk:
296 * Background color as a #GdkColor
298 * Deprecated: 3.4: Use #GtkCellRendererText:background-rgba instead.
300 g_object_class_install_property (object_class,
302 g_param_spec_boxed ("background-gdk",
303 P_("Background color"),
304 P_("Background color as a GdkColor"),
306 GTK_PARAM_READWRITE | G_PARAM_DEPRECATED));
309 * GtkCellRendererText:background-rgba:
311 * Background color as a #GdkRGBA
315 g_object_class_install_property (object_class,
316 PROP_BACKGROUND_RGBA,
317 g_param_spec_boxed ("background-rgba",
318 P_("Background color as RGBA"),
319 P_("Background color as a GdkRGBA"),
321 GTK_PARAM_READWRITE));
322 g_object_class_install_property (object_class,
324 g_param_spec_string ("foreground",
325 P_("Foreground color name"),
326 P_("Foreground color as a string"),
328 GTK_PARAM_WRITABLE));
331 * GtkCellRendererText:foreground-gdk:
333 * Foreground color as a #GdkColor
335 * Deprecated: 3.4: Use #GtkCellRendererText:foreground-rgba instead.
337 g_object_class_install_property (object_class,
339 g_param_spec_boxed ("foreground-gdk",
340 P_("Foreground color"),
341 P_("Foreground color as a GdkColor"),
343 GTK_PARAM_READWRITE | G_PARAM_DEPRECATED));
346 * GtkCellRendererText:foreground-rgba:
348 * Foreground color as a #GdkRGBA
352 g_object_class_install_property (object_class,
353 PROP_FOREGROUND_RGBA,
354 g_param_spec_boxed ("foreground-rgba",
355 P_("Foreground color as RGBA"),
356 P_("Foreground color as a GdkRGBA"),
358 GTK_PARAM_READWRITE));
361 g_object_class_install_property (object_class,
363 g_param_spec_boolean ("editable",
365 P_("Whether the text can be modified by the user"),
367 GTK_PARAM_READWRITE));
369 g_object_class_install_property (object_class,
371 g_param_spec_string ("font",
373 P_("Font description as a string, e.g. \"Sans Italic 12\""),
375 GTK_PARAM_READWRITE));
377 g_object_class_install_property (object_class,
379 g_param_spec_boxed ("font-desc",
381 P_("Font description as a PangoFontDescription struct"),
382 PANGO_TYPE_FONT_DESCRIPTION,
383 GTK_PARAM_READWRITE));
386 g_object_class_install_property (object_class,
388 g_param_spec_string ("family",
390 P_("Name of the font family, e.g. Sans, Helvetica, Times, Monospace"),
392 GTK_PARAM_READWRITE));
394 g_object_class_install_property (object_class,
396 g_param_spec_enum ("style",
401 GTK_PARAM_READWRITE));
403 g_object_class_install_property (object_class,
405 g_param_spec_enum ("variant",
409 PANGO_VARIANT_NORMAL,
410 GTK_PARAM_READWRITE));
412 g_object_class_install_property (object_class,
414 g_param_spec_int ("weight",
420 GTK_PARAM_READWRITE));
422 g_object_class_install_property (object_class,
424 g_param_spec_enum ("stretch",
428 PANGO_STRETCH_NORMAL,
429 GTK_PARAM_READWRITE));
431 g_object_class_install_property (object_class,
433 g_param_spec_int ("size",
439 GTK_PARAM_READWRITE));
441 g_object_class_install_property (object_class,
443 g_param_spec_double ("size-points",
445 P_("Font size in points"),
449 GTK_PARAM_READWRITE));
451 g_object_class_install_property (object_class,
453 g_param_spec_double ("scale",
455 P_("Font scaling factor"),
459 GTK_PARAM_READWRITE));
461 g_object_class_install_property (object_class,
463 g_param_spec_int ("rise",
465 P_("Offset of text above the baseline "
466 "(below the baseline if rise is negative)"),
470 GTK_PARAM_READWRITE));
473 g_object_class_install_property (object_class,
475 g_param_spec_boolean ("strikethrough",
477 P_("Whether to strike through the text"),
479 GTK_PARAM_READWRITE));
481 g_object_class_install_property (object_class,
483 g_param_spec_enum ("underline",
485 P_("Style of underline for this text"),
486 PANGO_TYPE_UNDERLINE,
487 PANGO_UNDERLINE_NONE,
488 GTK_PARAM_READWRITE));
490 g_object_class_install_property (object_class,
492 g_param_spec_string ("language",
494 P_("The language this text is in, as an ISO code. "
495 "Pango can use this as a hint when rendering the text. "
496 "If you don't understand this parameter, you probably don't need it"),
498 GTK_PARAM_READWRITE));
502 * GtkCellRendererText:ellipsize:
504 * Specifies the preferred place to ellipsize the string, if the cell renderer
505 * does not have enough room to display the entire string. Setting it to
506 * %PANGO_ELLIPSIZE_NONE turns off ellipsizing. See the wrap-width property
507 * for another way of making the text fit into a given width.
511 g_object_class_install_property (object_class,
513 g_param_spec_enum ("ellipsize",
515 P_("The preferred place to ellipsize the string, "
516 "if the cell renderer does not have enough room "
517 "to display the entire string"),
518 PANGO_TYPE_ELLIPSIZE_MODE,
519 PANGO_ELLIPSIZE_NONE,
520 GTK_PARAM_READWRITE));
523 * GtkCellRendererText:width-chars:
525 * The desired width of the cell, in characters. If this property is set to
526 * -1, the width will be calculated automatically, otherwise the cell will
527 * request either 3 characters or the property value, whichever is greater.
531 g_object_class_install_property (object_class,
533 g_param_spec_int ("width-chars",
534 P_("Width In Characters"),
535 P_("The desired width of the label, in characters"),
539 GTK_PARAM_READWRITE));
543 * GtkCellRendererText:max-width-chars:
545 * The desired maximum width of the cell, in characters. If this property
546 * is set to -1, the width will be calculated automatically.
548 * For cell renderers that ellipsize or wrap text; this property
549 * controls the maximum reported width of the cell. The
550 * cell should not receive any greater allocation unless it is
551 * set to expand in its #GtkCellLayout and all of the cell's siblings
552 * have received their natural width.
556 g_object_class_install_property (object_class,
557 PROP_MAX_WIDTH_CHARS,
558 g_param_spec_int ("max-width-chars",
559 P_("Maximum Width In Characters"),
560 P_("The maximum width of the cell, in characters"),
564 GTK_PARAM_READWRITE));
567 * GtkCellRendererText:wrap-mode:
569 * Specifies how to break the string into multiple lines, if the cell
570 * renderer does not have enough room to display the entire string.
571 * This property has no effect unless the wrap-width property is set.
575 g_object_class_install_property (object_class,
577 g_param_spec_enum ("wrap-mode",
579 P_("How to break the string into multiple lines, "
580 "if the cell renderer does not have enough room "
581 "to display the entire string"),
582 PANGO_TYPE_WRAP_MODE,
584 GTK_PARAM_READWRITE));
587 * GtkCellRendererText:wrap-width:
589 * Specifies the minimum width at which the text is wrapped. The wrap-mode property can
590 * be used to influence at what character positions the line breaks can be placed.
591 * Setting wrap-width to -1 turns wrapping off.
595 g_object_class_install_property (object_class,
597 g_param_spec_int ("wrap-width",
599 P_("The width at which the text is wrapped"),
603 GTK_PARAM_READWRITE));
606 * GtkCellRendererText:alignment:
608 * Specifies how to align the lines of text with respect to each other.
610 * Note that this property describes how to align the lines of text in
611 * case there are several of them. The "xalign" property of #GtkCellRenderer,
612 * on the other hand, sets the horizontal alignment of the whole text.
616 g_object_class_install_property (object_class,
618 g_param_spec_enum ("alignment",
620 P_("How to align the lines"),
621 PANGO_TYPE_ALIGNMENT,
623 GTK_PARAM_READWRITE));
627 /* Style props are set or not */
629 #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))
631 ADD_SET_PROP ("background-set", PROP_BACKGROUND_SET,
632 P_("Background set"),
633 P_("Whether this tag affects the background color"));
635 ADD_SET_PROP ("foreground-set", PROP_FOREGROUND_SET,
636 P_("Foreground set"),
637 P_("Whether this tag affects the foreground color"));
639 ADD_SET_PROP ("editable-set", PROP_EDITABLE_SET,
640 P_("Editability set"),
641 P_("Whether this tag affects text editability"));
643 ADD_SET_PROP ("family-set", PROP_FAMILY_SET,
644 P_("Font family set"),
645 P_("Whether this tag affects the font family"));
647 ADD_SET_PROP ("style-set", PROP_STYLE_SET,
648 P_("Font style set"),
649 P_("Whether this tag affects the font style"));
651 ADD_SET_PROP ("variant-set", PROP_VARIANT_SET,
652 P_("Font variant set"),
653 P_("Whether this tag affects the font variant"));
655 ADD_SET_PROP ("weight-set", PROP_WEIGHT_SET,
656 P_("Font weight set"),
657 P_("Whether this tag affects the font weight"));
659 ADD_SET_PROP ("stretch-set", PROP_STRETCH_SET,
660 P_("Font stretch set"),
661 P_("Whether this tag affects the font stretch"));
663 ADD_SET_PROP ("size-set", PROP_SIZE_SET,
665 P_("Whether this tag affects the font size"));
667 ADD_SET_PROP ("scale-set", PROP_SCALE_SET,
668 P_("Font scale set"),
669 P_("Whether this tag scales the font size by a factor"));
671 ADD_SET_PROP ("rise-set", PROP_RISE_SET,
673 P_("Whether this tag affects the rise"));
675 ADD_SET_PROP ("strikethrough-set", PROP_STRIKETHROUGH_SET,
676 P_("Strikethrough set"),
677 P_("Whether this tag affects strikethrough"));
679 ADD_SET_PROP ("underline-set", PROP_UNDERLINE_SET,
681 P_("Whether this tag affects underlining"));
683 ADD_SET_PROP ("language-set", PROP_LANGUAGE_SET,
685 P_("Whether this tag affects the language the text is rendered as"));
687 ADD_SET_PROP ("ellipsize-set", PROP_ELLIPSIZE_SET,
689 P_("Whether this tag affects the ellipsize mode"));
691 ADD_SET_PROP ("align-set", PROP_ALIGN_SET,
693 P_("Whether this tag affects the alignment mode"));
696 * GtkCellRendererText::edited
697 * @renderer: the object which received the signal
698 * @path: the path identifying the edited cell
699 * @new_text: the new text
701 * This signal is emitted after @renderer has been edited.
703 * It is the responsibility of the application to update the model
704 * and store @new_text at the position indicated by @path.
706 text_cell_renderer_signals [EDITED] =
707 g_signal_new (I_("edited"),
708 G_OBJECT_CLASS_TYPE (object_class),
710 G_STRUCT_OFFSET (GtkCellRendererTextClass, edited),
712 _gtk_marshal_VOID__STRING_STRING,
717 g_type_class_add_private (object_class, sizeof (GtkCellRendererTextPrivate));
719 _gtk_cell_renderer_class_set_accessible_type (cell_class, GTK_TYPE_TEXT_CELL_ACCESSIBLE);
723 gtk_cell_renderer_text_finalize (GObject *object)
725 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (object);
726 GtkCellRendererTextPrivate *priv = celltext->priv;
728 pango_font_description_free (priv->font);
732 if (priv->extra_attrs)
733 pango_attr_list_unref (priv->extra_attrs);
736 g_object_unref (priv->language);
738 G_OBJECT_CLASS (gtk_cell_renderer_text_parent_class)->finalize (object);
742 get_property_font_set_mask (guint prop_id)
746 case PROP_FAMILY_SET:
747 return PANGO_FONT_MASK_FAMILY;
749 return PANGO_FONT_MASK_STYLE;
750 case PROP_VARIANT_SET:
751 return PANGO_FONT_MASK_VARIANT;
752 case PROP_WEIGHT_SET:
753 return PANGO_FONT_MASK_WEIGHT;
754 case PROP_STRETCH_SET:
755 return PANGO_FONT_MASK_STRETCH;
757 return PANGO_FONT_MASK_SIZE;
764 gtk_cell_renderer_text_get_property (GObject *object,
769 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (object);
770 GtkCellRendererTextPrivate *priv = celltext->priv;
775 g_value_set_string (value, priv->text);
778 case PROP_ATTRIBUTES:
779 g_value_set_boxed (value, priv->extra_attrs);
782 case PROP_SINGLE_PARAGRAPH_MODE:
783 g_value_set_boolean (value, priv->single_paragraph);
786 case PROP_BACKGROUND_GDK:
790 color.red = (guint16) (priv->background.red * 65535);
791 color.green = (guint16) (priv->background.green * 65535);
792 color.blue = (guint16) (priv->background.blue * 65535);
794 g_value_set_boxed (value, &color);
798 case PROP_FOREGROUND_GDK:
802 color.red = (guint16) (priv->foreground.red * 65535);
803 color.green = (guint16) (priv->foreground.green * 65535);
804 color.blue = (guint16) (priv->foreground.blue * 65535);
806 g_value_set_boxed (value, &color);
810 case PROP_BACKGROUND_RGBA:
811 g_value_set_boxed (value, &priv->background);
814 case PROP_FOREGROUND_RGBA:
815 g_value_set_boxed (value, &priv->foreground);
819 g_value_take_string (value, pango_font_description_to_string (priv->font));
823 g_value_set_boxed (value, priv->font);
827 g_value_set_string (value, pango_font_description_get_family (priv->font));
831 g_value_set_enum (value, pango_font_description_get_style (priv->font));
835 g_value_set_enum (value, pango_font_description_get_variant (priv->font));
839 g_value_set_int (value, pango_font_description_get_weight (priv->font));
843 g_value_set_enum (value, pango_font_description_get_stretch (priv->font));
847 g_value_set_int (value, pango_font_description_get_size (priv->font));
850 case PROP_SIZE_POINTS:
851 g_value_set_double (value, ((double)pango_font_description_get_size (priv->font)) / (double)PANGO_SCALE);
855 g_value_set_double (value, priv->font_scale);
859 g_value_set_boolean (value, priv->editable);
862 case PROP_STRIKETHROUGH:
863 g_value_set_boolean (value, priv->strikethrough);
867 g_value_set_enum (value, priv->underline_style);
871 g_value_set_int (value, priv->rise);
875 g_value_set_static_string (value, pango_language_to_string (priv->language));
879 g_value_set_enum (value, priv->ellipsize);
883 g_value_set_enum (value, priv->wrap_mode);
886 case PROP_WRAP_WIDTH:
887 g_value_set_int (value, priv->wrap_width);
891 g_value_set_enum (value, priv->align);
894 case PROP_BACKGROUND_SET:
895 g_value_set_boolean (value, priv->background_set);
898 case PROP_FOREGROUND_SET:
899 g_value_set_boolean (value, priv->foreground_set);
902 case PROP_FAMILY_SET:
904 case PROP_VARIANT_SET:
905 case PROP_WEIGHT_SET:
906 case PROP_STRETCH_SET:
909 PangoFontMask mask = get_property_font_set_mask (param_id);
910 g_value_set_boolean (value, (pango_font_description_get_set_fields (priv->font) & mask) != 0);
916 g_value_set_boolean (value, priv->scale_set);
919 case PROP_EDITABLE_SET:
920 g_value_set_boolean (value, priv->editable_set);
923 case PROP_STRIKETHROUGH_SET:
924 g_value_set_boolean (value, priv->strikethrough_set);
927 case PROP_UNDERLINE_SET:
928 g_value_set_boolean (value, priv->underline_set);
932 g_value_set_boolean (value, priv->rise_set);
935 case PROP_LANGUAGE_SET:
936 g_value_set_boolean (value, priv->language_set);
939 case PROP_ELLIPSIZE_SET:
940 g_value_set_boolean (value, priv->ellipsize_set);
944 g_value_set_boolean (value, priv->align_set);
947 case PROP_WIDTH_CHARS:
948 g_value_set_int (value, priv->width_chars);
951 case PROP_MAX_WIDTH_CHARS:
952 g_value_set_int (value, priv->max_width_chars);
955 case PROP_BACKGROUND:
956 case PROP_FOREGROUND:
959 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
966 set_bg_color (GtkCellRendererText *celltext,
969 GtkCellRendererTextPrivate *priv = celltext->priv;
973 if (!priv->background_set)
975 priv->background_set = TRUE;
976 g_object_notify (G_OBJECT (celltext), "background-set");
979 priv->background = *rgba;
983 if (priv->background_set)
985 priv->background_set = FALSE;
986 g_object_notify (G_OBJECT (celltext), "background-set");
993 set_fg_color (GtkCellRendererText *celltext,
996 GtkCellRendererTextPrivate *priv = celltext->priv;
1000 if (!priv->foreground_set)
1002 priv->foreground_set = TRUE;
1003 g_object_notify (G_OBJECT (celltext), "foreground-set");
1006 priv->foreground = *rgba;
1010 if (priv->foreground_set)
1012 priv->foreground_set = FALSE;
1013 g_object_notify (G_OBJECT (celltext), "foreground-set");
1018 static PangoFontMask
1019 set_font_desc_fields (PangoFontDescription *desc,
1020 PangoFontMask to_set)
1022 PangoFontMask changed_mask = 0;
1024 if (to_set & PANGO_FONT_MASK_FAMILY)
1026 const char *family = pango_font_description_get_family (desc);
1030 changed_mask |= PANGO_FONT_MASK_FAMILY;
1033 pango_font_description_set_family (desc, family);
1035 if (to_set & PANGO_FONT_MASK_STYLE)
1036 pango_font_description_set_style (desc, pango_font_description_get_style (desc));
1037 if (to_set & PANGO_FONT_MASK_VARIANT)
1038 pango_font_description_set_variant (desc, pango_font_description_get_variant (desc));
1039 if (to_set & PANGO_FONT_MASK_WEIGHT)
1040 pango_font_description_set_weight (desc, pango_font_description_get_weight (desc));
1041 if (to_set & PANGO_FONT_MASK_STRETCH)
1042 pango_font_description_set_stretch (desc, pango_font_description_get_stretch (desc));
1043 if (to_set & PANGO_FONT_MASK_SIZE)
1045 gint size = pango_font_description_get_size (desc);
1048 size = 10 * PANGO_SCALE;
1049 changed_mask |= PANGO_FONT_MASK_SIZE;
1052 pango_font_description_set_size (desc, size);
1055 return changed_mask;
1059 notify_set_changed (GObject *object,
1060 PangoFontMask changed_mask)
1062 if (changed_mask & PANGO_FONT_MASK_FAMILY)
1063 g_object_notify (object, "family-set");
1064 if (changed_mask & PANGO_FONT_MASK_STYLE)
1065 g_object_notify (object, "style-set");
1066 if (changed_mask & PANGO_FONT_MASK_VARIANT)
1067 g_object_notify (object, "variant-set");
1068 if (changed_mask & PANGO_FONT_MASK_WEIGHT)
1069 g_object_notify (object, "weight-set");
1070 if (changed_mask & PANGO_FONT_MASK_STRETCH)
1071 g_object_notify (object, "stretch-set");
1072 if (changed_mask & PANGO_FONT_MASK_SIZE)
1073 g_object_notify (object, "size-set");
1077 notify_fields_changed (GObject *object,
1078 PangoFontMask changed_mask)
1080 if (changed_mask & PANGO_FONT_MASK_FAMILY)
1081 g_object_notify (object, "family");
1082 if (changed_mask & PANGO_FONT_MASK_STYLE)
1083 g_object_notify (object, "style");
1084 if (changed_mask & PANGO_FONT_MASK_VARIANT)
1085 g_object_notify (object, "variant");
1086 if (changed_mask & PANGO_FONT_MASK_WEIGHT)
1087 g_object_notify (object, "weight");
1088 if (changed_mask & PANGO_FONT_MASK_STRETCH)
1089 g_object_notify (object, "stretch");
1090 if (changed_mask & PANGO_FONT_MASK_SIZE)
1091 g_object_notify (object, "size");
1095 set_font_description (GtkCellRendererText *celltext,
1096 PangoFontDescription *font_desc)
1098 GtkCellRendererTextPrivate *priv = celltext->priv;
1099 GObject *object = G_OBJECT (celltext);
1100 PangoFontDescription *new_font_desc;
1101 PangoFontMask old_mask, new_mask, changed_mask, set_changed_mask;
1104 new_font_desc = pango_font_description_copy (font_desc);
1106 new_font_desc = pango_font_description_new ();
1108 old_mask = pango_font_description_get_set_fields (priv->font);
1109 new_mask = pango_font_description_get_set_fields (new_font_desc);
1111 changed_mask = old_mask | new_mask;
1112 set_changed_mask = old_mask ^ new_mask;
1114 pango_font_description_free (priv->font);
1115 priv->font = new_font_desc;
1117 g_object_freeze_notify (object);
1119 g_object_notify (object, "font-desc");
1120 g_object_notify (object, "font");
1122 if (changed_mask & PANGO_FONT_MASK_FAMILY)
1123 g_object_notify (object, "family");
1124 if (changed_mask & PANGO_FONT_MASK_STYLE)
1125 g_object_notify (object, "style");
1126 if (changed_mask & PANGO_FONT_MASK_VARIANT)
1127 g_object_notify (object, "variant");
1128 if (changed_mask & PANGO_FONT_MASK_WEIGHT)
1129 g_object_notify (object, "weight");
1130 if (changed_mask & PANGO_FONT_MASK_STRETCH)
1131 g_object_notify (object, "stretch");
1132 if (changed_mask & PANGO_FONT_MASK_SIZE)
1134 g_object_notify (object, "size");
1135 g_object_notify (object, "size-points");
1138 notify_set_changed (object, set_changed_mask);
1140 g_object_thaw_notify (object);
1144 gtk_cell_renderer_text_set_property (GObject *object,
1146 const GValue *value,
1149 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (object);
1150 GtkCellRendererTextPrivate *priv = celltext->priv;
1155 g_free (priv->text);
1157 if (priv->markup_set)
1159 if (priv->extra_attrs)
1160 pango_attr_list_unref (priv->extra_attrs);
1161 priv->extra_attrs = NULL;
1162 priv->markup_set = FALSE;
1165 priv->text = g_value_dup_string (value);
1166 g_object_notify (object, "text");
1169 case PROP_ATTRIBUTES:
1170 if (priv->extra_attrs)
1171 pango_attr_list_unref (priv->extra_attrs);
1173 priv->extra_attrs = g_value_get_boxed (value);
1174 if (priv->extra_attrs)
1175 pango_attr_list_ref (priv->extra_attrs);
1181 GError *error = NULL;
1182 PangoAttrList *attrs = NULL;
1184 str = g_value_get_string (value);
1185 if (str && !pango_parse_markup (str,
1193 g_warning ("Failed to set text from markup due to error parsing markup: %s",
1195 g_error_free (error);
1199 g_free (priv->text);
1201 if (priv->extra_attrs)
1202 pango_attr_list_unref (priv->extra_attrs);
1205 priv->extra_attrs = attrs;
1206 priv->markup_set = TRUE;
1210 case PROP_SINGLE_PARAGRAPH_MODE:
1211 priv->single_paragraph = g_value_get_boolean (value);
1214 case PROP_BACKGROUND:
1218 if (!g_value_get_string (value))
1219 set_bg_color (celltext, NULL); /* reset to background_set to FALSE */
1220 else if (gdk_rgba_parse (&rgba, g_value_get_string (value)))
1221 set_bg_color (celltext, &rgba);
1223 g_warning ("Don't know color `%s'", g_value_get_string (value));
1225 g_object_notify (object, "background-gdk");
1229 case PROP_FOREGROUND:
1233 if (!g_value_get_string (value))
1234 set_fg_color (celltext, NULL); /* reset to foreground_set to FALSE */
1235 else if (gdk_rgba_parse (&rgba, g_value_get_string (value)))
1236 set_fg_color (celltext, &rgba);
1238 g_warning ("Don't know color `%s'", g_value_get_string (value));
1240 g_object_notify (object, "foreground-gdk");
1244 case PROP_BACKGROUND_GDK:
1248 color = g_value_get_boxed (value);
1253 rgba.red = color->red / 65535.;
1254 rgba.green = color->green / 65535.;
1255 rgba.blue = color->blue / 65535.;
1258 set_bg_color (celltext, &rgba);
1262 set_bg_color (celltext, NULL);
1267 case PROP_FOREGROUND_GDK:
1271 color = g_value_get_boxed (value);
1276 rgba.red = color->red / 65535.;
1277 rgba.green = color->green / 65535.;
1278 rgba.blue = color->blue / 65535.;
1281 set_fg_color (celltext, &rgba);
1285 set_fg_color (celltext, NULL);
1290 case PROP_BACKGROUND_RGBA:
1291 /* This notifies the GObject itself. */
1292 set_bg_color (celltext, g_value_get_boxed (value));
1295 case PROP_FOREGROUND_RGBA:
1296 /* This notifies the GObject itself. */
1297 set_fg_color (celltext, g_value_get_boxed (value));
1302 PangoFontDescription *font_desc = NULL;
1305 name = g_value_get_string (value);
1308 font_desc = pango_font_description_from_string (name);
1310 set_font_description (celltext, font_desc);
1312 pango_font_description_free (font_desc);
1314 if (priv->fixed_height_rows != -1)
1315 priv->calc_fixed_height = TRUE;
1319 case PROP_FONT_DESC:
1320 set_font_description (celltext, g_value_get_boxed (value));
1322 if (priv->fixed_height_rows != -1)
1323 priv->calc_fixed_height = TRUE;
1332 case PROP_SIZE_POINTS:
1334 PangoFontMask old_set_mask = pango_font_description_get_set_fields (priv->font);
1339 pango_font_description_set_family (priv->font,
1340 g_value_get_string (value));
1343 pango_font_description_set_style (priv->font,
1344 g_value_get_enum (value));
1347 pango_font_description_set_variant (priv->font,
1348 g_value_get_enum (value));
1351 pango_font_description_set_weight (priv->font,
1352 g_value_get_int (value));
1355 pango_font_description_set_stretch (priv->font,
1356 g_value_get_enum (value));
1359 pango_font_description_set_size (priv->font,
1360 g_value_get_int (value));
1361 g_object_notify (object, "size-points");
1363 case PROP_SIZE_POINTS:
1364 pango_font_description_set_size (priv->font,
1365 g_value_get_double (value) * PANGO_SCALE);
1366 g_object_notify (object, "size");
1370 if (priv->fixed_height_rows != -1)
1371 priv->calc_fixed_height = TRUE;
1373 notify_set_changed (object, old_set_mask & pango_font_description_get_set_fields (priv->font));
1374 g_object_notify (object, "font-desc");
1375 g_object_notify (object, "font");
1381 priv->font_scale = g_value_get_double (value);
1382 priv->scale_set = TRUE;
1383 if (priv->fixed_height_rows != -1)
1384 priv->calc_fixed_height = TRUE;
1385 g_object_notify (object, "scale-set");
1389 priv->editable = g_value_get_boolean (value);
1390 priv->editable_set = TRUE;
1392 g_object_set (celltext, "mode", GTK_CELL_RENDERER_MODE_EDITABLE, NULL);
1394 g_object_set (celltext, "mode", GTK_CELL_RENDERER_MODE_INERT, NULL);
1395 g_object_notify (object, "editable-set");
1398 case PROP_STRIKETHROUGH:
1399 priv->strikethrough = g_value_get_boolean (value);
1400 priv->strikethrough_set = TRUE;
1401 g_object_notify (object, "strikethrough-set");
1404 case PROP_UNDERLINE:
1405 priv->underline_style = g_value_get_enum (value);
1406 priv->underline_set = TRUE;
1407 g_object_notify (object, "underline-set");
1412 priv->rise = g_value_get_int (value);
1413 priv->rise_set = TRUE;
1414 g_object_notify (object, "rise-set");
1415 if (priv->fixed_height_rows != -1)
1416 priv->calc_fixed_height = TRUE;
1420 priv->language_set = TRUE;
1422 g_object_unref (priv->language);
1423 priv->language = pango_language_from_string (g_value_get_string (value));
1424 g_object_notify (object, "language-set");
1427 case PROP_ELLIPSIZE:
1428 priv->ellipsize = g_value_get_enum (value);
1429 priv->ellipsize_set = TRUE;
1430 g_object_notify (object, "ellipsize-set");
1433 case PROP_WRAP_MODE:
1434 priv->wrap_mode = g_value_get_enum (value);
1437 case PROP_WRAP_WIDTH:
1438 priv->wrap_width = g_value_get_int (value);
1441 case PROP_WIDTH_CHARS:
1442 priv->width_chars = g_value_get_int (value);
1445 case PROP_MAX_WIDTH_CHARS:
1446 priv->max_width_chars = g_value_get_int (value);
1450 priv->align = g_value_get_enum (value);
1451 priv->align_set = TRUE;
1452 g_object_notify (object, "align-set");
1455 case PROP_BACKGROUND_SET:
1456 priv->background_set = g_value_get_boolean (value);
1459 case PROP_FOREGROUND_SET:
1460 priv->foreground_set = g_value_get_boolean (value);
1463 case PROP_FAMILY_SET:
1464 case PROP_STYLE_SET:
1465 case PROP_VARIANT_SET:
1466 case PROP_WEIGHT_SET:
1467 case PROP_STRETCH_SET:
1469 if (!g_value_get_boolean (value))
1471 pango_font_description_unset_fields (priv->font,
1472 get_property_font_set_mask (param_id));
1476 PangoFontMask changed_mask;
1478 changed_mask = set_font_desc_fields (priv->font,
1479 get_property_font_set_mask (param_id));
1480 notify_fields_changed (G_OBJECT (celltext), changed_mask);
1484 case PROP_SCALE_SET:
1485 priv->scale_set = g_value_get_boolean (value);
1488 case PROP_EDITABLE_SET:
1489 priv->editable_set = g_value_get_boolean (value);
1492 case PROP_STRIKETHROUGH_SET:
1493 priv->strikethrough_set = g_value_get_boolean (value);
1496 case PROP_UNDERLINE_SET:
1497 priv->underline_set = g_value_get_boolean (value);
1501 priv->rise_set = g_value_get_boolean (value);
1504 case PROP_LANGUAGE_SET:
1505 priv->language_set = g_value_get_boolean (value);
1508 case PROP_ELLIPSIZE_SET:
1509 priv->ellipsize_set = g_value_get_boolean (value);
1512 case PROP_ALIGN_SET:
1513 priv->align_set = g_value_get_boolean (value);
1517 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
1523 * gtk_cell_renderer_text_new:
1525 * Creates a new #GtkCellRendererText. Adjust how text is drawn using
1526 * object properties. Object properties can be
1527 * set globally (with g_object_set()). Also, with #GtkTreeViewColumn,
1528 * you can bind a property to a value in a #GtkTreeModel. For example,
1529 * you can bind the "text" property on the cell renderer to a string
1530 * value in the model, thus rendering a different string in each row
1531 * of the #GtkTreeView
1533 * Return value: the new cell renderer
1536 gtk_cell_renderer_text_new (void)
1538 return g_object_new (GTK_TYPE_CELL_RENDERER_TEXT, NULL);
1542 add_attr (PangoAttrList *attr_list,
1543 PangoAttribute *attr)
1545 attr->start_index = 0;
1546 attr->end_index = G_MAXINT;
1548 pango_attr_list_insert (attr_list, attr);
1552 get_layout (GtkCellRendererText *celltext,
1554 const GdkRectangle *cell_area,
1555 GtkCellRendererState flags)
1557 GtkCellRendererTextPrivate *priv = celltext->priv;
1558 PangoAttrList *attr_list;
1559 PangoLayout *layout;
1560 PangoUnderline uline;
1563 layout = gtk_widget_create_pango_layout (widget, priv->text);
1565 gtk_cell_renderer_get_padding (GTK_CELL_RENDERER (celltext), &xpad, NULL);
1567 if (priv->extra_attrs)
1568 attr_list = pango_attr_list_copy (priv->extra_attrs);
1570 attr_list = pango_attr_list_new ();
1572 pango_layout_set_single_paragraph_mode (layout, priv->single_paragraph);
1576 /* Add options that affect appearance but not size */
1578 /* note that background doesn't go here, since it affects
1579 * background_area not the PangoLayout area
1582 if (priv->foreground_set
1583 && (flags & GTK_CELL_RENDERER_SELECTED) == 0)
1587 color.red = (guint16) (priv->foreground.red * 65535);
1588 color.green = (guint16) (priv->foreground.green * 65535);
1589 color.blue = (guint16) (priv->foreground.blue * 65535);
1591 add_attr (attr_list,
1592 pango_attr_foreground_new (color.red, color.green, color.blue));
1595 if (priv->strikethrough_set)
1596 add_attr (attr_list,
1597 pango_attr_strikethrough_new (priv->strikethrough));
1600 add_attr (attr_list, pango_attr_font_desc_new (priv->font));
1602 if (priv->scale_set &&
1603 priv->font_scale != 1.0)
1604 add_attr (attr_list, pango_attr_scale_new (priv->font_scale));
1606 if (priv->underline_set)
1607 uline = priv->underline_style;
1609 uline = PANGO_UNDERLINE_NONE;
1611 if (priv->language_set)
1612 add_attr (attr_list, pango_attr_language_new (priv->language));
1614 if ((flags & GTK_CELL_RENDERER_PRELIT) == GTK_CELL_RENDERER_PRELIT)
1618 case PANGO_UNDERLINE_NONE:
1619 uline = PANGO_UNDERLINE_SINGLE;
1622 case PANGO_UNDERLINE_SINGLE:
1623 uline = PANGO_UNDERLINE_DOUBLE;
1631 if (uline != PANGO_UNDERLINE_NONE)
1632 add_attr (attr_list, pango_attr_underline_new (priv->underline_style));
1635 add_attr (attr_list, pango_attr_rise_new (priv->rise));
1637 /* Now apply the attributes as they will effect the outcome
1638 * of pango_layout_get_extents() */
1639 pango_layout_set_attributes (layout, attr_list);
1640 pango_attr_list_unref (attr_list);
1642 if (priv->ellipsize_set)
1643 pango_layout_set_ellipsize (layout, priv->ellipsize);
1645 pango_layout_set_ellipsize (layout, PANGO_ELLIPSIZE_NONE);
1647 if (priv->wrap_width != -1)
1649 PangoRectangle rect;
1650 gint width, text_width;
1652 pango_layout_get_extents (layout, NULL, &rect);
1653 text_width = rect.width;
1656 width = (cell_area->width - xpad * 2) * PANGO_SCALE;
1658 width = priv->wrap_width * PANGO_SCALE;
1660 width = MIN (width, text_width);
1662 pango_layout_set_width (layout, width);
1663 pango_layout_set_wrap (layout, priv->wrap_mode);
1667 pango_layout_set_width (layout, -1);
1668 pango_layout_set_wrap (layout, PANGO_WRAP_CHAR);
1671 if (priv->align_set)
1672 pango_layout_set_alignment (layout, priv->align);
1675 PangoAlignment align;
1677 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
1678 align = PANGO_ALIGN_RIGHT;
1680 align = PANGO_ALIGN_LEFT;
1682 pango_layout_set_alignment (layout, align);
1690 get_size (GtkCellRenderer *cell,
1692 const GdkRectangle *cell_area,
1693 PangoLayout *layout,
1699 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (cell);
1700 GtkCellRendererTextPrivate *priv = celltext->priv;
1701 PangoRectangle rect;
1703 gint cell_width, cell_height;
1705 gtk_cell_renderer_get_padding (cell, &xpad, &ypad);
1707 if (priv->calc_fixed_height)
1709 GtkStyleContext *style_context;
1710 GtkStateFlags state;
1711 PangoContext *context;
1712 PangoFontMetrics *metrics;
1713 PangoFontDescription *font_desc;
1716 style_context = gtk_widget_get_style_context (widget);
1717 state = gtk_widget_get_state_flags (widget);
1719 font_desc = pango_font_description_copy_static (gtk_style_context_get_font (style_context, state));
1720 pango_font_description_merge_static (font_desc, priv->font, TRUE);
1722 if (priv->scale_set)
1723 pango_font_description_set_size (font_desc,
1724 priv->font_scale * pango_font_description_get_size (font_desc));
1726 context = gtk_widget_get_pango_context (widget);
1728 metrics = pango_context_get_metrics (context,
1730 pango_context_get_language (context));
1731 row_height = (pango_font_metrics_get_ascent (metrics) +
1732 pango_font_metrics_get_descent (metrics));
1733 pango_font_metrics_unref (metrics);
1735 pango_font_description_free (font_desc);
1737 gtk_cell_renderer_get_fixed_size (cell, &cell_width, &cell_height);
1739 gtk_cell_renderer_set_fixed_size (cell,
1740 cell_width, 2 * ypad +
1741 priv->fixed_height_rows * PANGO_PIXELS (row_height));
1745 *height = cell_height;
1748 priv->calc_fixed_height = FALSE;
1754 g_object_ref (layout);
1756 layout = get_layout (celltext, widget, NULL, 0);
1758 pango_layout_get_pixel_extents (layout, NULL, &rect);
1762 gfloat xalign, yalign;
1764 gtk_cell_renderer_get_alignment (cell, &xalign, &yalign);
1766 rect.height = MIN (rect.height, cell_area->height - 2 * ypad);
1767 rect.width = MIN (rect.width, cell_area->width - 2 * xpad);
1771 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
1772 *x_offset = (1.0 - xalign) * (cell_area->width - (rect.width + (2 * xpad)));
1774 *x_offset = xalign * (cell_area->width - (rect.width + (2 * xpad)));
1776 if ((priv->ellipsize_set && priv->ellipsize != PANGO_ELLIPSIZE_NONE) || priv->wrap_width != -1)
1777 *x_offset = MAX(*x_offset, 0);
1781 *y_offset = yalign * (cell_area->height - (rect.height + (2 * ypad)));
1782 *y_offset = MAX (*y_offset, 0);
1787 if (x_offset) *x_offset = 0;
1788 if (y_offset) *y_offset = 0;
1792 *height = ypad * 2 + rect.height;
1795 *width = xpad * 2 + rect.width;
1797 g_object_unref (layout);
1801 gtk_cell_renderer_text_render (GtkCellRenderer *cell,
1804 const GdkRectangle *background_area,
1805 const GdkRectangle *cell_area,
1806 GtkCellRendererState flags)
1809 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (cell);
1810 GtkCellRendererTextPrivate *priv = celltext->priv;
1811 GtkStyleContext *context;
1812 PangoLayout *layout;
1816 PangoRectangle rect;
1818 layout = get_layout (celltext, widget, cell_area, flags);
1819 get_size (cell, widget, cell_area, layout, &x_offset, &y_offset, NULL, NULL);
1820 context = gtk_widget_get_style_context (widget);
1822 if (priv->background_set && (flags & GTK_CELL_RENDERER_SELECTED) == 0)
1824 gdk_cairo_rectangle (cr, background_area);
1825 gdk_cairo_set_source_rgba (cr, &priv->background);
1829 gtk_cell_renderer_get_padding (cell, &xpad, &ypad);
1831 if (priv->ellipsize_set && priv->ellipsize != PANGO_ELLIPSIZE_NONE)
1832 pango_layout_set_width (layout,
1833 (cell_area->width - x_offset - 2 * xpad) * PANGO_SCALE);
1834 else if (priv->wrap_width == -1)
1835 pango_layout_set_width (layout, -1);
1837 pango_layout_get_pixel_extents (layout, NULL, &rect);
1838 x_offset = x_offset - rect.x;
1842 gdk_cairo_rectangle (cr, cell_area);
1845 gtk_render_layout (context, cr,
1846 cell_area->x + x_offset + xpad,
1847 cell_area->y + y_offset + ypad,
1852 g_object_unref (layout);
1856 gtk_cell_renderer_text_editing_done (GtkCellEditable *entry,
1859 GtkCellRendererTextPrivate *priv;
1861 const gchar *new_text;
1864 priv = GTK_CELL_RENDERER_TEXT (data)->priv;
1868 if (priv->focus_out_id > 0)
1870 g_signal_handler_disconnect (entry, priv->focus_out_id);
1871 priv->focus_out_id = 0;
1874 if (priv->populate_popup_id > 0)
1876 g_signal_handler_disconnect (entry, priv->populate_popup_id);
1877 priv->populate_popup_id = 0;
1880 if (priv->entry_menu_popdown_timeout)
1882 g_source_remove (priv->entry_menu_popdown_timeout);
1883 priv->entry_menu_popdown_timeout = 0;
1886 g_object_get (entry,
1887 "editing-canceled", &canceled,
1889 gtk_cell_renderer_stop_editing (GTK_CELL_RENDERER (data), canceled);
1894 path = g_object_get_data (G_OBJECT (entry), GTK_CELL_RENDERER_TEXT_PATH);
1895 new_text = gtk_entry_get_text (GTK_ENTRY (entry));
1897 g_signal_emit (data, text_cell_renderer_signals[EDITED], 0, path, new_text);
1901 popdown_timeout (gpointer data)
1903 GtkCellRendererTextPrivate *priv;
1905 priv = GTK_CELL_RENDERER_TEXT (data)->priv;
1907 priv->entry_menu_popdown_timeout = 0;
1909 if (!gtk_widget_has_focus (priv->entry))
1910 gtk_cell_renderer_text_editing_done (GTK_CELL_EDITABLE (priv->entry), data);
1916 gtk_cell_renderer_text_popup_unmap (GtkMenu *menu,
1919 GtkCellRendererTextPrivate *priv;
1921 priv = GTK_CELL_RENDERER_TEXT (data)->priv;
1923 priv->in_entry_menu = FALSE;
1925 if (priv->entry_menu_popdown_timeout)
1928 priv->entry_menu_popdown_timeout = gdk_threads_add_timeout (500, popdown_timeout,
1933 gtk_cell_renderer_text_populate_popup (GtkEntry *entry,
1937 GtkCellRendererTextPrivate *priv;
1939 priv = GTK_CELL_RENDERER_TEXT (data)->priv;
1941 if (priv->entry_menu_popdown_timeout)
1943 g_source_remove (priv->entry_menu_popdown_timeout);
1944 priv->entry_menu_popdown_timeout = 0;
1947 priv->in_entry_menu = TRUE;
1949 g_signal_connect (menu, "unmap",
1950 G_CALLBACK (gtk_cell_renderer_text_popup_unmap), data);
1954 gtk_cell_renderer_text_focus_out_event (GtkWidget *entry,
1958 GtkCellRendererTextPrivate *priv;
1960 priv = GTK_CELL_RENDERER_TEXT (data)->priv;
1962 if (priv->in_entry_menu)
1965 g_object_set (entry,
1966 "editing-canceled", TRUE,
1968 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (entry));
1969 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (entry));
1971 /* entry needs focus-out-event */
1975 static GtkCellEditable *
1976 gtk_cell_renderer_text_start_editing (GtkCellRenderer *cell,
1980 const GdkRectangle *background_area,
1981 const GdkRectangle *cell_area,
1982 GtkCellRendererState flags)
1984 GtkRequisition requisition;
1985 GtkCellRendererText *celltext;
1986 GtkCellRendererTextPrivate *priv;
1987 gfloat xalign, yalign;
1989 celltext = GTK_CELL_RENDERER_TEXT (cell);
1990 priv = celltext->priv;
1992 /* If the cell isn't editable we return NULL. */
1993 if (priv->editable == FALSE)
1996 gtk_cell_renderer_get_alignment (cell, &xalign, &yalign);
1998 priv->entry = gtk_entry_new ();
1999 gtk_entry_set_has_frame (GTK_ENTRY (priv->entry), FALSE);
2000 gtk_entry_set_alignment (GTK_ENTRY (priv->entry), xalign);
2003 gtk_entry_set_text (GTK_ENTRY (priv->entry), priv->text);
2004 g_object_set_data_full (G_OBJECT (priv->entry), I_(GTK_CELL_RENDERER_TEXT_PATH), g_strdup (path), g_free);
2006 gtk_editable_select_region (GTK_EDITABLE (priv->entry), 0, -1);
2008 gtk_widget_get_preferred_size (priv->entry, &requisition, NULL);
2009 if (requisition.height < cell_area->height)
2011 GtkBorder *style_border;
2014 gtk_widget_style_get (priv->entry,
2015 "inner-border", &style_border,
2020 border = *style_border;
2021 g_boxed_free (GTK_TYPE_BORDER, style_border);
2025 /* Since boxed style properties can't have default values ... */
2030 border.top = (cell_area->height - requisition.height) / 2;
2031 border.bottom = (cell_area->height - requisition.height) / 2;
2032 gtk_entry_set_inner_border (GTK_ENTRY (priv->entry), &border);
2035 priv->in_entry_menu = FALSE;
2036 if (priv->entry_menu_popdown_timeout)
2038 g_source_remove (priv->entry_menu_popdown_timeout);
2039 priv->entry_menu_popdown_timeout = 0;
2042 g_signal_connect (priv->entry,
2044 G_CALLBACK (gtk_cell_renderer_text_editing_done),
2046 priv->focus_out_id = g_signal_connect_after (priv->entry, "focus-out-event",
2047 G_CALLBACK (gtk_cell_renderer_text_focus_out_event),
2049 priv->populate_popup_id =
2050 g_signal_connect (priv->entry, "populate-popup",
2051 G_CALLBACK (gtk_cell_renderer_text_populate_popup),
2054 gtk_widget_show (priv->entry);
2056 return GTK_CELL_EDITABLE (priv->entry);
2060 * gtk_cell_renderer_text_set_fixed_height_from_font:
2061 * @renderer: A #GtkCellRendererText
2062 * @number_of_rows: Number of rows of text each cell renderer is allocated, or -1
2064 * Sets the height of a renderer to explicitly be determined by the "font" and
2065 * "y_pad" property set on it. Further changes in these properties do not
2066 * affect the height, so they must be accompanied by a subsequent call to this
2067 * function. Using this function is unflexible, and should really only be used
2068 * if calculating the size of a cell is too slow (ie, a massive number of cells
2069 * displayed). If @number_of_rows is -1, then the fixed height is unset, and
2070 * the height is determined by the properties again.
2073 gtk_cell_renderer_text_set_fixed_height_from_font (GtkCellRendererText *renderer,
2074 gint number_of_rows)
2076 GtkCellRendererTextPrivate *priv;
2077 GtkCellRenderer *cell;
2079 g_return_if_fail (GTK_IS_CELL_RENDERER_TEXT (renderer));
2080 g_return_if_fail (number_of_rows == -1 || number_of_rows > 0);
2082 cell = GTK_CELL_RENDERER (renderer);
2083 priv = renderer->priv;
2085 if (number_of_rows == -1)
2089 gtk_cell_renderer_get_fixed_size (cell, &width, &height);
2090 gtk_cell_renderer_set_fixed_size (cell, width, -1);
2094 priv->fixed_height_rows = number_of_rows;
2095 priv->calc_fixed_height = TRUE;
2100 gtk_cell_renderer_text_get_preferred_width (GtkCellRenderer *cell,
2105 GtkCellRendererTextPrivate *priv;
2106 GtkCellRendererText *celltext;
2107 GtkStyleContext *style_context;
2108 const PangoFontDescription *font_desc;
2109 PangoLayout *layout;
2110 PangoContext *context;
2111 PangoFontMetrics *metrics;
2112 PangoRectangle rect;
2113 gint char_width, text_width, ellipsize_chars, xpad;
2114 gint min_width, nat_width;
2116 /* "width-chars" Hard-coded minimum width:
2117 * - minimum size should be MAX (width-chars, strlen ("..."));
2118 * - natural size should be MAX (width-chars, strlen (label->text));
2120 * "wrap-width" User specified natural wrap width
2121 * - minimum size should be MAX (width-chars, 0)
2122 * - natural size should be MIN (wrap-width, strlen (label->text))
2125 celltext = GTK_CELL_RENDERER_TEXT (cell);
2126 priv = celltext->priv;
2128 style_context = gtk_widget_get_style_context (widget);
2130 gtk_cell_renderer_get_padding (cell, &xpad, NULL);
2132 layout = get_layout (celltext, widget, NULL, 0);
2134 /* Fetch the length of the complete unwrapped text */
2135 pango_layout_set_width (layout, -1);
2136 pango_layout_get_extents (layout, NULL, &rect);
2137 text_width = rect.width;
2139 /* Fetch the average size of a charachter */
2140 context = pango_layout_get_context (layout);
2141 font_desc = gtk_style_context_get_font (style_context, 0);
2142 metrics = pango_context_get_metrics (context, font_desc,
2143 pango_context_get_language (context));
2145 char_width = pango_font_metrics_get_approximate_char_width (metrics);
2147 pango_font_metrics_unref (metrics);
2148 g_object_unref (layout);
2150 /* enforce minimum width for ellipsized labels at ~3 chars */
2151 if (priv->ellipsize_set && priv->ellipsize != PANGO_ELLIPSIZE_NONE)
2152 ellipsize_chars = 3;
2154 ellipsize_chars = 0;
2156 if ((priv->ellipsize_set && priv->ellipsize != PANGO_ELLIPSIZE_NONE) || priv->width_chars > 0)
2157 min_width = xpad * 2 +
2158 MIN (PANGO_PIXELS_CEIL (text_width),
2159 (PANGO_PIXELS (char_width) * MAX (priv->width_chars, ellipsize_chars)));
2160 /* If no width-chars set, minimum for wrapping text will be the wrap-width */
2161 else if (priv->wrap_width > -1)
2162 min_width = xpad * 2 + rect.x + MIN (PANGO_PIXELS_CEIL (text_width), priv->wrap_width);
2164 min_width = xpad * 2 + rect.x + PANGO_PIXELS_CEIL (text_width);
2166 if (priv->width_chars > 0)
2167 nat_width = xpad * 2 +
2168 MAX ((PANGO_PIXELS (char_width) * priv->width_chars), PANGO_PIXELS_CEIL (text_width));
2170 nat_width = xpad * 2 + PANGO_PIXELS_CEIL (text_width);
2172 nat_width = MAX (nat_width, min_width);
2174 if (priv->max_width_chars > 0)
2176 gint max_width = xpad * 2 + PANGO_PIXELS (char_width) * priv->max_width_chars;
2178 min_width = MIN (min_width, max_width);
2179 nat_width = MIN (nat_width, max_width);
2183 *minimum_size = min_width;
2186 *natural_size = nat_width;
2190 gtk_cell_renderer_text_get_preferred_height_for_width (GtkCellRenderer *cell,
2193 gint *minimum_height,
2194 gint *natural_height)
2196 GtkCellRendererText *celltext;
2197 PangoLayout *layout;
2198 gint text_height, xpad, ypad;
2201 celltext = GTK_CELL_RENDERER_TEXT (cell);
2203 gtk_cell_renderer_get_padding (cell, &xpad, &ypad);
2205 layout = get_layout (celltext, widget, NULL, 0);
2207 pango_layout_set_width (layout, (width - xpad * 2) * PANGO_SCALE);
2208 pango_layout_get_pixel_size (layout, NULL, &text_height);
2211 *minimum_height = text_height + ypad * 2;
2214 *natural_height = text_height + ypad * 2;
2216 g_object_unref (layout);
2220 gtk_cell_renderer_text_get_preferred_height (GtkCellRenderer *cell,
2227 /* Thankfully cell renderers dont rotate, so they only have to do
2228 * height-for-width and not the opposite. Here we have only to return
2229 * the height for the base minimum width of the renderer.
2231 * Note this code path wont be followed by GtkTreeView which is
2232 * height-for-width specifically.
2234 gtk_cell_renderer_get_preferred_width (cell, widget, &min_width, NULL);
2235 gtk_cell_renderer_text_get_preferred_height_for_width (cell, widget, min_width,
2236 minimum_size, natural_size);
2240 gtk_cell_renderer_text_get_aligned_area (GtkCellRenderer *cell,
2242 GtkCellRendererState flags,
2243 const GdkRectangle *cell_area,
2244 GdkRectangle *aligned_area)
2246 GtkCellRendererText *celltext = GTK_CELL_RENDERER_TEXT (cell);
2247 PangoLayout *layout;
2251 layout = get_layout (celltext, widget, cell_area, flags);
2252 get_size (cell, widget, cell_area, layout, &x_offset, &y_offset,
2253 &aligned_area->width, &aligned_area->height);
2255 aligned_area->x = cell_area->x + x_offset;
2256 aligned_area->y = cell_area->y + y_offset;
2258 g_object_unref (layout);