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/.
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 "gtkmenuitem.h"
42 #include "gtknotebook.h"
44 #include "gtkbindings.h"
46 #define GTK_LABEL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_LABEL, GtkLabelPrivate))
51 guint single_line_mode : 1;
55 struct _GtkLabelSelectionInfo
58 gint selection_anchor;
60 GtkWidget *popup_menu;
94 static guint signals[LAST_SIGNAL] = { 0 };
96 static void gtk_label_class_init (GtkLabelClass *klass);
97 static void gtk_label_init (GtkLabel *label);
98 static void gtk_label_set_property (GObject *object,
102 static void gtk_label_get_property (GObject *object,
106 static void gtk_label_destroy (GtkObject *object);
107 static void gtk_label_finalize (GObject *object);
108 static void gtk_label_size_request (GtkWidget *widget,
109 GtkRequisition *requisition);
110 static void gtk_label_size_allocate (GtkWidget *widget,
111 GtkAllocation *allocation);
112 static void gtk_label_state_changed (GtkWidget *widget,
114 static void gtk_label_style_set (GtkWidget *widget,
115 GtkStyle *previous_style);
116 static void gtk_label_direction_changed (GtkWidget *widget,
117 GtkTextDirection previous_dir);
118 static gint gtk_label_expose (GtkWidget *widget,
119 GdkEventExpose *event);
121 static void gtk_label_realize (GtkWidget *widget);
122 static void gtk_label_unrealize (GtkWidget *widget);
123 static void gtk_label_map (GtkWidget *widget);
124 static void gtk_label_unmap (GtkWidget *widget);
126 static gboolean gtk_label_button_press (GtkWidget *widget,
127 GdkEventButton *event);
128 static gboolean gtk_label_button_release (GtkWidget *widget,
129 GdkEventButton *event);
130 static gboolean gtk_label_motion (GtkWidget *widget,
131 GdkEventMotion *event);
134 static void gtk_label_set_text_internal (GtkLabel *label,
136 static void gtk_label_set_label_internal (GtkLabel *label,
138 static void gtk_label_set_use_markup_internal (GtkLabel *label,
140 static void gtk_label_set_use_underline_internal (GtkLabel *label,
142 static void gtk_label_set_attributes_internal (GtkLabel *label,
143 PangoAttrList *attrs);
144 static void gtk_label_set_uline_text_internal (GtkLabel *label,
146 static void gtk_label_set_pattern_internal (GtkLabel *label,
147 const gchar *pattern);
148 static void set_markup (GtkLabel *label,
150 gboolean with_uline);
151 static void gtk_label_recalculate (GtkLabel *label);
152 static void gtk_label_hierarchy_changed (GtkWidget *widget,
153 GtkWidget *old_toplevel);
154 static void gtk_label_screen_changed (GtkWidget *widget,
155 GdkScreen *old_screen);
157 static void gtk_label_create_window (GtkLabel *label);
158 static void gtk_label_destroy_window (GtkLabel *label);
159 static void gtk_label_clear_layout (GtkLabel *label);
160 static void gtk_label_ensure_layout (GtkLabel *label);
161 static void gtk_label_select_region_index (GtkLabel *label,
165 static gboolean gtk_label_mnemonic_activate (GtkWidget *widget,
166 gboolean group_cycling);
167 static void gtk_label_setup_mnemonic (GtkLabel *label,
169 static void gtk_label_drag_data_get (GtkWidget *widget,
170 GdkDragContext *context,
171 GtkSelectionData *selection_data,
176 /* For selectable lables: */
177 static void gtk_label_move_cursor (GtkLabel *label,
178 GtkMovementStep step,
180 gboolean extend_selection);
181 static void gtk_label_copy_clipboard (GtkLabel *label);
182 static void gtk_label_select_all (GtkLabel *label);
183 static void gtk_label_do_popup (GtkLabel *label,
184 GdkEventButton *event);
186 static gint gtk_label_move_forward_word (GtkLabel *label,
188 static gint gtk_label_move_backward_word (GtkLabel *label,
191 static GtkMiscClass *parent_class = NULL;
195 gtk_label_get_type (void)
197 static GType label_type = 0;
201 static const GTypeInfo label_info =
203 sizeof (GtkLabelClass),
204 NULL, /* base_init */
205 NULL, /* base_finalize */
206 (GClassInitFunc) gtk_label_class_init,
207 NULL, /* class_finalize */
208 NULL, /* class_data */
210 32, /* n_preallocs */
211 (GInstanceInitFunc) gtk_label_init,
214 label_type = g_type_register_static (GTK_TYPE_MISC, "GtkLabel",
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 parent_class = g_type_class_peek_parent (class);
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;
278 class->move_cursor = gtk_label_move_cursor;
279 class->copy_clipboard = gtk_label_copy_clipboard;
281 signals[MOVE_CURSOR] =
282 g_signal_new ("move_cursor",
283 G_OBJECT_CLASS_TYPE (gobject_class),
284 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
285 G_STRUCT_OFFSET (GtkLabelClass, move_cursor),
287 _gtk_marshal_VOID__ENUM_INT_BOOLEAN,
289 GTK_TYPE_MOVEMENT_STEP,
293 signals[COPY_CLIPBOARD] =
294 g_signal_new ("copy_clipboard",
295 G_OBJECT_CLASS_TYPE (gobject_class),
296 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
297 G_STRUCT_OFFSET (GtkLabelClass, copy_clipboard),
299 _gtk_marshal_VOID__VOID,
302 signals[POPULATE_POPUP] =
303 g_signal_new ("populate_popup",
304 G_OBJECT_CLASS_TYPE (gobject_class),
306 G_STRUCT_OFFSET (GtkLabelClass, populate_popup),
308 _gtk_marshal_VOID__OBJECT,
312 g_object_class_install_property (gobject_class,
314 g_param_spec_string ("label",
316 P_("The text of the label"),
319 g_object_class_install_property (gobject_class,
321 g_param_spec_boxed ("attributes",
323 P_("A list of style attributes to apply to the text of the label"),
324 PANGO_TYPE_ATTR_LIST,
326 g_object_class_install_property (gobject_class,
328 g_param_spec_boolean ("use_markup",
330 P_("The text of the label includes XML markup. See pango_parse_markup()"),
333 g_object_class_install_property (gobject_class,
335 g_param_spec_boolean ("use_underline",
337 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
341 g_object_class_install_property (gobject_class,
343 g_param_spec_enum ("justify",
345 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"),
346 GTK_TYPE_JUSTIFICATION,
350 g_object_class_install_property (gobject_class,
352 g_param_spec_string ("pattern",
354 P_("A string with _ characters in positions correspond to characters in the text to underline"),
358 g_object_class_install_property (gobject_class,
360 g_param_spec_boolean ("wrap",
362 P_("If set, wrap lines if the text becomes too wide"),
365 g_object_class_install_property (gobject_class,
367 g_param_spec_boolean ("selectable",
369 P_("Whether the label text can be selected with the mouse"),
372 g_object_class_install_property (gobject_class,
373 PROP_MNEMONIC_KEYVAL,
374 g_param_spec_uint ("mnemonic_keyval",
376 P_("The mnemonic accelerator key for this label"),
381 g_object_class_install_property (gobject_class,
382 PROP_MNEMONIC_WIDGET,
383 g_param_spec_object ("mnemonic_widget",
384 P_("Mnemonic widget"),
385 P_("The widget to be activated when the label's mnemonic "
390 g_object_class_install_property (gobject_class,
391 PROP_CURSOR_POSITION,
392 g_param_spec_int ("cursor_position",
393 P_("Cursor Position"),
394 P_("The current position of the insertion cursor in chars"),
400 g_object_class_install_property (gobject_class,
401 PROP_SELECTION_BOUND,
402 g_param_spec_int ("selection_bound",
403 P_("Selection Bound"),
404 P_("The position of the opposite end of the selection from the cursor in chars"),
411 * GtkLabel:ellipsize:
413 * The preferred place to ellipsize the string, if the label does not have
414 * enough room to display the entire string, specified as a #PangoEllisizeMode.
416 * Note that setting this property to a value other than %PANGO_ELLIPSIZE_NONE
417 * has the side-effect that the label requests only enough space to display the
418 * ellipsis "...". In particular, this means that ellipsizing labels don't
419 * work well in notebook tabs, unless the tab's ::tab-expand property is set
420 * to %TRUE. Other means to set a label's width are
421 * gtk_widget_set_size_request() and gtk_label_set_width_chars().
425 g_object_class_install_property (gobject_class,
427 g_param_spec_enum ("ellipsize",
429 P_("The preferred place to ellipsize the string, if the label does not have enough room to display the entire string, if at all"),
430 PANGO_TYPE_ELLIPSIZE_MODE,
431 PANGO_ELLIPSIZE_NONE,
435 * GtkLabel:width-chars:
437 * The desired width of the label, in characters. If this property is set to
438 * -1, the width will be calculated automatically, otherwise the label will
439 * request either 3 characters or the property value, whichever is greater.
443 g_object_class_install_property (gobject_class,
445 g_param_spec_int ("width_chars",
446 P_("Width In Chararacters"),
447 P_("The desired width of the label, in characters"),
454 * GtkLabel:single-line-mode:
456 * Whether the label is in single line mode. In single line mode,
457 * the height of the label does not depend on the actual text, it
458 * is always set to ascent + descent of the font. This can be an
459 * advantage in situations where resizing the label because of text
460 * changes would be distracting, e.g. in a statusbar.
464 g_object_class_install_property (gobject_class,
465 PROP_SINGLE_LINE_MODE,
466 g_param_spec_boolean ("single-line-mode",
467 P_("Single Line Mode"),
468 P_("Whether the label is in single line mode"),
475 binding_set = gtk_binding_set_by_class (class);
477 /* Moving the insertion point */
478 add_move_binding (binding_set, GDK_Right, 0,
479 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
481 add_move_binding (binding_set, GDK_Left, 0,
482 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
484 add_move_binding (binding_set, GDK_KP_Right, 0,
485 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
487 add_move_binding (binding_set, GDK_KP_Left, 0,
488 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
490 add_move_binding (binding_set, GDK_f, GDK_CONTROL_MASK,
491 GTK_MOVEMENT_LOGICAL_POSITIONS, 1);
493 add_move_binding (binding_set, GDK_b, GDK_CONTROL_MASK,
494 GTK_MOVEMENT_LOGICAL_POSITIONS, -1);
496 add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
497 GTK_MOVEMENT_WORDS, 1);
499 add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
500 GTK_MOVEMENT_WORDS, -1);
502 add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
503 GTK_MOVEMENT_WORDS, 1);
505 add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
506 GTK_MOVEMENT_WORDS, -1);
508 add_move_binding (binding_set, GDK_a, GDK_CONTROL_MASK,
509 GTK_MOVEMENT_PARAGRAPH_ENDS, -1);
511 add_move_binding (binding_set, GDK_e, GDK_CONTROL_MASK,
512 GTK_MOVEMENT_PARAGRAPH_ENDS, 1);
514 add_move_binding (binding_set, GDK_f, GDK_MOD1_MASK,
515 GTK_MOVEMENT_WORDS, 1);
517 add_move_binding (binding_set, GDK_b, GDK_MOD1_MASK,
518 GTK_MOVEMENT_WORDS, -1);
520 add_move_binding (binding_set, GDK_Home, 0,
521 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
523 add_move_binding (binding_set, GDK_End, 0,
524 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
526 add_move_binding (binding_set, GDK_KP_Home, 0,
527 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
529 add_move_binding (binding_set, GDK_KP_End, 0,
530 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
532 add_move_binding (binding_set, GDK_Home, GDK_CONTROL_MASK,
533 GTK_MOVEMENT_BUFFER_ENDS, -1);
535 add_move_binding (binding_set, GDK_End, GDK_CONTROL_MASK,
536 GTK_MOVEMENT_BUFFER_ENDS, 1);
538 add_move_binding (binding_set, GDK_KP_Home, GDK_CONTROL_MASK,
539 GTK_MOVEMENT_BUFFER_ENDS, -1);
541 add_move_binding (binding_set, GDK_KP_End, GDK_CONTROL_MASK,
542 GTK_MOVEMENT_BUFFER_ENDS, 1);
545 gtk_binding_entry_add_signal (binding_set, GDK_c, GDK_CONTROL_MASK,
546 "copy_clipboard", 0);
548 g_type_class_add_private (class, sizeof (GtkLabelPrivate));
552 gtk_label_set_property (GObject *object,
559 label = GTK_LABEL (object);
564 gtk_label_set_label (label, g_value_get_string (value));
566 case PROP_ATTRIBUTES:
567 gtk_label_set_attributes (label, g_value_get_boxed (value));
569 case PROP_USE_MARKUP:
570 gtk_label_set_use_markup (label, g_value_get_boolean (value));
572 case PROP_USE_UNDERLINE:
573 gtk_label_set_use_underline (label, g_value_get_boolean (value));
576 gtk_label_set_justify (label, g_value_get_enum (value));
579 gtk_label_set_pattern (label, g_value_get_string (value));
582 gtk_label_set_line_wrap (label, g_value_get_boolean (value));
584 case PROP_SELECTABLE:
585 gtk_label_set_selectable (label, g_value_get_boolean (value));
587 case PROP_MNEMONIC_WIDGET:
588 gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
591 gtk_label_set_ellipsize (label, g_value_get_enum (value));
593 case PROP_WIDTH_CHARS:
594 gtk_label_set_width_chars (label, g_value_get_int (value));
596 case PROP_SINGLE_LINE_MODE:
597 gtk_label_set_single_line_mode (label, g_value_get_boolean (value));
600 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
606 gtk_label_get_property (GObject *object,
613 label = GTK_LABEL (object);
618 g_value_set_string (value, label->label);
620 case PROP_ATTRIBUTES:
621 g_value_set_boxed (value, label->attrs);
623 case PROP_USE_MARKUP:
624 g_value_set_boolean (value, label->use_markup);
626 case PROP_USE_UNDERLINE:
627 g_value_set_boolean (value, label->use_underline);
630 g_value_set_enum (value, label->jtype);
633 g_value_set_boolean (value, label->wrap);
635 case PROP_SELECTABLE:
636 g_value_set_boolean (value, gtk_label_get_selectable (label));
638 case PROP_MNEMONIC_KEYVAL:
639 g_value_set_uint (value, label->mnemonic_keyval);
641 case PROP_MNEMONIC_WIDGET:
642 g_value_set_object (value, (GObject*) label->mnemonic_widget);
644 case PROP_CURSOR_POSITION:
645 if (label->select_info)
647 gint offset = g_utf8_pointer_to_offset (label->text,
648 label->text + label->select_info->selection_end);
649 g_value_set_int (value, offset);
652 g_value_set_int (value, 0);
654 case PROP_SELECTION_BOUND:
655 if (label->select_info)
657 gint offset = g_utf8_pointer_to_offset (label->text,
658 label->text + label->select_info->selection_anchor);
659 g_value_set_int (value, offset);
662 g_value_set_int (value, 0);
665 g_value_set_enum (value, label->ellipsize);
667 case PROP_WIDTH_CHARS:
668 g_value_set_enum (value, gtk_label_get_width_chars (label));
670 case PROP_SINGLE_LINE_MODE:
671 g_value_set_boolean (value, gtk_label_get_single_line_mode (label));
675 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
681 gtk_label_init (GtkLabel *label)
683 GtkLabelPrivate *priv;
685 GTK_WIDGET_SET_FLAGS (label, GTK_NO_WINDOW);
687 priv = GTK_LABEL_GET_PRIVATE (label);
688 priv->width_chars = -1;
692 label->jtype = GTK_JUSTIFY_LEFT;
694 label->ellipsize = PANGO_ELLIPSIZE_NONE;
696 label->use_underline = FALSE;
697 label->use_markup = FALSE;
699 label->mnemonic_keyval = GDK_VoidSymbol;
700 label->layout = NULL;
704 label->mnemonic_widget = NULL;
705 label->mnemonic_window = NULL;
707 gtk_label_set_text (label, "");
712 * @str: The text of the label
714 * Creates a new label with the given text inside it. You can
715 * pass %NULL to get an empty label widget.
717 * Return value: the new #GtkLabel
720 gtk_label_new (const gchar *str)
724 label = g_object_new (GTK_TYPE_LABEL, NULL);
727 gtk_label_set_text (label, str);
729 return GTK_WIDGET (label);
733 * gtk_label_new_with_mnemonic:
734 * @str: The text of the label, with an underscore in front of the
737 * Creates a new #GtkLabel, containing the text in @str.
739 * If characters in @str are preceded by an underscore, they are
740 * underlined. If you need a literal underscore character in a label, use
741 * '__' (two underscores). The first underlined character represents a
742 * keyboard accelerator called a mnemonic. The mnemonic key can be used
743 * to activate another widget, chosen automatically, or explicitly using
744 * gtk_label_set_mnemonic_widget().
746 * If gtk_label_set_mnemonic_widget()
747 * is not called, then the first activatable ancestor of the #GtkLabel
748 * will be chosen as the mnemonic widget. For instance, if the
749 * label is inside a button or menu item, the button or menu item will
750 * automatically become the mnemonic widget and be activated by
753 * Return value: the new #GtkLabel
756 gtk_label_new_with_mnemonic (const gchar *str)
760 label = g_object_new (GTK_TYPE_LABEL, NULL);
763 gtk_label_set_text_with_mnemonic (label, str);
765 return GTK_WIDGET (label);
769 gtk_label_mnemonic_activate (GtkWidget *widget,
770 gboolean group_cycling)
774 if (GTK_LABEL (widget)->mnemonic_widget)
775 return gtk_widget_mnemonic_activate (GTK_LABEL (widget)->mnemonic_widget, group_cycling);
777 /* Try to find the widget to activate by traversing the
780 parent = widget->parent;
782 if (parent && GTK_IS_NOTEBOOK (parent))
787 if (GTK_WIDGET_CAN_FOCUS (parent) ||
788 (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
789 (parent->parent && GTK_IS_NOTEBOOK (parent->parent)) ||
790 (GTK_IS_MENU_ITEM (parent)))
791 return gtk_widget_mnemonic_activate (parent, group_cycling);
792 parent = parent->parent;
795 /* barf if there was nothing to activate */
796 g_warning ("Couldn't find a target for a mnemonic activation.");
797 gdk_display_beep (gtk_widget_get_display (widget));
803 gtk_label_setup_mnemonic (GtkLabel *label,
808 if (last_key != GDK_VoidSymbol && label->mnemonic_window)
810 gtk_window_remove_mnemonic (label->mnemonic_window,
813 label->mnemonic_window = NULL;
816 if (label->mnemonic_keyval == GDK_VoidSymbol)
819 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (label));
820 if (GTK_WIDGET_TOPLEVEL (toplevel))
822 gtk_window_add_mnemonic (GTK_WINDOW (toplevel),
823 label->mnemonic_keyval,
825 label->mnemonic_window = GTK_WINDOW (toplevel);
830 gtk_label_hierarchy_changed (GtkWidget *widget,
831 GtkWidget *old_toplevel)
833 GtkLabel *label = GTK_LABEL (widget);
835 gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
839 gtk_label_screen_changed (GtkWidget *widget,
840 GdkScreen *old_screen)
842 gtk_label_clear_layout (GTK_LABEL (widget));
846 label_mnemonic_widget_weak_notify (gpointer data,
847 GObject *where_the_object_was)
849 GtkLabel *label = data;
851 label->mnemonic_widget = NULL;
852 g_object_notify (G_OBJECT (label), "mnemonic_widget");
856 * gtk_label_set_mnemonic_widget:
857 * @label: a #GtkLabel
858 * @widget: the target #GtkWidget
860 * If the label has been set so that it has an mnemonic key (using
861 * i.e. gtk_label_set_markup_with_mnemonic(),
862 * gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
863 * or the "use_underline" property) the label can be associated with a
864 * widget that is the target of the mnemonic. When the label is inside
865 * a widget (like a #GtkButton or a #GtkNotebook tab) it is
866 * automatically associated with the correct widget, but sometimes
867 * (i.e. when the target is a #GtkEntry next to the label) you need to
868 * set it explicitly using this function.
870 * The target widget will be accelerated by emitting "mnemonic_activate" on it.
871 * The default handler for this signal will activate the widget if there are no
872 * mnemonic collisions and toggle focus between the colliding widgets otherwise.
875 gtk_label_set_mnemonic_widget (GtkLabel *label,
878 g_return_if_fail (GTK_IS_LABEL (label));
880 g_return_if_fail (GTK_IS_WIDGET (widget));
882 if (label->mnemonic_widget)
884 gtk_widget_remove_mnemonic_label (label->mnemonic_widget, GTK_WIDGET (label));
885 g_object_weak_unref (G_OBJECT (label->mnemonic_widget),
886 label_mnemonic_widget_weak_notify,
889 label->mnemonic_widget = widget;
890 if (label->mnemonic_widget)
892 g_object_weak_ref (G_OBJECT (label->mnemonic_widget),
893 label_mnemonic_widget_weak_notify,
895 gtk_widget_add_mnemonic_label (label->mnemonic_widget, GTK_WIDGET (label));
898 g_object_notify (G_OBJECT (label), "mnemonic_widget");
902 * gtk_label_get_mnemonic_widget:
903 * @label: a #GtkLabel
905 * Retrieves the target of the mnemonic (keyboard shortcut) of this
906 * label. See gtk_label_set_mnemonic_widget ().
908 * Return value: the target of the label's mnemonic, or %NULL if none
909 * has been set and the default algorithm will be used.
912 gtk_label_get_mnemonic_widget (GtkLabel *label)
914 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
916 return label->mnemonic_widget;
920 * gtk_label_get_mnemonic_keyval:
921 * @label: a #GtkLabel
923 * If the label has been set so that it has an mnemonic key this function
924 * returns the keyval used for the mnemonic accelerator. If there is no
925 * mnemonic set up it returns #GDK_VoidSymbol.
927 * Returns: GDK keyval usable for accelerators, or #GDK_VoidSymbol
930 gtk_label_get_mnemonic_keyval (GtkLabel *label)
932 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);
934 return label->mnemonic_keyval;
938 gtk_label_set_text_internal (GtkLabel *label,
941 g_free (label->text);
945 gtk_label_select_region_index (label, 0, 0);
949 gtk_label_set_label_internal (GtkLabel *label,
952 g_free (label->label);
956 g_object_notify (G_OBJECT (label), "label");
960 gtk_label_set_use_markup_internal (GtkLabel *label,
964 if (label->use_markup != val)
966 g_object_notify (G_OBJECT (label), "use_markup");
967 label->use_markup = val;
972 gtk_label_set_use_underline_internal (GtkLabel *label,
976 if (label->use_underline != val)
978 g_object_notify (G_OBJECT (label), "use_underline");
979 label->use_underline = val;
984 gtk_label_set_attributes_internal (GtkLabel *label,
985 PangoAttrList *attrs)
988 pango_attr_list_ref (attrs);
991 pango_attr_list_unref (label->attrs);
993 if (!label->use_markup && !label->use_underline)
996 pango_attr_list_ref (attrs);
997 if (label->effective_attrs)
998 pango_attr_list_unref (label->effective_attrs);
999 label->effective_attrs = attrs;
1002 label->attrs = attrs;
1003 g_object_notify (G_OBJECT (label), "attributes");
1007 /* Calculates text, attrs and mnemonic_keyval from
1008 * label, use_underline and use_markup
1011 gtk_label_recalculate (GtkLabel *label)
1013 if (label->use_markup)
1014 set_markup (label, label->label, label->use_underline);
1017 if (label->use_underline)
1018 gtk_label_set_uline_text_internal (label, label->label);
1021 gtk_label_set_text_internal (label, g_strdup (label->label));
1023 pango_attr_list_ref (label->attrs);
1024 if (label->effective_attrs)
1025 pango_attr_list_unref (label->effective_attrs);
1026 label->effective_attrs = label->attrs;
1030 if (!label->use_underline)
1032 guint keyval = label->mnemonic_keyval;
1034 label->mnemonic_keyval = GDK_VoidSymbol;
1035 gtk_label_setup_mnemonic (label, keyval);
1038 gtk_label_clear_layout (label);
1039 gtk_widget_queue_resize (GTK_WIDGET (label));
1043 * gtk_label_set_text:
1044 * @label: a #GtkLabel
1045 * @str: The text you want to set.
1047 * Sets the text within the #GtkLabel widget. It overwrites any text that
1050 * This will also clear any previously set mnemonic accelerators.
1053 gtk_label_set_text (GtkLabel *label,
1056 g_return_if_fail (GTK_IS_LABEL (label));
1058 g_object_freeze_notify (G_OBJECT (label));
1060 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1061 gtk_label_set_use_markup_internal (label, FALSE);
1062 gtk_label_set_use_underline_internal (label, FALSE);
1064 gtk_label_recalculate (label);
1066 g_object_thaw_notify (G_OBJECT (label));
1070 * gtk_label_set_attributes:
1071 * @label: a #GtkLabel
1072 * @attrs: a #PangoAttrList
1074 * Sets a #PangoAttrList; the attributes in the list are applied to the
1075 * label text. The attributes set with this function will be ignored
1076 * if the "use_underline" property or the "use_markup" property
1080 gtk_label_set_attributes (GtkLabel *label,
1081 PangoAttrList *attrs)
1083 g_return_if_fail (GTK_IS_LABEL (label));
1085 gtk_label_set_attributes_internal (label, attrs);
1087 gtk_label_clear_layout (label);
1088 gtk_widget_queue_resize (GTK_WIDGET (label));
1092 * gtk_label_get_attributes:
1093 * @label: a #GtkLabel
1095 * Gets the attribute list that was set on the label using
1096 * gtk_label_set_attributes(), if any. This function does
1097 * not reflect attributes that come from the labels markup
1098 * (see gtk_label_set_markup()). If you want to get the
1099 * effective attributes for the label, use
1100 * pango_layout_get_attribute (gtk_label_get_layout (label)).
1102 * Return value: the attribute list, or %NULL if none was set.
1105 gtk_label_get_attributes (GtkLabel *label)
1107 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1109 return label->attrs;
1113 * gtk_label_set_label:
1114 * @label: a #GtkLabel
1115 * @str: the new text to set for the label
1117 * Sets the text of the label. The label is interpreted as
1118 * including embedded underlines and/or Pango markup depending
1119 * on the values of label->use_underline and label->use_markup.
1122 gtk_label_set_label (GtkLabel *label,
1127 g_return_if_fail (GTK_IS_LABEL (label));
1128 g_return_if_fail (str != NULL);
1130 last_keyval = label->mnemonic_keyval;
1132 gtk_label_set_label_internal (label, g_strdup (str));
1133 gtk_label_recalculate (label);
1134 if (last_keyval != label->mnemonic_keyval)
1135 gtk_label_setup_mnemonic (label, last_keyval);
1139 * gtk_label_get_label:
1140 * @label: a #GtkLabel
1142 * Fetches the text from a label widget including any embedded
1143 * underlines indicating mnemonics and Pango markup. (See
1144 * gtk_label_get_text ()).
1146 * Return value: the text of the label widget. This string is
1147 * owned by the widget and must not be modified or freed.
1149 G_CONST_RETURN gchar *
1150 gtk_label_get_label (GtkLabel *label)
1152 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1154 return label->label;
1158 set_markup (GtkLabel *label,
1160 gboolean with_uline)
1163 GError *error = NULL;
1164 PangoAttrList *attrs = NULL;
1165 gunichar accel_char = 0;
1167 if (!pango_parse_markup (str,
1169 with_uline ? '_' : 0,
1172 with_uline ? &accel_char : NULL,
1175 g_warning ("Failed to set label from markup due to error parsing markup: %s",
1177 g_error_free (error);
1182 gtk_label_set_text_internal (label, text);
1186 if (label->effective_attrs)
1187 pango_attr_list_unref (label->effective_attrs);
1188 label->effective_attrs = attrs;
1191 if (accel_char != 0)
1192 label->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
1194 label->mnemonic_keyval = GDK_VoidSymbol;
1198 * gtk_label_set_markup:
1199 * @label: a #GtkLabel
1200 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
1202 * Parses @str which is marked up with the <link
1203 * linkend="PangoMarkupFormat">Pango text markup language</link>, setting the
1204 * label's text and attribute list based on the parse results. If the @str is
1205 * external data, you may need to escape it with g_markup_escape_text() or
1206 * g_markup_printf_escaped()<!-- -->:
1207 * <informalexample><programlisting>
1210 * markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str);
1211 * gtk_label_set_markup (GTK_LABEL (label), markup);
1213 * </programlisting></informalexample>
1216 gtk_label_set_markup (GtkLabel *label,
1219 g_return_if_fail (GTK_IS_LABEL (label));
1221 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1222 gtk_label_set_use_markup_internal (label, TRUE);
1223 gtk_label_set_use_underline_internal (label, FALSE);
1225 gtk_label_recalculate (label);
1229 * gtk_label_set_markup_with_mnemonic:
1230 * @label: a #GtkLabel
1231 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
1233 * Parses @str which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>,
1234 * setting the label's text and attribute list based on the parse results.
1235 * If characters in @str are preceded by an underscore, they are underlined
1236 * indicating that they represent a keyboard accelerator called a mnemonic.
1238 * The mnemonic key can be used to activate another widget, chosen automatically,
1239 * or explicitly using gtk_label_set_mnemonic_widget().
1242 gtk_label_set_markup_with_mnemonic (GtkLabel *label,
1246 g_return_if_fail (GTK_IS_LABEL (label));
1248 last_keyval = label->mnemonic_keyval;
1249 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1250 gtk_label_set_use_markup_internal (label, TRUE);
1251 gtk_label_set_use_underline_internal (label, TRUE);
1253 gtk_label_recalculate (label);
1254 gtk_label_setup_mnemonic (label, last_keyval);
1258 * gtk_label_get_text:
1259 * @label: a #GtkLabel
1261 * Fetches the text from a label widget, as displayed on the
1262 * screen. This does not include any embedded underlines
1263 * indicating mnemonics or Pango markup. (See gtk_label_get_label())
1265 * Return value: the text in the label widget. This is the internal
1266 * string used by the label, and must not be modified.
1268 G_CONST_RETURN gchar *
1269 gtk_label_get_text (GtkLabel *label)
1271 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1276 static PangoAttrList *
1277 gtk_label_pattern_to_attrs (GtkLabel *label,
1278 const gchar *pattern)
1281 const char *p = label->text;
1282 const char *q = pattern;
1283 PangoAttrList *attrs;
1285 attrs = pango_attr_list_new ();
1289 while (*p && *q && *q != '_')
1291 p = g_utf8_next_char (p);
1295 while (*p && *q && *q == '_')
1297 p = g_utf8_next_char (p);
1303 PangoAttribute *attr = pango_attr_underline_new (PANGO_UNDERLINE_LOW);
1304 attr->start_index = start - label->text;
1305 attr->end_index = p - label->text;
1307 pango_attr_list_insert (attrs, attr);
1317 gtk_label_set_pattern_internal (GtkLabel *label,
1318 const gchar *pattern)
1320 PangoAttrList *attrs;
1321 g_return_if_fail (GTK_IS_LABEL (label));
1324 attrs = gtk_label_pattern_to_attrs (label, pattern);
1328 if (label->effective_attrs)
1329 pango_attr_list_unref (label->effective_attrs);
1330 label->effective_attrs = attrs;
1334 gtk_label_set_pattern (GtkLabel *label,
1335 const gchar *pattern)
1337 g_return_if_fail (GTK_IS_LABEL (label));
1339 gtk_label_set_pattern_internal (label, pattern);
1341 gtk_label_clear_layout (label);
1342 gtk_widget_queue_resize (GTK_WIDGET (label));
1347 * gtk_label_set_justify:
1348 * @label: a #GtkLabel
1349 * @jtype: a #GtkJustification
1351 * Sets the alignment of the lines in the text of the label relative to
1352 * each other. %GTK_JUSTIFY_LEFT is the default value when the
1353 * widget is first created with gtk_label_new(). If you instead want
1354 * to set the alignment of the label as a whole, use
1355 * gtk_misc_set_alignment() instead. gtk_label_set_justify() has no
1356 * effect on labels containing only a single line.
1359 gtk_label_set_justify (GtkLabel *label,
1360 GtkJustification jtype)
1362 g_return_if_fail (GTK_IS_LABEL (label));
1363 g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
1365 if ((GtkJustification) label->jtype != jtype)
1367 label->jtype = jtype;
1369 /* No real need to be this drastic, but easier than duplicating the code */
1370 gtk_label_clear_layout (label);
1372 g_object_notify (G_OBJECT (label), "justify");
1373 gtk_widget_queue_resize (GTK_WIDGET (label));
1378 * gtk_label_get_justify:
1379 * @label: a #GtkLabel
1381 * Returns the justification of the label. See gtk_label_set_justify ().
1383 * Return value: #GtkJustification
1386 gtk_label_get_justify (GtkLabel *label)
1388 g_return_val_if_fail (GTK_IS_LABEL (label), 0);
1390 return label->jtype;
1395 * gtk_label_set_ellipsize:
1396 * @label: a #GtkLabel
1397 * @mode: a #PangoEllipsizeMode
1399 * Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there
1400 * is not enough space to render the entire string.
1405 gtk_label_set_ellipsize (GtkLabel *label,
1406 PangoEllipsizeMode mode)
1408 g_return_if_fail (GTK_IS_LABEL (label));
1409 g_return_if_fail (mode >= PANGO_ELLIPSIZE_NONE && mode <= PANGO_ELLIPSIZE_END);
1411 if ((PangoEllipsizeMode) label->ellipsize != mode)
1413 label->ellipsize = mode;
1415 /* No real need to be this drastic, but easier than duplicating the code */
1416 gtk_label_clear_layout (label);
1418 g_object_notify (G_OBJECT (label), "ellipsize");
1419 gtk_widget_queue_resize (GTK_WIDGET (label));
1424 * gtk_label_get_ellipsize:
1425 * @label: a #GtkLabel
1427 * Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
1429 * Return value: #PangoEllipsizeMode
1434 gtk_label_get_ellipsize (GtkLabel *label)
1436 g_return_val_if_fail (GTK_IS_LABEL (label), PANGO_ELLIPSIZE_NONE);
1438 return label->ellipsize;
1442 * gtk_label_set_width_chars:
1443 * @label: a #GtkLabel
1444 * @n_chars: the new desired width, in characters.
1446 * Sets the desired width in characters of @label to @n_chars.
1451 gtk_label_set_width_chars (GtkLabel *label,
1454 GtkLabelPrivate *priv;
1456 g_return_if_fail (GTK_IS_LABEL (label));
1458 priv = GTK_LABEL_GET_PRIVATE (label);
1460 if (priv->width_chars != n_chars)
1462 priv->width_chars = n_chars;
1463 g_object_notify (G_OBJECT (label), "width-chars");
1464 gtk_widget_queue_resize (GTK_WIDGET (label));
1469 * gtk_label_get_width_chars:
1470 * @label: a #GtkLabel
1472 * Retrieves the desired width of @label, in characters. See
1473 * gtk_label_set_width_chars().
1475 * Return value: the width of a label in characters.
1480 gtk_label_get_width_chars (GtkLabel *label)
1482 g_return_val_if_fail (GTK_IS_LABEL (label), -1);
1484 return GTK_LABEL_GET_PRIVATE (label)->width_chars;
1488 * gtk_label_set_line_wrap:
1489 * @label: a #GtkLabel
1490 * @wrap: the setting
1492 * Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
1493 * lines if text exceeds the widget's size. %FALSE lets the text get cut off
1494 * by the edge of the widget if it exceeds the widget size.
1497 gtk_label_set_line_wrap (GtkLabel *label,
1500 g_return_if_fail (GTK_IS_LABEL (label));
1502 wrap = wrap != FALSE;
1504 if (label->wrap != wrap)
1507 g_object_notify (G_OBJECT (label), "wrap");
1509 gtk_widget_queue_resize (GTK_WIDGET (label));
1514 * gtk_label_get_line_wrap:
1515 * @label: a #GtkLabel
1517 * Returns whether lines in the label are automatically wrapped. See gtk_label_set_line_wrap ().
1519 * Return value: %TRUE if the lines of the label are automatically wrapped.
1522 gtk_label_get_line_wrap (GtkLabel *label)
1524 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
1530 gtk_label_get (GtkLabel *label,
1533 g_return_if_fail (GTK_IS_LABEL (label));
1534 g_return_if_fail (str != NULL);
1540 gtk_label_destroy (GtkObject *object)
1542 GtkLabel *label = GTK_LABEL (object);
1544 gtk_label_set_mnemonic_widget (label, NULL);
1546 GTK_OBJECT_CLASS (parent_class)->destroy (object);
1550 gtk_label_finalize (GObject *object)
1554 g_return_if_fail (GTK_IS_LABEL (object));
1556 label = GTK_LABEL (object);
1558 g_free (label->label);
1559 g_free (label->text);
1562 g_object_unref (label->layout);
1565 pango_attr_list_unref (label->attrs);
1567 if (label->effective_attrs)
1568 pango_attr_list_unref (label->effective_attrs);
1570 g_free (label->select_info);
1572 G_OBJECT_CLASS (parent_class)->finalize (object);
1576 gtk_label_clear_layout (GtkLabel *label)
1580 g_object_unref (label->layout);
1581 label->layout = NULL;
1585 typedef struct _LabelWrapWidth LabelWrapWidth;
1586 struct _LabelWrapWidth
1589 PangoFontDescription *font_desc;
1593 label_wrap_width_free (gpointer data)
1595 LabelWrapWidth *wrap_width = data;
1596 pango_font_description_free (wrap_width->font_desc);
1597 g_free (wrap_width);
1601 get_label_wrap_width (GtkLabel *label)
1603 PangoLayout *layout;
1604 GtkStyle *style = GTK_WIDGET (label)->style;
1606 LabelWrapWidth *wrap_width = g_object_get_data (G_OBJECT (style), "gtk-label-wrap-width");
1609 wrap_width = g_new0 (LabelWrapWidth, 1);
1610 g_object_set_data_full (G_OBJECT (style), "gtk-label-wrap-width",
1611 wrap_width, label_wrap_width_free);
1614 if (wrap_width->font_desc && pango_font_description_equal (wrap_width->font_desc, style->font_desc))
1615 return wrap_width->width;
1617 if (wrap_width->font_desc)
1618 pango_font_description_free (wrap_width->font_desc);
1620 wrap_width->font_desc = pango_font_description_copy (style->font_desc);
1622 layout = gtk_widget_create_pango_layout (GTK_WIDGET (label),
1623 "This long string gives a good enough length for any line to have.");
1624 pango_layout_get_size (layout, &wrap_width->width, NULL);
1625 g_object_unref (layout);
1627 return wrap_width->width;
1631 gtk_label_ensure_layout (GtkLabel *label)
1634 PangoRectangle logical_rect;
1635 gint rwidth, rheight;
1638 widget = GTK_WIDGET (label);
1640 rtl = gtk_widget_get_direction(widget) == GTK_TEXT_DIR_RTL;
1641 rwidth = label->misc.xpad * 2;
1642 rheight = label->misc.ypad * 2;
1646 PangoAlignment align = PANGO_ALIGN_LEFT; /* Quiet gcc */
1647 GtkLabelPrivate *priv = GTK_LABEL_GET_PRIVATE (label);
1649 label->layout = gtk_widget_create_pango_layout (widget, label->text);
1651 if (label->effective_attrs)
1652 pango_layout_set_attributes (label->layout, label->effective_attrs);
1654 switch (label->jtype)
1656 case GTK_JUSTIFY_LEFT:
1657 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
1659 case GTK_JUSTIFY_RIGHT:
1660 align = rtl ? PANGO_ALIGN_LEFT : PANGO_ALIGN_RIGHT;
1662 case GTK_JUSTIFY_CENTER:
1663 align = PANGO_ALIGN_CENTER;
1665 case GTK_JUSTIFY_FILL:
1666 /* FIXME: This just doesn't work to do this */
1667 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
1668 pango_layout_set_justify (label->layout, TRUE);
1671 g_assert_not_reached();
1674 pango_layout_set_alignment (label->layout, align);
1675 pango_layout_set_ellipsize (label->layout, label->ellipsize);
1676 pango_layout_set_single_paragraph_mode (label->layout, priv->single_line_mode);
1678 if (label->ellipsize)
1679 pango_layout_set_width (label->layout,
1680 widget->allocation.width * PANGO_SCALE);
1681 else if (label->wrap)
1683 GtkWidgetAuxInfo *aux_info;
1684 gint longest_paragraph;
1687 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
1688 if (aux_info && aux_info->width > 0)
1689 pango_layout_set_width (label->layout, aux_info->width * PANGO_SCALE);
1692 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (label));
1695 pango_layout_set_width (label->layout, -1);
1696 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1698 width = logical_rect.width;
1700 /* Try to guess a reasonable maximum width */
1701 longest_paragraph = width;
1703 wrap_width = get_label_wrap_width (label);
1704 width = MIN (width, wrap_width);
1706 PANGO_SCALE * (gdk_screen_get_width (screen) + 1) / 2);
1708 pango_layout_set_width (label->layout, width);
1709 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1710 width = logical_rect.width;
1711 height = logical_rect.height;
1713 /* Unfortunately, the above may leave us with a very unbalanced looking paragraph,
1714 * so we try short search for a narrower width that leaves us with the same height
1716 if (longest_paragraph > 0)
1718 gint nlines, perfect_width;
1720 nlines = pango_layout_get_line_count (label->layout);
1721 perfect_width = (longest_paragraph + nlines - 1) / nlines;
1723 if (perfect_width < width)
1725 pango_layout_set_width (label->layout, perfect_width);
1726 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1728 if (logical_rect.height <= height)
1729 width = logical_rect.width;
1732 gint mid_width = (perfect_width + width) / 2;
1734 if (mid_width > perfect_width)
1736 pango_layout_set_width (label->layout, mid_width);
1737 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1739 if (logical_rect.height <= height)
1740 width = logical_rect.width;
1745 pango_layout_set_width (label->layout, width);
1748 else /* !label->wrap */
1749 pango_layout_set_width (label->layout, -1);
1754 gtk_label_size_request (GtkWidget *widget,
1755 GtkRequisition *requisition)
1758 GtkLabelPrivate *priv;
1760 PangoRectangle logical_rect;
1761 GtkWidgetAuxInfo *aux_info;
1763 g_return_if_fail (GTK_IS_LABEL (widget));
1764 g_return_if_fail (requisition != NULL);
1766 label = GTK_LABEL (widget);
1767 priv = GTK_LABEL_GET_PRIVATE (widget);
1770 * If word wrapping is on, then the height requisition can depend
1773 * - Any width set on the widget via gtk_widget_set_usize().
1774 * - The padding of the widget (xpad, set by gtk_misc_set_padding)
1776 * Instead of trying to detect changes to these quantities, if we
1777 * are wrapping, we just rewrap for each size request. Since
1778 * size requisitions are cached by the GTK+ core, this is not
1783 gtk_label_clear_layout (label);
1785 gtk_label_ensure_layout (label);
1787 width = label->misc.xpad * 2;
1788 height = label->misc.ypad * 2;
1790 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1791 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
1793 if (label->ellipsize || priv->width_chars > 0)
1795 PangoContext *context;
1796 PangoFontMetrics *metrics;
1799 /* The minimum size for ellipsized labels is ~ 3 chars */
1800 context = pango_layout_get_context (label->layout);
1801 metrics = pango_context_get_metrics (context, widget->style->font_desc, NULL);
1803 char_width = pango_font_metrics_get_approximate_char_width (metrics);
1804 pango_font_metrics_unref (metrics);
1806 width += (PANGO_PIXELS (char_width) * MAX (priv->width_chars, 3));
1810 if (label->wrap && aux_info && aux_info->width > 0)
1811 width += aux_info->width;
1813 width += PANGO_PIXELS (logical_rect.width);
1816 if (priv->single_line_mode)
1818 PangoContext *context;
1819 PangoFontMetrics *metrics;
1820 gint ascent, descent;
1822 context = pango_layout_get_context (label->layout);
1823 metrics = pango_context_get_metrics (context, widget->style->font_desc,
1824 pango_context_get_language (context));
1826 ascent = pango_font_metrics_get_ascent (metrics);
1827 descent = pango_font_metrics_get_descent (metrics);
1828 pango_font_metrics_unref (metrics);
1830 height += PANGO_PIXELS (ascent + descent);
1833 height += PANGO_PIXELS (logical_rect.height);
1835 requisition->width = width;
1836 requisition->height = height;
1840 gtk_label_size_allocate (GtkWidget *widget,
1841 GtkAllocation *allocation)
1845 label = GTK_LABEL (widget);
1847 (* GTK_WIDGET_CLASS (parent_class)->size_allocate) (widget, allocation);
1849 if (label->ellipsize)
1852 pango_layout_set_width (label->layout, allocation->width * PANGO_SCALE);
1855 if (label->select_info && label->select_info->window)
1857 gdk_window_move_resize (label->select_info->window,
1861 allocation->height);
1866 gtk_label_state_changed (GtkWidget *widget,
1867 GtkStateType prev_state)
1871 label = GTK_LABEL (widget);
1873 if (label->select_info)
1874 gtk_label_select_region (label, 0, 0);
1876 if (GTK_WIDGET_CLASS (parent_class)->state_changed)
1877 GTK_WIDGET_CLASS (parent_class)->state_changed (widget, prev_state);
1881 gtk_label_style_set (GtkWidget *widget,
1882 GtkStyle *previous_style)
1886 g_return_if_fail (GTK_IS_LABEL (widget));
1888 label = GTK_LABEL (widget);
1890 /* We have to clear the layout, fonts etc. may have changed */
1891 gtk_label_clear_layout (label);
1895 gtk_label_direction_changed (GtkWidget *widget,
1896 GtkTextDirection previous_dir)
1898 GtkLabel *label = GTK_LABEL (widget);
1901 pango_layout_context_changed (label->layout);
1903 GTK_WIDGET_CLASS (parent_class)->direction_changed (widget, previous_dir);
1908 gtk_label_paint_word (GtkLabel *label,
1914 GtkWidget *widget = GTK_WIDGET (label);
1915 GtkLabelULine *uline;
1918 tmp_str = gdk_wcstombs (word->beginning);
1921 gtk_paint_string (widget->style, widget->window, widget->state,
1922 area, widget, "label",
1929 for (uline = word->uline; uline; uline = uline->next)
1930 gtk_paint_hline (widget->style, widget->window,
1931 widget->state, area,
1933 x + uline->x1, x + uline->x2, y + uline->y);
1938 get_layout_location (GtkLabel *label,
1945 gint req_width, x, y;
1947 misc = GTK_MISC (label);
1948 widget = GTK_WIDGET (label);
1950 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
1951 xalign = misc->xalign;
1953 xalign = 1.0 - misc->xalign;
1955 if (label->ellipsize)
1957 PangoRectangle ink_rect;
1959 pango_layout_get_extents (label->layout, &ink_rect, NULL);
1961 req_width = PANGO_PIXELS (ink_rect.width);
1964 req_width = widget->requisition.width;
1966 x = floor (widget->allocation.x + (gint)misc->xpad +
1967 xalign * (widget->allocation.width - req_width)
1970 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
1971 x = MAX (x, widget->allocation.x + misc->xpad);
1974 widget->allocation.x + widget->allocation.width -
1975 req_width - misc->xpad);
1977 y = floor (widget->allocation.y + (gint)misc->ypad
1978 + MAX (((widget->allocation.height - widget->requisition.height) * misc->yalign)
1989 draw_insertion_cursor (GtkLabel *label,
1990 GdkRectangle *cursor_location,
1991 gboolean is_primary,
1992 PangoDirection direction,
1993 gboolean draw_arrow)
1995 GtkWidget *widget = GTK_WIDGET (label);
1996 GtkTextDirection text_dir;
1998 if (direction == PANGO_DIRECTION_LTR)
1999 text_dir = GTK_TEXT_DIR_LTR;
2001 text_dir = GTK_TEXT_DIR_RTL;
2003 gtk_draw_insertion_cursor (widget, widget->window, &(widget->allocation),
2005 is_primary, text_dir, draw_arrow);
2008 static PangoDirection
2009 get_cursor_direction (GtkLabel *label)
2013 g_assert (label->select_info);
2015 gtk_label_ensure_layout (label);
2017 for (l = pango_layout_get_lines (label->layout); l; l = l->next)
2019 PangoLayoutLine *line = l->data;
2021 /* If label->select_info->selection_end is at the very end of
2022 * the line, we don't know if the cursor is on this line or
2023 * the next without looking ahead at the next line. (End
2024 * of paragraph is different from line break.) But it's
2025 * definitely in this paragraph, which is good enough
2026 * to figure out the resolved direction.
2028 if (line->start_index + line->length >= label->select_info->selection_end)
2029 return line->resolved_dir;
2032 return PANGO_DIRECTION_LTR;
2036 gtk_label_draw_cursor (GtkLabel *label, gint xoffset, gint yoffset)
2038 if (label->select_info == NULL)
2041 if (GTK_WIDGET_DRAWABLE (label))
2043 GtkWidget *widget = GTK_WIDGET (label);
2045 PangoDirection keymap_direction;
2046 PangoDirection cursor_direction;
2047 PangoRectangle strong_pos, weak_pos;
2048 gboolean split_cursor;
2049 PangoRectangle *cursor1 = NULL;
2050 PangoRectangle *cursor2 = NULL;
2051 GdkRectangle cursor_location;
2052 PangoDirection dir1 = PANGO_DIRECTION_NEUTRAL;
2053 PangoDirection dir2 = PANGO_DIRECTION_NEUTRAL;
2055 keymap_direction = gdk_keymap_get_direction (gdk_keymap_get_for_display (gtk_widget_get_display (widget)));
2056 cursor_direction = get_cursor_direction (label);
2058 gtk_label_ensure_layout (label);
2060 pango_layout_get_cursor_pos (label->layout, label->select_info->selection_end,
2061 &strong_pos, &weak_pos);
2063 g_object_get (gtk_widget_get_settings (widget),
2064 "gtk-split-cursor", &split_cursor,
2067 dir1 = cursor_direction;
2071 cursor1 = &strong_pos;
2073 if (strong_pos.x != weak_pos.x ||
2074 strong_pos.y != weak_pos.y)
2076 dir2 = (cursor_direction == PANGO_DIRECTION_LTR) ? PANGO_DIRECTION_RTL : PANGO_DIRECTION_LTR;
2077 cursor2 = &weak_pos;
2082 if (keymap_direction == cursor_direction)
2083 cursor1 = &strong_pos;
2085 cursor1 = &weak_pos;
2088 cursor_location.x = xoffset + PANGO_PIXELS (cursor1->x);
2089 cursor_location.y = yoffset + PANGO_PIXELS (cursor1->y);
2090 cursor_location.width = 0;
2091 cursor_location.height = PANGO_PIXELS (cursor1->height);
2093 draw_insertion_cursor (label,
2094 &cursor_location, TRUE, dir1,
2095 dir2 != PANGO_DIRECTION_NEUTRAL);
2097 if (dir2 != PANGO_DIRECTION_NEUTRAL)
2099 cursor_location.x = xoffset + PANGO_PIXELS (cursor2->x);
2100 cursor_location.y = yoffset + PANGO_PIXELS (cursor2->y);
2101 cursor_location.width = 0;
2102 cursor_location.height = PANGO_PIXELS (cursor2->height);
2104 draw_insertion_cursor (label,
2105 &cursor_location, FALSE, dir2,
2113 gtk_label_expose (GtkWidget *widget,
2114 GdkEventExpose *event)
2119 g_return_val_if_fail (GTK_IS_LABEL (widget), FALSE);
2120 g_return_val_if_fail (event != NULL, FALSE);
2122 label = GTK_LABEL (widget);
2124 gtk_label_ensure_layout (label);
2126 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
2127 label->text && (*label->text != '\0'))
2129 get_layout_location (label, &x, &y);
2131 gtk_paint_layout (widget->style,
2133 GTK_WIDGET_STATE (widget),
2141 if (label->select_info &&
2142 (label->select_info->selection_anchor !=
2143 label->select_info->selection_end))
2149 range[0] = label->select_info->selection_anchor;
2150 range[1] = label->select_info->selection_end;
2152 if (range[0] > range[1])
2154 gint tmp = range[0];
2155 range[0] = range[1];
2159 clip = gdk_pango_layout_get_clip_region (label->layout,
2163 gdk_region_intersect (clip, event->region);
2165 /* FIXME should use gtk_paint, but it can't use a clip
2169 gdk_gc_set_clip_region (widget->style->black_gc, clip);
2172 state = GTK_STATE_SELECTED;
2173 if (!GTK_WIDGET_HAS_FOCUS (widget))
2174 state = GTK_STATE_ACTIVE;
2176 gdk_draw_layout_with_colors (widget->window,
2177 widget->style->black_gc,
2180 &widget->style->text[state],
2181 &widget->style->base[state]);
2183 gdk_gc_set_clip_region (widget->style->black_gc, NULL);
2184 gdk_region_destroy (clip);
2186 else if (label->select_info && GTK_WIDGET_HAS_FOCUS (widget))
2187 gtk_label_draw_cursor (label, x, y);
2194 gtk_label_set_uline_text_internal (GtkLabel *label,
2197 guint accel_key = GDK_VoidSymbol;
2202 gchar *dest, *pattern_dest;
2203 gboolean underscore;
2205 g_return_if_fail (GTK_IS_LABEL (label));
2206 g_return_if_fail (str != NULL);
2208 /* Split text into the base text and a separate pattern
2212 new_str = g_new (gchar, strlen (str) + 1);
2213 pattern = g_new (gchar, g_utf8_strlen (str, -1) + 1);
2222 pattern_dest = pattern;
2229 c = g_utf8_get_char (src);
2230 if (c == (gunichar)-1)
2232 g_warning ("Invalid input string");
2237 next_src = g_utf8_next_char (src);
2242 *pattern_dest++ = ' ';
2245 *pattern_dest++ = '_';
2246 if (accel_key == GDK_VoidSymbol)
2247 accel_key = gdk_keyval_to_lower (gdk_unicode_to_keyval (c));
2250 while (src < next_src)
2264 while (src < next_src)
2267 *pattern_dest++ = ' ';
2274 gtk_label_set_text_internal (label, new_str);
2275 gtk_label_set_pattern_internal (label, pattern);
2279 label->mnemonic_keyval = accel_key;
2283 gtk_label_parse_uline (GtkLabel *label,
2289 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);
2290 g_return_val_if_fail (str != NULL, GDK_VoidSymbol);
2292 orig_keyval = label->mnemonic_keyval;
2294 g_object_freeze_notify (G_OBJECT (label));
2296 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
2297 gtk_label_set_use_markup_internal (label, FALSE);
2298 gtk_label_set_use_underline_internal (label, TRUE);
2300 gtk_label_recalculate (label);
2302 keyval = label->mnemonic_keyval;
2303 label->mnemonic_keyval = GDK_VoidSymbol;
2305 gtk_label_setup_mnemonic (label, orig_keyval);
2307 g_object_thaw_notify (G_OBJECT (label));
2313 * gtk_label_set_text_with_mnemonic:
2314 * @label: a #GtkLabel
2317 * Sets the label's text from the string @str.
2318 * If characters in @str are preceded by an underscore, they are underlined
2319 * indicating that they represent a keyboard accelerator called a mnemonic.
2320 * The mnemonic key can be used to activate another widget, chosen automatically,
2321 * or explicitly using gtk_label_set_mnemonic_widget().
2324 gtk_label_set_text_with_mnemonic (GtkLabel *label,
2329 g_return_if_fail (GTK_IS_LABEL (label));
2330 g_return_if_fail (str != NULL);
2332 last_keyval = label->mnemonic_keyval;
2334 g_object_freeze_notify (G_OBJECT (label));
2336 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
2337 gtk_label_set_use_markup_internal (label, FALSE);
2338 gtk_label_set_use_underline_internal (label, TRUE);
2340 gtk_label_recalculate (label);
2342 gtk_label_setup_mnemonic (label, last_keyval);
2344 g_object_thaw_notify (G_OBJECT (label));
2348 gtk_label_realize (GtkWidget *widget)
2352 label = GTK_LABEL (widget);
2354 (* GTK_WIDGET_CLASS (parent_class)->realize) (widget);
2356 if (label->select_info)
2357 gtk_label_create_window (label);
2361 gtk_label_unrealize (GtkWidget *widget)
2365 label = GTK_LABEL (widget);
2367 if (label->select_info)
2368 gtk_label_destroy_window (label);
2370 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
2374 gtk_label_map (GtkWidget *widget)
2378 label = GTK_LABEL (widget);
2380 (* GTK_WIDGET_CLASS (parent_class)->map) (widget);
2382 if (label->select_info)
2383 gdk_window_show (label->select_info->window);
2387 gtk_label_unmap (GtkWidget *widget)
2391 label = GTK_LABEL (widget);
2393 if (label->select_info)
2394 gdk_window_hide (label->select_info->window);
2396 (* GTK_WIDGET_CLASS (parent_class)->unmap) (widget);
2400 window_to_layout_coords (GtkLabel *label,
2407 widget = GTK_WIDGET (label);
2409 /* get layout location in widget->window coords */
2410 get_layout_location (label, &lx, &ly);
2414 *x += widget->allocation.x; /* go to widget->window */
2415 *x -= lx; /* go to layout */
2420 *y += widget->allocation.y; /* go to widget->window */
2421 *y -= ly; /* go to layout */
2427 layout_to_window_coords (GtkLabel *label,
2434 widget = GTK_WIDGET (label);
2436 /* get layout location in widget->window coords */
2437 get_layout_location (label, &lx, &ly);
2441 *x += lx; /* go to widget->window */
2442 *x -= widget->allocation.x; /* go to selection window */
2447 *y += ly; /* go to widget->window */
2448 *y -= widget->allocation.y; /* go to selection window */
2454 get_layout_index (GtkLabel *label,
2460 const gchar *cluster;
2461 const gchar *cluster_end;
2465 gtk_label_ensure_layout (label);
2467 window_to_layout_coords (label, &x, &y);
2472 pango_layout_xy_to_index (label->layout,
2477 cluster = label->text + *index;
2478 cluster_end = cluster;
2481 cluster_end = g_utf8_next_char (cluster_end);
2485 *index += (cluster_end - cluster);
2489 gtk_label_select_word (GtkLabel *label)
2493 gint start_index = gtk_label_move_backward_word (label, label->select_info->selection_end);
2494 gint end_index = gtk_label_move_forward_word (label, label->select_info->selection_end);
2496 min = MIN (label->select_info->selection_anchor,
2497 label->select_info->selection_end);
2498 max = MAX (label->select_info->selection_anchor,
2499 label->select_info->selection_end);
2501 min = MIN (min, start_index);
2502 max = MAX (max, end_index);
2504 gtk_label_select_region_index (label, min, max);
2508 gtk_label_button_press (GtkWidget *widget,
2509 GdkEventButton *event)
2515 label = GTK_LABEL (widget);
2517 if (label->select_info == NULL)
2520 label->select_info->in_drag = FALSE;
2521 if (event->button == 1)
2523 if (!GTK_WIDGET_HAS_FOCUS (widget))
2524 gtk_widget_grab_focus (widget);
2526 if (event->type == GDK_3BUTTON_PRESS)
2528 gtk_label_select_region_index (label, 0, strlen (label->text));
2532 if (event->type == GDK_2BUTTON_PRESS)
2534 gtk_label_select_word (label);
2538 get_layout_index (label, event->x, event->y, &index);
2540 min = MIN (label->select_info->selection_anchor,
2541 label->select_info->selection_end);
2542 max = MAX (label->select_info->selection_anchor,
2543 label->select_info->selection_end);
2545 if ((label->select_info->selection_anchor !=
2546 label->select_info->selection_end) &&
2547 (event->state & GDK_SHIFT_MASK))
2549 /* extend (same as motion) */
2550 min = MIN (min, index);
2551 max = MAX (max, index);
2553 /* ensure the anchor is opposite index */
2561 gtk_label_select_region_index (label, min, max);
2565 if (event->type == GDK_3BUTTON_PRESS)
2566 gtk_label_select_region_index (label, 0, strlen (label->text));
2567 else if (event->type == GDK_2BUTTON_PRESS)
2568 gtk_label_select_word (label);
2569 else if (min < max && min <= index && index <= max)
2571 label->select_info->in_drag = TRUE;
2572 label->select_info->drag_start_x = event->x;
2573 label->select_info->drag_start_y = event->y;
2576 /* start a replacement */
2577 gtk_label_select_region_index (label, index, index);
2582 else if (event->button == 3 && event->type == GDK_BUTTON_PRESS)
2584 gtk_label_do_popup (label, event);
2593 gtk_label_button_release (GtkWidget *widget,
2594 GdkEventButton *event)
2597 GtkLabel *label = GTK_LABEL (widget);
2600 if (label->select_info == NULL)
2603 if (label->select_info->in_drag)
2605 label->select_info->in_drag = 0;
2607 get_layout_index (label, event->x, event->y, &index);
2608 gtk_label_select_region_index (label, index, index);
2613 if (event->button != 1)
2616 /* The goal here is to return TRUE iff we ate the
2617 * button press to start selecting.
2624 gtk_label_motion (GtkWidget *widget,
2625 GdkEventMotion *event)
2631 label = GTK_LABEL (widget);
2633 if (label->select_info == NULL)
2637 if ((event->state & GDK_BUTTON1_MASK) == 0)
2640 gdk_window_get_pointer (label->select_info->window,
2643 if (label->select_info->in_drag)
2645 if (gtk_drag_check_threshold (widget,
2646 label->select_info->drag_start_x,
2647 label->select_info->drag_start_y,
2648 event->x, event->y))
2650 GdkDragContext *context;
2651 GtkTargetList *target_list = gtk_target_list_new (NULL, 0);
2653 gtk_target_list_add_text_targets (target_list, 0);
2655 context = gtk_drag_begin (widget, target_list,
2657 1, (GdkEvent *)event);
2660 label->select_info->in_drag = FALSE;
2662 gtk_target_list_unref (target_list);
2663 gtk_drag_set_icon_default (context);
2668 get_layout_index (label, x, y, &index);
2670 gtk_label_select_region_index (label,
2671 label->select_info->selection_anchor,
2679 gtk_label_create_window (GtkLabel *label)
2682 GdkWindowAttr attributes;
2683 gint attributes_mask;
2685 g_assert (label->select_info);
2686 g_assert (GTK_WIDGET_REALIZED (label));
2688 if (label->select_info->window)
2691 widget = GTK_WIDGET (label);
2693 attributes.x = widget->allocation.x;
2694 attributes.y = widget->allocation.y;
2695 attributes.width = widget->allocation.width;
2696 attributes.height = widget->allocation.height;
2697 attributes.window_type = GDK_WINDOW_TEMP;
2698 attributes.wclass = GDK_INPUT_ONLY;
2699 attributes.override_redirect = TRUE;
2700 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
2702 attributes.event_mask = gtk_widget_get_events (widget) |
2703 GDK_BUTTON_PRESS_MASK |
2704 GDK_BUTTON_RELEASE_MASK |
2705 GDK_BUTTON_MOTION_MASK;
2707 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR | GDK_WA_CURSOR;
2709 label->select_info->window = gdk_window_new (widget->window,
2710 &attributes, attributes_mask);
2711 gdk_window_set_user_data (label->select_info->window, widget);
2713 gdk_cursor_unref (attributes.cursor);
2717 gtk_label_destroy_window (GtkLabel *label)
2719 g_assert (label->select_info);
2721 if (label->select_info->window == NULL)
2724 gdk_window_set_user_data (label->select_info->window, NULL);
2725 gdk_window_destroy (label->select_info->window);
2726 label->select_info->window = NULL;
2730 * gtk_label_set_selectable:
2731 * @label: a #GtkLabel
2732 * @setting: %TRUE to allow selecting text in the label
2734 * Selectable labels allow the user to select text from the label, for
2739 gtk_label_set_selectable (GtkLabel *label,
2742 gboolean old_setting;
2744 g_return_if_fail (GTK_IS_LABEL (label));
2746 setting = setting != FALSE;
2747 old_setting = label->select_info != NULL;
2751 if (label->select_info == NULL)
2753 label->select_info = g_new0 (GtkLabelSelectionInfo, 1);
2755 GTK_WIDGET_SET_FLAGS (label, GTK_CAN_FOCUS);
2757 if (GTK_WIDGET_REALIZED (label))
2758 gtk_label_create_window (label);
2760 if (GTK_WIDGET_MAPPED (label))
2761 gdk_window_show (label->select_info->window);
2766 if (label->select_info)
2768 /* unselect, to give up the selection */
2769 gtk_label_select_region (label, 0, 0);
2771 if (label->select_info->window)
2773 gtk_label_destroy_window (label);
2776 g_free (label->select_info);
2778 label->select_info = NULL;
2780 GTK_WIDGET_UNSET_FLAGS (label, GTK_CAN_FOCUS);
2783 if (setting != old_setting)
2785 g_object_freeze_notify (G_OBJECT (label));
2786 g_object_notify (G_OBJECT (label), "selectable");
2787 g_object_notify (G_OBJECT (label), "cursor_position");
2788 g_object_notify (G_OBJECT (label), "selection_bound");
2789 g_object_thaw_notify (G_OBJECT (label));
2790 gtk_widget_queue_draw (GTK_WIDGET (label));
2795 * gtk_label_get_selectable:
2796 * @label: a #GtkLabel
2798 * Gets the value set by gtk_label_set_selectable().
2800 * Return value: %TRUE if the user can copy text from the label
2803 gtk_label_get_selectable (GtkLabel *label)
2805 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
2807 return label->select_info != NULL;
2811 gtk_label_set_selection_text (GtkLabel *label,
2812 GtkSelectionData *selection_data)
2814 if ((label->select_info->selection_anchor !=
2815 label->select_info->selection_end) &&
2821 start = MIN (label->select_info->selection_anchor,
2822 label->select_info->selection_end);
2823 end = MAX (label->select_info->selection_anchor,
2824 label->select_info->selection_end);
2826 len = strlen (label->text);
2834 gtk_selection_data_set_text (selection_data,
2835 label->text + start,
2841 gtk_label_drag_data_get (GtkWidget *widget,
2842 GdkDragContext *context,
2843 GtkSelectionData *selection_data,
2847 gtk_label_set_selection_text (GTK_LABEL (widget), selection_data);
2851 get_text_callback (GtkClipboard *clipboard,
2852 GtkSelectionData *selection_data,
2854 gpointer user_data_or_owner)
2856 gtk_label_set_selection_text (GTK_LABEL (user_data_or_owner), selection_data);
2860 clear_text_callback (GtkClipboard *clipboard,
2861 gpointer user_data_or_owner)
2865 label = GTK_LABEL (user_data_or_owner);
2867 if (label->select_info)
2869 label->select_info->selection_anchor = label->select_info->selection_end;
2871 gtk_widget_queue_draw (GTK_WIDGET (label));
2876 gtk_label_select_region_index (GtkLabel *label,
2880 static const GtkTargetEntry targets[] = {
2883 { "COMPOUND_TEXT", 0, 0 },
2884 { "UTF8_STRING", 0, 0 }
2887 g_return_if_fail (GTK_IS_LABEL (label));
2889 if (label->select_info)
2891 GtkClipboard *clipboard;
2893 if (label->select_info->selection_anchor == anchor_index &&
2894 label->select_info->selection_end == end_index)
2897 label->select_info->selection_anchor = anchor_index;
2898 label->select_info->selection_end = end_index;
2900 clipboard = gtk_widget_get_clipboard (GTK_WIDGET (label),
2901 GDK_SELECTION_PRIMARY);
2903 if (anchor_index != end_index)
2905 gtk_clipboard_set_with_owner (clipboard,
2907 G_N_ELEMENTS (targets),
2909 clear_text_callback,
2914 if (gtk_clipboard_get_owner (clipboard) == G_OBJECT (label))
2915 gtk_clipboard_clear (clipboard);
2918 gtk_widget_queue_draw (GTK_WIDGET (label));
2920 g_object_freeze_notify (G_OBJECT (label));
2921 g_object_notify (G_OBJECT (label), "cursor_position");
2922 g_object_notify (G_OBJECT (label), "selection_bound");
2923 g_object_thaw_notify (G_OBJECT (label));
2928 * gtk_label_select_region:
2929 * @label: a #GtkLabel
2930 * @start_offset: start offset (in characters not bytes)
2931 * @end_offset: end offset (in characters not bytes)
2933 * Selects a range of characters in the label, if the label is selectable.
2934 * See gtk_label_set_selectable(). If the label is not selectable,
2935 * this function has no effect. If @start_offset or
2936 * @end_offset are -1, then the end of the label will be substituted.
2940 gtk_label_select_region (GtkLabel *label,
2944 g_return_if_fail (GTK_IS_LABEL (label));
2946 if (label->text && label->select_info)
2948 if (start_offset < 0)
2949 start_offset = g_utf8_strlen (label->text, -1);
2952 end_offset = g_utf8_strlen (label->text, -1);
2954 gtk_label_select_region_index (label,
2955 g_utf8_offset_to_pointer (label->text, start_offset) - label->text,
2956 g_utf8_offset_to_pointer (label->text, end_offset) - label->text);
2961 * gtk_label_get_selection_bounds:
2962 * @label: a #GtkLabel
2963 * @start: return location for start of selection, as a character offset
2964 * @end: return location for end of selection, as a character offset
2966 * Gets the selected range of characters in the label, returning %TRUE
2967 * if there's a selection.
2969 * Return value: %TRUE if selection is non-empty
2972 gtk_label_get_selection_bounds (GtkLabel *label,
2976 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
2978 if (label->select_info == NULL)
2980 /* not a selectable label */
2990 gint start_index, end_index;
2991 gint start_offset, end_offset;
2994 start_index = MIN (label->select_info->selection_anchor,
2995 label->select_info->selection_end);
2996 end_index = MAX (label->select_info->selection_anchor,
2997 label->select_info->selection_end);
2999 len = strlen (label->text);
3001 if (end_index > len)
3004 if (start_index > len)
3007 start_offset = g_utf8_strlen (label->text, start_index);
3008 end_offset = g_utf8_strlen (label->text, end_index);
3010 if (start_offset > end_offset)
3012 gint tmp = start_offset;
3013 start_offset = end_offset;
3018 *start = start_offset;
3023 return start_offset != end_offset;
3029 * gtk_label_get_layout:
3030 * @label: a #GtkLabel
3032 * Gets the #PangoLayout used to display the label.
3033 * The layout is useful to e.g. convert text positions to
3034 * pixel positions, in combination with gtk_label_get_layout_offsets().
3035 * The returned layout is owned by the label so need not be
3036 * freed by the caller.
3038 * Return value: the #PangoLayout for this label
3041 gtk_label_get_layout (GtkLabel *label)
3043 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
3045 gtk_label_ensure_layout (label);
3047 return label->layout;
3051 * gtk_label_get_layout_offsets:
3052 * @label: a #GtkLabel
3053 * @x: location to store X offset of layout, or %NULL
3054 * @y: location to store Y offset of layout, or %NULL
3056 * Obtains the coordinates where the label will draw the #PangoLayout
3057 * representing the text in the label; useful to convert mouse events
3058 * into coordinates inside the #PangoLayout, e.g. to take some action
3059 * if some part of the label is clicked. Of course you will need to
3060 * create a #GtkEventBox to receive the events, and pack the label
3061 * inside it, since labels are a #GTK_NO_WINDOW widget. Remember
3062 * when using the #PangoLayout functions you need to convert to
3063 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
3067 gtk_label_get_layout_offsets (GtkLabel *label,
3071 g_return_if_fail (GTK_IS_LABEL (label));
3073 get_layout_location (label, x, y);
3077 * gtk_label_set_use_markup:
3078 * @label: a #GtkLabel
3079 * @setting: %TRUE if the label's text should be parsed for markup.
3081 * Sets whether the text of the label contains markup in <link
3082 * linkend="PangoMarkupFormat">Pango's text markup
3083 * language</link>. See gtk_label_set_markup().
3086 gtk_label_set_use_markup (GtkLabel *label,
3089 g_return_if_fail (GTK_IS_LABEL (label));
3091 gtk_label_set_use_markup_internal (label, setting);
3092 gtk_label_recalculate (label);
3096 * gtk_label_get_use_markup:
3097 * @label: a #GtkLabel
3099 * Returns whether the label's text is interpreted as marked up with
3100 * the <link linkend="PangoMarkupFormat">Pango text markup
3101 * language</link>. See gtk_label_set_use_markup ().
3103 * Return value: %TRUE if the label's text will be parsed for markup.
3106 gtk_label_get_use_markup (GtkLabel *label)
3108 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3110 return label->use_markup;
3114 * gtk_label_set_use_underline:
3115 * @label: a #GtkLabel
3116 * @setting: %TRUE if underlines in the text indicate mnemonics
3118 * If true, an underline in the text indicates the next character should be
3119 * used for the mnemonic accelerator key.
3122 gtk_label_set_use_underline (GtkLabel *label,
3125 g_return_if_fail (GTK_IS_LABEL (label));
3127 gtk_label_set_use_underline_internal (label, setting);
3128 gtk_label_recalculate (label);
3129 if (label->use_underline)
3130 gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
3134 * gtk_label_get_use_underline:
3135 * @label: a #GtkLabel
3137 * Returns whether an embedded underline in the label indicates a
3138 * mnemonic. See gtk_label_set_use_underline ().
3140 * Return value: %TRUE whether an embedded underline in the label indicates
3141 * the mnemonic accelerator keys.
3144 gtk_label_get_use_underline (GtkLabel *label)
3146 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3148 return label->use_underline;
3152 * gtk_label_set_single_line_mode:
3153 * @label: a #GtkLabel
3154 * @single_line_mode: %TRUE if the label should be in single line mode
3156 * Sets whether the label is in single line mode.
3161 gtk_label_set_single_line_mode (GtkLabel *label,
3162 gboolean single_line_mode)
3164 GtkLabelPrivate *priv;
3166 g_return_if_fail (GTK_IS_LABEL (label));
3168 single_line_mode = single_line_mode != FALSE;
3170 priv = GTK_LABEL_GET_PRIVATE (label);
3171 if (priv->single_line_mode != single_line_mode)
3173 priv->single_line_mode = single_line_mode;
3175 gtk_label_clear_layout (label);
3176 gtk_widget_queue_resize (GTK_WIDGET (label));
3178 g_object_notify (G_OBJECT (label), "single-line-mode");
3183 * gtk_label_get_single_line_mode:
3184 * @label: a #GtkLabel
3186 * Returns whether the label is in single line mode.
3188 * Return value: %TRUE when the label is in single line mode.
3193 gtk_label_get_single_line_mode (GtkLabel *label)
3195 GtkLabelPrivate *priv;
3197 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3199 priv = GTK_LABEL_GET_PRIVATE (label);
3201 return priv->single_line_mode;
3204 /* Compute the X position for an offset that corresponds to the "more important
3205 * cursor position for that offset. We use this when trying to guess to which
3206 * end of the selection we should go to when the user hits the left or
3210 get_better_cursor (GtkLabel *label,
3215 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
3216 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
3217 PangoDirection cursor_direction = get_cursor_direction (label);
3218 gboolean split_cursor;
3219 PangoRectangle strong_pos, weak_pos;
3221 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
3222 "gtk-split-cursor", &split_cursor,
3225 gtk_label_ensure_layout (label);
3227 pango_layout_get_cursor_pos (label->layout, index,
3228 &strong_pos, &weak_pos);
3232 *x = strong_pos.x / PANGO_SCALE;
3233 *y = strong_pos.y / PANGO_SCALE;
3237 if (keymap_direction == cursor_direction)
3239 *x = strong_pos.x / PANGO_SCALE;
3240 *y = strong_pos.y / PANGO_SCALE;
3244 *x = weak_pos.x / PANGO_SCALE;
3245 *y = weak_pos.y / PANGO_SCALE;
3252 gtk_label_move_logically (GtkLabel *label,
3256 gint offset = g_utf8_pointer_to_offset (label->text,
3257 label->text + start);
3261 PangoLogAttr *log_attrs;
3265 gtk_label_ensure_layout (label);
3267 length = g_utf8_strlen (label->text, -1);
3269 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
3271 while (count > 0 && offset < length)
3275 while (offset < length && !log_attrs[offset].is_cursor_position);
3279 while (count < 0 && offset > 0)
3283 while (offset > 0 && !log_attrs[offset].is_cursor_position);
3291 return g_utf8_offset_to_pointer (label->text, offset) - label->text;
3295 gtk_label_move_visually (GtkLabel *label,
3305 int new_index, new_trailing;
3306 gboolean split_cursor;
3309 gtk_label_ensure_layout (label);
3311 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
3312 "gtk-split-cursor", &split_cursor,
3319 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
3320 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
3322 strong = keymap_direction == get_cursor_direction (label);
3327 pango_layout_move_cursor_visually (label->layout, strong, index, 0, 1, &new_index, &new_trailing);
3332 pango_layout_move_cursor_visually (label->layout, strong, index, 0, -1, &new_index, &new_trailing);
3336 if (new_index < 0 || new_index == G_MAXINT)
3341 while (new_trailing--)
3342 index = g_utf8_next_char (label->text + new_index) - label->text;
3349 gtk_label_move_forward_word (GtkLabel *label,
3352 gint new_pos = g_utf8_pointer_to_offset (label->text,
3353 label->text + start);
3356 length = g_utf8_strlen (label->text, -1);
3357 if (new_pos < length)
3359 PangoLogAttr *log_attrs;
3362 gtk_label_ensure_layout (label);
3364 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
3366 /* Find the next word end */
3368 while (new_pos < n_attrs && !log_attrs[new_pos].is_word_end)
3374 return g_utf8_offset_to_pointer (label->text, new_pos) - label->text;
3379 gtk_label_move_backward_word (GtkLabel *label,
3382 gint new_pos = g_utf8_pointer_to_offset (label->text,
3383 label->text + start);
3386 length = g_utf8_strlen (label->text, -1);
3390 PangoLogAttr *log_attrs;
3393 gtk_label_ensure_layout (label);
3395 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
3399 /* Find the previous word beginning */
3400 while (new_pos > 0 && !log_attrs[new_pos].is_word_start)
3406 return g_utf8_offset_to_pointer (label->text, new_pos) - label->text;
3410 gtk_label_move_cursor (GtkLabel *label,
3411 GtkMovementStep step,
3413 gboolean extend_selection)
3417 if (label->select_info == NULL)
3420 new_pos = label->select_info->selection_end;
3422 if (label->select_info->selection_end != label->select_info->selection_anchor &&
3425 /* If we have a current selection and aren't extending it, move to the
3426 * start/or end of the selection as appropriate
3430 case GTK_MOVEMENT_VISUAL_POSITIONS:
3433 gint anchor_x, anchor_y;
3434 gboolean end_is_left;
3436 get_better_cursor (label, label->select_info->selection_end, &end_x, &end_y);
3437 get_better_cursor (label, label->select_info->selection_anchor, &anchor_x, &anchor_y);
3439 end_is_left = (end_y < anchor_y) || (end_y == anchor_y && end_x < anchor_x);
3442 new_pos = end_is_left ? label->select_info->selection_end : label->select_info->selection_anchor;
3444 new_pos = !end_is_left ? label->select_info->selection_end : label->select_info->selection_anchor;
3448 case GTK_MOVEMENT_LOGICAL_POSITIONS:
3449 case GTK_MOVEMENT_WORDS:
3451 new_pos = MIN (label->select_info->selection_end, label->select_info->selection_anchor);
3453 new_pos = MAX (label->select_info->selection_end, label->select_info->selection_anchor);
3455 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
3456 case GTK_MOVEMENT_PARAGRAPH_ENDS:
3457 case GTK_MOVEMENT_BUFFER_ENDS:
3458 /* FIXME: Can do better here */
3459 new_pos = count < 0 ? 0 : strlen (label->text);
3461 case GTK_MOVEMENT_DISPLAY_LINES:
3462 case GTK_MOVEMENT_PARAGRAPHS:
3463 case GTK_MOVEMENT_PAGES:
3464 case GTK_MOVEMENT_HORIZONTAL_PAGES:
3472 case GTK_MOVEMENT_LOGICAL_POSITIONS:
3473 new_pos = gtk_label_move_logically (label, new_pos, count);
3475 case GTK_MOVEMENT_VISUAL_POSITIONS:
3476 new_pos = gtk_label_move_visually (label, new_pos, count);
3478 case GTK_MOVEMENT_WORDS:
3481 new_pos = gtk_label_move_forward_word (label, new_pos);
3486 new_pos = gtk_label_move_backward_word (label, new_pos);
3490 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
3491 case GTK_MOVEMENT_PARAGRAPH_ENDS:
3492 case GTK_MOVEMENT_BUFFER_ENDS:
3493 /* FIXME: Can do better here */
3494 new_pos = count < 0 ? 0 : strlen (label->text);
3496 case GTK_MOVEMENT_DISPLAY_LINES:
3497 case GTK_MOVEMENT_PARAGRAPHS:
3498 case GTK_MOVEMENT_PAGES:
3499 case GTK_MOVEMENT_HORIZONTAL_PAGES:
3504 if (extend_selection)
3505 gtk_label_select_region_index (label,
3506 label->select_info->selection_anchor,
3509 gtk_label_select_region_index (label, new_pos, new_pos);
3513 gtk_label_copy_clipboard (GtkLabel *label)
3515 if (label->text && label->select_info)
3520 start = MIN (label->select_info->selection_anchor,
3521 label->select_info->selection_end);
3522 end = MAX (label->select_info->selection_anchor,
3523 label->select_info->selection_end);
3525 len = strlen (label->text);
3534 gtk_clipboard_set_text (gtk_widget_get_clipboard (GTK_WIDGET (label),
3535 GDK_SELECTION_CLIPBOARD),
3536 label->text + start, end - start);
3541 gtk_label_select_all (GtkLabel *label)
3543 gtk_label_select_region_index (label, 0, strlen (label->text));
3546 /* Quick hack of a popup menu
3549 activate_cb (GtkWidget *menuitem,
3552 const gchar *signal = g_object_get_data (G_OBJECT (menuitem), "gtk-signal");
3553 g_signal_emit_by_name (label, signal);
3557 append_action_signal (GtkLabel *label,
3559 const gchar *stock_id,
3560 const gchar *signal,
3563 GtkWidget *menuitem = gtk_image_menu_item_new_from_stock (stock_id, NULL);
3565 g_object_set_data (G_OBJECT (menuitem), "gtk-signal", (char *)signal);
3566 g_signal_connect (menuitem, "activate",
3567 G_CALLBACK (activate_cb), label);
3569 gtk_widget_set_sensitive (menuitem, sensitive);
3571 gtk_widget_show (menuitem);
3572 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
3576 popup_menu_detach (GtkWidget *attach_widget,
3580 label = GTK_LABEL (attach_widget);
3582 if (label->select_info)
3583 label->select_info->popup_menu = NULL;
3587 popup_position_func (GtkMenu *menu,
3598 label = GTK_LABEL (user_data);
3599 widget = GTK_WIDGET (label);
3601 if (label->select_info == NULL)
3604 g_return_if_fail (GTK_WIDGET_REALIZED (label));
3606 screen = gtk_widget_get_screen (widget);
3607 gdk_window_get_origin (widget->window, x, y);
3609 gtk_widget_size_request (label->select_info->popup_menu, &req);
3611 *x += widget->allocation.width / 2;
3612 *y += widget->allocation.height;
3614 *x = CLAMP (*x, 0, MAX (0, gdk_screen_get_width (screen) - req.width));
3615 *y = CLAMP (*y, 0, MAX (0, gdk_screen_get_height (screen) - req.height));
3620 gtk_label_do_popup (GtkLabel *label,
3621 GdkEventButton *event)
3623 GtkWidget *menuitem;
3624 gboolean have_selection;
3626 if (label->select_info == NULL)
3629 if (label->select_info->popup_menu)
3630 gtk_widget_destroy (label->select_info->popup_menu);
3632 label->select_info->popup_menu = gtk_menu_new ();
3634 gtk_menu_attach_to_widget (GTK_MENU (label->select_info->popup_menu),
3639 label->select_info->selection_anchor != label->select_info->selection_end;
3642 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_CUT, "cut_clipboard",
3644 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_COPY, "copy_clipboard",
3646 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_PASTE, "paste_clipboard",
3649 menuitem = gtk_image_menu_item_new_from_stock (GTK_STOCK_DELETE, NULL);
3650 gtk_widget_set_sensitive (menuitem, FALSE);
3651 gtk_widget_show (menuitem);
3652 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
3654 menuitem = gtk_separator_menu_item_new ();
3655 gtk_widget_show (menuitem);
3656 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
3658 menuitem = gtk_menu_item_new_with_label (_("Select All"));
3659 g_signal_connect_swapped (menuitem, "activate",
3660 G_CALLBACK (gtk_label_select_all), label);
3661 gtk_widget_show (menuitem);
3662 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
3664 g_signal_emit (label,
3665 signals[POPULATE_POPUP],
3667 label->select_info->popup_menu);
3670 gtk_menu_popup (GTK_MENU (label->select_info->popup_menu), NULL, NULL,
3672 event->button, event->time);
3674 gtk_menu_popup (GTK_MENU (label->select_info->popup_menu), NULL, NULL,
3675 popup_position_func, label,
3676 0, gtk_get_current_event_time ());