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/.
32 #include "gtkmarshalers.h"
33 #include "gtkwindow.h"
34 #include "gdk/gdkkeysyms.h"
35 #include "gtkclipboard.h"
36 #include <pango/pango.h>
37 #include "gtkimagemenuitem.h"
39 #include "gtkseparatormenuitem.h"
40 #include "gtkmenuitem.h"
41 #include "gtknotebook.h"
43 #include "gtkbindings.h"
45 #define GTK_LABEL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_LABEL, GtkLabelPrivate))
50 guint single_line_mode : 1;
54 struct _GtkLabelSelectionInfo
57 gint selection_anchor;
59 GtkWidget *popup_menu;
93 static guint signals[LAST_SIGNAL] = { 0 };
95 static void gtk_label_class_init (GtkLabelClass *klass);
96 static void gtk_label_init (GtkLabel *label);
97 static void gtk_label_set_property (GObject *object,
101 static void gtk_label_get_property (GObject *object,
105 static void gtk_label_destroy (GtkObject *object);
106 static void gtk_label_finalize (GObject *object);
107 static void gtk_label_size_request (GtkWidget *widget,
108 GtkRequisition *requisition);
109 static void gtk_label_size_allocate (GtkWidget *widget,
110 GtkAllocation *allocation);
111 static void gtk_label_state_changed (GtkWidget *widget,
113 static void gtk_label_style_set (GtkWidget *widget,
114 GtkStyle *previous_style);
115 static void gtk_label_direction_changed (GtkWidget *widget,
116 GtkTextDirection previous_dir);
117 static gint gtk_label_expose (GtkWidget *widget,
118 GdkEventExpose *event);
120 static void gtk_label_realize (GtkWidget *widget);
121 static void gtk_label_unrealize (GtkWidget *widget);
122 static void gtk_label_map (GtkWidget *widget);
123 static void gtk_label_unmap (GtkWidget *widget);
125 static gboolean gtk_label_button_press (GtkWidget *widget,
126 GdkEventButton *event);
127 static gboolean gtk_label_button_release (GtkWidget *widget,
128 GdkEventButton *event);
129 static gboolean gtk_label_motion (GtkWidget *widget,
130 GdkEventMotion *event);
133 static void gtk_label_set_text_internal (GtkLabel *label,
135 static void gtk_label_set_label_internal (GtkLabel *label,
137 static void gtk_label_set_use_markup_internal (GtkLabel *label,
139 static void gtk_label_set_use_underline_internal (GtkLabel *label,
141 static void gtk_label_set_attributes_internal (GtkLabel *label,
142 PangoAttrList *attrs);
143 static void gtk_label_set_uline_text_internal (GtkLabel *label,
145 static void gtk_label_set_pattern_internal (GtkLabel *label,
146 const gchar *pattern);
147 static void set_markup (GtkLabel *label,
149 gboolean with_uline);
150 static void gtk_label_recalculate (GtkLabel *label);
151 static void gtk_label_hierarchy_changed (GtkWidget *widget,
152 GtkWidget *old_toplevel);
153 static void gtk_label_screen_changed (GtkWidget *widget,
154 GdkScreen *old_screen);
156 static void gtk_label_create_window (GtkLabel *label);
157 static void gtk_label_destroy_window (GtkLabel *label);
158 static void gtk_label_clear_layout (GtkLabel *label);
159 static void gtk_label_ensure_layout (GtkLabel *label);
160 static void gtk_label_select_region_index (GtkLabel *label,
164 static gboolean gtk_label_mnemonic_activate (GtkWidget *widget,
165 gboolean group_cycling);
166 static void gtk_label_setup_mnemonic (GtkLabel *label,
168 static void gtk_label_drag_data_get (GtkWidget *widget,
169 GdkDragContext *context,
170 GtkSelectionData *selection_data,
175 /* For selectable lables: */
176 static void gtk_label_move_cursor (GtkLabel *label,
177 GtkMovementStep step,
179 gboolean extend_selection);
180 static void gtk_label_copy_clipboard (GtkLabel *label);
181 static void gtk_label_select_all (GtkLabel *label);
182 static void gtk_label_do_popup (GtkLabel *label,
183 GdkEventButton *event);
185 static gint gtk_label_move_forward_word (GtkLabel *label,
187 static gint gtk_label_move_backward_word (GtkLabel *label,
190 static GtkMiscClass *parent_class = NULL;
194 gtk_label_get_type (void)
196 static GType label_type = 0;
200 static const GTypeInfo label_info =
202 sizeof (GtkLabelClass),
203 NULL, /* base_init */
204 NULL, /* base_finalize */
205 (GClassInitFunc) gtk_label_class_init,
206 NULL, /* class_finalize */
207 NULL, /* class_data */
209 32, /* n_preallocs */
210 (GInstanceInitFunc) gtk_label_init,
213 label_type = g_type_register_static (GTK_TYPE_MISC, "GtkLabel",
221 add_move_binding (GtkBindingSet *binding_set,
224 GtkMovementStep step,
227 g_return_if_fail ((modmask & GDK_SHIFT_MASK) == 0);
229 gtk_binding_entry_add_signal (binding_set, keyval, modmask,
233 G_TYPE_BOOLEAN, FALSE);
235 /* Selection-extending version */
236 gtk_binding_entry_add_signal (binding_set, keyval, modmask | GDK_SHIFT_MASK,
240 G_TYPE_BOOLEAN, TRUE);
244 gtk_label_class_init (GtkLabelClass *class)
246 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
247 GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
248 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
249 GtkBindingSet *binding_set;
251 parent_class = g_type_class_peek_parent (class);
253 gobject_class->set_property = gtk_label_set_property;
254 gobject_class->get_property = gtk_label_get_property;
255 gobject_class->finalize = gtk_label_finalize;
257 object_class->destroy = gtk_label_destroy;
259 widget_class->size_request = gtk_label_size_request;
260 widget_class->size_allocate = gtk_label_size_allocate;
261 widget_class->state_changed = gtk_label_state_changed;
262 widget_class->style_set = gtk_label_style_set;
263 widget_class->direction_changed = gtk_label_direction_changed;
264 widget_class->expose_event = gtk_label_expose;
265 widget_class->realize = gtk_label_realize;
266 widget_class->unrealize = gtk_label_unrealize;
267 widget_class->map = gtk_label_map;
268 widget_class->unmap = gtk_label_unmap;
269 widget_class->button_press_event = gtk_label_button_press;
270 widget_class->button_release_event = gtk_label_button_release;
271 widget_class->motion_notify_event = gtk_label_motion;
272 widget_class->hierarchy_changed = gtk_label_hierarchy_changed;
273 widget_class->screen_changed = gtk_label_screen_changed;
274 widget_class->mnemonic_activate = gtk_label_mnemonic_activate;
275 widget_class->drag_data_get = gtk_label_drag_data_get;
277 class->move_cursor = gtk_label_move_cursor;
278 class->copy_clipboard = gtk_label_copy_clipboard;
280 signals[MOVE_CURSOR] =
281 g_signal_new ("move_cursor",
282 G_OBJECT_CLASS_TYPE (gobject_class),
283 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
284 G_STRUCT_OFFSET (GtkLabelClass, move_cursor),
286 _gtk_marshal_VOID__ENUM_INT_BOOLEAN,
288 GTK_TYPE_MOVEMENT_STEP,
292 signals[COPY_CLIPBOARD] =
293 g_signal_new ("copy_clipboard",
294 G_OBJECT_CLASS_TYPE (gobject_class),
295 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
296 G_STRUCT_OFFSET (GtkLabelClass, copy_clipboard),
298 _gtk_marshal_VOID__VOID,
301 signals[POPULATE_POPUP] =
302 g_signal_new ("populate_popup",
303 G_OBJECT_CLASS_TYPE (gobject_class),
305 G_STRUCT_OFFSET (GtkLabelClass, populate_popup),
307 _gtk_marshal_VOID__OBJECT,
311 g_object_class_install_property (gobject_class,
313 g_param_spec_string ("label",
315 P_("The text of the label"),
318 g_object_class_install_property (gobject_class,
320 g_param_spec_boxed ("attributes",
322 P_("A list of style attributes to apply to the text of the label"),
323 PANGO_TYPE_ATTR_LIST,
325 g_object_class_install_property (gobject_class,
327 g_param_spec_boolean ("use_markup",
329 P_("The text of the label includes XML markup. See pango_parse_markup()"),
332 g_object_class_install_property (gobject_class,
334 g_param_spec_boolean ("use_underline",
336 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
340 g_object_class_install_property (gobject_class,
342 g_param_spec_enum ("justify",
344 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"),
345 GTK_TYPE_JUSTIFICATION,
349 g_object_class_install_property (gobject_class,
351 g_param_spec_string ("pattern",
353 P_("A string with _ characters in positions correspond to characters in the text to underline"),
357 g_object_class_install_property (gobject_class,
359 g_param_spec_boolean ("wrap",
361 P_("If set, wrap lines if the text becomes too wide"),
364 g_object_class_install_property (gobject_class,
366 g_param_spec_boolean ("selectable",
368 P_("Whether the label text can be selected with the mouse"),
371 g_object_class_install_property (gobject_class,
372 PROP_MNEMONIC_KEYVAL,
373 g_param_spec_uint ("mnemonic_keyval",
375 P_("The mnemonic accelerator key for this label"),
380 g_object_class_install_property (gobject_class,
381 PROP_MNEMONIC_WIDGET,
382 g_param_spec_object ("mnemonic_widget",
383 P_("Mnemonic widget"),
384 P_("The widget to be activated when the label's mnemonic "
389 g_object_class_install_property (gobject_class,
390 PROP_CURSOR_POSITION,
391 g_param_spec_int ("cursor_position",
392 P_("Cursor Position"),
393 P_("The current position of the insertion cursor in chars"),
399 g_object_class_install_property (gobject_class,
400 PROP_SELECTION_BOUND,
401 g_param_spec_int ("selection_bound",
402 P_("Selection Bound"),
403 P_("The position of the opposite end of the selection from the cursor in chars"),
410 * GtkLabel:ellipsize:
412 * The preferred place to ellipsize the string, if the label does not have
413 * enough room to display the entire string, specified as a #PangoEllisizeMode.
415 * Note that setting this property to a value other than %PANGO_ELLIPSIZE_NONE
416 * has the side-effect that the label requests only enough space to display the
417 * ellipsis "...". In particular, this means that ellipsizing labels don't
418 * work well in notebook tabs, unless the tab's ::tab-expand property is set
419 * to %TRUE. Other means to set a label's width are
420 * gtk_widget_set_size_request() and gtk_label_set_width_chars().
424 g_object_class_install_property (gobject_class,
426 g_param_spec_enum ("ellipsize",
428 P_("The preferred place to ellipsize the string, if the label does not have enough room to display the entire string, if at all"),
429 PANGO_TYPE_ELLIPSIZE_MODE,
430 PANGO_ELLIPSIZE_NONE,
434 * GtkLabel:width-chars:
436 * The desired width of the label, in characters. If this property is set to
437 * -1, the width will be calculated automatically, otherwise the label will
438 * request either 3 characters or the property value, whichever is greater.
442 g_object_class_install_property (gobject_class,
444 g_param_spec_int ("width_chars",
445 P_("Width In Chararacters"),
446 P_("The desired width of the label, in characters"),
453 * GtkLabel:single-line-mode:
455 * Whether the label is in single line mode. In single line mode,
456 * the height of the label does not depend on the actual text, it
457 * is always set to ascent + descent of the font. This can be an
458 * advantage in situations where resizing the label because of text
459 * changes would be distracting, e.g. in a statusbar.
463 g_object_class_install_property (gobject_class,
464 PROP_SINGLE_LINE_MODE,
465 g_param_spec_boolean ("single-line-mode",
466 P_("Single Line Mode"),
467 P_("Whether the label is in single line mode"),
474 binding_set = gtk_binding_set_by_class (class);
476 /* Moving the insertion point */
477 add_move_binding (binding_set, GDK_Right, 0,
478 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
480 add_move_binding (binding_set, GDK_Left, 0,
481 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
483 add_move_binding (binding_set, GDK_KP_Right, 0,
484 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
486 add_move_binding (binding_set, GDK_KP_Left, 0,
487 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
489 add_move_binding (binding_set, GDK_f, GDK_CONTROL_MASK,
490 GTK_MOVEMENT_LOGICAL_POSITIONS, 1);
492 add_move_binding (binding_set, GDK_b, GDK_CONTROL_MASK,
493 GTK_MOVEMENT_LOGICAL_POSITIONS, -1);
495 add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
496 GTK_MOVEMENT_WORDS, 1);
498 add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
499 GTK_MOVEMENT_WORDS, -1);
501 add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
502 GTK_MOVEMENT_WORDS, 1);
504 add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
505 GTK_MOVEMENT_WORDS, -1);
507 add_move_binding (binding_set, GDK_a, GDK_CONTROL_MASK,
508 GTK_MOVEMENT_PARAGRAPH_ENDS, -1);
510 add_move_binding (binding_set, GDK_e, GDK_CONTROL_MASK,
511 GTK_MOVEMENT_PARAGRAPH_ENDS, 1);
513 add_move_binding (binding_set, GDK_f, GDK_MOD1_MASK,
514 GTK_MOVEMENT_WORDS, 1);
516 add_move_binding (binding_set, GDK_b, GDK_MOD1_MASK,
517 GTK_MOVEMENT_WORDS, -1);
519 add_move_binding (binding_set, GDK_Home, 0,
520 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
522 add_move_binding (binding_set, GDK_End, 0,
523 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
525 add_move_binding (binding_set, GDK_KP_Home, 0,
526 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
528 add_move_binding (binding_set, GDK_KP_End, 0,
529 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
531 add_move_binding (binding_set, GDK_Home, GDK_CONTROL_MASK,
532 GTK_MOVEMENT_BUFFER_ENDS, -1);
534 add_move_binding (binding_set, GDK_End, GDK_CONTROL_MASK,
535 GTK_MOVEMENT_BUFFER_ENDS, 1);
537 add_move_binding (binding_set, GDK_KP_Home, GDK_CONTROL_MASK,
538 GTK_MOVEMENT_BUFFER_ENDS, -1);
540 add_move_binding (binding_set, GDK_KP_End, GDK_CONTROL_MASK,
541 GTK_MOVEMENT_BUFFER_ENDS, 1);
544 gtk_binding_entry_add_signal (binding_set, GDK_c, GDK_CONTROL_MASK,
545 "copy_clipboard", 0);
547 g_type_class_add_private (class, sizeof (GtkLabelPrivate));
551 gtk_label_set_property (GObject *object,
558 label = GTK_LABEL (object);
563 gtk_label_set_label (label, g_value_get_string (value));
565 case PROP_ATTRIBUTES:
566 gtk_label_set_attributes (label, g_value_get_boxed (value));
568 case PROP_USE_MARKUP:
569 gtk_label_set_use_markup (label, g_value_get_boolean (value));
571 case PROP_USE_UNDERLINE:
572 gtk_label_set_use_underline (label, g_value_get_boolean (value));
575 gtk_label_set_justify (label, g_value_get_enum (value));
578 gtk_label_set_pattern (label, g_value_get_string (value));
581 gtk_label_set_line_wrap (label, g_value_get_boolean (value));
583 case PROP_SELECTABLE:
584 gtk_label_set_selectable (label, g_value_get_boolean (value));
586 case PROP_MNEMONIC_WIDGET:
587 gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
590 gtk_label_set_ellipsize (label, g_value_get_enum (value));
592 case PROP_WIDTH_CHARS:
593 gtk_label_set_width_chars (label, g_value_get_int (value));
595 case PROP_SINGLE_LINE_MODE:
596 gtk_label_set_single_line_mode (label, g_value_get_boolean (value));
599 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
605 gtk_label_get_property (GObject *object,
612 label = GTK_LABEL (object);
617 g_value_set_string (value, label->label);
619 case PROP_ATTRIBUTES:
620 g_value_set_boxed (value, label->attrs);
622 case PROP_USE_MARKUP:
623 g_value_set_boolean (value, label->use_markup);
625 case PROP_USE_UNDERLINE:
626 g_value_set_boolean (value, label->use_underline);
629 g_value_set_enum (value, label->jtype);
632 g_value_set_boolean (value, label->wrap);
634 case PROP_SELECTABLE:
635 g_value_set_boolean (value, gtk_label_get_selectable (label));
637 case PROP_MNEMONIC_KEYVAL:
638 g_value_set_uint (value, label->mnemonic_keyval);
640 case PROP_MNEMONIC_WIDGET:
641 g_value_set_object (value, (GObject*) label->mnemonic_widget);
643 case PROP_CURSOR_POSITION:
644 if (label->select_info)
646 gint offset = g_utf8_pointer_to_offset (label->text,
647 label->text + label->select_info->selection_end);
648 g_value_set_int (value, offset);
651 g_value_set_int (value, 0);
653 case PROP_SELECTION_BOUND:
654 if (label->select_info)
656 gint offset = g_utf8_pointer_to_offset (label->text,
657 label->text + label->select_info->selection_anchor);
658 g_value_set_int (value, offset);
661 g_value_set_int (value, 0);
664 g_value_set_enum (value, label->ellipsize);
666 case PROP_WIDTH_CHARS:
667 g_value_set_enum (value, gtk_label_get_width_chars (label));
669 case PROP_SINGLE_LINE_MODE:
670 g_value_set_boolean (value, gtk_label_get_single_line_mode (label));
674 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
680 gtk_label_init (GtkLabel *label)
682 GtkLabelPrivate *priv;
684 GTK_WIDGET_SET_FLAGS (label, GTK_NO_WINDOW);
686 priv = GTK_LABEL_GET_PRIVATE (label);
687 priv->width_chars = -1;
691 label->jtype = GTK_JUSTIFY_LEFT;
693 label->ellipsize = PANGO_ELLIPSIZE_NONE;
695 label->use_underline = FALSE;
696 label->use_markup = FALSE;
698 label->mnemonic_keyval = GDK_VoidSymbol;
699 label->layout = NULL;
703 label->mnemonic_widget = NULL;
704 label->mnemonic_window = NULL;
706 gtk_label_set_text (label, "");
711 * @str: The text of the label
713 * Creates a new label with the given text inside it. You can
714 * pass %NULL to get an empty label widget.
716 * Return value: the new #GtkLabel
719 gtk_label_new (const gchar *str)
723 label = g_object_new (GTK_TYPE_LABEL, NULL);
726 gtk_label_set_text (label, str);
728 return GTK_WIDGET (label);
732 * gtk_label_new_with_mnemonic:
733 * @str: The text of the label, with an underscore in front of the
736 * Creates a new #GtkLabel, containing the text in @str.
738 * If characters in @str are preceded by an underscore, they are
739 * underlined. If you need a literal underscore character in a label, use
740 * '__' (two underscores). The first underlined character represents a
741 * keyboard accelerator called a mnemonic. The mnemonic key can be used
742 * to activate another widget, chosen automatically, or explicitly using
743 * gtk_label_set_mnemonic_widget().
745 * If gtk_label_set_mnemonic_widget()
746 * is not called, then the first activatable ancestor of the #GtkLabel
747 * will be chosen as the mnemonic widget. For instance, if the
748 * label is inside a button or menu item, the button or menu item will
749 * automatically become the mnemonic widget and be activated by
752 * Return value: the new #GtkLabel
755 gtk_label_new_with_mnemonic (const gchar *str)
759 label = g_object_new (GTK_TYPE_LABEL, NULL);
762 gtk_label_set_text_with_mnemonic (label, str);
764 return GTK_WIDGET (label);
768 gtk_label_mnemonic_activate (GtkWidget *widget,
769 gboolean group_cycling)
773 if (GTK_LABEL (widget)->mnemonic_widget)
774 return gtk_widget_mnemonic_activate (GTK_LABEL (widget)->mnemonic_widget, group_cycling);
776 /* Try to find the widget to activate by traversing the
779 parent = widget->parent;
781 if (parent && GTK_IS_NOTEBOOK (parent))
786 if (GTK_WIDGET_CAN_FOCUS (parent) ||
787 (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
788 (parent->parent && GTK_IS_NOTEBOOK (parent->parent)) ||
789 (GTK_IS_MENU_ITEM (parent)))
790 return gtk_widget_mnemonic_activate (parent, group_cycling);
791 parent = parent->parent;
794 /* barf if there was nothing to activate */
795 g_warning ("Couldn't find a target for a mnemonic activation.");
796 gdk_display_beep (gtk_widget_get_display (widget));
802 gtk_label_setup_mnemonic (GtkLabel *label,
807 if (last_key != GDK_VoidSymbol && label->mnemonic_window)
809 gtk_window_remove_mnemonic (label->mnemonic_window,
812 label->mnemonic_window = NULL;
815 if (label->mnemonic_keyval == GDK_VoidSymbol)
818 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (label));
819 if (GTK_WIDGET_TOPLEVEL (toplevel))
821 gtk_window_add_mnemonic (GTK_WINDOW (toplevel),
822 label->mnemonic_keyval,
824 label->mnemonic_window = GTK_WINDOW (toplevel);
829 gtk_label_hierarchy_changed (GtkWidget *widget,
830 GtkWidget *old_toplevel)
832 GtkLabel *label = GTK_LABEL (widget);
834 gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
838 gtk_label_screen_changed (GtkWidget *widget,
839 GdkScreen *old_screen)
841 gtk_label_clear_layout (GTK_LABEL (widget));
845 label_mnemonic_widget_weak_notify (gpointer data,
846 GObject *where_the_object_was)
848 GtkLabel *label = data;
850 label->mnemonic_widget = NULL;
851 g_object_notify (G_OBJECT (label), "mnemonic_widget");
855 * gtk_label_set_mnemonic_widget:
856 * @label: a #GtkLabel
857 * @widget: the target #GtkWidget
859 * If the label has been set so that it has an mnemonic key (using
860 * i.e. gtk_label_set_markup_with_mnemonic(),
861 * gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
862 * or the "use_underline" property) the label can be associated with a
863 * widget that is the target of the mnemonic. When the label is inside
864 * a widget (like a #GtkButton or a #GtkNotebook tab) it is
865 * automatically associated with the correct widget, but sometimes
866 * (i.e. when the target is a #GtkEntry next to the label) you need to
867 * set it explicitly using this function.
869 * The target widget will be accelerated by emitting "mnemonic_activate" on it.
870 * The default handler for this signal will activate the widget if there are no
871 * mnemonic collisions and toggle focus between the colliding widgets otherwise.
874 gtk_label_set_mnemonic_widget (GtkLabel *label,
877 g_return_if_fail (GTK_IS_LABEL (label));
879 g_return_if_fail (GTK_IS_WIDGET (widget));
881 if (label->mnemonic_widget)
883 gtk_widget_remove_mnemonic_label (label->mnemonic_widget, GTK_WIDGET (label));
884 g_object_weak_unref (G_OBJECT (label->mnemonic_widget),
885 label_mnemonic_widget_weak_notify,
888 label->mnemonic_widget = widget;
889 if (label->mnemonic_widget)
891 g_object_weak_ref (G_OBJECT (label->mnemonic_widget),
892 label_mnemonic_widget_weak_notify,
894 gtk_widget_add_mnemonic_label (label->mnemonic_widget, GTK_WIDGET (label));
897 g_object_notify (G_OBJECT (label), "mnemonic_widget");
901 * gtk_label_get_mnemonic_widget:
902 * @label: a #GtkLabel
904 * Retrieves the target of the mnemonic (keyboard shortcut) of this
905 * label. See gtk_label_set_mnemonic_widget ().
907 * Return value: the target of the label's mnemonic, or %NULL if none
908 * has been set and the default algorithm will be used.
911 gtk_label_get_mnemonic_widget (GtkLabel *label)
913 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
915 return label->mnemonic_widget;
919 * gtk_label_get_mnemonic_keyval:
920 * @label: a #GtkLabel
922 * If the label has been set so that it has an mnemonic key this function
923 * returns the keyval used for the mnemonic accelerator. If there is no
924 * mnemonic set up it returns #GDK_VoidSymbol.
926 * Returns: GDK keyval usable for accelerators, or #GDK_VoidSymbol
929 gtk_label_get_mnemonic_keyval (GtkLabel *label)
931 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);
933 return label->mnemonic_keyval;
937 gtk_label_set_text_internal (GtkLabel *label,
940 g_free (label->text);
944 gtk_label_select_region_index (label, 0, 0);
948 gtk_label_set_label_internal (GtkLabel *label,
951 g_free (label->label);
955 g_object_notify (G_OBJECT (label), "label");
959 gtk_label_set_use_markup_internal (GtkLabel *label,
963 if (label->use_markup != val)
965 g_object_notify (G_OBJECT (label), "use_markup");
966 label->use_markup = val;
971 gtk_label_set_use_underline_internal (GtkLabel *label,
975 if (label->use_underline != val)
977 g_object_notify (G_OBJECT (label), "use_underline");
978 label->use_underline = val;
983 gtk_label_set_attributes_internal (GtkLabel *label,
984 PangoAttrList *attrs)
987 pango_attr_list_ref (attrs);
990 pango_attr_list_unref (label->attrs);
992 if (!label->use_markup && !label->use_underline)
995 pango_attr_list_ref (attrs);
996 if (label->effective_attrs)
997 pango_attr_list_unref (label->effective_attrs);
998 label->effective_attrs = attrs;
1001 label->attrs = attrs;
1002 g_object_notify (G_OBJECT (label), "attributes");
1006 /* Calculates text, attrs and mnemonic_keyval from
1007 * label, use_underline and use_markup
1010 gtk_label_recalculate (GtkLabel *label)
1012 if (label->use_markup)
1013 set_markup (label, label->label, label->use_underline);
1016 if (label->use_underline)
1017 gtk_label_set_uline_text_internal (label, label->label);
1020 gtk_label_set_text_internal (label, g_strdup (label->label));
1022 pango_attr_list_ref (label->attrs);
1023 if (label->effective_attrs)
1024 pango_attr_list_unref (label->effective_attrs);
1025 label->effective_attrs = label->attrs;
1029 if (!label->use_underline)
1031 guint keyval = label->mnemonic_keyval;
1033 label->mnemonic_keyval = GDK_VoidSymbol;
1034 gtk_label_setup_mnemonic (label, keyval);
1037 gtk_label_clear_layout (label);
1038 gtk_widget_queue_resize (GTK_WIDGET (label));
1042 * gtk_label_set_text:
1043 * @label: a #GtkLabel
1044 * @str: The text you want to set.
1046 * Sets the text within the #GtkLabel widget. It overwrites any text that
1049 * This will also clear any previously set mnemonic accelerators.
1052 gtk_label_set_text (GtkLabel *label,
1055 g_return_if_fail (GTK_IS_LABEL (label));
1057 g_object_freeze_notify (G_OBJECT (label));
1059 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1060 gtk_label_set_use_markup_internal (label, FALSE);
1061 gtk_label_set_use_underline_internal (label, FALSE);
1063 gtk_label_recalculate (label);
1065 g_object_thaw_notify (G_OBJECT (label));
1069 * gtk_label_set_attributes:
1070 * @label: a #GtkLabel
1071 * @attrs: a #PangoAttrList
1073 * Sets a #PangoAttrList; the attributes in the list are applied to the
1074 * label text. The attributes set with this function will be ignored
1075 * if the "use_underline" property or the "use_markup" property
1079 gtk_label_set_attributes (GtkLabel *label,
1080 PangoAttrList *attrs)
1082 g_return_if_fail (GTK_IS_LABEL (label));
1084 gtk_label_set_attributes_internal (label, attrs);
1086 gtk_label_clear_layout (label);
1087 gtk_widget_queue_resize (GTK_WIDGET (label));
1091 * gtk_label_get_attributes:
1092 * @label: a #GtkLabel
1094 * Gets the attribute list that was set on the label using
1095 * gtk_label_set_attributes(), if any. This function does
1096 * not reflect attributes that come from the labels markup
1097 * (see gtk_label_set_markup()). If you want to get the
1098 * effective attributes for the label, use
1099 * pango_layout_get_attribute (gtk_label_get_layout (label)).
1101 * Return value: the attribute list, or %NULL if none was set.
1104 gtk_label_get_attributes (GtkLabel *label)
1106 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1108 return label->attrs;
1112 * gtk_label_set_label:
1113 * @label: a #GtkLabel
1114 * @str: the new text to set for the label
1116 * Sets the text of the label. The label is interpreted as
1117 * including embedded underlines and/or Pango markup depending
1118 * on the values of label->use_underline and label->use_markup.
1121 gtk_label_set_label (GtkLabel *label,
1126 g_return_if_fail (GTK_IS_LABEL (label));
1127 g_return_if_fail (str != NULL);
1129 last_keyval = label->mnemonic_keyval;
1131 gtk_label_set_label_internal (label, g_strdup (str));
1132 gtk_label_recalculate (label);
1133 if (last_keyval != label->mnemonic_keyval)
1134 gtk_label_setup_mnemonic (label, last_keyval);
1138 * gtk_label_get_label:
1139 * @label: a #GtkLabel
1141 * Fetches the text from a label widget including any embedded
1142 * underlines indicating mnemonics and Pango markup. (See
1143 * gtk_label_get_text ()).
1145 * Return value: the text of the label widget. This string is
1146 * owned by the widget and must not be modified or freed.
1148 G_CONST_RETURN gchar *
1149 gtk_label_get_label (GtkLabel *label)
1151 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1153 return label->label;
1157 set_markup (GtkLabel *label,
1159 gboolean with_uline)
1162 GError *error = NULL;
1163 PangoAttrList *attrs = NULL;
1164 gunichar accel_char = 0;
1166 if (!pango_parse_markup (str,
1168 with_uline ? '_' : 0,
1171 with_uline ? &accel_char : NULL,
1174 g_warning ("Failed to set label from markup due to error parsing markup: %s",
1176 g_error_free (error);
1181 gtk_label_set_text_internal (label, text);
1185 if (label->effective_attrs)
1186 pango_attr_list_unref (label->effective_attrs);
1187 label->effective_attrs = attrs;
1190 if (accel_char != 0)
1191 label->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
1193 label->mnemonic_keyval = GDK_VoidSymbol;
1197 * gtk_label_set_markup:
1198 * @label: a #GtkLabel
1199 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
1201 * Parses @str which is marked up with the <link
1202 * linkend="PangoMarkupFormat">Pango text markup language</link>, setting the
1203 * label's text and attribute list based on the parse results. If the @str is
1204 * external data, you may need to escape it with g_markup_escape_text() or
1205 * g_markup_printf_escaped()<!-- -->:
1206 * <informalexample><programlisting>
1209 * markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str);
1210 * gtk_label_set_markup (GTK_LABEL (label), markup);
1212 * </programlisting></informalexample>
1215 gtk_label_set_markup (GtkLabel *label,
1218 g_return_if_fail (GTK_IS_LABEL (label));
1220 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1221 gtk_label_set_use_markup_internal (label, TRUE);
1222 gtk_label_set_use_underline_internal (label, FALSE);
1224 gtk_label_recalculate (label);
1228 * gtk_label_set_markup_with_mnemonic:
1229 * @label: a #GtkLabel
1230 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
1232 * Parses @str which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>,
1233 * setting the label's text and attribute list based on the parse results.
1234 * If characters in @str are preceded by an underscore, they are underlined
1235 * indicating that they represent a keyboard accelerator called a mnemonic.
1237 * The mnemonic key can be used to activate another widget, chosen automatically,
1238 * or explicitly using gtk_label_set_mnemonic_widget().
1241 gtk_label_set_markup_with_mnemonic (GtkLabel *label,
1245 g_return_if_fail (GTK_IS_LABEL (label));
1247 last_keyval = label->mnemonic_keyval;
1248 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1249 gtk_label_set_use_markup_internal (label, TRUE);
1250 gtk_label_set_use_underline_internal (label, TRUE);
1252 gtk_label_recalculate (label);
1253 gtk_label_setup_mnemonic (label, last_keyval);
1257 * gtk_label_get_text:
1258 * @label: a #GtkLabel
1260 * Fetches the text from a label widget, as displayed on the
1261 * screen. This does not include any embedded underlines
1262 * indicating mnemonics or Pango markup. (See gtk_label_get_label())
1264 * Return value: the text in the label widget. This is the internal
1265 * string used by the label, and must not be modified.
1267 G_CONST_RETURN gchar *
1268 gtk_label_get_text (GtkLabel *label)
1270 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1275 static PangoAttrList *
1276 gtk_label_pattern_to_attrs (GtkLabel *label,
1277 const gchar *pattern)
1280 const char *p = label->text;
1281 const char *q = pattern;
1282 PangoAttrList *attrs;
1284 attrs = pango_attr_list_new ();
1288 while (*p && *q && *q != '_')
1290 p = g_utf8_next_char (p);
1294 while (*p && *q && *q == '_')
1296 p = g_utf8_next_char (p);
1302 PangoAttribute *attr = pango_attr_underline_new (PANGO_UNDERLINE_LOW);
1303 attr->start_index = start - label->text;
1304 attr->end_index = p - label->text;
1306 pango_attr_list_insert (attrs, attr);
1316 gtk_label_set_pattern_internal (GtkLabel *label,
1317 const gchar *pattern)
1319 PangoAttrList *attrs;
1320 g_return_if_fail (GTK_IS_LABEL (label));
1323 attrs = gtk_label_pattern_to_attrs (label, pattern);
1327 if (label->effective_attrs)
1328 pango_attr_list_unref (label->effective_attrs);
1329 label->effective_attrs = attrs;
1333 gtk_label_set_pattern (GtkLabel *label,
1334 const gchar *pattern)
1336 g_return_if_fail (GTK_IS_LABEL (label));
1338 gtk_label_set_pattern_internal (label, pattern);
1340 gtk_label_clear_layout (label);
1341 gtk_widget_queue_resize (GTK_WIDGET (label));
1346 * gtk_label_set_justify:
1347 * @label: a #GtkLabel
1348 * @jtype: a #GtkJustification
1350 * Sets the alignment of the lines in the text of the label relative to
1351 * each other. %GTK_JUSTIFY_LEFT is the default value when the
1352 * widget is first created with gtk_label_new(). If you instead want
1353 * to set the alignment of the label as a whole, use
1354 * gtk_misc_set_alignment() instead. gtk_label_set_justify() has no
1355 * effect on labels containing only a single line.
1358 gtk_label_set_justify (GtkLabel *label,
1359 GtkJustification jtype)
1361 g_return_if_fail (GTK_IS_LABEL (label));
1362 g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
1364 if ((GtkJustification) label->jtype != jtype)
1366 label->jtype = jtype;
1368 /* No real need to be this drastic, but easier than duplicating the code */
1369 gtk_label_clear_layout (label);
1371 g_object_notify (G_OBJECT (label), "justify");
1372 gtk_widget_queue_resize (GTK_WIDGET (label));
1377 * gtk_label_get_justify:
1378 * @label: a #GtkLabel
1380 * Returns the justification of the label. See gtk_label_set_justify ().
1382 * Return value: #GtkJustification
1385 gtk_label_get_justify (GtkLabel *label)
1387 g_return_val_if_fail (GTK_IS_LABEL (label), 0);
1389 return label->jtype;
1394 * gtk_label_set_ellipsize:
1395 * @label: a #GtkLabel
1396 * @mode: a #PangoEllipsizeMode
1398 * Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there
1399 * is not enough space to render the entire string.
1404 gtk_label_set_ellipsize (GtkLabel *label,
1405 PangoEllipsizeMode mode)
1407 g_return_if_fail (GTK_IS_LABEL (label));
1408 g_return_if_fail (mode >= PANGO_ELLIPSIZE_NONE && mode <= PANGO_ELLIPSIZE_END);
1410 if ((PangoEllipsizeMode) label->ellipsize != mode)
1412 label->ellipsize = mode;
1414 /* No real need to be this drastic, but easier than duplicating the code */
1415 gtk_label_clear_layout (label);
1417 g_object_notify (G_OBJECT (label), "ellipsize");
1418 gtk_widget_queue_resize (GTK_WIDGET (label));
1423 * gtk_label_get_ellipsize:
1424 * @label: a #GtkLabel
1426 * Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
1428 * Return value: #PangoEllipsizeMode
1433 gtk_label_get_ellipsize (GtkLabel *label)
1435 g_return_val_if_fail (GTK_IS_LABEL (label), PANGO_ELLIPSIZE_NONE);
1437 return label->ellipsize;
1441 * gtk_label_set_width_chars:
1442 * @label: a #GtkLabel
1443 * @n_chars: the new desired width, in characters.
1445 * Sets the desired width in characters of @label to @n_chars.
1450 gtk_label_set_width_chars (GtkLabel *label,
1453 GtkLabelPrivate *priv;
1455 g_return_if_fail (GTK_IS_LABEL (label));
1457 priv = GTK_LABEL_GET_PRIVATE (label);
1459 if (priv->width_chars != n_chars)
1461 priv->width_chars = n_chars;
1462 g_object_notify (G_OBJECT (label), "width-chars");
1463 gtk_widget_queue_resize (GTK_WIDGET (label));
1468 * gtk_label_get_width_chars:
1469 * @label: a #GtkLabel
1471 * Retrieves the desired width of @label, in characters. See
1472 * gtk_label_set_width_chars().
1474 * Return value: the width of a label in characters.
1479 gtk_label_get_width_chars (GtkLabel *label)
1481 g_return_val_if_fail (GTK_IS_LABEL (label), -1);
1483 return GTK_LABEL_GET_PRIVATE (label)->width_chars;
1487 * gtk_label_set_line_wrap:
1488 * @label: a #GtkLabel
1489 * @wrap: the setting
1491 * Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
1492 * lines if text exceeds the widget's size. %FALSE lets the text get cut off
1493 * by the edge of the widget if it exceeds the widget size.
1496 gtk_label_set_line_wrap (GtkLabel *label,
1499 g_return_if_fail (GTK_IS_LABEL (label));
1501 wrap = wrap != FALSE;
1503 if (label->wrap != wrap)
1506 g_object_notify (G_OBJECT (label), "wrap");
1508 gtk_widget_queue_resize (GTK_WIDGET (label));
1513 * gtk_label_get_line_wrap:
1514 * @label: a #GtkLabel
1516 * Returns whether lines in the label are automatically wrapped. See gtk_label_set_line_wrap ().
1518 * Return value: %TRUE if the lines of the label are automatically wrapped.
1521 gtk_label_get_line_wrap (GtkLabel *label)
1523 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
1529 gtk_label_get (GtkLabel *label,
1532 g_return_if_fail (GTK_IS_LABEL (label));
1533 g_return_if_fail (str != NULL);
1539 gtk_label_destroy (GtkObject *object)
1541 GtkLabel *label = GTK_LABEL (object);
1543 gtk_label_set_mnemonic_widget (label, NULL);
1545 GTK_OBJECT_CLASS (parent_class)->destroy (object);
1549 gtk_label_finalize (GObject *object)
1553 g_return_if_fail (GTK_IS_LABEL (object));
1555 label = GTK_LABEL (object);
1557 g_free (label->label);
1558 g_free (label->text);
1561 g_object_unref (label->layout);
1564 pango_attr_list_unref (label->attrs);
1566 if (label->effective_attrs)
1567 pango_attr_list_unref (label->effective_attrs);
1569 g_free (label->select_info);
1571 G_OBJECT_CLASS (parent_class)->finalize (object);
1575 gtk_label_clear_layout (GtkLabel *label)
1579 g_object_unref (label->layout);
1580 label->layout = NULL;
1584 typedef struct _LabelWrapWidth LabelWrapWidth;
1585 struct _LabelWrapWidth
1588 PangoFontDescription *font_desc;
1592 label_wrap_width_free (gpointer data)
1594 LabelWrapWidth *wrap_width = data;
1595 pango_font_description_free (wrap_width->font_desc);
1596 g_free (wrap_width);
1600 get_label_wrap_width (GtkLabel *label)
1602 PangoLayout *layout;
1603 GtkStyle *style = GTK_WIDGET (label)->style;
1605 LabelWrapWidth *wrap_width = g_object_get_data (G_OBJECT (style), "gtk-label-wrap-width");
1608 wrap_width = g_new0 (LabelWrapWidth, 1);
1609 g_object_set_data_full (G_OBJECT (style), "gtk-label-wrap-width",
1610 wrap_width, label_wrap_width_free);
1613 if (wrap_width->font_desc && pango_font_description_equal (wrap_width->font_desc, style->font_desc))
1614 return wrap_width->width;
1616 if (wrap_width->font_desc)
1617 pango_font_description_free (wrap_width->font_desc);
1619 wrap_width->font_desc = pango_font_description_copy (style->font_desc);
1621 layout = gtk_widget_create_pango_layout (GTK_WIDGET (label),
1622 "This long string gives a good enough length for any line to have.");
1623 pango_layout_get_size (layout, &wrap_width->width, NULL);
1624 g_object_unref (layout);
1626 return wrap_width->width;
1630 gtk_label_ensure_layout (GtkLabel *label)
1633 PangoRectangle logical_rect;
1634 gint rwidth, rheight;
1637 widget = GTK_WIDGET (label);
1639 rtl = gtk_widget_get_direction(widget) == GTK_TEXT_DIR_RTL;
1640 rwidth = label->misc.xpad * 2;
1641 rheight = label->misc.ypad * 2;
1645 PangoAlignment align = PANGO_ALIGN_LEFT; /* Quiet gcc */
1646 GtkLabelPrivate *priv = GTK_LABEL_GET_PRIVATE (label);
1648 label->layout = gtk_widget_create_pango_layout (widget, label->text);
1650 if (label->effective_attrs)
1651 pango_layout_set_attributes (label->layout, label->effective_attrs);
1653 switch (label->jtype)
1655 case GTK_JUSTIFY_LEFT:
1656 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
1658 case GTK_JUSTIFY_RIGHT:
1659 align = rtl ? PANGO_ALIGN_LEFT : PANGO_ALIGN_RIGHT;
1661 case GTK_JUSTIFY_CENTER:
1662 align = PANGO_ALIGN_CENTER;
1664 case GTK_JUSTIFY_FILL:
1665 /* FIXME: This just doesn't work to do this */
1666 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
1667 pango_layout_set_justify (label->layout, TRUE);
1670 g_assert_not_reached();
1673 pango_layout_set_alignment (label->layout, align);
1674 pango_layout_set_ellipsize (label->layout, label->ellipsize);
1675 pango_layout_set_single_paragraph_mode (label->layout, priv->single_line_mode);
1677 if (label->ellipsize)
1678 pango_layout_set_width (label->layout,
1679 widget->allocation.width * PANGO_SCALE);
1680 else if (label->wrap)
1682 GtkWidgetAuxInfo *aux_info;
1683 gint longest_paragraph;
1686 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
1687 if (aux_info && aux_info->width > 0)
1688 pango_layout_set_width (label->layout, aux_info->width * PANGO_SCALE);
1691 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (label));
1694 pango_layout_set_width (label->layout, -1);
1695 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1697 width = logical_rect.width;
1699 /* Try to guess a reasonable maximum width */
1700 longest_paragraph = width;
1702 wrap_width = get_label_wrap_width (label);
1703 width = MIN (width, wrap_width);
1705 PANGO_SCALE * (gdk_screen_get_width (screen) + 1) / 2);
1707 pango_layout_set_width (label->layout, width);
1708 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1709 width = logical_rect.width;
1710 height = logical_rect.height;
1712 /* Unfortunately, the above may leave us with a very unbalanced looking paragraph,
1713 * so we try short search for a narrower width that leaves us with the same height
1715 if (longest_paragraph > 0)
1717 gint nlines, perfect_width;
1719 nlines = pango_layout_get_line_count (label->layout);
1720 perfect_width = (longest_paragraph + nlines - 1) / nlines;
1722 if (perfect_width < width)
1724 pango_layout_set_width (label->layout, perfect_width);
1725 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1727 if (logical_rect.height <= height)
1728 width = logical_rect.width;
1731 gint mid_width = (perfect_width + width) / 2;
1733 if (mid_width > perfect_width)
1735 pango_layout_set_width (label->layout, mid_width);
1736 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1738 if (logical_rect.height <= height)
1739 width = logical_rect.width;
1744 pango_layout_set_width (label->layout, width);
1747 else /* !label->wrap */
1748 pango_layout_set_width (label->layout, -1);
1753 gtk_label_size_request (GtkWidget *widget,
1754 GtkRequisition *requisition)
1757 GtkLabelPrivate *priv;
1759 PangoRectangle logical_rect;
1760 GtkWidgetAuxInfo *aux_info;
1762 g_return_if_fail (GTK_IS_LABEL (widget));
1763 g_return_if_fail (requisition != NULL);
1765 label = GTK_LABEL (widget);
1766 priv = GTK_LABEL_GET_PRIVATE (widget);
1769 * If word wrapping is on, then the height requisition can depend
1772 * - Any width set on the widget via gtk_widget_set_usize().
1773 * - The padding of the widget (xpad, set by gtk_misc_set_padding)
1775 * Instead of trying to detect changes to these quantities, if we
1776 * are wrapping, we just rewrap for each size request. Since
1777 * size requisitions are cached by the GTK+ core, this is not
1782 gtk_label_clear_layout (label);
1784 gtk_label_ensure_layout (label);
1786 width = label->misc.xpad * 2;
1787 height = label->misc.ypad * 2;
1789 pango_layout_get_extents (label->layout, NULL, &logical_rect);
1790 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
1792 if (label->ellipsize || priv->width_chars > 0)
1794 PangoContext *context;
1795 PangoFontMetrics *metrics;
1798 /* The minimum size for ellipsized labels is ~ 3 chars */
1799 context = pango_layout_get_context (label->layout);
1800 metrics = pango_context_get_metrics (context, widget->style->font_desc, NULL);
1802 char_width = pango_font_metrics_get_approximate_char_width (metrics);
1803 pango_font_metrics_unref (metrics);
1805 width += (PANGO_PIXELS (char_width) * MAX (priv->width_chars, 3));
1809 if (label->wrap && aux_info && aux_info->width > 0)
1810 width += aux_info->width;
1812 width += PANGO_PIXELS (logical_rect.width);
1815 if (priv->single_line_mode)
1817 PangoContext *context;
1818 PangoFontMetrics *metrics;
1819 gint ascent, descent;
1821 context = pango_layout_get_context (label->layout);
1822 metrics = pango_context_get_metrics (context, widget->style->font_desc,
1823 pango_context_get_language (context));
1825 ascent = pango_font_metrics_get_ascent (metrics);
1826 descent = pango_font_metrics_get_descent (metrics);
1827 pango_font_metrics_unref (metrics);
1829 height += PANGO_PIXELS (ascent + descent);
1832 height += PANGO_PIXELS (logical_rect.height);
1834 requisition->width = width;
1835 requisition->height = height;
1839 gtk_label_size_allocate (GtkWidget *widget,
1840 GtkAllocation *allocation)
1844 label = GTK_LABEL (widget);
1846 (* GTK_WIDGET_CLASS (parent_class)->size_allocate) (widget, allocation);
1848 if (label->ellipsize)
1851 pango_layout_set_width (label->layout, allocation->width * PANGO_SCALE);
1854 if (label->select_info && label->select_info->window)
1856 gdk_window_move_resize (label->select_info->window,
1860 allocation->height);
1865 gtk_label_state_changed (GtkWidget *widget,
1866 GtkStateType prev_state)
1870 label = GTK_LABEL (widget);
1872 if (label->select_info)
1873 gtk_label_select_region (label, 0, 0);
1875 if (GTK_WIDGET_CLASS (parent_class)->state_changed)
1876 GTK_WIDGET_CLASS (parent_class)->state_changed (widget, prev_state);
1880 gtk_label_style_set (GtkWidget *widget,
1881 GtkStyle *previous_style)
1885 g_return_if_fail (GTK_IS_LABEL (widget));
1887 label = GTK_LABEL (widget);
1889 /* We have to clear the layout, fonts etc. may have changed */
1890 gtk_label_clear_layout (label);
1894 gtk_label_direction_changed (GtkWidget *widget,
1895 GtkTextDirection previous_dir)
1897 GtkLabel *label = GTK_LABEL (widget);
1900 pango_layout_context_changed (label->layout);
1902 GTK_WIDGET_CLASS (parent_class)->direction_changed (widget, previous_dir);
1907 gtk_label_paint_word (GtkLabel *label,
1913 GtkWidget *widget = GTK_WIDGET (label);
1914 GtkLabelULine *uline;
1917 tmp_str = gdk_wcstombs (word->beginning);
1920 gtk_paint_string (widget->style, widget->window, widget->state,
1921 area, widget, "label",
1928 for (uline = word->uline; uline; uline = uline->next)
1929 gtk_paint_hline (widget->style, widget->window,
1930 widget->state, area,
1932 x + uline->x1, x + uline->x2, y + uline->y);
1937 get_layout_location (GtkLabel *label,
1944 gint req_width, x, y;
1946 misc = GTK_MISC (label);
1947 widget = GTK_WIDGET (label);
1949 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
1950 xalign = misc->xalign;
1952 xalign = 1.0 - misc->xalign;
1954 if (label->ellipsize)
1956 PangoRectangle ink_rect;
1958 pango_layout_get_extents (label->layout, &ink_rect, NULL);
1960 req_width = PANGO_PIXELS (ink_rect.width);
1963 req_width = widget->requisition.width;
1965 x = floor (widget->allocation.x + (gint)misc->xpad +
1966 xalign * (widget->allocation.width - req_width)
1969 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
1970 x = MAX (x, widget->allocation.x + misc->xpad);
1973 widget->allocation.x + widget->allocation.width -
1974 req_width - misc->xpad);
1976 y = floor (widget->allocation.y + (gint)misc->ypad
1977 + MAX (((widget->allocation.height - widget->requisition.height) * misc->yalign)
1988 draw_insertion_cursor (GtkLabel *label,
1989 GdkRectangle *cursor_location,
1990 gboolean is_primary,
1991 PangoDirection direction,
1992 gboolean draw_arrow)
1994 GtkWidget *widget = GTK_WIDGET (label);
1995 GtkTextDirection text_dir;
1997 if (direction == PANGO_DIRECTION_LTR)
1998 text_dir = GTK_TEXT_DIR_LTR;
2000 text_dir = GTK_TEXT_DIR_RTL;
2002 gtk_draw_insertion_cursor (widget, widget->window, &(widget->allocation),
2004 is_primary, text_dir, draw_arrow);
2007 static PangoDirection
2008 get_cursor_direction (GtkLabel *label)
2012 g_assert (label->select_info);
2014 gtk_label_ensure_layout (label);
2016 for (l = pango_layout_get_lines (label->layout); l; l = l->next)
2018 PangoLayoutLine *line = l->data;
2020 /* If label->select_info->selection_end is at the very end of
2021 * the line, we don't know if the cursor is on this line or
2022 * the next without looking ahead at the next line. (End
2023 * of paragraph is different from line break.) But it's
2024 * definitely in this paragraph, which is good enough
2025 * to figure out the resolved direction.
2027 if (line->start_index + line->length >= label->select_info->selection_end)
2028 return line->resolved_dir;
2031 return PANGO_DIRECTION_LTR;
2035 gtk_label_draw_cursor (GtkLabel *label, gint xoffset, gint yoffset)
2037 if (label->select_info == NULL)
2040 if (GTK_WIDGET_DRAWABLE (label))
2042 GtkWidget *widget = GTK_WIDGET (label);
2044 PangoDirection keymap_direction;
2045 PangoDirection cursor_direction;
2046 PangoRectangle strong_pos, weak_pos;
2047 gboolean split_cursor;
2048 PangoRectangle *cursor1 = NULL;
2049 PangoRectangle *cursor2 = NULL;
2050 GdkRectangle cursor_location;
2051 PangoDirection dir1 = PANGO_DIRECTION_NEUTRAL;
2052 PangoDirection dir2 = PANGO_DIRECTION_NEUTRAL;
2054 keymap_direction = gdk_keymap_get_direction (gdk_keymap_get_for_display (gtk_widget_get_display (widget)));
2055 cursor_direction = get_cursor_direction (label);
2057 gtk_label_ensure_layout (label);
2059 pango_layout_get_cursor_pos (label->layout, label->select_info->selection_end,
2060 &strong_pos, &weak_pos);
2062 g_object_get (gtk_widget_get_settings (widget),
2063 "gtk-split-cursor", &split_cursor,
2066 dir1 = cursor_direction;
2070 cursor1 = &strong_pos;
2072 if (strong_pos.x != weak_pos.x ||
2073 strong_pos.y != weak_pos.y)
2075 dir2 = (cursor_direction == PANGO_DIRECTION_LTR) ? PANGO_DIRECTION_RTL : PANGO_DIRECTION_LTR;
2076 cursor2 = &weak_pos;
2081 if (keymap_direction == cursor_direction)
2082 cursor1 = &strong_pos;
2084 cursor1 = &weak_pos;
2087 cursor_location.x = xoffset + PANGO_PIXELS (cursor1->x);
2088 cursor_location.y = yoffset + PANGO_PIXELS (cursor1->y);
2089 cursor_location.width = 0;
2090 cursor_location.height = PANGO_PIXELS (cursor1->height);
2092 draw_insertion_cursor (label,
2093 &cursor_location, TRUE, dir1,
2094 dir2 != PANGO_DIRECTION_NEUTRAL);
2096 if (dir2 != PANGO_DIRECTION_NEUTRAL)
2098 cursor_location.x = xoffset + PANGO_PIXELS (cursor2->x);
2099 cursor_location.y = yoffset + PANGO_PIXELS (cursor2->y);
2100 cursor_location.width = 0;
2101 cursor_location.height = PANGO_PIXELS (cursor2->height);
2103 draw_insertion_cursor (label,
2104 &cursor_location, FALSE, dir2,
2112 gtk_label_expose (GtkWidget *widget,
2113 GdkEventExpose *event)
2118 g_return_val_if_fail (GTK_IS_LABEL (widget), FALSE);
2119 g_return_val_if_fail (event != NULL, FALSE);
2121 label = GTK_LABEL (widget);
2123 gtk_label_ensure_layout (label);
2125 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
2126 label->text && (*label->text != '\0'))
2128 get_layout_location (label, &x, &y);
2130 gtk_paint_layout (widget->style,
2132 GTK_WIDGET_STATE (widget),
2140 if (label->select_info &&
2141 (label->select_info->selection_anchor !=
2142 label->select_info->selection_end))
2148 range[0] = label->select_info->selection_anchor;
2149 range[1] = label->select_info->selection_end;
2151 if (range[0] > range[1])
2153 gint tmp = range[0];
2154 range[0] = range[1];
2158 clip = gdk_pango_layout_get_clip_region (label->layout,
2162 gdk_region_intersect (clip, event->region);
2164 /* FIXME should use gtk_paint, but it can't use a clip
2168 gdk_gc_set_clip_region (widget->style->black_gc, clip);
2171 state = GTK_STATE_SELECTED;
2172 if (!GTK_WIDGET_HAS_FOCUS (widget))
2173 state = GTK_STATE_ACTIVE;
2175 gdk_draw_layout_with_colors (widget->window,
2176 widget->style->black_gc,
2179 &widget->style->text[state],
2180 &widget->style->base[state]);
2182 gdk_gc_set_clip_region (widget->style->black_gc, NULL);
2183 gdk_region_destroy (clip);
2185 else if (label->select_info && GTK_WIDGET_HAS_FOCUS (widget))
2186 gtk_label_draw_cursor (label, x, y);
2193 gtk_label_set_uline_text_internal (GtkLabel *label,
2196 guint accel_key = GDK_VoidSymbol;
2201 gchar *dest, *pattern_dest;
2202 gboolean underscore;
2204 g_return_if_fail (GTK_IS_LABEL (label));
2205 g_return_if_fail (str != NULL);
2207 /* Split text into the base text and a separate pattern
2211 new_str = g_new (gchar, strlen (str) + 1);
2212 pattern = g_new (gchar, g_utf8_strlen (str, -1) + 1);
2221 pattern_dest = pattern;
2228 c = g_utf8_get_char (src);
2229 if (c == (gunichar)-1)
2231 g_warning ("Invalid input string");
2236 next_src = g_utf8_next_char (src);
2241 *pattern_dest++ = ' ';
2244 *pattern_dest++ = '_';
2245 if (accel_key == GDK_VoidSymbol)
2246 accel_key = gdk_keyval_to_lower (gdk_unicode_to_keyval (c));
2249 while (src < next_src)
2263 while (src < next_src)
2266 *pattern_dest++ = ' ';
2273 gtk_label_set_text_internal (label, new_str);
2274 gtk_label_set_pattern_internal (label, pattern);
2278 label->mnemonic_keyval = accel_key;
2282 gtk_label_parse_uline (GtkLabel *label,
2288 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);
2289 g_return_val_if_fail (str != NULL, GDK_VoidSymbol);
2291 orig_keyval = label->mnemonic_keyval;
2293 g_object_freeze_notify (G_OBJECT (label));
2295 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
2296 gtk_label_set_use_markup_internal (label, FALSE);
2297 gtk_label_set_use_underline_internal (label, TRUE);
2299 gtk_label_recalculate (label);
2301 keyval = label->mnemonic_keyval;
2302 label->mnemonic_keyval = GDK_VoidSymbol;
2304 gtk_label_setup_mnemonic (label, orig_keyval);
2306 g_object_thaw_notify (G_OBJECT (label));
2312 * gtk_label_set_text_with_mnemonic:
2313 * @label: a #GtkLabel
2316 * Sets the label's text from the string @str.
2317 * If characters in @str are preceded by an underscore, they are underlined
2318 * indicating that they represent a keyboard accelerator called a mnemonic.
2319 * The mnemonic key can be used to activate another widget, chosen automatically,
2320 * or explicitly using gtk_label_set_mnemonic_widget().
2323 gtk_label_set_text_with_mnemonic (GtkLabel *label,
2328 g_return_if_fail (GTK_IS_LABEL (label));
2329 g_return_if_fail (str != NULL);
2331 last_keyval = label->mnemonic_keyval;
2333 g_object_freeze_notify (G_OBJECT (label));
2335 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
2336 gtk_label_set_use_markup_internal (label, FALSE);
2337 gtk_label_set_use_underline_internal (label, TRUE);
2339 gtk_label_recalculate (label);
2341 gtk_label_setup_mnemonic (label, last_keyval);
2343 g_object_thaw_notify (G_OBJECT (label));
2347 gtk_label_realize (GtkWidget *widget)
2351 label = GTK_LABEL (widget);
2353 (* GTK_WIDGET_CLASS (parent_class)->realize) (widget);
2355 if (label->select_info)
2356 gtk_label_create_window (label);
2360 gtk_label_unrealize (GtkWidget *widget)
2364 label = GTK_LABEL (widget);
2366 if (label->select_info)
2367 gtk_label_destroy_window (label);
2369 (* GTK_WIDGET_CLASS (parent_class)->unrealize) (widget);
2373 gtk_label_map (GtkWidget *widget)
2377 label = GTK_LABEL (widget);
2379 (* GTK_WIDGET_CLASS (parent_class)->map) (widget);
2381 if (label->select_info)
2382 gdk_window_show (label->select_info->window);
2386 gtk_label_unmap (GtkWidget *widget)
2390 label = GTK_LABEL (widget);
2392 if (label->select_info)
2393 gdk_window_hide (label->select_info->window);
2395 (* GTK_WIDGET_CLASS (parent_class)->unmap) (widget);
2399 window_to_layout_coords (GtkLabel *label,
2406 widget = GTK_WIDGET (label);
2408 /* get layout location in widget->window coords */
2409 get_layout_location (label, &lx, &ly);
2413 *x += widget->allocation.x; /* go to widget->window */
2414 *x -= lx; /* go to layout */
2419 *y += widget->allocation.y; /* go to widget->window */
2420 *y -= ly; /* go to layout */
2426 layout_to_window_coords (GtkLabel *label,
2433 widget = GTK_WIDGET (label);
2435 /* get layout location in widget->window coords */
2436 get_layout_location (label, &lx, &ly);
2440 *x += lx; /* go to widget->window */
2441 *x -= widget->allocation.x; /* go to selection window */
2446 *y += ly; /* go to widget->window */
2447 *y -= widget->allocation.y; /* go to selection window */
2453 get_layout_index (GtkLabel *label,
2459 const gchar *cluster;
2460 const gchar *cluster_end;
2464 gtk_label_ensure_layout (label);
2466 window_to_layout_coords (label, &x, &y);
2471 pango_layout_xy_to_index (label->layout,
2476 cluster = label->text + *index;
2477 cluster_end = cluster;
2480 cluster_end = g_utf8_next_char (cluster_end);
2484 *index += (cluster_end - cluster);
2488 gtk_label_select_word (GtkLabel *label)
2492 gint start_index = gtk_label_move_backward_word (label, label->select_info->selection_end);
2493 gint end_index = gtk_label_move_forward_word (label, label->select_info->selection_end);
2495 min = MIN (label->select_info->selection_anchor,
2496 label->select_info->selection_end);
2497 max = MAX (label->select_info->selection_anchor,
2498 label->select_info->selection_end);
2500 min = MIN (min, start_index);
2501 max = MAX (max, end_index);
2503 gtk_label_select_region_index (label, min, max);
2507 gtk_label_button_press (GtkWidget *widget,
2508 GdkEventButton *event)
2514 label = GTK_LABEL (widget);
2516 if (label->select_info == NULL)
2519 label->select_info->in_drag = FALSE;
2520 if (event->button == 1)
2522 if (!GTK_WIDGET_HAS_FOCUS (widget))
2523 gtk_widget_grab_focus (widget);
2525 if (event->type == GDK_3BUTTON_PRESS)
2527 gtk_label_select_region_index (label, 0, strlen (label->text));
2531 if (event->type == GDK_2BUTTON_PRESS)
2533 gtk_label_select_word (label);
2537 get_layout_index (label, event->x, event->y, &index);
2539 min = MIN (label->select_info->selection_anchor,
2540 label->select_info->selection_end);
2541 max = MAX (label->select_info->selection_anchor,
2542 label->select_info->selection_end);
2544 if ((label->select_info->selection_anchor !=
2545 label->select_info->selection_end) &&
2546 (event->state & GDK_SHIFT_MASK))
2548 /* extend (same as motion) */
2549 min = MIN (min, index);
2550 max = MAX (max, index);
2552 /* ensure the anchor is opposite index */
2560 gtk_label_select_region_index (label, min, max);
2564 if (event->type == GDK_3BUTTON_PRESS)
2565 gtk_label_select_region_index (label, 0, strlen (label->text));
2566 else if (event->type == GDK_2BUTTON_PRESS)
2567 gtk_label_select_word (label);
2568 else if (min < max && min <= index && index <= max)
2570 label->select_info->in_drag = TRUE;
2571 label->select_info->drag_start_x = event->x;
2572 label->select_info->drag_start_y = event->y;
2575 /* start a replacement */
2576 gtk_label_select_region_index (label, index, index);
2581 else if (event->button == 3 && event->type == GDK_BUTTON_PRESS)
2583 gtk_label_do_popup (label, event);
2592 gtk_label_button_release (GtkWidget *widget,
2593 GdkEventButton *event)
2596 GtkLabel *label = GTK_LABEL (widget);
2599 if (label->select_info == NULL)
2602 if (label->select_info->in_drag)
2604 label->select_info->in_drag = 0;
2606 get_layout_index (label, event->x, event->y, &index);
2607 gtk_label_select_region_index (label, index, index);
2612 if (event->button != 1)
2615 /* The goal here is to return TRUE iff we ate the
2616 * button press to start selecting.
2623 gtk_label_motion (GtkWidget *widget,
2624 GdkEventMotion *event)
2630 label = GTK_LABEL (widget);
2632 if (label->select_info == NULL)
2636 if ((event->state & GDK_BUTTON1_MASK) == 0)
2639 gdk_window_get_pointer (label->select_info->window,
2642 if (label->select_info->in_drag)
2644 if (gtk_drag_check_threshold (widget,
2645 label->select_info->drag_start_x,
2646 label->select_info->drag_start_y,
2647 event->x, event->y))
2649 GdkDragContext *context;
2650 GtkTargetList *target_list = gtk_target_list_new (NULL, 0);
2652 gtk_target_list_add_text_targets (target_list, 0);
2654 context = gtk_drag_begin (widget, target_list,
2656 1, (GdkEvent *)event);
2659 label->select_info->in_drag = FALSE;
2661 gtk_target_list_unref (target_list);
2662 gtk_drag_set_icon_default (context);
2667 get_layout_index (label, x, y, &index);
2669 gtk_label_select_region_index (label,
2670 label->select_info->selection_anchor,
2678 gtk_label_create_window (GtkLabel *label)
2681 GdkWindowAttr attributes;
2682 gint attributes_mask;
2684 g_assert (label->select_info);
2685 g_assert (GTK_WIDGET_REALIZED (label));
2687 if (label->select_info->window)
2690 widget = GTK_WIDGET (label);
2692 attributes.x = widget->allocation.x;
2693 attributes.y = widget->allocation.y;
2694 attributes.width = widget->allocation.width;
2695 attributes.height = widget->allocation.height;
2696 attributes.window_type = GDK_WINDOW_TEMP;
2697 attributes.wclass = GDK_INPUT_ONLY;
2698 attributes.override_redirect = TRUE;
2699 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
2701 attributes.event_mask = gtk_widget_get_events (widget) |
2702 GDK_BUTTON_PRESS_MASK |
2703 GDK_BUTTON_RELEASE_MASK |
2704 GDK_BUTTON_MOTION_MASK;
2706 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR | GDK_WA_CURSOR;
2708 label->select_info->window = gdk_window_new (widget->window,
2709 &attributes, attributes_mask);
2710 gdk_window_set_user_data (label->select_info->window, widget);
2712 gdk_cursor_unref (attributes.cursor);
2716 gtk_label_destroy_window (GtkLabel *label)
2718 g_assert (label->select_info);
2720 if (label->select_info->window == NULL)
2723 gdk_window_set_user_data (label->select_info->window, NULL);
2724 gdk_window_destroy (label->select_info->window);
2725 label->select_info->window = NULL;
2729 * gtk_label_set_selectable:
2730 * @label: a #GtkLabel
2731 * @setting: %TRUE to allow selecting text in the label
2733 * Selectable labels allow the user to select text from the label, for
2738 gtk_label_set_selectable (GtkLabel *label,
2741 gboolean old_setting;
2743 g_return_if_fail (GTK_IS_LABEL (label));
2745 setting = setting != FALSE;
2746 old_setting = label->select_info != NULL;
2750 if (label->select_info == NULL)
2752 label->select_info = g_new0 (GtkLabelSelectionInfo, 1);
2754 GTK_WIDGET_SET_FLAGS (label, GTK_CAN_FOCUS);
2756 if (GTK_WIDGET_REALIZED (label))
2757 gtk_label_create_window (label);
2759 if (GTK_WIDGET_MAPPED (label))
2760 gdk_window_show (label->select_info->window);
2765 if (label->select_info)
2767 /* unselect, to give up the selection */
2768 gtk_label_select_region (label, 0, 0);
2770 if (label->select_info->window)
2772 gtk_label_destroy_window (label);
2775 g_free (label->select_info);
2777 label->select_info = NULL;
2779 GTK_WIDGET_UNSET_FLAGS (label, GTK_CAN_FOCUS);
2782 if (setting != old_setting)
2784 g_object_freeze_notify (G_OBJECT (label));
2785 g_object_notify (G_OBJECT (label), "selectable");
2786 g_object_notify (G_OBJECT (label), "cursor_position");
2787 g_object_notify (G_OBJECT (label), "selection_bound");
2788 g_object_thaw_notify (G_OBJECT (label));
2789 gtk_widget_queue_draw (GTK_WIDGET (label));
2794 * gtk_label_get_selectable:
2795 * @label: a #GtkLabel
2797 * Gets the value set by gtk_label_set_selectable().
2799 * Return value: %TRUE if the user can copy text from the label
2802 gtk_label_get_selectable (GtkLabel *label)
2804 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
2806 return label->select_info != NULL;
2810 gtk_label_set_selection_text (GtkLabel *label,
2811 GtkSelectionData *selection_data)
2813 if ((label->select_info->selection_anchor !=
2814 label->select_info->selection_end) &&
2820 start = MIN (label->select_info->selection_anchor,
2821 label->select_info->selection_end);
2822 end = MAX (label->select_info->selection_anchor,
2823 label->select_info->selection_end);
2825 len = strlen (label->text);
2833 gtk_selection_data_set_text (selection_data,
2834 label->text + start,
2840 gtk_label_drag_data_get (GtkWidget *widget,
2841 GdkDragContext *context,
2842 GtkSelectionData *selection_data,
2846 gtk_label_set_selection_text (GTK_LABEL (widget), selection_data);
2850 get_text_callback (GtkClipboard *clipboard,
2851 GtkSelectionData *selection_data,
2853 gpointer user_data_or_owner)
2855 gtk_label_set_selection_text (GTK_LABEL (user_data_or_owner), selection_data);
2859 clear_text_callback (GtkClipboard *clipboard,
2860 gpointer user_data_or_owner)
2864 label = GTK_LABEL (user_data_or_owner);
2866 if (label->select_info)
2868 label->select_info->selection_anchor = label->select_info->selection_end;
2870 gtk_widget_queue_draw (GTK_WIDGET (label));
2875 gtk_label_select_region_index (GtkLabel *label,
2879 static const GtkTargetEntry targets[] = {
2882 { "COMPOUND_TEXT", 0, 0 },
2883 { "UTF8_STRING", 0, 0 }
2886 g_return_if_fail (GTK_IS_LABEL (label));
2888 if (label->select_info)
2890 GtkClipboard *clipboard;
2892 if (label->select_info->selection_anchor == anchor_index &&
2893 label->select_info->selection_end == end_index)
2896 label->select_info->selection_anchor = anchor_index;
2897 label->select_info->selection_end = end_index;
2899 clipboard = gtk_widget_get_clipboard (GTK_WIDGET (label),
2900 GDK_SELECTION_PRIMARY);
2902 if (anchor_index != end_index)
2904 gtk_clipboard_set_with_owner (clipboard,
2906 G_N_ELEMENTS (targets),
2908 clear_text_callback,
2913 if (gtk_clipboard_get_owner (clipboard) == G_OBJECT (label))
2914 gtk_clipboard_clear (clipboard);
2917 gtk_widget_queue_draw (GTK_WIDGET (label));
2919 g_object_freeze_notify (G_OBJECT (label));
2920 g_object_notify (G_OBJECT (label), "cursor_position");
2921 g_object_notify (G_OBJECT (label), "selection_bound");
2922 g_object_thaw_notify (G_OBJECT (label));
2927 * gtk_label_select_region:
2928 * @label: a #GtkLabel
2929 * @start_offset: start offset (in characters not bytes)
2930 * @end_offset: end offset (in characters not bytes)
2932 * Selects a range of characters in the label, if the label is selectable.
2933 * See gtk_label_set_selectable(). If the label is not selectable,
2934 * this function has no effect. If @start_offset or
2935 * @end_offset are -1, then the end of the label will be substituted.
2939 gtk_label_select_region (GtkLabel *label,
2943 g_return_if_fail (GTK_IS_LABEL (label));
2945 if (label->text && label->select_info)
2947 if (start_offset < 0)
2948 start_offset = g_utf8_strlen (label->text, -1);
2951 end_offset = g_utf8_strlen (label->text, -1);
2953 gtk_label_select_region_index (label,
2954 g_utf8_offset_to_pointer (label->text, start_offset) - label->text,
2955 g_utf8_offset_to_pointer (label->text, end_offset) - label->text);
2960 * gtk_label_get_selection_bounds:
2961 * @label: a #GtkLabel
2962 * @start: return location for start of selection, as a character offset
2963 * @end: return location for end of selection, as a character offset
2965 * Gets the selected range of characters in the label, returning %TRUE
2966 * if there's a selection.
2968 * Return value: %TRUE if selection is non-empty
2971 gtk_label_get_selection_bounds (GtkLabel *label,
2975 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
2977 if (label->select_info == NULL)
2979 /* not a selectable label */
2989 gint start_index, end_index;
2990 gint start_offset, end_offset;
2993 start_index = MIN (label->select_info->selection_anchor,
2994 label->select_info->selection_end);
2995 end_index = MAX (label->select_info->selection_anchor,
2996 label->select_info->selection_end);
2998 len = strlen (label->text);
3000 if (end_index > len)
3003 if (start_index > len)
3006 start_offset = g_utf8_strlen (label->text, start_index);
3007 end_offset = g_utf8_strlen (label->text, end_index);
3009 if (start_offset > end_offset)
3011 gint tmp = start_offset;
3012 start_offset = end_offset;
3017 *start = start_offset;
3022 return start_offset != end_offset;
3028 * gtk_label_get_layout:
3029 * @label: a #GtkLabel
3031 * Gets the #PangoLayout used to display the label.
3032 * The layout is useful to e.g. convert text positions to
3033 * pixel positions, in combination with gtk_label_get_layout_offsets().
3034 * The returned layout is owned by the label so need not be
3035 * freed by the caller.
3037 * Return value: the #PangoLayout for this label
3040 gtk_label_get_layout (GtkLabel *label)
3042 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
3044 gtk_label_ensure_layout (label);
3046 return label->layout;
3050 * gtk_label_get_layout_offsets:
3051 * @label: a #GtkLabel
3052 * @x: location to store X offset of layout, or %NULL
3053 * @y: location to store Y offset of layout, or %NULL
3055 * Obtains the coordinates where the label will draw the #PangoLayout
3056 * representing the text in the label; useful to convert mouse events
3057 * into coordinates inside the #PangoLayout, e.g. to take some action
3058 * if some part of the label is clicked. Of course you will need to
3059 * create a #GtkEventBox to receive the events, and pack the label
3060 * inside it, since labels are a #GTK_NO_WINDOW widget. Remember
3061 * when using the #PangoLayout functions you need to convert to
3062 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
3066 gtk_label_get_layout_offsets (GtkLabel *label,
3070 g_return_if_fail (GTK_IS_LABEL (label));
3072 get_layout_location (label, x, y);
3076 * gtk_label_set_use_markup:
3077 * @label: a #GtkLabel
3078 * @setting: %TRUE if the label's text should be parsed for markup.
3080 * Sets whether the text of the label contains markup in <link
3081 * linkend="PangoMarkupFormat">Pango's text markup
3082 * language</link>. See gtk_label_set_markup().
3085 gtk_label_set_use_markup (GtkLabel *label,
3088 g_return_if_fail (GTK_IS_LABEL (label));
3090 gtk_label_set_use_markup_internal (label, setting);
3091 gtk_label_recalculate (label);
3095 * gtk_label_get_use_markup:
3096 * @label: a #GtkLabel
3098 * Returns whether the label's text is interpreted as marked up with
3099 * the <link linkend="PangoMarkupFormat">Pango text markup
3100 * language</link>. See gtk_label_set_use_markup ().
3102 * Return value: %TRUE if the label's text will be parsed for markup.
3105 gtk_label_get_use_markup (GtkLabel *label)
3107 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3109 return label->use_markup;
3113 * gtk_label_set_use_underline:
3114 * @label: a #GtkLabel
3115 * @setting: %TRUE if underlines in the text indicate mnemonics
3117 * If true, an underline in the text indicates the next character should be
3118 * used for the mnemonic accelerator key.
3121 gtk_label_set_use_underline (GtkLabel *label,
3124 g_return_if_fail (GTK_IS_LABEL (label));
3126 gtk_label_set_use_underline_internal (label, setting);
3127 gtk_label_recalculate (label);
3128 if (label->use_underline)
3129 gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
3133 * gtk_label_get_use_underline:
3134 * @label: a #GtkLabel
3136 * Returns whether an embedded underline in the label indicates a
3137 * mnemonic. See gtk_label_set_use_underline ().
3139 * Return value: %TRUE whether an embedded underline in the label indicates
3140 * the mnemonic accelerator keys.
3143 gtk_label_get_use_underline (GtkLabel *label)
3145 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3147 return label->use_underline;
3151 * gtk_label_set_single_line_mode:
3152 * @label: a #GtkLabel
3153 * @single_line_mode: %TRUE if the label should be in single line mode
3155 * Sets whether the label is in single line mode.
3160 gtk_label_set_single_line_mode (GtkLabel *label,
3161 gboolean single_line_mode)
3163 GtkLabelPrivate *priv;
3165 g_return_if_fail (GTK_IS_LABEL (label));
3167 single_line_mode = single_line_mode != FALSE;
3169 priv = GTK_LABEL_GET_PRIVATE (label);
3170 if (priv->single_line_mode != single_line_mode)
3172 priv->single_line_mode = single_line_mode;
3174 gtk_label_clear_layout (label);
3175 gtk_widget_queue_resize (GTK_WIDGET (label));
3177 g_object_notify (G_OBJECT (label), "single-line-mode");
3182 * gtk_label_get_single_line_mode:
3183 * @label: a #GtkLabel
3185 * Returns whether the label is in single line mode.
3187 * Return value: %TRUE when the label is in single line mode.
3192 gtk_label_get_single_line_mode (GtkLabel *label)
3194 GtkLabelPrivate *priv;
3196 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3198 priv = GTK_LABEL_GET_PRIVATE (label);
3200 return priv->single_line_mode;
3203 /* Compute the X position for an offset that corresponds to the "more important
3204 * cursor position for that offset. We use this when trying to guess to which
3205 * end of the selection we should go to when the user hits the left or
3209 get_better_cursor (GtkLabel *label,
3214 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
3215 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
3216 PangoDirection cursor_direction = get_cursor_direction (label);
3217 gboolean split_cursor;
3218 PangoRectangle strong_pos, weak_pos;
3220 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
3221 "gtk-split-cursor", &split_cursor,
3224 gtk_label_ensure_layout (label);
3226 pango_layout_get_cursor_pos (label->layout, index,
3227 &strong_pos, &weak_pos);
3231 *x = strong_pos.x / PANGO_SCALE;
3232 *y = strong_pos.y / PANGO_SCALE;
3236 if (keymap_direction == cursor_direction)
3238 *x = strong_pos.x / PANGO_SCALE;
3239 *y = strong_pos.y / PANGO_SCALE;
3243 *x = weak_pos.x / PANGO_SCALE;
3244 *y = weak_pos.y / PANGO_SCALE;
3251 gtk_label_move_logically (GtkLabel *label,
3255 gint offset = g_utf8_pointer_to_offset (label->text,
3256 label->text + start);
3260 PangoLogAttr *log_attrs;
3264 gtk_label_ensure_layout (label);
3266 length = g_utf8_strlen (label->text, -1);
3268 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
3270 while (count > 0 && offset < length)
3274 while (offset < length && !log_attrs[offset].is_cursor_position);
3278 while (count < 0 && offset > 0)
3282 while (offset > 0 && !log_attrs[offset].is_cursor_position);
3290 return g_utf8_offset_to_pointer (label->text, offset) - label->text;
3294 gtk_label_move_visually (GtkLabel *label,
3304 int new_index, new_trailing;
3305 gboolean split_cursor;
3308 gtk_label_ensure_layout (label);
3310 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
3311 "gtk-split-cursor", &split_cursor,
3318 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
3319 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
3321 strong = keymap_direction == get_cursor_direction (label);
3326 pango_layout_move_cursor_visually (label->layout, strong, index, 0, 1, &new_index, &new_trailing);
3331 pango_layout_move_cursor_visually (label->layout, strong, index, 0, -1, &new_index, &new_trailing);
3335 if (new_index < 0 || new_index == G_MAXINT)
3340 while (new_trailing--)
3341 index = g_utf8_next_char (label->text + new_index) - label->text;
3348 gtk_label_move_forward_word (GtkLabel *label,
3351 gint new_pos = g_utf8_pointer_to_offset (label->text,
3352 label->text + start);
3355 length = g_utf8_strlen (label->text, -1);
3356 if (new_pos < length)
3358 PangoLogAttr *log_attrs;
3361 gtk_label_ensure_layout (label);
3363 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
3365 /* Find the next word end */
3367 while (new_pos < n_attrs && !log_attrs[new_pos].is_word_end)
3373 return g_utf8_offset_to_pointer (label->text, new_pos) - label->text;
3378 gtk_label_move_backward_word (GtkLabel *label,
3381 gint new_pos = g_utf8_pointer_to_offset (label->text,
3382 label->text + start);
3385 length = g_utf8_strlen (label->text, -1);
3389 PangoLogAttr *log_attrs;
3392 gtk_label_ensure_layout (label);
3394 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
3398 /* Find the previous word beginning */
3399 while (new_pos > 0 && !log_attrs[new_pos].is_word_start)
3405 return g_utf8_offset_to_pointer (label->text, new_pos) - label->text;
3409 gtk_label_move_cursor (GtkLabel *label,
3410 GtkMovementStep step,
3412 gboolean extend_selection)
3416 if (label->select_info == NULL)
3419 new_pos = label->select_info->selection_end;
3421 if (label->select_info->selection_end != label->select_info->selection_anchor &&
3424 /* If we have a current selection and aren't extending it, move to the
3425 * start/or end of the selection as appropriate
3429 case GTK_MOVEMENT_VISUAL_POSITIONS:
3432 gint anchor_x, anchor_y;
3433 gboolean end_is_left;
3435 get_better_cursor (label, label->select_info->selection_end, &end_x, &end_y);
3436 get_better_cursor (label, label->select_info->selection_anchor, &anchor_x, &anchor_y);
3438 end_is_left = (end_y < anchor_y) || (end_y == anchor_y && end_x < anchor_x);
3441 new_pos = end_is_left ? label->select_info->selection_end : label->select_info->selection_anchor;
3443 new_pos = !end_is_left ? label->select_info->selection_end : label->select_info->selection_anchor;
3447 case GTK_MOVEMENT_LOGICAL_POSITIONS:
3448 case GTK_MOVEMENT_WORDS:
3450 new_pos = MIN (label->select_info->selection_end, label->select_info->selection_anchor);
3452 new_pos = MAX (label->select_info->selection_end, label->select_info->selection_anchor);
3454 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
3455 case GTK_MOVEMENT_PARAGRAPH_ENDS:
3456 case GTK_MOVEMENT_BUFFER_ENDS:
3457 /* FIXME: Can do better here */
3458 new_pos = count < 0 ? 0 : strlen (label->text);
3460 case GTK_MOVEMENT_DISPLAY_LINES:
3461 case GTK_MOVEMENT_PARAGRAPHS:
3462 case GTK_MOVEMENT_PAGES:
3463 case GTK_MOVEMENT_HORIZONTAL_PAGES:
3471 case GTK_MOVEMENT_LOGICAL_POSITIONS:
3472 new_pos = gtk_label_move_logically (label, new_pos, count);
3474 case GTK_MOVEMENT_VISUAL_POSITIONS:
3475 new_pos = gtk_label_move_visually (label, new_pos, count);
3477 case GTK_MOVEMENT_WORDS:
3480 new_pos = gtk_label_move_forward_word (label, new_pos);
3485 new_pos = gtk_label_move_backward_word (label, new_pos);
3489 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
3490 case GTK_MOVEMENT_PARAGRAPH_ENDS:
3491 case GTK_MOVEMENT_BUFFER_ENDS:
3492 /* FIXME: Can do better here */
3493 new_pos = count < 0 ? 0 : strlen (label->text);
3495 case GTK_MOVEMENT_DISPLAY_LINES:
3496 case GTK_MOVEMENT_PARAGRAPHS:
3497 case GTK_MOVEMENT_PAGES:
3498 case GTK_MOVEMENT_HORIZONTAL_PAGES:
3503 if (extend_selection)
3504 gtk_label_select_region_index (label,
3505 label->select_info->selection_anchor,
3508 gtk_label_select_region_index (label, new_pos, new_pos);
3512 gtk_label_copy_clipboard (GtkLabel *label)
3514 if (label->text && label->select_info)
3519 start = MIN (label->select_info->selection_anchor,
3520 label->select_info->selection_end);
3521 end = MAX (label->select_info->selection_anchor,
3522 label->select_info->selection_end);
3524 len = strlen (label->text);
3533 gtk_clipboard_set_text (gtk_widget_get_clipboard (GTK_WIDGET (label),
3534 GDK_SELECTION_CLIPBOARD),
3535 label->text + start, end - start);
3540 gtk_label_select_all (GtkLabel *label)
3542 gtk_label_select_region_index (label, 0, strlen (label->text));
3545 /* Quick hack of a popup menu
3548 activate_cb (GtkWidget *menuitem,
3551 const gchar *signal = g_object_get_data (G_OBJECT (menuitem), "gtk-signal");
3552 g_signal_emit_by_name (label, signal);
3556 append_action_signal (GtkLabel *label,
3558 const gchar *stock_id,
3559 const gchar *signal,
3562 GtkWidget *menuitem = gtk_image_menu_item_new_from_stock (stock_id, NULL);
3564 g_object_set_data (G_OBJECT (menuitem), "gtk-signal", (char *)signal);
3565 g_signal_connect (menuitem, "activate",
3566 G_CALLBACK (activate_cb), label);
3568 gtk_widget_set_sensitive (menuitem, sensitive);
3570 gtk_widget_show (menuitem);
3571 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
3575 popup_menu_detach (GtkWidget *attach_widget,
3579 label = GTK_LABEL (attach_widget);
3581 if (label->select_info)
3582 label->select_info->popup_menu = NULL;
3586 popup_position_func (GtkMenu *menu,
3597 label = GTK_LABEL (user_data);
3598 widget = GTK_WIDGET (label);
3600 if (label->select_info == NULL)
3603 g_return_if_fail (GTK_WIDGET_REALIZED (label));
3605 screen = gtk_widget_get_screen (widget);
3606 gdk_window_get_origin (widget->window, x, y);
3608 gtk_widget_size_request (label->select_info->popup_menu, &req);
3610 *x += widget->allocation.width / 2;
3611 *y += widget->allocation.height;
3613 *x = CLAMP (*x, 0, MAX (0, gdk_screen_get_width (screen) - req.width));
3614 *y = CLAMP (*y, 0, MAX (0, gdk_screen_get_height (screen) - req.height));
3619 gtk_label_do_popup (GtkLabel *label,
3620 GdkEventButton *event)
3622 GtkWidget *menuitem;
3623 gboolean have_selection;
3625 if (label->select_info == NULL)
3628 if (label->select_info->popup_menu)
3629 gtk_widget_destroy (label->select_info->popup_menu);
3631 label->select_info->popup_menu = gtk_menu_new ();
3633 gtk_menu_attach_to_widget (GTK_MENU (label->select_info->popup_menu),
3638 label->select_info->selection_anchor != label->select_info->selection_end;
3641 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_CUT, "cut_clipboard",
3643 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_COPY, "copy_clipboard",
3645 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_PASTE, "paste_clipboard",
3648 menuitem = gtk_image_menu_item_new_from_stock (GTK_STOCK_DELETE, NULL);
3649 gtk_widget_set_sensitive (menuitem, FALSE);
3650 gtk_widget_show (menuitem);
3651 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
3653 menuitem = gtk_separator_menu_item_new ();
3654 gtk_widget_show (menuitem);
3655 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
3657 menuitem = gtk_menu_item_new_with_label (_("Select All"));
3658 g_signal_connect_swapped (menuitem, "activate",
3659 G_CALLBACK (gtk_label_select_all), label);
3660 gtk_widget_show (menuitem);
3661 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
3663 g_signal_emit (label,
3664 signals[POPULATE_POPUP],
3666 label->select_info->popup_menu);
3669 gtk_menu_popup (GTK_MENU (label->select_info->popup_menu), NULL, NULL,
3671 event->button, event->time);
3673 gtk_menu_popup (GTK_MENU (label->select_info->popup_menu), NULL, NULL,
3674 popup_position_func, label,
3675 0, gtk_get_current_event_time ());