1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser 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 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free
16 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
21 * file for a list of people on the GTK+ Team. See the ChangeLog
22 * files for a list of changes. These files are distributed with
23 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include "gtkaccellabel.h"
33 #include "gtkmarshalers.h"
34 #include "gtkwindow.h"
35 #include "gdk/gdkkeysyms.h"
36 #include "gtkclipboard.h"
37 #include <pango/pango.h>
38 #include "gtkimagemenuitem.h"
40 #include "gtkseparatormenuitem.h"
41 #include "gtktextutil.h"
42 #include "gtkmenuitem.h"
43 #include "gtknotebook.h"
45 #include "gtkbindings.h"
46 #include "gtkbuildable.h"
47 #include "gtkprivate.h"
50 #define GTK_LABEL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_LABEL, GtkLabelPrivate))
60 struct _GtkLabelSelectionInfo
63 gint selection_anchor;
65 GtkWidget *popup_menu;
97 PROP_SINGLE_LINE_MODE,
102 static guint signals[LAST_SIGNAL] = { 0 };
104 static void gtk_label_set_property (GObject *object,
108 static void gtk_label_get_property (GObject *object,
112 static void gtk_label_destroy (GtkObject *object);
113 static void gtk_label_finalize (GObject *object);
114 static void gtk_label_size_request (GtkWidget *widget,
115 GtkRequisition *requisition);
116 static void gtk_label_size_allocate (GtkWidget *widget,
117 GtkAllocation *allocation);
118 static void gtk_label_state_changed (GtkWidget *widget,
120 static void gtk_label_style_set (GtkWidget *widget,
121 GtkStyle *previous_style);
122 static void gtk_label_direction_changed (GtkWidget *widget,
123 GtkTextDirection previous_dir);
124 static gint gtk_label_expose (GtkWidget *widget,
125 GdkEventExpose *event);
127 static void gtk_label_realize (GtkWidget *widget);
128 static void gtk_label_unrealize (GtkWidget *widget);
129 static void gtk_label_map (GtkWidget *widget);
130 static void gtk_label_unmap (GtkWidget *widget);
132 static gboolean gtk_label_button_press (GtkWidget *widget,
133 GdkEventButton *event);
134 static gboolean gtk_label_button_release (GtkWidget *widget,
135 GdkEventButton *event);
136 static gboolean gtk_label_motion (GtkWidget *widget,
137 GdkEventMotion *event);
138 static void gtk_label_grab_focus (GtkWidget *widget);
141 static void gtk_label_set_text_internal (GtkLabel *label,
143 static void gtk_label_set_label_internal (GtkLabel *label,
145 static void gtk_label_set_use_markup_internal (GtkLabel *label,
147 static void gtk_label_set_use_underline_internal (GtkLabel *label,
149 static void gtk_label_set_attributes_internal (GtkLabel *label,
150 PangoAttrList *attrs);
151 static void gtk_label_set_uline_text_internal (GtkLabel *label,
153 static void gtk_label_set_pattern_internal (GtkLabel *label,
154 const gchar *pattern);
155 static void set_markup (GtkLabel *label,
157 gboolean with_uline);
158 static void gtk_label_recalculate (GtkLabel *label);
159 static void gtk_label_hierarchy_changed (GtkWidget *widget,
160 GtkWidget *old_toplevel);
161 static void gtk_label_screen_changed (GtkWidget *widget,
162 GdkScreen *old_screen);
164 static void gtk_label_create_window (GtkLabel *label);
165 static void gtk_label_destroy_window (GtkLabel *label);
166 static void gtk_label_clear_layout (GtkLabel *label);
167 static void gtk_label_ensure_layout (GtkLabel *label);
168 static void gtk_label_invalidate_wrap_width (GtkLabel *label);
169 static void gtk_label_select_region_index (GtkLabel *label,
173 static gboolean gtk_label_mnemonic_activate (GtkWidget *widget,
174 gboolean group_cycling);
175 static void gtk_label_setup_mnemonic (GtkLabel *label,
177 static void gtk_label_drag_data_get (GtkWidget *widget,
178 GdkDragContext *context,
179 GtkSelectionData *selection_data,
183 static void gtk_label_buildable_interface_init (GtkBuildableIface *iface);
184 static gboolean gtk_label_buildable_custom_tag_start (GtkBuildable *buildable,
187 const gchar *tagname,
188 GMarkupParser *parser,
191 static void gtk_label_buildable_custom_finished (GtkBuildable *buildable,
194 const gchar *tagname,
198 /* For selectable lables: */
199 static void gtk_label_move_cursor (GtkLabel *label,
200 GtkMovementStep step,
202 gboolean extend_selection);
203 static void gtk_label_copy_clipboard (GtkLabel *label);
204 static void gtk_label_select_all (GtkLabel *label);
205 static void gtk_label_do_popup (GtkLabel *label,
206 GdkEventButton *event);
208 static gint gtk_label_move_forward_word (GtkLabel *label,
210 static gint gtk_label_move_backward_word (GtkLabel *label,
213 static GQuark quark_angle = 0;
215 static GtkBuildableIface *buildable_parent_iface = NULL;
217 G_DEFINE_TYPE_WITH_CODE (GtkLabel, gtk_label, GTK_TYPE_MISC,
218 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
219 gtk_label_buildable_interface_init));
222 add_move_binding (GtkBindingSet *binding_set,
225 GtkMovementStep step,
228 g_return_if_fail ((modmask & GDK_SHIFT_MASK) == 0);
230 gtk_binding_entry_add_signal (binding_set, keyval, modmask,
234 G_TYPE_BOOLEAN, FALSE);
236 /* Selection-extending version */
237 gtk_binding_entry_add_signal (binding_set, keyval, modmask | GDK_SHIFT_MASK,
241 G_TYPE_BOOLEAN, TRUE);
245 gtk_label_class_init (GtkLabelClass *class)
247 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
248 GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
249 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
250 GtkBindingSet *binding_set;
252 quark_angle = g_quark_from_static_string ("angle");
254 gobject_class->set_property = gtk_label_set_property;
255 gobject_class->get_property = gtk_label_get_property;
256 gobject_class->finalize = gtk_label_finalize;
258 object_class->destroy = gtk_label_destroy;
260 widget_class->size_request = gtk_label_size_request;
261 widget_class->size_allocate = gtk_label_size_allocate;
262 widget_class->state_changed = gtk_label_state_changed;
263 widget_class->style_set = gtk_label_style_set;
264 widget_class->direction_changed = gtk_label_direction_changed;
265 widget_class->expose_event = gtk_label_expose;
266 widget_class->realize = gtk_label_realize;
267 widget_class->unrealize = gtk_label_unrealize;
268 widget_class->map = gtk_label_map;
269 widget_class->unmap = gtk_label_unmap;
270 widget_class->button_press_event = gtk_label_button_press;
271 widget_class->button_release_event = gtk_label_button_release;
272 widget_class->motion_notify_event = gtk_label_motion;
273 widget_class->hierarchy_changed = gtk_label_hierarchy_changed;
274 widget_class->screen_changed = gtk_label_screen_changed;
275 widget_class->mnemonic_activate = gtk_label_mnemonic_activate;
276 widget_class->drag_data_get = gtk_label_drag_data_get;
277 widget_class->grab_focus = gtk_label_grab_focus;
279 class->move_cursor = gtk_label_move_cursor;
280 class->copy_clipboard = gtk_label_copy_clipboard;
282 signals[MOVE_CURSOR] =
283 g_signal_new (I_("move_cursor"),
284 G_OBJECT_CLASS_TYPE (gobject_class),
285 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
286 G_STRUCT_OFFSET (GtkLabelClass, move_cursor),
288 _gtk_marshal_VOID__ENUM_INT_BOOLEAN,
290 GTK_TYPE_MOVEMENT_STEP,
294 signals[COPY_CLIPBOARD] =
295 g_signal_new (I_("copy_clipboard"),
296 G_OBJECT_CLASS_TYPE (gobject_class),
297 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
298 G_STRUCT_OFFSET (GtkLabelClass, copy_clipboard),
300 _gtk_marshal_VOID__VOID,
303 signals[POPULATE_POPUP] =
304 g_signal_new (I_("populate_popup"),
305 G_OBJECT_CLASS_TYPE (gobject_class),
307 G_STRUCT_OFFSET (GtkLabelClass, populate_popup),
309 _gtk_marshal_VOID__OBJECT,
313 g_object_class_install_property (gobject_class,
315 g_param_spec_string ("label",
317 P_("The text of the label"),
319 GTK_PARAM_READWRITE));
320 g_object_class_install_property (gobject_class,
322 g_param_spec_boxed ("attributes",
324 P_("A list of style attributes to apply to the text of the label"),
325 PANGO_TYPE_ATTR_LIST,
326 GTK_PARAM_READWRITE));
327 g_object_class_install_property (gobject_class,
329 g_param_spec_boolean ("use-markup",
331 P_("The text of the label includes XML markup. See pango_parse_markup()"),
333 GTK_PARAM_READWRITE));
334 g_object_class_install_property (gobject_class,
336 g_param_spec_boolean ("use-underline",
338 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
340 GTK_PARAM_READWRITE));
342 g_object_class_install_property (gobject_class,
344 g_param_spec_enum ("justify",
346 P_("The alignment of the lines in the text of the label relative to each other. This does NOT affect the alignment of the label within its allocation. See GtkMisc::xalign for that"),
347 GTK_TYPE_JUSTIFICATION,
349 GTK_PARAM_READWRITE));
351 g_object_class_install_property (gobject_class,
353 g_param_spec_string ("pattern",
355 P_("A string with _ characters in positions correspond to characters in the text to underline"),
357 GTK_PARAM_WRITABLE));
359 g_object_class_install_property (gobject_class,
361 g_param_spec_boolean ("wrap",
363 P_("If set, wrap lines if the text becomes too wide"),
365 GTK_PARAM_READWRITE));
367 * GtkLabel:wrap-mode:
369 * If line wrapping is on (see the #GtkLabel:wrap property) this controls
370 * how the line wrapping is done. The default is %PANGO_WRAP_WORD, which
371 * means wrap on word boundaries.
375 g_object_class_install_property (gobject_class,
377 g_param_spec_enum ("wrap-mode",
378 P_("Line wrap mode"),
379 P_("If wrap is set, controls how linewrapping is done"),
380 PANGO_TYPE_WRAP_MODE,
382 GTK_PARAM_READWRITE));
383 g_object_class_install_property (gobject_class,
385 g_param_spec_boolean ("selectable",
387 P_("Whether the label text can be selected with the mouse"),
389 GTK_PARAM_READWRITE));
390 g_object_class_install_property (gobject_class,
391 PROP_MNEMONIC_KEYVAL,
392 g_param_spec_uint ("mnemonic-keyval",
394 P_("The mnemonic accelerator key for this label"),
398 GTK_PARAM_READABLE));
399 g_object_class_install_property (gobject_class,
400 PROP_MNEMONIC_WIDGET,
401 g_param_spec_object ("mnemonic-widget",
402 P_("Mnemonic widget"),
403 P_("The widget to be activated when the label's mnemonic "
406 GTK_PARAM_READWRITE));
408 g_object_class_install_property (gobject_class,
409 PROP_CURSOR_POSITION,
410 g_param_spec_int ("cursor-position",
411 P_("Cursor Position"),
412 P_("The current position of the insertion cursor in chars"),
416 GTK_PARAM_READABLE));
418 g_object_class_install_property (gobject_class,
419 PROP_SELECTION_BOUND,
420 g_param_spec_int ("selection-bound",
421 P_("Selection Bound"),
422 P_("The position of the opposite end of the selection from the cursor in chars"),
426 GTK_PARAM_READABLE));
429 * GtkLabel:ellipsize:
431 * The preferred place to ellipsize the string, if the label does
432 * not have enough room to display the entire string, specified as a
433 * #PangoEllisizeMode.
435 * Note that setting this property to a value other than
436 * %PANGO_ELLIPSIZE_NONE has the side-effect that the label requests
437 * only enough space to display the ellipsis "...". In particular, this
438 * means that ellipsizing labels do not work well in notebook tabs, unless
439 * the tab's #GtkNotebook:tab-expand property is set to %TRUE. Other ways
440 * to set a label's width are gtk_widget_set_size_request() and
441 * gtk_label_set_width_chars().
445 g_object_class_install_property (gobject_class,
447 g_param_spec_enum ("ellipsize",
449 P_("The preferred place to ellipsize the string, if the label does not have enough room to display the entire string"),
450 PANGO_TYPE_ELLIPSIZE_MODE,
451 PANGO_ELLIPSIZE_NONE,
452 GTK_PARAM_READWRITE));
455 * GtkLabel:width-chars:
457 * The desired width of the label, in characters. If this property is set to
458 * -1, the width will be calculated automatically, otherwise the label will
459 * request either 3 characters or the property value, whichever is greater.
460 * If the "width-chars" property is set to a positive value, then the
461 * #GtkLabel:max-width-chars property is ignored.
465 g_object_class_install_property (gobject_class,
467 g_param_spec_int ("width-chars",
468 P_("Width In Characters"),
469 P_("The desired width of the label, in characters"),
473 GTK_PARAM_READWRITE));
476 * GtkLabel:single-line-mode:
478 * Whether the label is in single line mode. In single line mode,
479 * the height of the label does not depend on the actual text, it
480 * is always set to ascent + descent of the font. This can be an
481 * advantage in situations where resizing the label because of text
482 * changes would be distracting, e.g. in a statusbar.
486 g_object_class_install_property (gobject_class,
487 PROP_SINGLE_LINE_MODE,
488 g_param_spec_boolean ("single-line-mode",
489 P_("Single Line Mode"),
490 P_("Whether the label is in single line mode"),
492 GTK_PARAM_READWRITE));
497 * The angle that the baseline of the label makes with the horizontal,
498 * in degrees, measured counterclockwise. An angle of 90 reads from
499 * from bottom to top, an angle of 270, from top to bottom. Ignored
500 * if the label is selectable, wrapped, or ellipsized.
504 g_object_class_install_property (gobject_class,
506 g_param_spec_double ("angle",
508 P_("Angle at which the label is rotated"),
512 GTK_PARAM_READWRITE));
515 * GtkLabel:max-width-chars:
517 * The desired maximum width of the label, in characters. If this property
518 * is set to -1, the width will be calculated automatically, otherwise the
519 * label will request space for no more than the requested number of
520 * characters. If the #GtkLabel:width-chars property is set to a positive
521 * value, then the "max-width-chars" property is ignored.
525 g_object_class_install_property (gobject_class,
526 PROP_MAX_WIDTH_CHARS,
527 g_param_spec_int ("max-width-chars",
528 P_("Maximum Width In Characters"),
529 P_("The desired maximum width of the label, in characters"),
533 GTK_PARAM_READWRITE));
538 binding_set = gtk_binding_set_by_class (class);
540 /* Moving the insertion point */
541 add_move_binding (binding_set, GDK_Right, 0,
542 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
544 add_move_binding (binding_set, GDK_Left, 0,
545 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
547 add_move_binding (binding_set, GDK_KP_Right, 0,
548 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
550 add_move_binding (binding_set, GDK_KP_Left, 0,
551 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
553 add_move_binding (binding_set, GDK_f, GDK_CONTROL_MASK,
554 GTK_MOVEMENT_LOGICAL_POSITIONS, 1);
556 add_move_binding (binding_set, GDK_b, GDK_CONTROL_MASK,
557 GTK_MOVEMENT_LOGICAL_POSITIONS, -1);
559 add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
560 GTK_MOVEMENT_WORDS, 1);
562 add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
563 GTK_MOVEMENT_WORDS, -1);
565 add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
566 GTK_MOVEMENT_WORDS, 1);
568 add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
569 GTK_MOVEMENT_WORDS, -1);
572 gtk_binding_entry_add_signal (binding_set, GDK_a, GDK_CONTROL_MASK,
574 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
576 G_TYPE_BOOLEAN, FALSE);
578 gtk_binding_entry_add_signal (binding_set, GDK_a, GDK_CONTROL_MASK,
580 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
582 G_TYPE_BOOLEAN, TRUE);
584 gtk_binding_entry_add_signal (binding_set, GDK_slash, GDK_CONTROL_MASK,
586 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
588 G_TYPE_BOOLEAN, FALSE);
590 gtk_binding_entry_add_signal (binding_set, GDK_slash, GDK_CONTROL_MASK,
592 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
594 G_TYPE_BOOLEAN, TRUE);
597 gtk_binding_entry_add_signal (binding_set, GDK_a, GDK_SHIFT_MASK | GDK_CONTROL_MASK,
599 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
601 G_TYPE_BOOLEAN, FALSE);
603 gtk_binding_entry_add_signal (binding_set, GDK_backslash, GDK_CONTROL_MASK,
605 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
607 G_TYPE_BOOLEAN, FALSE);
609 add_move_binding (binding_set, GDK_f, GDK_MOD1_MASK,
610 GTK_MOVEMENT_WORDS, 1);
612 add_move_binding (binding_set, GDK_b, GDK_MOD1_MASK,
613 GTK_MOVEMENT_WORDS, -1);
615 add_move_binding (binding_set, GDK_Home, 0,
616 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
618 add_move_binding (binding_set, GDK_End, 0,
619 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
621 add_move_binding (binding_set, GDK_KP_Home, 0,
622 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
624 add_move_binding (binding_set, GDK_KP_End, 0,
625 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
627 add_move_binding (binding_set, GDK_Home, GDK_CONTROL_MASK,
628 GTK_MOVEMENT_BUFFER_ENDS, -1);
630 add_move_binding (binding_set, GDK_End, GDK_CONTROL_MASK,
631 GTK_MOVEMENT_BUFFER_ENDS, 1);
633 add_move_binding (binding_set, GDK_KP_Home, GDK_CONTROL_MASK,
634 GTK_MOVEMENT_BUFFER_ENDS, -1);
636 add_move_binding (binding_set, GDK_KP_End, GDK_CONTROL_MASK,
637 GTK_MOVEMENT_BUFFER_ENDS, 1);
640 gtk_binding_entry_add_signal (binding_set, GDK_c, GDK_CONTROL_MASK,
641 "copy_clipboard", 0);
643 gtk_settings_install_property (g_param_spec_boolean ("gtk-label-select-on-focus",
644 P_("Select on focus"),
645 P_("Whether to select the contents of a selectable label when it is focused"),
647 GTK_PARAM_READWRITE));
650 g_type_class_add_private (class, sizeof (GtkLabelPrivate));
654 gtk_label_set_property (GObject *object,
661 label = GTK_LABEL (object);
666 gtk_label_set_label (label, g_value_get_string (value));
668 case PROP_ATTRIBUTES:
669 gtk_label_set_attributes (label, g_value_get_boxed (value));
671 case PROP_USE_MARKUP:
672 gtk_label_set_use_markup (label, g_value_get_boolean (value));
674 case PROP_USE_UNDERLINE:
675 gtk_label_set_use_underline (label, g_value_get_boolean (value));
678 gtk_label_set_justify (label, g_value_get_enum (value));
681 gtk_label_set_pattern (label, g_value_get_string (value));
684 gtk_label_set_line_wrap (label, g_value_get_boolean (value));
687 gtk_label_set_line_wrap_mode (label, g_value_get_enum (value));
689 case PROP_SELECTABLE:
690 gtk_label_set_selectable (label, g_value_get_boolean (value));
692 case PROP_MNEMONIC_WIDGET:
693 gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
696 gtk_label_set_ellipsize (label, g_value_get_enum (value));
698 case PROP_WIDTH_CHARS:
699 gtk_label_set_width_chars (label, g_value_get_int (value));
701 case PROP_SINGLE_LINE_MODE:
702 gtk_label_set_single_line_mode (label, g_value_get_boolean (value));
705 gtk_label_set_angle (label, g_value_get_double (value));
707 case PROP_MAX_WIDTH_CHARS:
708 gtk_label_set_max_width_chars (label, g_value_get_int (value));
711 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
717 gtk_label_get_property (GObject *object,
724 label = GTK_LABEL (object);
729 g_value_set_string (value, label->label);
731 case PROP_ATTRIBUTES:
732 g_value_set_boxed (value, label->attrs);
734 case PROP_USE_MARKUP:
735 g_value_set_boolean (value, label->use_markup);
737 case PROP_USE_UNDERLINE:
738 g_value_set_boolean (value, label->use_underline);
741 g_value_set_enum (value, label->jtype);
744 g_value_set_boolean (value, label->wrap);
747 g_value_set_enum (value, label->wrap_mode);
749 case PROP_SELECTABLE:
750 g_value_set_boolean (value, gtk_label_get_selectable (label));
752 case PROP_MNEMONIC_KEYVAL:
753 g_value_set_uint (value, label->mnemonic_keyval);
755 case PROP_MNEMONIC_WIDGET:
756 g_value_set_object (value, (GObject*) label->mnemonic_widget);
758 case PROP_CURSOR_POSITION:
759 if (label->select_info)
761 gint offset = g_utf8_pointer_to_offset (label->text,
762 label->text + label->select_info->selection_end);
763 g_value_set_int (value, offset);
766 g_value_set_int (value, 0);
768 case PROP_SELECTION_BOUND:
769 if (label->select_info)
771 gint offset = g_utf8_pointer_to_offset (label->text,
772 label->text + label->select_info->selection_anchor);
773 g_value_set_int (value, offset);
776 g_value_set_int (value, 0);
779 g_value_set_enum (value, label->ellipsize);
781 case PROP_WIDTH_CHARS:
782 g_value_set_int (value, gtk_label_get_width_chars (label));
784 case PROP_SINGLE_LINE_MODE:
785 g_value_set_boolean (value, gtk_label_get_single_line_mode (label));
788 g_value_set_double (value, gtk_label_get_angle (label));
790 case PROP_MAX_WIDTH_CHARS:
791 g_value_set_int (value, gtk_label_get_max_width_chars (label));
795 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
801 gtk_label_init (GtkLabel *label)
803 GtkLabelPrivate *priv;
805 GTK_WIDGET_SET_FLAGS (label, GTK_NO_WINDOW);
807 priv = GTK_LABEL_GET_PRIVATE (label);
808 priv->width_chars = -1;
809 priv->max_width_chars = -1;
810 priv->wrap_width = -1;
813 label->jtype = GTK_JUSTIFY_LEFT;
815 label->wrap_mode = PANGO_WRAP_WORD;
816 label->ellipsize = PANGO_ELLIPSIZE_NONE;
818 label->use_underline = FALSE;
819 label->use_markup = FALSE;
820 label->pattern_set = FALSE;
822 label->mnemonic_keyval = GDK_VoidSymbol;
823 label->layout = NULL;
827 label->mnemonic_widget = NULL;
828 label->mnemonic_window = NULL;
830 gtk_label_set_text (label, "");
835 gtk_label_buildable_interface_init (GtkBuildableIface *iface)
837 buildable_parent_iface = g_type_interface_peek_parent (iface);
839 iface->custom_tag_start = gtk_label_buildable_custom_tag_start;
840 iface->custom_finished = gtk_label_buildable_custom_finished;
846 PangoAttrList *attrs;
850 attribute_from_text (GtkBuilder *builder,
855 PangoAttribute *attribute = NULL;
857 PangoLanguage *language;
858 PangoFontDescription *font_desc;
862 if (!gtk_builder_value_from_string_type (builder, PANGO_TYPE_ATTR_TYPE, name, &val, error))
865 type = g_value_get_enum (&val);
866 g_value_unset (&val);
870 /* PangoAttrLanguage */
871 case PANGO_ATTR_LANGUAGE:
872 if ((language = pango_language_from_string (value)))
874 attribute = pango_attr_language_new (language);
875 g_value_init (&val, G_TYPE_INT);
879 case PANGO_ATTR_STYLE:
880 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_STYLE, value, &val, error))
881 attribute = pango_attr_style_new (g_value_get_enum (&val));
883 case PANGO_ATTR_WEIGHT:
884 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_WEIGHT, value, &val, error))
885 attribute = pango_attr_weight_new (g_value_get_enum (&val));
887 case PANGO_ATTR_VARIANT:
888 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_VARIANT, value, &val, error))
889 attribute = pango_attr_variant_new (g_value_get_enum (&val));
891 case PANGO_ATTR_STRETCH:
892 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_STRETCH, value, &val, error))
893 attribute = pango_attr_stretch_new (g_value_get_enum (&val));
895 case PANGO_ATTR_UNDERLINE:
896 if (gtk_builder_value_from_string_type (builder, G_TYPE_BOOLEAN, value, &val, error))
897 attribute = pango_attr_underline_new (g_value_get_boolean (&val));
899 case PANGO_ATTR_STRIKETHROUGH:
900 if (gtk_builder_value_from_string_type (builder, G_TYPE_BOOLEAN, value, &val, error))
901 attribute = pango_attr_strikethrough_new (g_value_get_boolean (&val));
903 case PANGO_ATTR_GRAVITY:
904 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_GRAVITY, value, &val, error))
905 attribute = pango_attr_gravity_new (g_value_get_enum (&val));
907 case PANGO_ATTR_GRAVITY_HINT:
908 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_GRAVITY_HINT,
910 attribute = pango_attr_gravity_hint_new (g_value_get_enum (&val));
913 /* PangoAttrString */
914 case PANGO_ATTR_FAMILY:
915 attribute = pango_attr_family_new (value);
916 g_value_init (&val, G_TYPE_INT);
920 case PANGO_ATTR_SIZE:
921 if (gtk_builder_value_from_string_type (builder, G_TYPE_INT,
923 attribute = pango_attr_size_new (g_value_get_int (&val));
925 case PANGO_ATTR_ABSOLUTE_SIZE:
926 if (gtk_builder_value_from_string_type (builder, G_TYPE_INT,
928 attribute = pango_attr_size_new_absolute (g_value_get_int (&val));
931 /* PangoAttrFontDesc */
932 case PANGO_ATTR_FONT_DESC:
933 if ((font_desc = pango_font_description_from_string (value)))
935 attribute = pango_attr_font_desc_new (font_desc);
936 pango_font_description_free (font_desc);
937 g_value_init (&val, G_TYPE_INT);
942 case PANGO_ATTR_FOREGROUND:
943 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
946 color = g_value_get_boxed (&val);
947 attribute = pango_attr_foreground_new (color->red, color->green, color->blue);
950 case PANGO_ATTR_BACKGROUND:
951 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
954 color = g_value_get_boxed (&val);
955 attribute = pango_attr_background_new (color->red, color->green, color->blue);
958 case PANGO_ATTR_UNDERLINE_COLOR:
959 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
962 color = g_value_get_boxed (&val);
963 attribute = pango_attr_underline_color_new (color->red, color->green, color->blue);
966 case PANGO_ATTR_STRIKETHROUGH_COLOR:
967 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
970 color = g_value_get_boxed (&val);
971 attribute = pango_attr_strikethrough_color_new (color->red, color->green, color->blue);
976 case PANGO_ATTR_SHAPE:
977 /* Unsupported for now */
980 case PANGO_ATTR_SCALE:
981 if (gtk_builder_value_from_string_type (builder, G_TYPE_DOUBLE,
983 attribute = pango_attr_scale_new (g_value_get_double (&val));
986 case PANGO_ATTR_INVALID:
987 case PANGO_ATTR_LETTER_SPACING:
988 case PANGO_ATTR_RISE:
989 case PANGO_ATTR_FALLBACK:
994 g_value_unset (&val);
1001 pango_start_element (GMarkupParseContext *context,
1002 const gchar *element_name,
1003 const gchar **names,
1004 const gchar **values,
1008 PangoParserData *data = (PangoParserData*)user_data;
1009 GValue val = { 0, };
1011 gint line_number, char_number;
1013 if (strcmp (element_name, "attribute") == 0)
1015 PangoAttribute *attr = NULL;
1016 const gchar *name = NULL;
1017 const gchar *value = NULL;
1018 const gchar *start = NULL;
1019 const gchar *end = NULL;
1020 guint start_val = 0;
1021 guint end_val = G_MAXUINT;
1023 for (i = 0; names[i]; i++)
1025 if (strcmp (names[i], "name") == 0)
1027 else if (strcmp (names[i], "value") == 0)
1029 else if (strcmp (names[i], "start") == 0)
1031 else if (strcmp (names[i], "end") == 0)
1035 g_markup_parse_context_get_position (context,
1040 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
1041 "%s:%d:%d '%s' is not a valid attribute of <%s>",
1043 line_number, char_number, names[i], "attribute");
1048 if (!name || !value)
1050 g_markup_parse_context_get_position (context,
1055 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
1056 "%s:%d:%d <%s> requires attribute \"%s\"",
1058 line_number, char_number, "attribute",
1059 name ? "value" : "name");
1065 if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_UINT,
1066 start, &val, error))
1068 start_val = g_value_get_uint (&val);
1069 g_value_unset (&val);
1074 if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_UINT,
1077 end_val = g_value_get_uint (&val);
1078 g_value_unset (&val);
1081 attr = attribute_from_text (data->builder, name, value, error);
1082 attr->start_index = start_val;
1083 attr->end_index = end_val;
1088 data->attrs = pango_attr_list_new ();
1090 pango_attr_list_insert (data->attrs, attr);
1093 else if (strcmp (element_name, "attributes") == 0)
1096 g_warning ("Unsupported tag for GtkLabel: %s\n", element_name);
1099 static const GMarkupParser pango_parser =
1101 pango_start_element,
1105 gtk_label_buildable_custom_tag_start (GtkBuildable *buildable,
1106 GtkBuilder *builder,
1108 const gchar *tagname,
1109 GMarkupParser *parser,
1112 if (buildable_parent_iface->custom_tag_start (buildable, builder, child,
1113 tagname, parser, data))
1116 if (strcmp (tagname, "attributes") == 0)
1118 PangoParserData *parser_data;
1120 parser_data = g_slice_new0 (PangoParserData);
1121 parser_data->builder = g_object_ref (builder);
1122 parser_data->object = g_object_ref (buildable);
1123 *parser = pango_parser;
1124 *data = parser_data;
1131 gtk_label_buildable_custom_finished (GtkBuildable *buildable,
1132 GtkBuilder *builder,
1134 const gchar *tagname,
1137 PangoParserData *data;
1139 buildable_parent_iface->custom_finished (buildable, builder, child,
1140 tagname, user_data);
1142 if (strcmp (tagname, "attributes") == 0)
1144 data = (PangoParserData*)user_data;
1148 gtk_label_set_attributes (GTK_LABEL (buildable), data->attrs);
1149 pango_attr_list_unref (data->attrs);
1152 g_object_unref (data->object);
1153 g_object_unref (data->builder);
1154 g_slice_free (PangoParserData, data);
1161 * @str: The text of the label
1163 * Creates a new label with the given text inside it. You can
1164 * pass %NULL to get an empty label widget.
1166 * Return value: the new #GtkLabel
1169 gtk_label_new (const gchar *str)
1173 label = g_object_new (GTK_TYPE_LABEL, NULL);
1176 gtk_label_set_text (label, str);
1178 return GTK_WIDGET (label);
1182 * gtk_label_new_with_mnemonic:
1183 * @str: The text of the label, with an underscore in front of the
1184 * mnemonic character
1186 * Creates a new #GtkLabel, containing the text in @str.
1188 * If characters in @str are preceded by an underscore, they are
1189 * underlined. If you need a literal underscore character in a label, use
1190 * '__' (two underscores). The first underlined character represents a
1191 * keyboard accelerator called a mnemonic. The mnemonic key can be used
1192 * to activate another widget, chosen automatically, or explicitly using
1193 * gtk_label_set_mnemonic_widget().
1195 * If gtk_label_set_mnemonic_widget() is not called, then the first
1196 * activatable ancestor of the #GtkLabel will be chosen as the mnemonic
1197 * widget. For instance, if the label is inside a button or menu item,
1198 * the button or menu item will automatically become the mnemonic widget
1199 * and be activated by the mnemonic.
1201 * Return value: the new #GtkLabel
1204 gtk_label_new_with_mnemonic (const gchar *str)
1208 label = g_object_new (GTK_TYPE_LABEL, NULL);
1211 gtk_label_set_text_with_mnemonic (label, str);
1213 return GTK_WIDGET (label);
1217 gtk_label_mnemonic_activate (GtkWidget *widget,
1218 gboolean group_cycling)
1222 if (GTK_LABEL (widget)->mnemonic_widget)
1223 return gtk_widget_mnemonic_activate (GTK_LABEL (widget)->mnemonic_widget, group_cycling);
1225 /* Try to find the widget to activate by traversing the
1226 * widget's ancestry.
1228 parent = widget->parent;
1230 if (GTK_IS_NOTEBOOK (parent))
1235 if (GTK_WIDGET_CAN_FOCUS (parent) ||
1236 (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
1237 GTK_IS_NOTEBOOK (parent->parent) ||
1238 GTK_IS_MENU_ITEM (parent))
1239 return gtk_widget_mnemonic_activate (parent, group_cycling);
1240 parent = parent->parent;
1243 /* barf if there was nothing to activate */
1244 g_warning ("Couldn't find a target for a mnemonic activation.");
1245 gtk_widget_error_bell (widget);
1251 gtk_label_setup_mnemonic (GtkLabel *label,
1254 GtkWidget *widget = GTK_WIDGET (label);
1255 GtkWidget *toplevel;
1256 GtkWidget *mnemonic_menu;
1258 mnemonic_menu = g_object_get_data (G_OBJECT (label), "gtk-mnemonic-menu");
1260 if (last_key != GDK_VoidSymbol)
1262 if (label->mnemonic_window)
1264 gtk_window_remove_mnemonic (label->mnemonic_window,
1267 label->mnemonic_window = NULL;
1271 _gtk_menu_shell_remove_mnemonic (GTK_MENU_SHELL (mnemonic_menu),
1274 mnemonic_menu = NULL;
1278 if (label->mnemonic_keyval == GDK_VoidSymbol)
1281 toplevel = gtk_widget_get_toplevel (widget);
1282 if (GTK_WIDGET_TOPLEVEL (toplevel))
1284 GtkWidget *menu_shell;
1286 menu_shell = gtk_widget_get_ancestor (widget,
1287 GTK_TYPE_MENU_SHELL);
1291 _gtk_menu_shell_add_mnemonic (GTK_MENU_SHELL (menu_shell),
1292 label->mnemonic_keyval,
1294 mnemonic_menu = menu_shell;
1297 if (!GTK_IS_MENU (menu_shell))
1299 gtk_window_add_mnemonic (GTK_WINDOW (toplevel),
1300 label->mnemonic_keyval,
1302 label->mnemonic_window = GTK_WINDOW (toplevel);
1307 g_object_set_data (G_OBJECT (label), I_("gtk-mnemonic-menu"), mnemonic_menu);
1311 gtk_label_hierarchy_changed (GtkWidget *widget,
1312 GtkWidget *old_toplevel)
1314 GtkLabel *label = GTK_LABEL (widget);
1316 gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
1320 label_shortcut_setting_apply (GtkLabel *label)
1322 gtk_label_recalculate (label);
1323 if (GTK_IS_ACCEL_LABEL (label))
1324 gtk_accel_label_refetch (GTK_ACCEL_LABEL (label));
1328 label_shortcut_setting_traverse_container (GtkWidget *widget,
1331 if (GTK_IS_LABEL (widget))
1332 label_shortcut_setting_apply (GTK_LABEL (widget));
1333 else if (GTK_IS_CONTAINER (widget))
1334 gtk_container_forall (GTK_CONTAINER (widget),
1335 label_shortcut_setting_traverse_container, data);
1339 label_shortcut_setting_changed (GtkSettings *settings)
1343 list = gtk_window_list_toplevels ();
1345 for (l = list; l ; l = l->next)
1347 GtkWidget *widget = l->data;
1349 if (gtk_widget_get_settings (widget) == settings)
1350 gtk_container_forall (GTK_CONTAINER (widget),
1351 label_shortcut_setting_traverse_container, NULL);
1358 gtk_label_screen_changed (GtkWidget *widget,
1359 GdkScreen *old_screen)
1361 GtkSettings *settings;
1362 gboolean shortcuts_connected;
1364 if (!gtk_widget_has_screen (widget))
1367 settings = gtk_widget_get_settings (widget);
1369 shortcuts_connected =
1370 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
1371 "gtk-label-shortcuts-connected"));
1373 if (! shortcuts_connected)
1375 g_signal_connect (settings, "notify::gtk-enable-mnemonics",
1376 G_CALLBACK (label_shortcut_setting_changed),
1378 g_signal_connect (settings, "notify::gtk-enable-accels",
1379 G_CALLBACK (label_shortcut_setting_changed),
1382 g_object_set_data (G_OBJECT (settings), "gtk-label-shortcuts-connected",
1383 GINT_TO_POINTER (TRUE));
1386 label_shortcut_setting_apply (GTK_LABEL (widget));
1391 label_mnemonic_widget_weak_notify (gpointer data,
1392 GObject *where_the_object_was)
1394 GtkLabel *label = data;
1396 label->mnemonic_widget = NULL;
1397 g_object_notify (G_OBJECT (label), "mnemonic-widget");
1401 * gtk_label_set_mnemonic_widget:
1402 * @label: a #GtkLabel
1403 * @widget: the target #GtkWidget
1405 * If the label has been set so that it has an mnemonic key (using
1406 * i.e. gtk_label_set_markup_with_mnemonic(),
1407 * gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
1408 * or the "use_underline" property) the label can be associated with a
1409 * widget that is the target of the mnemonic. When the label is inside
1410 * a widget (like a #GtkButton or a #GtkNotebook tab) it is
1411 * automatically associated with the correct widget, but sometimes
1412 * (i.e. when the target is a #GtkEntry next to the label) you need to
1413 * set it explicitly using this function.
1415 * The target widget will be accelerated by emitting the
1416 * GtkWidget::mnemonic-activate signal on it. The default handler for
1417 * this signal will activate the widget if there are no mnemonic collisions
1418 * and toggle focus between the colliding widgets otherwise.
1421 gtk_label_set_mnemonic_widget (GtkLabel *label,
1424 g_return_if_fail (GTK_IS_LABEL (label));
1426 g_return_if_fail (GTK_IS_WIDGET (widget));
1428 if (label->mnemonic_widget)
1430 gtk_widget_remove_mnemonic_label (label->mnemonic_widget, GTK_WIDGET (label));
1431 g_object_weak_unref (G_OBJECT (label->mnemonic_widget),
1432 label_mnemonic_widget_weak_notify,
1435 label->mnemonic_widget = widget;
1436 if (label->mnemonic_widget)
1438 g_object_weak_ref (G_OBJECT (label->mnemonic_widget),
1439 label_mnemonic_widget_weak_notify,
1441 gtk_widget_add_mnemonic_label (label->mnemonic_widget, GTK_WIDGET (label));
1444 g_object_notify (G_OBJECT (label), "mnemonic-widget");
1448 * gtk_label_get_mnemonic_widget:
1449 * @label: a #GtkLabel
1451 * Retrieves the target of the mnemonic (keyboard shortcut) of this
1452 * label. See gtk_label_set_mnemonic_widget().
1454 * Return value: the target of the label's mnemonic, or %NULL if none
1455 * has been set and the default algorithm will be used.
1458 gtk_label_get_mnemonic_widget (GtkLabel *label)
1460 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1462 return label->mnemonic_widget;
1466 * gtk_label_get_mnemonic_keyval:
1467 * @label: a #GtkLabel
1469 * If the label has been set so that it has an mnemonic key this function
1470 * returns the keyval used for the mnemonic accelerator. If there is no
1471 * mnemonic set up it returns #GDK_VoidSymbol.
1473 * Returns: GDK keyval usable for accelerators, or #GDK_VoidSymbol
1476 gtk_label_get_mnemonic_keyval (GtkLabel *label)
1478 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);
1480 return label->mnemonic_keyval;
1484 gtk_label_set_text_internal (GtkLabel *label,
1487 g_free (label->text);
1491 gtk_label_select_region_index (label, 0, 0);
1495 gtk_label_set_label_internal (GtkLabel *label,
1498 g_free (label->label);
1502 g_object_notify (G_OBJECT (label), "label");
1506 gtk_label_set_use_markup_internal (GtkLabel *label,
1510 if (label->use_markup != val)
1512 label->use_markup = val;
1514 g_object_notify (G_OBJECT (label), "use-markup");
1519 gtk_label_set_use_underline_internal (GtkLabel *label,
1523 if (label->use_underline != val)
1525 label->use_underline = val;
1527 g_object_notify (G_OBJECT (label), "use-underline");
1532 gtk_label_set_attributes_internal (GtkLabel *label,
1533 PangoAttrList *attrs)
1536 pango_attr_list_ref (attrs);
1539 pango_attr_list_unref (label->attrs);
1541 if (!label->use_markup && !label->use_underline)
1544 pango_attr_list_ref (attrs);
1545 if (label->effective_attrs)
1546 pango_attr_list_unref (label->effective_attrs);
1547 label->effective_attrs = attrs;
1550 label->attrs = attrs;
1551 g_object_notify (G_OBJECT (label), "attributes");
1555 /* Calculates text, attrs and mnemonic_keyval from
1556 * label, use_underline and use_markup
1559 gtk_label_recalculate (GtkLabel *label)
1561 if (label->use_markup)
1562 set_markup (label, label->label, label->use_underline);
1565 if (label->use_underline)
1566 gtk_label_set_uline_text_internal (label, label->label);
1569 gtk_label_set_text_internal (label, g_strdup (label->label));
1571 pango_attr_list_ref (label->attrs);
1572 if (label->effective_attrs)
1573 pango_attr_list_unref (label->effective_attrs);
1574 label->effective_attrs = label->attrs;
1578 if (!label->use_underline)
1580 guint keyval = label->mnemonic_keyval;
1582 label->mnemonic_keyval = GDK_VoidSymbol;
1583 gtk_label_setup_mnemonic (label, keyval);
1586 gtk_label_clear_layout (label);
1587 gtk_widget_queue_resize (GTK_WIDGET (label));
1591 * gtk_label_set_text:
1592 * @label: a #GtkLabel
1593 * @str: The text you want to set
1595 * Sets the text within the #GtkLabel widget. It overwrites any text that
1598 * This will also clear any previously set mnemonic accelerators.
1601 gtk_label_set_text (GtkLabel *label,
1604 g_return_if_fail (GTK_IS_LABEL (label));
1606 g_object_freeze_notify (G_OBJECT (label));
1608 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1609 gtk_label_set_use_markup_internal (label, FALSE);
1610 gtk_label_set_use_underline_internal (label, FALSE);
1612 gtk_label_recalculate (label);
1614 g_object_thaw_notify (G_OBJECT (label));
1618 * gtk_label_set_attributes:
1619 * @label: a #GtkLabel
1620 * @attrs: a #PangoAttrList
1622 * Sets a #PangoAttrList; the attributes in the list are applied to the
1623 * label text. The attributes set with this function will be ignored
1624 * if the #GtkLabel:use-underline" or #GtkLabel:use-markup properties
1628 gtk_label_set_attributes (GtkLabel *label,
1629 PangoAttrList *attrs)
1631 g_return_if_fail (GTK_IS_LABEL (label));
1633 gtk_label_set_attributes_internal (label, attrs);
1635 gtk_label_clear_layout (label);
1636 gtk_widget_queue_resize (GTK_WIDGET (label));
1640 * gtk_label_get_attributes:
1641 * @label: a #GtkLabel
1643 * Gets the attribute list that was set on the label using
1644 * gtk_label_set_attributes(), if any. This function does
1645 * not reflect attributes that come from the labels markup
1646 * (see gtk_label_set_markup()). If you want to get the
1647 * effective attributes for the label, use
1648 * pango_layout_get_attribute (gtk_label_get_layout (label)).
1650 * Return value: the attribute list, or %NULL if none was set.
1653 gtk_label_get_attributes (GtkLabel *label)
1655 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1657 return label->attrs;
1661 * gtk_label_set_label:
1662 * @label: a #GtkLabel
1663 * @str: the new text to set for the label
1665 * Sets the text of the label. The label is interpreted as
1666 * including embedded underlines and/or Pango markup depending
1667 * on the values of the #GtkLabel:use-underline" and
1668 * #GtkLabel:use-markup properties.
1671 gtk_label_set_label (GtkLabel *label,
1676 g_return_if_fail (GTK_IS_LABEL (label));
1677 g_return_if_fail (str != NULL);
1679 g_object_freeze_notify (G_OBJECT (label));
1681 last_keyval = label->mnemonic_keyval;
1683 gtk_label_set_label_internal (label, g_strdup (str));
1684 gtk_label_recalculate (label);
1685 if (last_keyval != label->mnemonic_keyval)
1686 gtk_label_setup_mnemonic (label, last_keyval);
1688 g_object_thaw_notify (G_OBJECT (label));
1692 * gtk_label_get_label:
1693 * @label: a #GtkLabel
1695 * Fetches the text from a label widget including any embedded
1696 * underlines indicating mnemonics and Pango markup. (See
1697 * gtk_label_get_text()).
1699 * Return value: the text of the label widget. This string is
1700 * owned by the widget and must not be modified or freed.
1702 G_CONST_RETURN gchar *
1703 gtk_label_get_label (GtkLabel *label)
1705 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1707 return label->label;
1711 set_markup (GtkLabel *label,
1713 gboolean with_uline)
1716 GError *error = NULL;
1717 PangoAttrList *attrs = NULL;
1718 gunichar accel_char = 0;
1720 if (!pango_parse_markup (str,
1722 with_uline ? '_' : 0,
1725 with_uline ? &accel_char : NULL,
1728 g_warning ("Failed to set text from markup due to error parsing markup: %s",
1730 g_error_free (error);
1735 gtk_label_set_text_internal (label, text);
1739 if (label->effective_attrs)
1740 pango_attr_list_unref (label->effective_attrs);
1741 label->effective_attrs = attrs;
1744 if (accel_char != 0)
1745 label->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
1747 label->mnemonic_keyval = GDK_VoidSymbol;
1751 * gtk_label_set_markup:
1752 * @label: a #GtkLabel
1753 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
1755 * Parses @str which is marked up with the <link
1756 * linkend="PangoMarkupFormat">Pango text markup language</link>, setting the
1757 * label's text and attribute list based on the parse results. If the @str is
1758 * external data, you may need to escape it with g_markup_escape_text() or
1759 * g_markup_printf_escaped()<!-- -->:
1763 * markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str);
1764 * gtk_label_set_markup (GTK_LABEL (label), markup);
1769 gtk_label_set_markup (GtkLabel *label,
1772 g_return_if_fail (GTK_IS_LABEL (label));
1774 g_object_freeze_notify (G_OBJECT (label));
1776 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1777 gtk_label_set_use_markup_internal (label, TRUE);
1778 gtk_label_set_use_underline_internal (label, FALSE);
1780 gtk_label_recalculate (label);
1782 g_object_thaw_notify (G_OBJECT (label));
1786 * gtk_label_set_markup_with_mnemonic:
1787 * @label: a #GtkLabel
1788 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
1790 * Parses @str which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>,
1791 * setting the label's text and attribute list based on the parse results.
1792 * If characters in @str are preceded by an underscore, they are underlined
1793 * indicating that they represent a keyboard accelerator called a mnemonic.
1795 * The mnemonic key can be used to activate another widget, chosen
1796 * automatically, or explicitly using gtk_label_set_mnemonic_widget().
1799 gtk_label_set_markup_with_mnemonic (GtkLabel *label,
1803 g_return_if_fail (GTK_IS_LABEL (label));
1805 g_object_freeze_notify (G_OBJECT (label));
1807 last_keyval = label->mnemonic_keyval;
1808 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1809 gtk_label_set_use_markup_internal (label, TRUE);
1810 gtk_label_set_use_underline_internal (label, TRUE);
1812 gtk_label_recalculate (label);
1813 gtk_label_setup_mnemonic (label, last_keyval);
1815 g_object_thaw_notify (G_OBJECT (label));
1819 * gtk_label_get_text:
1820 * @label: a #GtkLabel
1822 * Fetches the text from a label widget, as displayed on the
1823 * screen. This does not include any embedded underlines
1824 * indicating mnemonics or Pango markup. (See gtk_label_get_label())
1826 * Return value: the text in the label widget. This is the internal
1827 * string used by the label, and must not be modified.
1829 G_CONST_RETURN gchar *
1830 gtk_label_get_text (GtkLabel *label)
1832 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1837 static PangoAttrList *
1838 gtk_label_pattern_to_attrs (GtkLabel *label,
1839 const gchar *pattern)
1842 const char *p = label->text;
1843 const char *q = pattern;
1844 PangoAttrList *attrs;
1846 attrs = pango_attr_list_new ();
1850 while (*p && *q && *q != '_')
1852 p = g_utf8_next_char (p);
1856 while (*p && *q && *q == '_')
1858 p = g_utf8_next_char (p);
1864 PangoAttribute *attr = pango_attr_underline_new (PANGO_UNDERLINE_LOW);
1865 attr->start_index = start - label->text;
1866 attr->end_index = p - label->text;
1868 pango_attr_list_insert (attrs, attr);
1878 gtk_label_set_pattern_internal (GtkLabel *label,
1879 const gchar *pattern)
1881 PangoAttrList *attrs;
1882 gboolean enable_mnemonics;
1884 g_return_if_fail (GTK_IS_LABEL (label));
1886 if (label->pattern_set)
1889 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
1890 "gtk-enable-mnemonics", &enable_mnemonics,
1893 if (enable_mnemonics && pattern)
1894 attrs = gtk_label_pattern_to_attrs (label, pattern);
1898 if (label->effective_attrs)
1899 pango_attr_list_unref (label->effective_attrs);
1900 label->effective_attrs = attrs;
1904 gtk_label_set_pattern (GtkLabel *label,
1905 const gchar *pattern)
1907 g_return_if_fail (GTK_IS_LABEL (label));
1909 label->pattern_set = FALSE;
1913 gtk_label_set_pattern_internal (label, pattern);
1914 label->pattern_set = TRUE;
1917 gtk_label_recalculate (label);
1919 gtk_label_clear_layout (label);
1920 gtk_widget_queue_resize (GTK_WIDGET (label));
1925 * gtk_label_set_justify:
1926 * @label: a #GtkLabel
1927 * @jtype: a #GtkJustification
1929 * Sets the alignment of the lines in the text of the label relative to
1930 * each other. %GTK_JUSTIFY_LEFT is the default value when the
1931 * widget is first created with gtk_label_new(). If you instead want
1932 * to set the alignment of the label as a whole, use
1933 * gtk_misc_set_alignment() instead. gtk_label_set_justify() has no
1934 * effect on labels containing only a single line.
1937 gtk_label_set_justify (GtkLabel *label,
1938 GtkJustification jtype)
1940 g_return_if_fail (GTK_IS_LABEL (label));
1941 g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
1943 if ((GtkJustification) label->jtype != jtype)
1945 label->jtype = jtype;
1947 /* No real need to be this drastic, but easier than duplicating the code */
1948 gtk_label_clear_layout (label);
1950 g_object_notify (G_OBJECT (label), "justify");
1951 gtk_widget_queue_resize (GTK_WIDGET (label));
1956 * gtk_label_get_justify:
1957 * @label: a #GtkLabel
1959 * Returns the justification of the label. See gtk_label_set_justify().
1961 * Return value: #GtkJustification
1964 gtk_label_get_justify (GtkLabel *label)
1966 g_return_val_if_fail (GTK_IS_LABEL (label), 0);
1968 return label->jtype;
1972 * gtk_label_set_ellipsize:
1973 * @label: a #GtkLabel
1974 * @mode: a #PangoEllipsizeMode
1976 * Sets the mode used to ellipsize (add an ellipsis: "...") to the text
1977 * if there is not enough space to render the entire string.
1982 gtk_label_set_ellipsize (GtkLabel *label,
1983 PangoEllipsizeMode mode)
1985 g_return_if_fail (GTK_IS_LABEL (label));
1986 g_return_if_fail (mode >= PANGO_ELLIPSIZE_NONE && mode <= PANGO_ELLIPSIZE_END);
1988 if ((PangoEllipsizeMode) label->ellipsize != mode)
1990 label->ellipsize = mode;
1992 /* No real need to be this drastic, but easier than duplicating the code */
1993 gtk_label_clear_layout (label);
1995 g_object_notify (G_OBJECT (label), "ellipsize");
1996 gtk_widget_queue_resize (GTK_WIDGET (label));
2001 * gtk_label_get_ellipsize:
2002 * @label: a #GtkLabel
2004 * Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
2006 * Return value: #PangoEllipsizeMode
2011 gtk_label_get_ellipsize (GtkLabel *label)
2013 g_return_val_if_fail (GTK_IS_LABEL (label), PANGO_ELLIPSIZE_NONE);
2015 return label->ellipsize;
2019 * gtk_label_set_width_chars:
2020 * @label: a #GtkLabel
2021 * @n_chars: the new desired width, in characters.
2023 * Sets the desired width in characters of @label to @n_chars.
2028 gtk_label_set_width_chars (GtkLabel *label,
2031 GtkLabelPrivate *priv;
2033 g_return_if_fail (GTK_IS_LABEL (label));
2035 priv = GTK_LABEL_GET_PRIVATE (label);
2037 if (priv->width_chars != n_chars)
2039 priv->width_chars = n_chars;
2040 g_object_notify (G_OBJECT (label), "width-chars");
2041 gtk_label_invalidate_wrap_width (label);
2042 gtk_widget_queue_resize (GTK_WIDGET (label));
2047 * gtk_label_get_width_chars:
2048 * @label: a #GtkLabel
2050 * Retrieves the desired width of @label, in characters. See
2051 * gtk_label_set_width_chars().
2053 * Return value: the width of the label in characters.
2058 gtk_label_get_width_chars (GtkLabel *label)
2060 g_return_val_if_fail (GTK_IS_LABEL (label), -1);
2062 return GTK_LABEL_GET_PRIVATE (label)->width_chars;
2066 * gtk_label_set_max_width_chars:
2067 * @label: a #GtkLabel
2068 * @n_chars: the new desired maximum width, in characters.
2070 * Sets the desired maximum width in characters of @label to @n_chars.
2075 gtk_label_set_max_width_chars (GtkLabel *label,
2078 GtkLabelPrivate *priv;
2080 g_return_if_fail (GTK_IS_LABEL (label));
2082 priv = GTK_LABEL_GET_PRIVATE (label);
2084 if (priv->max_width_chars != n_chars)
2086 priv->max_width_chars = n_chars;
2088 g_object_notify (G_OBJECT (label), "max-width-chars");
2089 gtk_label_invalidate_wrap_width (label);
2090 gtk_widget_queue_resize (GTK_WIDGET (label));
2095 * gtk_label_get_max_width_chars:
2096 * @label: a #GtkLabel
2098 * Retrieves the desired maximum width of @label, in characters. See
2099 * gtk_label_set_width_chars().
2101 * Return value: the maximum width of the label in characters.
2106 gtk_label_get_max_width_chars (GtkLabel *label)
2108 g_return_val_if_fail (GTK_IS_LABEL (label), -1);
2110 return GTK_LABEL_GET_PRIVATE (label)->max_width_chars;
2114 * gtk_label_set_line_wrap:
2115 * @label: a #GtkLabel
2116 * @wrap: the setting
2118 * Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
2119 * lines if text exceeds the widget's size. %FALSE lets the text get cut off
2120 * by the edge of the widget if it exceeds the widget size.
2122 * Note that setting line wrapping to %TRUE does not make the label
2123 * wrap at its parent container's width, because GTK+ widgets
2124 * conceptually can't make their requisition depend on the parent
2125 * container's size. For a label that wraps at a specific position,
2126 * set the label's width using gtk_widget_set_size_request().
2129 gtk_label_set_line_wrap (GtkLabel *label,
2132 g_return_if_fail (GTK_IS_LABEL (label));
2134 wrap = wrap != FALSE;
2136 if (label->wrap != wrap)
2140 gtk_label_clear_layout (label);
2141 gtk_widget_queue_resize (GTK_WIDGET (label));
2142 g_object_notify (G_OBJECT (label), "wrap");
2147 * gtk_label_get_line_wrap:
2148 * @label: a #GtkLabel
2150 * Returns whether lines in the label are automatically wrapped.
2151 * See gtk_label_set_line_wrap().
2153 * Return value: %TRUE if the lines of the label are automatically wrapped.
2156 gtk_label_get_line_wrap (GtkLabel *label)
2158 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
2164 * gtk_label_set_line_wrap_mode:
2165 * @label: a #GtkLabel
2166 * @wrap_mode: the line wrapping mode
2168 * If line wrapping is on (see gtk_label_set_line_wrap()) this controls how
2169 * the line wrapping is done. The default is %PANGO_WRAP_WORD which means
2170 * wrap on word boundaries.
2175 gtk_label_set_line_wrap_mode (GtkLabel *label,
2176 PangoWrapMode wrap_mode)
2178 g_return_if_fail (GTK_IS_LABEL (label));
2180 if (label->wrap_mode != wrap_mode)
2182 label->wrap_mode = wrap_mode;
2183 g_object_notify (G_OBJECT (label), "wrap-mode");
2185 gtk_widget_queue_resize (GTK_WIDGET (label));
2190 * gtk_label_get_line_wrap_mode:
2191 * @label: a #GtkLabel
2193 * Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode().
2195 * Return value: %TRUE if the lines of the label are automatically wrapped.
2200 gtk_label_get_line_wrap_mode (GtkLabel *label)
2202 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
2204 return label->wrap_mode;
2209 gtk_label_get (GtkLabel *label,
2212 g_return_if_fail (GTK_IS_LABEL (label));
2213 g_return_if_fail (str != NULL);
2219 gtk_label_destroy (GtkObject *object)
2221 GtkLabel *label = GTK_LABEL (object);
2223 gtk_label_set_mnemonic_widget (label, NULL);
2225 GTK_OBJECT_CLASS (gtk_label_parent_class)->destroy (object);
2229 gtk_label_finalize (GObject *object)
2231 GtkLabel *label = GTK_LABEL (object);
2233 g_free (label->label);
2234 g_free (label->text);
2237 g_object_unref (label->layout);
2240 pango_attr_list_unref (label->attrs);
2242 if (label->effective_attrs)
2243 pango_attr_list_unref (label->effective_attrs);
2245 g_free (label->select_info);
2247 G_OBJECT_CLASS (gtk_label_parent_class)->finalize (object);
2251 gtk_label_clear_layout (GtkLabel *label)
2255 g_object_unref (label->layout);
2256 label->layout = NULL;
2261 get_label_char_width (GtkLabel *label)
2263 GtkLabelPrivate *priv;
2264 PangoContext *context;
2265 PangoFontMetrics *metrics;
2266 gint char_width, digit_width, char_pixels, w;
2268 priv = GTK_LABEL_GET_PRIVATE (label);
2270 context = pango_layout_get_context (label->layout);
2271 metrics = pango_context_get_metrics (context, GTK_WIDGET (label)->style->font_desc,
2272 pango_context_get_language (context));
2274 char_width = pango_font_metrics_get_approximate_char_width (metrics);
2275 digit_width = pango_font_metrics_get_approximate_digit_width (metrics);
2276 char_pixels = MAX (char_width, digit_width);
2277 pango_font_metrics_unref (metrics);
2279 if (priv->width_chars < 0)
2281 PangoRectangle rect;
2283 pango_layout_set_width (label->layout, -1);
2284 pango_layout_get_extents (label->layout, NULL, &rect);
2286 w = char_pixels * MAX (priv->max_width_chars, 3);
2287 w = MIN (rect.width, w);
2291 /* enforce minimum width for ellipsized labels at ~3 chars */
2292 w = char_pixels * MAX (priv->width_chars, 3);
2299 gtk_label_invalidate_wrap_width (GtkLabel *label)
2301 GtkLabelPrivate *priv;
2303 priv = GTK_LABEL_GET_PRIVATE (label);
2305 priv->wrap_width = -1;
2309 get_label_wrap_width (GtkLabel *label)
2311 GtkLabelPrivate *priv;
2313 priv = GTK_LABEL_GET_PRIVATE (label);
2315 if (priv->wrap_width < 0)
2317 if (priv->width_chars > 0 || priv->max_width_chars > 0)
2318 priv->wrap_width = get_label_char_width (label);
2321 PangoLayout *layout;
2323 layout = gtk_widget_create_pango_layout (GTK_WIDGET (label),
2324 "This long string gives a good enough length for any line to have.");
2325 pango_layout_get_size (layout, &priv->wrap_width, NULL);
2326 g_object_unref (layout);
2330 return priv->wrap_width;
2334 gtk_label_ensure_layout (GtkLabel *label)
2337 PangoRectangle logical_rect;
2340 widget = GTK_WIDGET (label);
2342 rtl = gtk_widget_get_direction(widget) == GTK_TEXT_DIR_RTL;
2346 PangoAlignment align = PANGO_ALIGN_LEFT; /* Quiet gcc */
2347 gdouble angle = gtk_label_get_angle (label);
2349 if (angle != 0.0 && !label->wrap && !label->ellipsize && !label->select_info)
2351 /* We rotate the standard singleton PangoContext for the widget,
2352 * depending on the fact that it's meant pretty much exclusively
2355 PangoMatrix matrix = PANGO_MATRIX_INIT;
2357 pango_matrix_rotate (&matrix, angle);
2359 pango_context_set_matrix (gtk_widget_get_pango_context (widget), &matrix);
2361 label->have_transform = TRUE;
2365 if (label->have_transform)
2366 pango_context_set_matrix (gtk_widget_get_pango_context (widget), NULL);
2368 label->have_transform = FALSE;
2371 label->layout = gtk_widget_create_pango_layout (widget, label->text);
2373 if (label->effective_attrs)
2374 pango_layout_set_attributes (label->layout, label->effective_attrs);
2376 switch (label->jtype)
2378 case GTK_JUSTIFY_LEFT:
2379 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
2381 case GTK_JUSTIFY_RIGHT:
2382 align = rtl ? PANGO_ALIGN_LEFT : PANGO_ALIGN_RIGHT;
2384 case GTK_JUSTIFY_CENTER:
2385 align = PANGO_ALIGN_CENTER;
2387 case GTK_JUSTIFY_FILL:
2388 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
2389 pango_layout_set_justify (label->layout, TRUE);
2392 g_assert_not_reached();
2395 pango_layout_set_alignment (label->layout, align);
2396 pango_layout_set_ellipsize (label->layout, label->ellipsize);
2397 pango_layout_set_single_paragraph_mode (label->layout, label->single_line_mode);
2399 if (label->ellipsize)
2400 pango_layout_set_width (label->layout,
2401 widget->allocation.width * PANGO_SCALE);
2402 else if (label->wrap)
2404 GtkWidgetAuxInfo *aux_info;
2405 gint longest_paragraph;
2408 pango_layout_set_wrap (label->layout, label->wrap_mode);
2410 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
2411 if (aux_info && aux_info->width > 0)
2412 pango_layout_set_width (label->layout, aux_info->width * PANGO_SCALE);
2415 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (label));
2418 pango_layout_set_width (label->layout, -1);
2419 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2421 width = logical_rect.width;
2423 /* Try to guess a reasonable maximum width */
2424 longest_paragraph = width;
2426 wrap_width = get_label_wrap_width (label);
2427 width = MIN (width, wrap_width);
2429 PANGO_SCALE * (gdk_screen_get_width (screen) + 1) / 2);
2431 pango_layout_set_width (label->layout, width);
2432 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2433 width = logical_rect.width;
2434 height = logical_rect.height;
2436 /* Unfortunately, the above may leave us with a very unbalanced looking paragraph,
2437 * so we try short search for a narrower width that leaves us with the same height
2439 if (longest_paragraph > 0)
2441 gint nlines, perfect_width;
2443 nlines = pango_layout_get_line_count (label->layout);
2444 perfect_width = (longest_paragraph + nlines - 1) / nlines;
2446 if (perfect_width < width)
2448 pango_layout_set_width (label->layout, perfect_width);
2449 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2451 if (logical_rect.height <= height)
2452 width = logical_rect.width;
2455 gint mid_width = (perfect_width + width) / 2;
2457 if (mid_width > perfect_width)
2459 pango_layout_set_width (label->layout, mid_width);
2460 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2462 if (logical_rect.height <= height)
2463 width = logical_rect.width;
2468 pango_layout_set_width (label->layout, width);
2471 else /* !label->wrap */
2472 pango_layout_set_width (label->layout, -1);
2477 gtk_label_size_request (GtkWidget *widget,
2478 GtkRequisition *requisition)
2480 GtkLabel *label = GTK_LABEL (widget);
2481 GtkLabelPrivate *priv;
2483 PangoRectangle logical_rect;
2484 GtkWidgetAuxInfo *aux_info;
2486 priv = GTK_LABEL_GET_PRIVATE (widget);
2489 * If word wrapping is on, then the height requisition can depend
2492 * - Any width set on the widget via gtk_widget_set_size_request().
2493 * - The padding of the widget (xpad, set by gtk_misc_set_padding)
2495 * Instead of trying to detect changes to these quantities, if we
2496 * are wrapping, we just rewrap for each size request. Since
2497 * size requisitions are cached by the GTK+ core, this is not
2502 gtk_label_clear_layout (label);
2504 gtk_label_ensure_layout (label);
2506 width = label->misc.xpad * 2;
2507 height = label->misc.ypad * 2;
2509 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
2511 if (label->have_transform)
2513 PangoRectangle rect;
2514 PangoContext *context = pango_layout_get_context (label->layout);
2515 const PangoMatrix *matrix = pango_context_get_matrix (context);
2517 pango_layout_get_extents (label->layout, NULL, &rect);
2518 pango_matrix_transform_rectangle (matrix, &rect);
2519 pango_extents_to_pixels (&rect, NULL);
2521 requisition->width = width + rect.width;
2522 requisition->height = height + rect.height;
2527 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2529 if ((label->wrap || label->ellipsize ||
2530 priv->width_chars > 0 || priv->max_width_chars > 0) &&
2531 aux_info && aux_info->width > 0)
2532 width += aux_info->width;
2533 else if (label->ellipsize || priv->width_chars > 0 || priv->max_width_chars > 0)
2535 width += PANGO_PIXELS (get_label_char_width (label));
2538 width += PANGO_PIXELS (logical_rect.width);
2540 if (label->single_line_mode)
2542 PangoContext *context;
2543 PangoFontMetrics *metrics;
2544 gint ascent, descent;
2546 context = pango_layout_get_context (label->layout);
2547 metrics = pango_context_get_metrics (context, widget->style->font_desc,
2548 pango_context_get_language (context));
2550 ascent = pango_font_metrics_get_ascent (metrics);
2551 descent = pango_font_metrics_get_descent (metrics);
2552 pango_font_metrics_unref (metrics);
2554 height += PANGO_PIXELS (ascent + descent);
2557 height += PANGO_PIXELS (logical_rect.height);
2559 requisition->width = width;
2560 requisition->height = height;
2564 gtk_label_size_allocate (GtkWidget *widget,
2565 GtkAllocation *allocation)
2569 label = GTK_LABEL (widget);
2571 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->size_allocate) (widget, allocation);
2573 if (label->ellipsize)
2578 PangoRectangle logical;
2580 width = (allocation->width - label->misc.xpad * 2) * PANGO_SCALE;
2582 pango_layout_set_width (label->layout, -1);
2583 pango_layout_get_extents (label->layout, NULL, &logical);
2585 if (logical.width > width)
2586 pango_layout_set_width (label->layout, width);
2590 if (label->select_info && label->select_info->window)
2592 gdk_window_move_resize (label->select_info->window,
2596 allocation->height);
2601 gtk_label_state_changed (GtkWidget *widget,
2602 GtkStateType prev_state)
2607 label = GTK_LABEL (widget);
2609 if (label->select_info)
2611 gtk_label_select_region (label, 0, 0);
2613 if (GTK_WIDGET_REALIZED (widget))
2615 if (GTK_WIDGET_IS_SENSITIVE (widget))
2616 cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget), GDK_XTERM);
2620 gdk_window_set_cursor (label->select_info->window, cursor);
2623 gdk_cursor_unref (cursor);
2627 if (GTK_WIDGET_CLASS (gtk_label_parent_class)->state_changed)
2628 GTK_WIDGET_CLASS (gtk_label_parent_class)->state_changed (widget, prev_state);
2632 gtk_label_style_set (GtkWidget *widget,
2633 GtkStyle *previous_style)
2635 GtkLabel *label = GTK_LABEL (widget);
2637 /* We have to clear the layout, fonts etc. may have changed */
2638 gtk_label_clear_layout (label);
2639 gtk_label_invalidate_wrap_width (label);
2643 gtk_label_direction_changed (GtkWidget *widget,
2644 GtkTextDirection previous_dir)
2646 GtkLabel *label = GTK_LABEL (widget);
2649 pango_layout_context_changed (label->layout);
2651 GTK_WIDGET_CLASS (gtk_label_parent_class)->direction_changed (widget, previous_dir);
2655 get_layout_location (GtkLabel *label,
2661 GtkLabelPrivate *priv;
2663 gint req_width, x, y;
2664 PangoRectangle logical;
2666 misc = GTK_MISC (label);
2667 widget = GTK_WIDGET (label);
2668 priv = GTK_LABEL_GET_PRIVATE (label);
2670 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
2671 xalign = misc->xalign;
2673 xalign = 1.0 - misc->xalign;
2675 pango_layout_get_pixel_extents (label->layout, NULL, &logical);
2677 if (label->ellipsize || priv->width_chars > 0)
2681 width = pango_layout_get_width (label->layout);
2683 req_width = logical.width;
2685 req_width = MIN(PANGO_PIXELS (width), req_width);
2686 req_width += 2 * misc->xpad;
2689 req_width = widget->requisition.width;
2691 x = floor (widget->allocation.x + (gint)misc->xpad +
2692 xalign * (widget->allocation.width - req_width));
2694 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
2695 x = MAX (x, widget->allocation.x + misc->xpad);
2697 x = MIN (x, widget->allocation.x + widget->allocation.width - misc->xpad);
2700 y = floor (widget->allocation.y + (gint)misc->ypad
2701 + MAX (((widget->allocation.height - widget->requisition.height) * misc->yalign),
2712 draw_insertion_cursor (GtkLabel *label,
2713 GdkRectangle *cursor_location,
2714 gboolean is_primary,
2715 PangoDirection direction,
2716 gboolean draw_arrow)
2718 GtkWidget *widget = GTK_WIDGET (label);
2719 GtkTextDirection text_dir;
2721 if (direction == PANGO_DIRECTION_LTR)
2722 text_dir = GTK_TEXT_DIR_LTR;
2724 text_dir = GTK_TEXT_DIR_RTL;
2726 gtk_draw_insertion_cursor (widget, widget->window, &(widget->allocation),
2728 is_primary, text_dir, draw_arrow);
2731 static PangoDirection
2732 get_cursor_direction (GtkLabel *label)
2736 g_assert (label->select_info);
2738 gtk_label_ensure_layout (label);
2740 for (l = pango_layout_get_lines_readonly (label->layout); l; l = l->next)
2742 PangoLayoutLine *line = l->data;
2744 /* If label->select_info->selection_end is at the very end of
2745 * the line, we don't know if the cursor is on this line or
2746 * the next without looking ahead at the next line. (End
2747 * of paragraph is different from line break.) But it's
2748 * definitely in this paragraph, which is good enough
2749 * to figure out the resolved direction.
2751 if (line->start_index + line->length >= label->select_info->selection_end)
2752 return line->resolved_dir;
2755 return PANGO_DIRECTION_LTR;
2759 gtk_label_draw_cursor (GtkLabel *label, gint xoffset, gint yoffset)
2761 if (label->select_info == NULL)
2764 if (GTK_WIDGET_DRAWABLE (label))
2766 GtkWidget *widget = GTK_WIDGET (label);
2768 PangoDirection keymap_direction;
2769 PangoDirection cursor_direction;
2770 PangoRectangle strong_pos, weak_pos;
2771 gboolean split_cursor;
2772 PangoRectangle *cursor1 = NULL;
2773 PangoRectangle *cursor2 = NULL;
2774 GdkRectangle cursor_location;
2775 PangoDirection dir1 = PANGO_DIRECTION_NEUTRAL;
2776 PangoDirection dir2 = PANGO_DIRECTION_NEUTRAL;
2778 keymap_direction = gdk_keymap_get_direction (gdk_keymap_get_for_display (gtk_widget_get_display (widget)));
2779 cursor_direction = get_cursor_direction (label);
2781 gtk_label_ensure_layout (label);
2783 pango_layout_get_cursor_pos (label->layout, label->select_info->selection_end,
2784 &strong_pos, &weak_pos);
2786 g_object_get (gtk_widget_get_settings (widget),
2787 "gtk-split-cursor", &split_cursor,
2790 dir1 = cursor_direction;
2794 cursor1 = &strong_pos;
2796 if (strong_pos.x != weak_pos.x ||
2797 strong_pos.y != weak_pos.y)
2799 dir2 = (cursor_direction == PANGO_DIRECTION_LTR) ? PANGO_DIRECTION_RTL : PANGO_DIRECTION_LTR;
2800 cursor2 = &weak_pos;
2805 if (keymap_direction == cursor_direction)
2806 cursor1 = &strong_pos;
2808 cursor1 = &weak_pos;
2811 cursor_location.x = xoffset + PANGO_PIXELS (cursor1->x);
2812 cursor_location.y = yoffset + PANGO_PIXELS (cursor1->y);
2813 cursor_location.width = 0;
2814 cursor_location.height = PANGO_PIXELS (cursor1->height);
2816 draw_insertion_cursor (label,
2817 &cursor_location, TRUE, dir1,
2818 dir2 != PANGO_DIRECTION_NEUTRAL);
2820 if (dir2 != PANGO_DIRECTION_NEUTRAL)
2822 cursor_location.x = xoffset + PANGO_PIXELS (cursor2->x);
2823 cursor_location.y = yoffset + PANGO_PIXELS (cursor2->y);
2824 cursor_location.width = 0;
2825 cursor_location.height = PANGO_PIXELS (cursor2->height);
2827 draw_insertion_cursor (label,
2828 &cursor_location, FALSE, dir2,
2836 gtk_label_expose (GtkWidget *widget,
2837 GdkEventExpose *event)
2842 g_return_val_if_fail (GTK_IS_LABEL (widget), FALSE);
2843 g_return_val_if_fail (event != NULL, FALSE);
2845 label = GTK_LABEL (widget);
2847 gtk_label_ensure_layout (label);
2849 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
2850 label->text && (*label->text != '\0'))
2852 get_layout_location (label, &x, &y);
2854 gtk_paint_layout (widget->style,
2856 GTK_WIDGET_STATE (widget),
2864 if (label->select_info &&
2865 (label->select_info->selection_anchor !=
2866 label->select_info->selection_end))
2872 range[0] = label->select_info->selection_anchor;
2873 range[1] = label->select_info->selection_end;
2875 if (range[0] > range[1])
2877 gint tmp = range[0];
2878 range[0] = range[1];
2882 clip = gdk_pango_layout_get_clip_region (label->layout,
2886 gdk_region_intersect (clip, event->region);
2888 /* FIXME should use gtk_paint, but it can't use a clip
2892 gdk_gc_set_clip_region (widget->style->black_gc, clip);
2895 state = GTK_STATE_SELECTED;
2896 if (!GTK_WIDGET_HAS_FOCUS (widget))
2897 state = GTK_STATE_ACTIVE;
2899 gdk_draw_layout_with_colors (widget->window,
2900 widget->style->black_gc,
2903 &widget->style->text[state],
2904 &widget->style->base[state]);
2906 gdk_gc_set_clip_region (widget->style->black_gc, NULL);
2907 gdk_region_destroy (clip);
2909 else if (label->select_info && GTK_WIDGET_HAS_FOCUS (widget))
2910 gtk_label_draw_cursor (label, x, y);
2917 gtk_label_set_uline_text_internal (GtkLabel *label,
2920 guint accel_key = GDK_VoidSymbol;
2925 gchar *dest, *pattern_dest;
2926 gboolean underscore;
2928 g_return_if_fail (GTK_IS_LABEL (label));
2929 g_return_if_fail (str != NULL);
2931 /* Split text into the base text and a separate pattern
2935 new_str = g_new (gchar, strlen (str) + 1);
2936 pattern = g_new (gchar, g_utf8_strlen (str, -1) + 1);
2945 pattern_dest = pattern;
2952 c = g_utf8_get_char (src);
2953 if (c == (gunichar)-1)
2955 g_warning ("Invalid input string");
2960 next_src = g_utf8_next_char (src);
2965 *pattern_dest++ = ' ';
2968 *pattern_dest++ = '_';
2969 if (accel_key == GDK_VoidSymbol)
2970 accel_key = gdk_keyval_to_lower (gdk_unicode_to_keyval (c));
2973 while (src < next_src)
2987 while (src < next_src)
2990 *pattern_dest++ = ' ';
2997 gtk_label_set_text_internal (label, new_str);
2998 gtk_label_set_pattern_internal (label, pattern);
3002 label->mnemonic_keyval = accel_key;
3006 gtk_label_parse_uline (GtkLabel *label,
3012 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);
3013 g_return_val_if_fail (str != NULL, GDK_VoidSymbol);
3015 orig_keyval = label->mnemonic_keyval;
3017 g_object_freeze_notify (G_OBJECT (label));
3019 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
3020 gtk_label_set_use_markup_internal (label, FALSE);
3021 gtk_label_set_use_underline_internal (label, TRUE);
3023 gtk_label_recalculate (label);
3025 keyval = label->mnemonic_keyval;
3026 label->mnemonic_keyval = GDK_VoidSymbol;
3028 gtk_label_setup_mnemonic (label, orig_keyval);
3030 g_object_thaw_notify (G_OBJECT (label));
3036 * gtk_label_set_text_with_mnemonic:
3037 * @label: a #GtkLabel
3040 * Sets the label's text from the string @str.
3041 * If characters in @str are preceded by an underscore, they are underlined
3042 * indicating that they represent a keyboard accelerator called a mnemonic.
3043 * The mnemonic key can be used to activate another widget, chosen
3044 * automatically, or explicitly using gtk_label_set_mnemonic_widget().
3047 gtk_label_set_text_with_mnemonic (GtkLabel *label,
3052 g_return_if_fail (GTK_IS_LABEL (label));
3053 g_return_if_fail (str != NULL);
3055 last_keyval = label->mnemonic_keyval;
3057 g_object_freeze_notify (G_OBJECT (label));
3059 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
3060 gtk_label_set_use_markup_internal (label, FALSE);
3061 gtk_label_set_use_underline_internal (label, TRUE);
3063 gtk_label_recalculate (label);
3065 gtk_label_setup_mnemonic (label, last_keyval);
3067 g_object_thaw_notify (G_OBJECT (label));
3071 gtk_label_realize (GtkWidget *widget)
3075 label = GTK_LABEL (widget);
3077 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->realize) (widget);
3079 if (label->select_info)
3080 gtk_label_create_window (label);
3084 gtk_label_unrealize (GtkWidget *widget)
3088 label = GTK_LABEL (widget);
3090 if (label->select_info)
3091 gtk_label_destroy_window (label);
3093 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->unrealize) (widget);
3097 gtk_label_map (GtkWidget *widget)
3101 label = GTK_LABEL (widget);
3103 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->map) (widget);
3105 if (label->select_info)
3106 gdk_window_show (label->select_info->window);
3110 gtk_label_unmap (GtkWidget *widget)
3114 label = GTK_LABEL (widget);
3116 if (label->select_info)
3117 gdk_window_hide (label->select_info->window);
3119 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->unmap) (widget);
3123 window_to_layout_coords (GtkLabel *label,
3130 widget = GTK_WIDGET (label);
3132 /* get layout location in widget->window coords */
3133 get_layout_location (label, &lx, &ly);
3137 *x += widget->allocation.x; /* go to widget->window */
3138 *x -= lx; /* go to layout */
3143 *y += widget->allocation.y; /* go to widget->window */
3144 *y -= ly; /* go to layout */
3150 layout_to_window_coords (GtkLabel *label,
3157 widget = GTK_WIDGET (label);
3159 /* get layout location in widget->window coords */
3160 get_layout_location (label, &lx, &ly);
3164 *x += lx; /* go to widget->window */
3165 *x -= widget->allocation.x; /* go to selection window */
3170 *y += ly; /* go to widget->window */
3171 *y -= widget->allocation.y; /* go to selection window */
3177 get_layout_index (GtkLabel *label,
3183 const gchar *cluster;
3184 const gchar *cluster_end;
3188 gtk_label_ensure_layout (label);
3190 window_to_layout_coords (label, &x, &y);
3195 pango_layout_xy_to_index (label->layout,
3200 cluster = label->text + *index;
3201 cluster_end = cluster;
3204 cluster_end = g_utf8_next_char (cluster_end);
3208 *index += (cluster_end - cluster);
3212 gtk_label_select_word (GtkLabel *label)
3216 gint start_index = gtk_label_move_backward_word (label, label->select_info->selection_end);
3217 gint end_index = gtk_label_move_forward_word (label, label->select_info->selection_end);
3219 min = MIN (label->select_info->selection_anchor,
3220 label->select_info->selection_end);
3221 max = MAX (label->select_info->selection_anchor,
3222 label->select_info->selection_end);
3224 min = MIN (min, start_index);
3225 max = MAX (max, end_index);
3227 gtk_label_select_region_index (label, min, max);
3231 gtk_label_grab_focus (GtkWidget *widget)
3234 gboolean select_on_focus;
3236 label = GTK_LABEL (widget);
3238 if (label->select_info == NULL)
3241 GTK_WIDGET_CLASS (gtk_label_parent_class)->grab_focus (widget);
3243 g_object_get (gtk_widget_get_settings (widget),
3244 "gtk-label-select-on-focus",
3248 if (select_on_focus && !label->in_click)
3249 gtk_label_select_region (label, 0, -1);
3253 gtk_label_button_press (GtkWidget *widget,
3254 GdkEventButton *event)
3260 label = GTK_LABEL (widget);
3262 if (label->select_info == NULL)
3265 label->select_info->in_drag = FALSE;
3266 if (event->button == 1)
3268 if (!GTK_WIDGET_HAS_FOCUS (widget))
3270 label->in_click = TRUE;
3271 gtk_widget_grab_focus (widget);
3272 label->in_click = FALSE;
3275 if (event->type == GDK_3BUTTON_PRESS)
3277 gtk_label_select_region_index (label, 0, strlen (label->text));
3281 if (event->type == GDK_2BUTTON_PRESS)
3283 gtk_label_select_word (label);
3287 get_layout_index (label, event->x, event->y, &index);
3289 min = MIN (label->select_info->selection_anchor,
3290 label->select_info->selection_end);
3291 max = MAX (label->select_info->selection_anchor,
3292 label->select_info->selection_end);
3294 if ((label->select_info->selection_anchor !=
3295 label->select_info->selection_end) &&
3296 (event->state & GDK_SHIFT_MASK))
3298 /* extend (same as motion) */
3299 min = MIN (min, index);
3300 max = MAX (max, index);
3302 /* ensure the anchor is opposite index */
3310 gtk_label_select_region_index (label, min, max);
3314 if (event->type == GDK_3BUTTON_PRESS)
3315 gtk_label_select_region_index (label, 0, strlen (label->text));
3316 else if (event->type == GDK_2BUTTON_PRESS)
3317 gtk_label_select_word (label);
3318 else if (min < max && min <= index && index <= max)
3320 label->select_info->in_drag = TRUE;
3321 label->select_info->drag_start_x = event->x;
3322 label->select_info->drag_start_y = event->y;
3325 /* start a replacement */
3326 gtk_label_select_region_index (label, index, index);
3331 else if (event->button == 3 && event->type == GDK_BUTTON_PRESS)
3333 gtk_label_do_popup (label, event);
3342 gtk_label_button_release (GtkWidget *widget,
3343 GdkEventButton *event)
3346 GtkLabel *label = GTK_LABEL (widget);
3349 if (label->select_info == NULL)
3352 if (label->select_info->in_drag)
3354 label->select_info->in_drag = 0;
3356 get_layout_index (label, event->x, event->y, &index);
3357 gtk_label_select_region_index (label, index, index);
3362 if (event->button != 1)
3365 /* The goal here is to return TRUE iff we ate the
3366 * button press to start selecting.
3373 drag_begin_cb (GtkWidget *widget,
3374 GdkDragContext *context,
3378 GdkPixmap *pixmap = NULL;
3380 g_signal_handlers_disconnect_by_func (widget, drag_begin_cb, NULL);
3382 label = GTK_LABEL (widget);
3384 if ((label->select_info->selection_anchor !=
3385 label->select_info->selection_end) &&
3391 start = MIN (label->select_info->selection_anchor,
3392 label->select_info->selection_end);
3393 end = MAX (label->select_info->selection_anchor,
3394 label->select_info->selection_end);
3396 len = strlen (label->text);
3404 pixmap = _gtk_text_util_create_drag_icon (widget,
3405 label->text + start,
3410 gtk_drag_set_icon_pixmap (context,
3411 gdk_drawable_get_colormap (pixmap),
3416 gtk_drag_set_icon_default (context);
3419 g_object_unref (pixmap);
3423 gtk_label_motion (GtkWidget *widget,
3424 GdkEventMotion *event)
3430 label = GTK_LABEL (widget);
3432 if (label->select_info == NULL)
3436 if ((event->state & GDK_BUTTON1_MASK) == 0)
3439 gdk_window_get_pointer (label->select_info->window,
3442 if (label->select_info->in_drag)
3444 if (gtk_drag_check_threshold (widget,
3445 label->select_info->drag_start_x,
3446 label->select_info->drag_start_y,
3447 event->x, event->y))
3449 GtkTargetList *target_list = gtk_target_list_new (NULL, 0);
3451 gtk_target_list_add_text_targets (target_list, 0);
3453 g_signal_connect (widget, "drag_begin",
3454 G_CALLBACK (drag_begin_cb), NULL);
3455 gtk_drag_begin (widget, target_list,
3457 1, (GdkEvent *)event);
3459 label->select_info->in_drag = FALSE;
3461 gtk_target_list_unref (target_list);
3466 get_layout_index (label, x, y, &index);
3468 gtk_label_select_region_index (label,
3469 label->select_info->selection_anchor,
3477 gtk_label_create_window (GtkLabel *label)
3480 GdkWindowAttr attributes;
3481 gint attributes_mask;
3483 g_assert (label->select_info);
3484 g_assert (GTK_WIDGET_REALIZED (label));
3486 if (label->select_info->window)
3489 widget = GTK_WIDGET (label);
3491 attributes.x = widget->allocation.x;
3492 attributes.y = widget->allocation.y;
3493 attributes.width = widget->allocation.width;
3494 attributes.height = widget->allocation.height;
3495 attributes.window_type = GDK_WINDOW_CHILD;
3496 attributes.wclass = GDK_INPUT_ONLY;
3497 attributes.override_redirect = TRUE;
3498 attributes.event_mask = gtk_widget_get_events (widget) |
3499 GDK_BUTTON_PRESS_MASK |
3500 GDK_BUTTON_RELEASE_MASK |
3501 GDK_BUTTON_MOTION_MASK;
3502 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
3503 if (GTK_WIDGET_IS_SENSITIVE (widget))
3505 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
3507 attributes_mask |= GDK_WA_CURSOR;
3511 label->select_info->window = gdk_window_new (widget->window,
3512 &attributes, attributes_mask);
3513 gdk_window_set_user_data (label->select_info->window, widget);
3515 if (attributes_mask & GDK_WA_CURSOR)
3516 gdk_cursor_unref (attributes.cursor);
3520 gtk_label_destroy_window (GtkLabel *label)
3522 g_assert (label->select_info);
3524 if (label->select_info->window == NULL)
3527 gdk_window_set_user_data (label->select_info->window, NULL);
3528 gdk_window_destroy (label->select_info->window);
3529 label->select_info->window = NULL;
3533 * gtk_label_set_selectable:
3534 * @label: a #GtkLabel
3535 * @setting: %TRUE to allow selecting text in the label
3537 * Selectable labels allow the user to select text from the label, for
3541 gtk_label_set_selectable (GtkLabel *label,
3544 gboolean old_setting;
3546 g_return_if_fail (GTK_IS_LABEL (label));
3548 setting = setting != FALSE;
3549 old_setting = label->select_info != NULL;
3553 if (label->select_info == NULL)
3555 label->select_info = g_new0 (GtkLabelSelectionInfo, 1);
3557 GTK_WIDGET_SET_FLAGS (label, GTK_CAN_FOCUS);
3559 if (GTK_WIDGET_REALIZED (label))
3560 gtk_label_create_window (label);
3562 if (GTK_WIDGET_MAPPED (label))
3563 gdk_window_show (label->select_info->window);
3568 if (label->select_info)
3570 /* unselect, to give up the selection */
3571 gtk_label_select_region (label, 0, 0);
3573 if (label->select_info->window)
3575 gtk_label_destroy_window (label);
3578 g_free (label->select_info);
3580 label->select_info = NULL;
3582 GTK_WIDGET_UNSET_FLAGS (label, GTK_CAN_FOCUS);
3585 if (setting != old_setting)
3587 g_object_freeze_notify (G_OBJECT (label));
3588 g_object_notify (G_OBJECT (label), "selectable");
3589 g_object_notify (G_OBJECT (label), "cursor-position");
3590 g_object_notify (G_OBJECT (label), "selection-bound");
3591 g_object_thaw_notify (G_OBJECT (label));
3592 gtk_widget_queue_draw (GTK_WIDGET (label));
3597 * gtk_label_get_selectable:
3598 * @label: a #GtkLabel
3600 * Gets the value set by gtk_label_set_selectable().
3602 * Return value: %TRUE if the user can copy text from the label
3605 gtk_label_get_selectable (GtkLabel *label)
3607 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3609 return label->select_info != NULL;
3613 free_angle (gpointer angle)
3615 g_slice_free (gdouble, angle);
3619 * gtk_label_set_angle:
3620 * @label: a #GtkLabel
3621 * @angle: the angle that the baseline of the label makes with
3622 * the horizontal, in degrees, measured counterclockwise
3624 * Sets the angle of rotation for the label. An angle of 90 reads from
3625 * from bottom to top, an angle of 270, from top to bottom. The angle
3626 * setting for the label is ignored if the label is selectable,
3627 * wrapped, or ellipsized.
3632 gtk_label_set_angle (GtkLabel *label,
3635 gdouble *label_angle;
3637 g_return_if_fail (GTK_IS_LABEL (label));
3639 label_angle = (gdouble *)g_object_get_qdata (G_OBJECT (label), quark_angle);
3643 label_angle = g_slice_new (gdouble);
3645 g_object_set_qdata_full (G_OBJECT (label), quark_angle,
3646 label_angle, free_angle);
3649 /* Canonicalize to [0,360]. We don't canonicalize 360 to 0, because
3650 * double property ranges are inclusive, and changing 360 to 0 would
3651 * make a property editor behave strangely.
3653 if (angle < 0 || angle > 360.0)
3654 angle = angle - 360. * floor (angle / 360.);
3656 if (*label_angle != angle)
3658 *label_angle = angle;
3660 gtk_label_clear_layout (label);
3661 gtk_widget_queue_resize (GTK_WIDGET (label));
3663 g_object_notify (G_OBJECT (label), "angle");
3668 * gtk_label_get_angle:
3669 * @label: a #GtkLabel
3671 * Gets the angle of rotation for the label. See
3672 * gtk_label_set_angle().
3674 * Return value: the angle of rotation for the label
3679 gtk_label_get_angle (GtkLabel *label)
3683 g_return_val_if_fail (GTK_IS_LABEL (label), 0.0);
3685 angle = (gdouble *)g_object_get_qdata (G_OBJECT (label), quark_angle);
3694 gtk_label_set_selection_text (GtkLabel *label,
3695 GtkSelectionData *selection_data)
3697 if ((label->select_info->selection_anchor !=
3698 label->select_info->selection_end) &&
3704 start = MIN (label->select_info->selection_anchor,
3705 label->select_info->selection_end);
3706 end = MAX (label->select_info->selection_anchor,
3707 label->select_info->selection_end);
3709 len = strlen (label->text);
3717 gtk_selection_data_set_text (selection_data,
3718 label->text + start,
3724 gtk_label_drag_data_get (GtkWidget *widget,
3725 GdkDragContext *context,
3726 GtkSelectionData *selection_data,
3730 gtk_label_set_selection_text (GTK_LABEL (widget), selection_data);
3734 get_text_callback (GtkClipboard *clipboard,
3735 GtkSelectionData *selection_data,
3737 gpointer user_data_or_owner)
3739 gtk_label_set_selection_text (GTK_LABEL (user_data_or_owner), selection_data);
3743 clear_text_callback (GtkClipboard *clipboard,
3744 gpointer user_data_or_owner)
3748 label = GTK_LABEL (user_data_or_owner);
3750 if (label->select_info)
3752 label->select_info->selection_anchor = label->select_info->selection_end;
3754 gtk_widget_queue_draw (GTK_WIDGET (label));
3759 gtk_label_select_region_index (GtkLabel *label,
3763 g_return_if_fail (GTK_IS_LABEL (label));
3765 if (label->select_info)
3767 GtkClipboard *clipboard;
3769 if (label->select_info->selection_anchor == anchor_index &&
3770 label->select_info->selection_end == end_index)
3773 label->select_info->selection_anchor = anchor_index;
3774 label->select_info->selection_end = end_index;
3776 clipboard = gtk_widget_get_clipboard (GTK_WIDGET (label),
3777 GDK_SELECTION_PRIMARY);
3779 if (anchor_index != end_index)
3781 GtkTargetList *list;
3782 GtkTargetEntry *targets;
3785 list = gtk_target_list_new (NULL, 0);
3786 gtk_target_list_add_text_targets (list, 0);
3787 targets = gtk_target_table_new_from_list (list, &n_targets);
3789 gtk_clipboard_set_with_owner (clipboard,
3792 clear_text_callback,
3795 gtk_target_table_free (targets, n_targets);
3796 gtk_target_list_unref (list);
3800 if (gtk_clipboard_get_owner (clipboard) == G_OBJECT (label))
3801 gtk_clipboard_clear (clipboard);
3804 gtk_widget_queue_draw (GTK_WIDGET (label));
3806 g_object_freeze_notify (G_OBJECT (label));
3807 g_object_notify (G_OBJECT (label), "cursor-position");
3808 g_object_notify (G_OBJECT (label), "selection-bound");
3809 g_object_thaw_notify (G_OBJECT (label));
3814 * gtk_label_select_region:
3815 * @label: a #GtkLabel
3816 * @start_offset: start offset (in characters not bytes)
3817 * @end_offset: end offset (in characters not bytes)
3819 * Selects a range of characters in the label, if the label is selectable.
3820 * See gtk_label_set_selectable(). If the label is not selectable,
3821 * this function has no effect. If @start_offset or
3822 * @end_offset are -1, then the end of the label will be substituted.
3825 gtk_label_select_region (GtkLabel *label,
3829 g_return_if_fail (GTK_IS_LABEL (label));
3831 if (label->text && label->select_info)
3833 if (start_offset < 0)
3834 start_offset = g_utf8_strlen (label->text, -1);
3837 end_offset = g_utf8_strlen (label->text, -1);
3839 gtk_label_select_region_index (label,
3840 g_utf8_offset_to_pointer (label->text, start_offset) - label->text,
3841 g_utf8_offset_to_pointer (label->text, end_offset) - label->text);
3846 * gtk_label_get_selection_bounds:
3847 * @label: a #GtkLabel
3848 * @start: return location for start of selection, as a character offset
3849 * @end: return location for end of selection, as a character offset
3851 * Gets the selected range of characters in the label, returning %TRUE
3852 * if there's a selection.
3854 * Return value: %TRUE if selection is non-empty
3857 gtk_label_get_selection_bounds (GtkLabel *label,
3861 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3863 if (label->select_info == NULL)
3865 /* not a selectable label */
3875 gint start_index, end_index;
3876 gint start_offset, end_offset;
3879 start_index = MIN (label->select_info->selection_anchor,
3880 label->select_info->selection_end);
3881 end_index = MAX (label->select_info->selection_anchor,
3882 label->select_info->selection_end);
3884 len = strlen (label->text);
3886 if (end_index > len)
3889 if (start_index > len)
3892 start_offset = g_utf8_strlen (label->text, start_index);
3893 end_offset = g_utf8_strlen (label->text, end_index);
3895 if (start_offset > end_offset)
3897 gint tmp = start_offset;
3898 start_offset = end_offset;
3903 *start = start_offset;
3908 return start_offset != end_offset;
3914 * gtk_label_get_layout:
3915 * @label: a #GtkLabel
3917 * Gets the #PangoLayout used to display the label.
3918 * The layout is useful to e.g. convert text positions to
3919 * pixel positions, in combination with gtk_label_get_layout_offsets().
3920 * The returned layout is owned by the label so need not be
3921 * freed by the caller.
3923 * Return value: the #PangoLayout for this label
3926 gtk_label_get_layout (GtkLabel *label)
3928 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
3930 gtk_label_ensure_layout (label);
3932 return label->layout;
3936 * gtk_label_get_layout_offsets:
3937 * @label: a #GtkLabel
3938 * @x: location to store X offset of layout, or %NULL
3939 * @y: location to store Y offset of layout, or %NULL
3941 * Obtains the coordinates where the label will draw the #PangoLayout
3942 * representing the text in the label; useful to convert mouse events
3943 * into coordinates inside the #PangoLayout, e.g. to take some action
3944 * if some part of the label is clicked. Of course you will need to
3945 * create a #GtkEventBox to receive the events, and pack the label
3946 * inside it, since labels are a #GTK_NO_WINDOW widget. Remember
3947 * when using the #PangoLayout functions you need to convert to
3948 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
3951 gtk_label_get_layout_offsets (GtkLabel *label,
3955 g_return_if_fail (GTK_IS_LABEL (label));
3957 get_layout_location (label, x, y);
3961 * gtk_label_set_use_markup:
3962 * @label: a #GtkLabel
3963 * @setting: %TRUE if the label's text should be parsed for markup.
3965 * Sets whether the text of the label contains markup in <link
3966 * linkend="PangoMarkupFormat">Pango's text markup
3967 * language</link>. See gtk_label_set_markup().
3970 gtk_label_set_use_markup (GtkLabel *label,
3973 g_return_if_fail (GTK_IS_LABEL (label));
3975 gtk_label_set_use_markup_internal (label, setting);
3976 gtk_label_recalculate (label);
3980 * gtk_label_get_use_markup:
3981 * @label: a #GtkLabel
3983 * Returns whether the label's text is interpreted as marked up with
3984 * the <link linkend="PangoMarkupFormat">Pango text markup
3985 * language</link>. See gtk_label_set_use_markup ().
3987 * Return value: %TRUE if the label's text will be parsed for markup.
3990 gtk_label_get_use_markup (GtkLabel *label)
3992 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3994 return label->use_markup;
3998 * gtk_label_set_use_underline:
3999 * @label: a #GtkLabel
4000 * @setting: %TRUE if underlines in the text indicate mnemonics
4002 * If true, an underline in the text indicates the next character should be
4003 * used for the mnemonic accelerator key.
4006 gtk_label_set_use_underline (GtkLabel *label,
4009 g_return_if_fail (GTK_IS_LABEL (label));
4011 gtk_label_set_use_underline_internal (label, setting);
4012 gtk_label_recalculate (label);
4013 if (label->use_underline)
4014 gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
4018 * gtk_label_get_use_underline:
4019 * @label: a #GtkLabel
4021 * Returns whether an embedded underline in the label indicates a
4022 * mnemonic. See gtk_label_set_use_underline().
4024 * Return value: %TRUE whether an embedded underline in the label indicates
4025 * the mnemonic accelerator keys.
4028 gtk_label_get_use_underline (GtkLabel *label)
4030 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
4032 return label->use_underline;
4036 * gtk_label_set_single_line_mode:
4037 * @label: a #GtkLabel
4038 * @single_line_mode: %TRUE if the label should be in single line mode
4040 * Sets whether the label is in single line mode.
4045 gtk_label_set_single_line_mode (GtkLabel *label,
4046 gboolean single_line_mode)
4048 g_return_if_fail (GTK_IS_LABEL (label));
4050 single_line_mode = single_line_mode != FALSE;
4052 if (label->single_line_mode != single_line_mode)
4054 label->single_line_mode = single_line_mode;
4056 gtk_label_clear_layout (label);
4057 gtk_widget_queue_resize (GTK_WIDGET (label));
4059 g_object_notify (G_OBJECT (label), "single-line-mode");
4064 * gtk_label_get_single_line_mode:
4065 * @label: a #GtkLabel
4067 * Returns whether the label is in single line mode.
4069 * Return value: %TRUE when the label is in single line mode.
4074 gtk_label_get_single_line_mode (GtkLabel *label)
4076 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
4078 return label->single_line_mode;
4081 /* Compute the X position for an offset that corresponds to the "more important
4082 * cursor position for that offset. We use this when trying to guess to which
4083 * end of the selection we should go to when the user hits the left or
4087 get_better_cursor (GtkLabel *label,
4092 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
4093 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
4094 PangoDirection cursor_direction = get_cursor_direction (label);
4095 gboolean split_cursor;
4096 PangoRectangle strong_pos, weak_pos;
4098 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
4099 "gtk-split-cursor", &split_cursor,
4102 gtk_label_ensure_layout (label);
4104 pango_layout_get_cursor_pos (label->layout, index,
4105 &strong_pos, &weak_pos);
4109 *x = strong_pos.x / PANGO_SCALE;
4110 *y = strong_pos.y / PANGO_SCALE;
4114 if (keymap_direction == cursor_direction)
4116 *x = strong_pos.x / PANGO_SCALE;
4117 *y = strong_pos.y / PANGO_SCALE;
4121 *x = weak_pos.x / PANGO_SCALE;
4122 *y = weak_pos.y / PANGO_SCALE;
4129 gtk_label_move_logically (GtkLabel *label,
4133 gint offset = g_utf8_pointer_to_offset (label->text,
4134 label->text + start);
4138 PangoLogAttr *log_attrs;
4142 gtk_label_ensure_layout (label);
4144 length = g_utf8_strlen (label->text, -1);
4146 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
4148 while (count > 0 && offset < length)
4152 while (offset < length && !log_attrs[offset].is_cursor_position);
4156 while (count < 0 && offset > 0)
4160 while (offset > 0 && !log_attrs[offset].is_cursor_position);
4168 return g_utf8_offset_to_pointer (label->text, offset) - label->text;
4172 gtk_label_move_visually (GtkLabel *label,
4182 int new_index, new_trailing;
4183 gboolean split_cursor;
4186 gtk_label_ensure_layout (label);
4188 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
4189 "gtk-split-cursor", &split_cursor,
4196 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
4197 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
4199 strong = keymap_direction == get_cursor_direction (label);
4204 pango_layout_move_cursor_visually (label->layout, strong, index, 0, 1, &new_index, &new_trailing);
4209 pango_layout_move_cursor_visually (label->layout, strong, index, 0, -1, &new_index, &new_trailing);
4213 if (new_index < 0 || new_index == G_MAXINT)
4218 while (new_trailing--)
4219 index = g_utf8_next_char (label->text + new_index) - label->text;
4226 gtk_label_move_forward_word (GtkLabel *label,
4229 gint new_pos = g_utf8_pointer_to_offset (label->text,
4230 label->text + start);
4233 length = g_utf8_strlen (label->text, -1);
4234 if (new_pos < length)
4236 PangoLogAttr *log_attrs;
4239 gtk_label_ensure_layout (label);
4241 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
4243 /* Find the next word end */
4245 while (new_pos < n_attrs && !log_attrs[new_pos].is_word_end)
4251 return g_utf8_offset_to_pointer (label->text, new_pos) - label->text;
4256 gtk_label_move_backward_word (GtkLabel *label,
4259 gint new_pos = g_utf8_pointer_to_offset (label->text,
4260 label->text + start);
4264 PangoLogAttr *log_attrs;
4267 gtk_label_ensure_layout (label);
4269 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
4273 /* Find the previous word beginning */
4274 while (new_pos > 0 && !log_attrs[new_pos].is_word_start)
4280 return g_utf8_offset_to_pointer (label->text, new_pos) - label->text;
4284 gtk_label_move_cursor (GtkLabel *label,
4285 GtkMovementStep step,
4287 gboolean extend_selection)
4292 if (label->select_info == NULL)
4295 old_pos = new_pos = label->select_info->selection_end;
4297 if (label->select_info->selection_end != label->select_info->selection_anchor &&
4300 /* If we have a current selection and aren't extending it, move to the
4301 * start/or end of the selection as appropriate
4305 case GTK_MOVEMENT_VISUAL_POSITIONS:
4308 gint anchor_x, anchor_y;
4309 gboolean end_is_left;
4311 get_better_cursor (label, label->select_info->selection_end, &end_x, &end_y);
4312 get_better_cursor (label, label->select_info->selection_anchor, &anchor_x, &anchor_y);
4314 end_is_left = (end_y < anchor_y) || (end_y == anchor_y && end_x < anchor_x);
4317 new_pos = end_is_left ? label->select_info->selection_end : label->select_info->selection_anchor;
4319 new_pos = !end_is_left ? label->select_info->selection_end : label->select_info->selection_anchor;
4322 case GTK_MOVEMENT_LOGICAL_POSITIONS:
4323 case GTK_MOVEMENT_WORDS:
4325 new_pos = MIN (label->select_info->selection_end, label->select_info->selection_anchor);
4327 new_pos = MAX (label->select_info->selection_end, label->select_info->selection_anchor);
4329 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
4330 case GTK_MOVEMENT_PARAGRAPH_ENDS:
4331 case GTK_MOVEMENT_BUFFER_ENDS:
4332 /* FIXME: Can do better here */
4333 new_pos = count < 0 ? 0 : strlen (label->text);
4335 case GTK_MOVEMENT_DISPLAY_LINES:
4336 case GTK_MOVEMENT_PARAGRAPHS:
4337 case GTK_MOVEMENT_PAGES:
4338 case GTK_MOVEMENT_HORIZONTAL_PAGES:
4346 case GTK_MOVEMENT_LOGICAL_POSITIONS:
4347 new_pos = gtk_label_move_logically (label, new_pos, count);
4349 case GTK_MOVEMENT_VISUAL_POSITIONS:
4350 new_pos = gtk_label_move_visually (label, new_pos, count);
4351 if (new_pos == old_pos)
4353 if (!extend_selection)
4355 if (!gtk_widget_keynav_failed (GTK_WIDGET (label),
4357 GTK_DIR_RIGHT : GTK_DIR_LEFT))
4359 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (label));
4362 gtk_widget_child_focus (toplevel,
4364 GTK_DIR_RIGHT : GTK_DIR_LEFT);
4369 gtk_widget_error_bell (GTK_WIDGET (label));
4373 case GTK_MOVEMENT_WORDS:
4376 new_pos = gtk_label_move_forward_word (label, new_pos);
4381 new_pos = gtk_label_move_backward_word (label, new_pos);
4384 if (new_pos == old_pos)
4385 gtk_widget_error_bell (GTK_WIDGET (label));
4387 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
4388 case GTK_MOVEMENT_PARAGRAPH_ENDS:
4389 case GTK_MOVEMENT_BUFFER_ENDS:
4390 /* FIXME: Can do better here */
4391 new_pos = count < 0 ? 0 : strlen (label->text);
4392 if (new_pos == old_pos)
4393 gtk_widget_error_bell (GTK_WIDGET (label));
4395 case GTK_MOVEMENT_DISPLAY_LINES:
4396 case GTK_MOVEMENT_PARAGRAPHS:
4397 case GTK_MOVEMENT_PAGES:
4398 case GTK_MOVEMENT_HORIZONTAL_PAGES:
4403 if (extend_selection)
4404 gtk_label_select_region_index (label,
4405 label->select_info->selection_anchor,
4408 gtk_label_select_region_index (label, new_pos, new_pos);
4412 gtk_label_copy_clipboard (GtkLabel *label)
4414 if (label->text && label->select_info)
4419 start = MIN (label->select_info->selection_anchor,
4420 label->select_info->selection_end);
4421 end = MAX (label->select_info->selection_anchor,
4422 label->select_info->selection_end);
4424 len = strlen (label->text);
4433 gtk_clipboard_set_text (gtk_widget_get_clipboard (GTK_WIDGET (label),
4434 GDK_SELECTION_CLIPBOARD),
4435 label->text + start, end - start);
4440 gtk_label_select_all (GtkLabel *label)
4442 gtk_label_select_region_index (label, 0, strlen (label->text));
4445 /* Quick hack of a popup menu
4448 activate_cb (GtkWidget *menuitem,
4451 const gchar *signal = g_object_get_data (G_OBJECT (menuitem), "gtk-signal");
4452 g_signal_emit_by_name (label, signal);
4456 append_action_signal (GtkLabel *label,
4458 const gchar *stock_id,
4459 const gchar *signal,
4462 GtkWidget *menuitem = gtk_image_menu_item_new_from_stock (stock_id, NULL);
4464 g_object_set_data (G_OBJECT (menuitem), I_("gtk-signal"), (char *)signal);
4465 g_signal_connect (menuitem, "activate",
4466 G_CALLBACK (activate_cb), label);
4468 gtk_widget_set_sensitive (menuitem, sensitive);
4470 gtk_widget_show (menuitem);
4471 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
4475 popup_menu_detach (GtkWidget *attach_widget,
4479 label = GTK_LABEL (attach_widget);
4481 if (label->select_info)
4482 label->select_info->popup_menu = NULL;
4486 popup_position_func (GtkMenu *menu,
4497 label = GTK_LABEL (user_data);
4498 widget = GTK_WIDGET (label);
4500 if (label->select_info == NULL)
4503 g_return_if_fail (GTK_WIDGET_REALIZED (label));
4505 screen = gtk_widget_get_screen (widget);
4506 gdk_window_get_origin (widget->window, x, y);
4508 gtk_widget_size_request (label->select_info->popup_menu, &req);
4510 *x += widget->allocation.width / 2;
4511 *y += widget->allocation.height;
4513 *x = CLAMP (*x, 0, MAX (0, gdk_screen_get_width (screen) - req.width));
4514 *y = CLAMP (*y, 0, MAX (0, gdk_screen_get_height (screen) - req.height));
4519 gtk_label_do_popup (GtkLabel *label,
4520 GdkEventButton *event)
4522 GtkWidget *menuitem;
4523 gboolean have_selection;
4525 if (label->select_info == NULL)
4528 if (label->select_info->popup_menu)
4529 gtk_widget_destroy (label->select_info->popup_menu);
4531 label->select_info->popup_menu = gtk_menu_new ();
4533 gtk_menu_attach_to_widget (GTK_MENU (label->select_info->popup_menu),
4538 label->select_info->selection_anchor != label->select_info->selection_end;
4541 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_CUT, "cut_clipboard",
4543 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_COPY, "copy_clipboard",
4545 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_PASTE, "paste_clipboard",
4548 menuitem = gtk_image_menu_item_new_from_stock (GTK_STOCK_DELETE, NULL);
4549 gtk_widget_set_sensitive (menuitem, FALSE);
4550 gtk_widget_show (menuitem);
4551 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
4553 menuitem = gtk_separator_menu_item_new ();
4554 gtk_widget_show (menuitem);
4555 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
4557 menuitem = gtk_image_menu_item_new_from_stock (GTK_STOCK_SELECT_ALL, NULL);
4558 g_signal_connect_swapped (menuitem, "activate",
4559 G_CALLBACK (gtk_label_select_all), label);
4560 gtk_widget_show (menuitem);
4561 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
4563 g_signal_emit (label,
4564 signals[POPULATE_POPUP],
4566 label->select_info->popup_menu);
4569 gtk_menu_popup (GTK_MENU (label->select_info->popup_menu), NULL, NULL,
4571 event->button, event->time);
4573 gtk_menu_popup (GTK_MENU (label->select_info->popup_menu), NULL, NULL,
4574 popup_position_func, label,
4575 0, gtk_get_current_event_time ());
4578 #define __GTK_LABEL_C__
4579 #include "gtkaliasdef.c"