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, see <http://www.gnu.org/licenses/>.Free
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include "gtkaccellabel.h"
33 #include "gtkmarshalers.h"
35 #include "gtkwindow.h"
36 #include "gtkclipboard.h"
37 #include "gtkimagemenuitem.h"
39 #include "gtkseparatormenuitem.h"
40 #include "gtktextutil.h"
42 #include "gtkmenuitem.h"
43 #include "gtkmenushellprivate.h"
44 #include "gtknotebook.h"
46 #include "gtkbindings.h"
47 #include "gtkbuildable.h"
50 #include "gtktooltip.h"
51 #include "gtkprivate.h"
52 #include "gtktypebuiltins.h"
55 #include "a11y/gtklabelaccessible.h"
57 /* this is in case rint() is not provided by the compiler,
58 * such as in the case of C89 compilers, like MSVC
60 #include "fallback-c89.c"
64 * @Short_description: A widget that displays a small to medium amount of text
67 * The #GtkLabel widget displays a small amount of text. As the name
68 * implies, most labels are used to label another widget such as a
69 * #GtkButton, a #GtkMenuItem, or a #GtkComboBox.
71 * <refsect2 id="GtkLabel-BUILDER-UI">
72 * <title>GtkLabel as GtkBuildable</title>
74 * The GtkLabel implementation of the GtkBuildable interface supports a
75 * custom <attributes> element, which supports any number of <attribute>
76 * elements. the <attribute> element has attributes named name, value,
77 * start and end and allows you to specify #PangoAttribute values for this label.
80 * <title>A UI definition fragment specifying Pango attributes</title>
81 * <programlisting><![CDATA[
82 * <object class="GtkLabel">
84 * <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>
85 * <attribute name="background" value="red" start="5" end="10"/>"
88 * ]]></programlisting>
90 * The start and end attributes specify the range of characters to which the
91 * Pango attribute applies. If start and end are not specified, the attribute is
92 * applied to the whole text. Note that specifying ranges does not make much
93 * sense with translatable attributes. Use markup embedded in the translatable
98 * <title>Mnemonics</title>
100 * Labels may contain <firstterm>mnemonics</firstterm>. Mnemonics are
101 * underlined characters in the label, used for keyboard navigation.
102 * Mnemonics are created by providing a string with an underscore before
103 * the mnemonic character, such as <literal>"_File"</literal>, to the
104 * functions gtk_label_new_with_mnemonic() or
105 * gtk_label_set_text_with_mnemonic().
107 * Mnemonics automatically activate any activatable widget the label is
108 * inside, such as a #GtkButton; if the label is not inside the
109 * mnemonic's target widget, you have to tell the label about the target
110 * using gtk_label_set_mnemonic_widget(). Here's a simple example where
111 * the label is inside a button:
115 * // Pressing Alt+H will activate this button
116 * button = gtk_button_new (<!-- -->);
117 * label = gtk_label_new_with_mnemonic ("_Hello");
118 * gtk_container_add (GTK_CONTAINER (button), label);
122 * There's a convenience function to create buttons with a mnemonic label
127 * // Pressing Alt+H will activate this button
128 * button = gtk_button_new_with_mnemonic ("_Hello");
132 * To create a mnemonic for a widget alongside the label, such as a
133 * #GtkEntry, you have to point the label at the entry with
134 * gtk_label_set_mnemonic_widget():
138 * // Pressing Alt+H will focus the entry
139 * entry = gtk_entry_new (<!-- -->);
140 * label = gtk_label_new_with_mnemonic ("_Hello");
141 * gtk_label_set_mnemonic_widget (GTK_LABEL (label), entry);
147 * <title>Markup (styled text)</title>
149 * To make it easy to format text in a label (changing colors, fonts,
150 * etc.), label text can be provided in a simple <link
151 * linkend="PangoMarkupFormat">markup format</link>.
152 * Here's how to create a label with a small font:
156 * label = gtk_label_new (NULL);
157 * gtk_label_set_markup (GTK_LABEL (label), "<small>Small text</small>");
162 * linkend="PangoMarkupFormat">complete documentation</link> of available
163 * tags in the Pango manual.)
165 * The markup passed to gtk_label_set_markup() must be valid; for example,
166 * literal <, > and & characters must be escaped as \<,
167 * \gt;, and \&. If you pass text obtained from the user, file,
168 * or a network to gtk_label_set_markup(), you'll want to escape it with
169 * g_markup_escape_text() or g_markup_printf_escaped().
171 * Markup strings are just a convenient way to set the #PangoAttrList on
172 * a label; gtk_label_set_attributes() may be a simpler way to set
173 * attributes in some cases. Be careful though; #PangoAttrList tends to
174 * cause internationalization problems, unless you're applying attributes
175 * to the entire string (i.e. unless you set the range of each attribute
176 * to [0, %G_MAXINT)). The reason is that specifying the start_index and
177 * end_index for a #PangoAttribute requires knowledge of the exact string
178 * being displayed, so translations will cause problems.
182 * <title>Selectable labels</title>
183 * Labels can be made selectable with gtk_label_set_selectable().
184 * Selectable labels allow the user to copy the label contents to
185 * the clipboard. Only labels that contain useful-to-copy information
186 * — such as error messages — should be made selectable.
188 * <refsect2 id="label-text-layout">
189 * <title>Text layout</title>
191 * A label can contain any number of paragraphs, but will have
192 * performance problems if it contains more than a small number.
193 * Paragraphs are separated by newlines or other paragraph separators
194 * understood by Pango.
196 * Labels can automatically wrap text if you call
197 * gtk_label_set_line_wrap().
199 * gtk_label_set_justify() sets how the lines in a label align
200 * with one another. If you want to set how the label as a whole
201 * aligns in its available space, see gtk_misc_set_alignment().
203 * The #GtkLabel:width-chars and #GtkLabel:max-width-chars properties
204 * can be used to control the size allocation of ellipsized or wrapped
205 * labels. For ellipsizing labels, if either is specified (and less
206 * than the actual text size), it is used as the minimum width, and the actual
207 * text size is used as the natural width of the label. For wrapping labels,
208 * width-chars is used as the minimum width, if specified, and max-width-chars
209 * is used as the natural width. Even if max-width-chars specified, wrapping
210 * labels will be rewrapped to use all of the available width.
213 * Note that the interpretation of #GtkLabel:width-chars and
214 * #GtkLabel:max-width-chars has changed a bit with the introduction of
215 * <link linkend="geometry-management">width-for-height geometry management.</link>
220 * <title>Links</title>
222 * Since 2.18, GTK+ supports markup for clickable hyperlinks in addition
223 * to regular Pango markup. The markup for links is borrowed from HTML, using the
224 * <tag>a</tag> with href and title attributes. GTK+ renders links similar to the
225 * way they appear in web browsers, with colored, underlined text. The title
226 * attribute is displayed as a tooltip on the link. An example looks like this:
228 * <informalexample><programlisting>
229 * gtk_label_set_markup (label, "Go to the <a href="http://www.gtk.org" title="<i>Our</i> website">GTK+ website</a> for more...");
230 * </programlisting></informalexample>
232 * It is possible to implement custom handling for links and their tooltips with
233 * the #GtkLabel::activate-link signal and the gtk_label_get_current_uri() function.
238 struct _GtkLabelPrivate
240 GtkLabelSelectionInfo *select_info;
241 GtkWidget *mnemonic_widget;
242 GtkWindow *mnemonic_window;
244 PangoAttrList *attrs;
245 PangoAttrList *markup_attrs;
253 guint mnemonics_visible : 1;
256 guint use_underline : 1;
257 guint use_markup : 1;
259 guint single_line_mode : 1;
260 guint have_transform : 1;
263 guint pattern_set : 1;
264 guint track_links : 1;
266 guint mnemonic_keyval;
269 gint max_width_chars;
272 /* Notes about the handling of links:
274 * Links share the GtkLabelSelectionInfo struct with selectable labels.
275 * There are some new fields for links. The links field contains the list
276 * of GtkLabelLink structs that describe the links which are embedded in
277 * the label. The active_link field points to the link under the mouse
278 * pointer. For keyboard navigation, the 'focus' link is determined by
279 * finding the link which contains the selection_anchor position.
280 * The link_clicked field is used with button press and release events
281 * to ensure that pressing inside a link and releasing outside of it
282 * does not activate the link.
284 * Links are rendered with the link-color/visited-link-color colors
285 * that are determined by the style and with an underline. When the mouse
286 * pointer is over a link, the pointer is changed to indicate the link,
287 * and the background behind the link is rendered with the base[PRELIGHT]
288 * color. While a button is pressed over a link, the background is rendered
289 * with the base[ACTIVE] color.
291 * Labels with links accept keyboard focus, and it is possible to move
292 * the focus between the embedded links using Tab/Shift-Tab. The focus
293 * is indicated by a focus rectangle that is drawn around the link text.
294 * Pressing Enter activates the focussed link, and there is a suitable
295 * context menu for links that can be opened with the Menu key. Pressing
296 * Control-C copies the link URI to the clipboard.
298 * In selectable labels with links, link functionality is only available
299 * when the selection is empty.
304 gchar *title; /* the title attribute, used as tooltip */
305 gboolean visited; /* get set when the link is activated; this flag
306 * gets preserved over later set_markup() calls
308 gint start; /* position of the link in the PangoLayout */
312 struct _GtkLabelSelectionInfo
315 gint selection_anchor;
317 GtkWidget *popup_menu;
320 GtkLabelLink *active_link;
326 guint select_words : 1;
327 guint selectable : 1;
328 guint link_clicked : 1;
336 ACTIVATE_CURRENT_LINK,
351 PROP_MNEMONIC_KEYVAL,
352 PROP_MNEMONIC_WIDGET,
353 PROP_CURSOR_POSITION,
354 PROP_SELECTION_BOUND,
357 PROP_SINGLE_LINE_MODE,
359 PROP_MAX_WIDTH_CHARS,
360 PROP_TRACK_VISITED_LINKS
363 /* When rotating ellipsizable text we want the natural size to request
364 * more to ensure the label wont ever ellipsize in an allocation of full natural size.
366 #define ROTATION_ELLIPSIZE_PADDING 2
368 static guint signals[LAST_SIGNAL] = { 0 };
370 static const GdkColor default_link_color = { 0, 0, 0, 0xeeee };
371 static const GdkColor default_visited_link_color = { 0, 0x5555, 0x1a1a, 0x8b8b };
373 static void gtk_label_set_property (GObject *object,
377 static void gtk_label_get_property (GObject *object,
381 static void gtk_label_finalize (GObject *object);
382 static void gtk_label_destroy (GtkWidget *widget);
383 static void gtk_label_size_allocate (GtkWidget *widget,
384 GtkAllocation *allocation);
385 static void gtk_label_state_flags_changed (GtkWidget *widget,
386 GtkStateFlags prev_state);
387 static gint gtk_label_draw (GtkWidget *widget,
389 static gboolean gtk_label_focus (GtkWidget *widget,
390 GtkDirectionType direction);
392 static void gtk_label_realize (GtkWidget *widget);
393 static void gtk_label_unrealize (GtkWidget *widget);
394 static void gtk_label_map (GtkWidget *widget);
395 static void gtk_label_unmap (GtkWidget *widget);
397 static gboolean gtk_label_button_press (GtkWidget *widget,
398 GdkEventButton *event);
399 static gboolean gtk_label_button_release (GtkWidget *widget,
400 GdkEventButton *event);
401 static gboolean gtk_label_motion (GtkWidget *widget,
402 GdkEventMotion *event);
403 static gboolean gtk_label_leave_notify (GtkWidget *widget,
404 GdkEventCrossing *event);
406 static void gtk_label_grab_focus (GtkWidget *widget);
408 static gboolean gtk_label_query_tooltip (GtkWidget *widget,
411 gboolean keyboard_tip,
412 GtkTooltip *tooltip);
414 static void gtk_label_set_text_internal (GtkLabel *label,
416 static void gtk_label_set_label_internal (GtkLabel *label,
418 static void gtk_label_set_use_markup_internal (GtkLabel *label,
420 static void gtk_label_set_use_underline_internal (GtkLabel *label,
422 static void gtk_label_set_uline_text_internal (GtkLabel *label,
424 static void gtk_label_set_pattern_internal (GtkLabel *label,
425 const gchar *pattern,
426 gboolean is_mnemonic);
427 static void gtk_label_set_markup_internal (GtkLabel *label,
429 gboolean with_uline);
430 static void gtk_label_recalculate (GtkLabel *label);
431 static void gtk_label_hierarchy_changed (GtkWidget *widget,
432 GtkWidget *old_toplevel);
433 static void gtk_label_screen_changed (GtkWidget *widget,
434 GdkScreen *old_screen);
435 static gboolean gtk_label_popup_menu (GtkWidget *widget);
437 static void gtk_label_create_window (GtkLabel *label);
438 static void gtk_label_destroy_window (GtkLabel *label);
439 static void gtk_label_ensure_select_info (GtkLabel *label);
440 static void gtk_label_clear_select_info (GtkLabel *label);
441 static void gtk_label_update_cursor (GtkLabel *label);
442 static void gtk_label_clear_layout (GtkLabel *label);
443 static void gtk_label_ensure_layout (GtkLabel *label);
444 static void gtk_label_select_region_index (GtkLabel *label,
449 static gboolean gtk_label_mnemonic_activate (GtkWidget *widget,
450 gboolean group_cycling);
451 static void gtk_label_setup_mnemonic (GtkLabel *label,
453 static void gtk_label_drag_data_get (GtkWidget *widget,
454 GdkDragContext *context,
455 GtkSelectionData *selection_data,
459 static void gtk_label_buildable_interface_init (GtkBuildableIface *iface);
460 static gboolean gtk_label_buildable_custom_tag_start (GtkBuildable *buildable,
463 const gchar *tagname,
464 GMarkupParser *parser,
467 static void gtk_label_buildable_custom_finished (GtkBuildable *buildable,
470 const gchar *tagname,
474 static void connect_mnemonics_visible_notify (GtkLabel *label);
475 static gboolean separate_uline_pattern (const gchar *str,
481 /* For selectable labels: */
482 static void gtk_label_move_cursor (GtkLabel *label,
483 GtkMovementStep step,
485 gboolean extend_selection);
486 static void gtk_label_copy_clipboard (GtkLabel *label);
487 static void gtk_label_select_all (GtkLabel *label);
488 static void gtk_label_do_popup (GtkLabel *label,
489 GdkEventButton *event);
490 static gint gtk_label_move_forward_word (GtkLabel *label,
492 static gint gtk_label_move_backward_word (GtkLabel *label,
496 static void gtk_label_clear_links (GtkLabel *label);
497 static gboolean gtk_label_activate_link (GtkLabel *label,
499 static void gtk_label_activate_current_link (GtkLabel *label);
500 static GtkLabelLink *gtk_label_get_current_link (GtkLabel *label);
501 static void gtk_label_get_link_colors (GtkWidget *widget,
502 GdkColor *link_color,
503 GdkColor *visited_link_color);
504 static void emit_activate_link (GtkLabel *label,
507 static GtkSizeRequestMode gtk_label_get_request_mode (GtkWidget *widget);
508 static void gtk_label_get_preferred_width (GtkWidget *widget,
511 static void gtk_label_get_preferred_height (GtkWidget *widget,
514 static void gtk_label_get_preferred_width_for_height (GtkWidget *widget,
517 gint *natural_width);
518 static void gtk_label_get_preferred_height_for_width (GtkWidget *widget,
520 gint *minimum_height,
521 gint *natural_height);
523 static GtkBuildableIface *buildable_parent_iface = NULL;
525 G_DEFINE_TYPE_WITH_CODE (GtkLabel, gtk_label, GTK_TYPE_MISC,
526 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
527 gtk_label_buildable_interface_init))
530 add_move_binding (GtkBindingSet *binding_set,
533 GtkMovementStep step,
536 g_return_if_fail ((modmask & GDK_SHIFT_MASK) == 0);
538 gtk_binding_entry_add_signal (binding_set, keyval, modmask,
542 G_TYPE_BOOLEAN, FALSE);
544 /* Selection-extending version */
545 gtk_binding_entry_add_signal (binding_set, keyval, modmask | GDK_SHIFT_MASK,
549 G_TYPE_BOOLEAN, TRUE);
553 gtk_label_class_init (GtkLabelClass *class)
555 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
556 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
557 GtkBindingSet *binding_set;
559 gobject_class->set_property = gtk_label_set_property;
560 gobject_class->get_property = gtk_label_get_property;
561 gobject_class->finalize = gtk_label_finalize;
563 widget_class->destroy = gtk_label_destroy;
564 widget_class->size_allocate = gtk_label_size_allocate;
565 widget_class->state_flags_changed = gtk_label_state_flags_changed;
566 widget_class->query_tooltip = gtk_label_query_tooltip;
567 widget_class->draw = gtk_label_draw;
568 widget_class->realize = gtk_label_realize;
569 widget_class->unrealize = gtk_label_unrealize;
570 widget_class->map = gtk_label_map;
571 widget_class->unmap = gtk_label_unmap;
572 widget_class->button_press_event = gtk_label_button_press;
573 widget_class->button_release_event = gtk_label_button_release;
574 widget_class->motion_notify_event = gtk_label_motion;
575 widget_class->leave_notify_event = gtk_label_leave_notify;
576 widget_class->hierarchy_changed = gtk_label_hierarchy_changed;
577 widget_class->screen_changed = gtk_label_screen_changed;
578 widget_class->mnemonic_activate = gtk_label_mnemonic_activate;
579 widget_class->drag_data_get = gtk_label_drag_data_get;
580 widget_class->grab_focus = gtk_label_grab_focus;
581 widget_class->popup_menu = gtk_label_popup_menu;
582 widget_class->focus = gtk_label_focus;
583 widget_class->get_request_mode = gtk_label_get_request_mode;
584 widget_class->get_preferred_width = gtk_label_get_preferred_width;
585 widget_class->get_preferred_height = gtk_label_get_preferred_height;
586 widget_class->get_preferred_width_for_height = gtk_label_get_preferred_width_for_height;
587 widget_class->get_preferred_height_for_width = gtk_label_get_preferred_height_for_width;
589 class->move_cursor = gtk_label_move_cursor;
590 class->copy_clipboard = gtk_label_copy_clipboard;
591 class->activate_link = gtk_label_activate_link;
594 * GtkLabel::move-cursor:
595 * @entry: the object which received the signal
596 * @step: the granularity of the move, as a #GtkMovementStep
597 * @count: the number of @step units to move
598 * @extend_selection: %TRUE if the move should extend the selection
600 * The ::move-cursor signal is a
601 * <link linkend="keybinding-signals">keybinding signal</link>
602 * which gets emitted when the user initiates a cursor movement.
603 * If the cursor is not visible in @entry, this signal causes
604 * the viewport to be moved instead.
606 * Applications should not connect to it, but may emit it with
607 * g_signal_emit_by_name() if they need to control the cursor
610 * The default bindings for this signal come in two variants,
611 * the variant with the Shift modifier extends the selection,
612 * the variant without the Shift modifer does not.
613 * There are too many key combinations to list them all here.
615 * <listitem>Arrow keys move by individual characters/lines</listitem>
616 * <listitem>Ctrl-arrow key combinations move by words/paragraphs</listitem>
617 * <listitem>Home/End keys move to the ends of the buffer</listitem>
620 signals[MOVE_CURSOR] =
621 g_signal_new (I_("move-cursor"),
622 G_OBJECT_CLASS_TYPE (gobject_class),
623 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
624 G_STRUCT_OFFSET (GtkLabelClass, move_cursor),
626 _gtk_marshal_VOID__ENUM_INT_BOOLEAN,
628 GTK_TYPE_MOVEMENT_STEP,
633 * GtkLabel::copy-clipboard:
634 * @label: the object which received the signal
636 * The ::copy-clipboard signal is a
637 * <link linkend="keybinding-signals">keybinding signal</link>
638 * which gets emitted to copy the selection to the clipboard.
640 * The default binding for this signal is Ctrl-c.
642 signals[COPY_CLIPBOARD] =
643 g_signal_new (I_("copy-clipboard"),
644 G_OBJECT_CLASS_TYPE (gobject_class),
645 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
646 G_STRUCT_OFFSET (GtkLabelClass, copy_clipboard),
648 _gtk_marshal_VOID__VOID,
652 * GtkLabel::populate-popup:
653 * @label: The label on which the signal is emitted
654 * @menu: the menu that is being populated
656 * The ::populate-popup signal gets emitted before showing the
657 * context menu of the label. Note that only selectable labels
658 * have context menus.
660 * If you need to add items to the context menu, connect
661 * to this signal and append your menuitems to the @menu.
663 signals[POPULATE_POPUP] =
664 g_signal_new (I_("populate-popup"),
665 G_OBJECT_CLASS_TYPE (gobject_class),
667 G_STRUCT_OFFSET (GtkLabelClass, populate_popup),
669 _gtk_marshal_VOID__OBJECT,
674 * GtkLabel::activate-current-link:
675 * @label: The label on which the signal was emitted
677 * A <link linkend="keybinding-signals">keybinding signal</link>
678 * which gets emitted when the user activates a link in the label.
680 * Applications may also emit the signal with g_signal_emit_by_name()
681 * if they need to control activation of URIs programmatically.
683 * The default bindings for this signal are all forms of the Enter key.
687 signals[ACTIVATE_CURRENT_LINK] =
688 g_signal_new_class_handler ("activate-current-link",
689 G_TYPE_FROM_CLASS (gobject_class),
690 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
691 G_CALLBACK (gtk_label_activate_current_link),
693 _gtk_marshal_VOID__VOID,
697 * GtkLabel::activate-link:
698 * @label: The label on which the signal was emitted
699 * @uri: the URI that is activated
701 * The signal which gets emitted to activate a URI.
702 * Applications may connect to it to override the default behaviour,
703 * which is to call gtk_show_uri().
705 * Returns: %TRUE if the link has been activated
709 signals[ACTIVATE_LINK] =
710 g_signal_new ("activate-link",
711 G_TYPE_FROM_CLASS (gobject_class),
713 G_STRUCT_OFFSET (GtkLabelClass, activate_link),
714 _gtk_boolean_handled_accumulator, NULL,
715 _gtk_marshal_BOOLEAN__STRING,
716 G_TYPE_BOOLEAN, 1, G_TYPE_STRING);
718 g_object_class_install_property (gobject_class,
720 g_param_spec_string ("label",
722 P_("The text of the label"),
724 GTK_PARAM_READWRITE));
725 g_object_class_install_property (gobject_class,
727 g_param_spec_boxed ("attributes",
729 P_("A list of style attributes to apply to the text of the label"),
730 PANGO_TYPE_ATTR_LIST,
731 GTK_PARAM_READWRITE));
732 g_object_class_install_property (gobject_class,
734 g_param_spec_boolean ("use-markup",
736 P_("The text of the label includes XML markup. See pango_parse_markup()"),
738 GTK_PARAM_READWRITE));
739 g_object_class_install_property (gobject_class,
741 g_param_spec_boolean ("use-underline",
743 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
745 GTK_PARAM_READWRITE));
747 g_object_class_install_property (gobject_class,
749 g_param_spec_enum ("justify",
751 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"),
752 GTK_TYPE_JUSTIFICATION,
754 GTK_PARAM_READWRITE));
756 g_object_class_install_property (gobject_class,
758 g_param_spec_string ("pattern",
760 P_("A string with _ characters in positions correspond to characters in the text to underline"),
762 GTK_PARAM_WRITABLE));
764 g_object_class_install_property (gobject_class,
766 g_param_spec_boolean ("wrap",
768 P_("If set, wrap lines if the text becomes too wide"),
770 GTK_PARAM_READWRITE));
772 * GtkLabel:wrap-mode:
774 * If line wrapping is on (see the #GtkLabel:wrap property) this controls
775 * how the line wrapping is done. The default is %PANGO_WRAP_WORD, which
776 * means wrap on word boundaries.
780 g_object_class_install_property (gobject_class,
782 g_param_spec_enum ("wrap-mode",
783 P_("Line wrap mode"),
784 P_("If wrap is set, controls how linewrapping is done"),
785 PANGO_TYPE_WRAP_MODE,
787 GTK_PARAM_READWRITE));
788 g_object_class_install_property (gobject_class,
790 g_param_spec_boolean ("selectable",
792 P_("Whether the label text can be selected with the mouse"),
794 GTK_PARAM_READWRITE));
795 g_object_class_install_property (gobject_class,
796 PROP_MNEMONIC_KEYVAL,
797 g_param_spec_uint ("mnemonic-keyval",
799 P_("The mnemonic accelerator key for this label"),
803 GTK_PARAM_READABLE));
804 g_object_class_install_property (gobject_class,
805 PROP_MNEMONIC_WIDGET,
806 g_param_spec_object ("mnemonic-widget",
807 P_("Mnemonic widget"),
808 P_("The widget to be activated when the label's mnemonic "
811 GTK_PARAM_READWRITE));
813 g_object_class_install_property (gobject_class,
814 PROP_CURSOR_POSITION,
815 g_param_spec_int ("cursor-position",
816 P_("Cursor Position"),
817 P_("The current position of the insertion cursor in chars"),
821 GTK_PARAM_READABLE));
823 g_object_class_install_property (gobject_class,
824 PROP_SELECTION_BOUND,
825 g_param_spec_int ("selection-bound",
826 P_("Selection Bound"),
827 P_("The position of the opposite end of the selection from the cursor in chars"),
831 GTK_PARAM_READABLE));
834 * GtkLabel:ellipsize:
836 * The preferred place to ellipsize the string, if the label does
837 * not have enough room to display the entire string, specified as a
838 * #PangoEllipsizeMode.
840 * Note that setting this property to a value other than
841 * %PANGO_ELLIPSIZE_NONE has the side-effect that the label requests
842 * only enough space to display the ellipsis "...". In particular, this
843 * means that ellipsizing labels do not work well in notebook tabs, unless
844 * the tab's #GtkNotebook:tab-expand property is set to %TRUE. Other ways
845 * to set a label's width are gtk_widget_set_size_request() and
846 * gtk_label_set_width_chars().
850 g_object_class_install_property (gobject_class,
852 g_param_spec_enum ("ellipsize",
854 P_("The preferred place to ellipsize the string, if the label does not have enough room to display the entire string"),
855 PANGO_TYPE_ELLIPSIZE_MODE,
856 PANGO_ELLIPSIZE_NONE,
857 GTK_PARAM_READWRITE));
860 * GtkLabel:width-chars:
862 * The desired width of the label, in characters. If this property is set to
863 * -1, the width will be calculated automatically.
865 * See the section on <link linkend="label-text-layout">text layout</link>
866 * for details of how #GtkLabel:width-chars and #GtkLabel:max-width-chars
867 * determine the width of ellipsized and wrapped labels.
871 g_object_class_install_property (gobject_class,
873 g_param_spec_int ("width-chars",
874 P_("Width In Characters"),
875 P_("The desired width of the label, in characters"),
879 GTK_PARAM_READWRITE));
882 * GtkLabel:single-line-mode:
884 * Whether the label is in single line mode. In single line mode,
885 * the height of the label does not depend on the actual text, it
886 * is always set to ascent + descent of the font. This can be an
887 * advantage in situations where resizing the label because of text
888 * changes would be distracting, e.g. in a statusbar.
892 g_object_class_install_property (gobject_class,
893 PROP_SINGLE_LINE_MODE,
894 g_param_spec_boolean ("single-line-mode",
895 P_("Single Line Mode"),
896 P_("Whether the label is in single line mode"),
898 GTK_PARAM_READWRITE));
903 * The angle that the baseline of the label makes with the horizontal,
904 * in degrees, measured counterclockwise. An angle of 90 reads from
905 * from bottom to top, an angle of 270, from top to bottom. Ignored
906 * if the label is selectable, wrapped, or ellipsized.
910 g_object_class_install_property (gobject_class,
912 g_param_spec_double ("angle",
914 P_("Angle at which the label is rotated"),
918 GTK_PARAM_READWRITE));
921 * GtkLabel:max-width-chars:
923 * The desired maximum width of the label, in characters. If this property
924 * is set to -1, the width will be calculated automatically.
926 * See the section on <link linkend="label-text-layout">text layout</link>
927 * for details of how #GtkLabel:width-chars and #GtkLabel:max-width-chars
928 * determine the width of ellipsized and wrapped labels.
932 g_object_class_install_property (gobject_class,
933 PROP_MAX_WIDTH_CHARS,
934 g_param_spec_int ("max-width-chars",
935 P_("Maximum Width In Characters"),
936 P_("The desired maximum width of the label, in characters"),
940 GTK_PARAM_READWRITE));
943 * GtkLabel:track-visited-links:
945 * Set this property to %TRUE to make the label track which links
946 * have been clicked. It will then apply the ::visited-link-color
947 * color, instead of ::link-color.
951 g_object_class_install_property (gobject_class,
952 PROP_TRACK_VISITED_LINKS,
953 g_param_spec_boolean ("track-visited-links",
954 P_("Track visited links"),
955 P_("Whether visited links should be tracked"),
957 GTK_PARAM_READWRITE));
962 binding_set = gtk_binding_set_by_class (class);
964 /* Moving the insertion point */
965 add_move_binding (binding_set, GDK_KEY_Right, 0,
966 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
968 add_move_binding (binding_set, GDK_KEY_Left, 0,
969 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
971 add_move_binding (binding_set, GDK_KEY_KP_Right, 0,
972 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
974 add_move_binding (binding_set, GDK_KEY_KP_Left, 0,
975 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
977 add_move_binding (binding_set, GDK_KEY_f, GDK_CONTROL_MASK,
978 GTK_MOVEMENT_LOGICAL_POSITIONS, 1);
980 add_move_binding (binding_set, GDK_KEY_b, GDK_CONTROL_MASK,
981 GTK_MOVEMENT_LOGICAL_POSITIONS, -1);
983 add_move_binding (binding_set, GDK_KEY_Right, GDK_CONTROL_MASK,
984 GTK_MOVEMENT_WORDS, 1);
986 add_move_binding (binding_set, GDK_KEY_Left, GDK_CONTROL_MASK,
987 GTK_MOVEMENT_WORDS, -1);
989 add_move_binding (binding_set, GDK_KEY_KP_Right, GDK_CONTROL_MASK,
990 GTK_MOVEMENT_WORDS, 1);
992 add_move_binding (binding_set, GDK_KEY_KP_Left, GDK_CONTROL_MASK,
993 GTK_MOVEMENT_WORDS, -1);
996 gtk_binding_entry_add_signal (binding_set, GDK_KEY_a, GDK_CONTROL_MASK,
998 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
1000 G_TYPE_BOOLEAN, FALSE);
1002 gtk_binding_entry_add_signal (binding_set, GDK_KEY_a, GDK_CONTROL_MASK,
1004 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
1006 G_TYPE_BOOLEAN, TRUE);
1008 gtk_binding_entry_add_signal (binding_set, GDK_KEY_slash, GDK_CONTROL_MASK,
1010 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
1012 G_TYPE_BOOLEAN, FALSE);
1014 gtk_binding_entry_add_signal (binding_set, GDK_KEY_slash, GDK_CONTROL_MASK,
1016 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
1018 G_TYPE_BOOLEAN, TRUE);
1021 gtk_binding_entry_add_signal (binding_set, GDK_KEY_a, GDK_SHIFT_MASK | GDK_CONTROL_MASK,
1023 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
1025 G_TYPE_BOOLEAN, FALSE);
1027 gtk_binding_entry_add_signal (binding_set, GDK_KEY_backslash, GDK_CONTROL_MASK,
1029 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
1031 G_TYPE_BOOLEAN, FALSE);
1033 add_move_binding (binding_set, GDK_KEY_f, GDK_MOD1_MASK,
1034 GTK_MOVEMENT_WORDS, 1);
1036 add_move_binding (binding_set, GDK_KEY_b, GDK_MOD1_MASK,
1037 GTK_MOVEMENT_WORDS, -1);
1039 add_move_binding (binding_set, GDK_KEY_Home, 0,
1040 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
1042 add_move_binding (binding_set, GDK_KEY_End, 0,
1043 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
1045 add_move_binding (binding_set, GDK_KEY_KP_Home, 0,
1046 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
1048 add_move_binding (binding_set, GDK_KEY_KP_End, 0,
1049 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
1051 add_move_binding (binding_set, GDK_KEY_Home, GDK_CONTROL_MASK,
1052 GTK_MOVEMENT_BUFFER_ENDS, -1);
1054 add_move_binding (binding_set, GDK_KEY_End, GDK_CONTROL_MASK,
1055 GTK_MOVEMENT_BUFFER_ENDS, 1);
1057 add_move_binding (binding_set, GDK_KEY_KP_Home, GDK_CONTROL_MASK,
1058 GTK_MOVEMENT_BUFFER_ENDS, -1);
1060 add_move_binding (binding_set, GDK_KEY_KP_End, GDK_CONTROL_MASK,
1061 GTK_MOVEMENT_BUFFER_ENDS, 1);
1064 gtk_binding_entry_add_signal (binding_set, GDK_KEY_c, GDK_CONTROL_MASK,
1065 "copy-clipboard", 0);
1067 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Return, 0,
1068 "activate-current-link", 0);
1069 gtk_binding_entry_add_signal (binding_set, GDK_KEY_ISO_Enter, 0,
1070 "activate-current-link", 0);
1071 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Enter, 0,
1072 "activate-current-link", 0);
1074 g_type_class_add_private (class, sizeof (GtkLabelPrivate));
1076 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_LABEL_ACCESSIBLE);
1080 gtk_label_set_property (GObject *object,
1082 const GValue *value,
1085 GtkLabel *label = GTK_LABEL (object);
1090 gtk_label_set_label (label, g_value_get_string (value));
1092 case PROP_ATTRIBUTES:
1093 gtk_label_set_attributes (label, g_value_get_boxed (value));
1095 case PROP_USE_MARKUP:
1096 gtk_label_set_use_markup (label, g_value_get_boolean (value));
1098 case PROP_USE_UNDERLINE:
1099 gtk_label_set_use_underline (label, g_value_get_boolean (value));
1102 gtk_label_set_justify (label, g_value_get_enum (value));
1105 gtk_label_set_pattern (label, g_value_get_string (value));
1108 gtk_label_set_line_wrap (label, g_value_get_boolean (value));
1110 case PROP_WRAP_MODE:
1111 gtk_label_set_line_wrap_mode (label, g_value_get_enum (value));
1113 case PROP_SELECTABLE:
1114 gtk_label_set_selectable (label, g_value_get_boolean (value));
1116 case PROP_MNEMONIC_WIDGET:
1117 gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
1119 case PROP_ELLIPSIZE:
1120 gtk_label_set_ellipsize (label, g_value_get_enum (value));
1122 case PROP_WIDTH_CHARS:
1123 gtk_label_set_width_chars (label, g_value_get_int (value));
1125 case PROP_SINGLE_LINE_MODE:
1126 gtk_label_set_single_line_mode (label, g_value_get_boolean (value));
1129 gtk_label_set_angle (label, g_value_get_double (value));
1131 case PROP_MAX_WIDTH_CHARS:
1132 gtk_label_set_max_width_chars (label, g_value_get_int (value));
1134 case PROP_TRACK_VISITED_LINKS:
1135 gtk_label_set_track_visited_links (label, g_value_get_boolean (value));
1138 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1144 gtk_label_get_property (GObject *object,
1149 GtkLabel *label = GTK_LABEL (object);
1150 GtkLabelPrivate *priv = label->priv;
1155 g_value_set_string (value, priv->label);
1157 case PROP_ATTRIBUTES:
1158 g_value_set_boxed (value, priv->attrs);
1160 case PROP_USE_MARKUP:
1161 g_value_set_boolean (value, priv->use_markup);
1163 case PROP_USE_UNDERLINE:
1164 g_value_set_boolean (value, priv->use_underline);
1167 g_value_set_enum (value, priv->jtype);
1170 g_value_set_boolean (value, priv->wrap);
1172 case PROP_WRAP_MODE:
1173 g_value_set_enum (value, priv->wrap_mode);
1175 case PROP_SELECTABLE:
1176 g_value_set_boolean (value, gtk_label_get_selectable (label));
1178 case PROP_MNEMONIC_KEYVAL:
1179 g_value_set_uint (value, priv->mnemonic_keyval);
1181 case PROP_MNEMONIC_WIDGET:
1182 g_value_set_object (value, (GObject*) priv->mnemonic_widget);
1184 case PROP_CURSOR_POSITION:
1185 g_value_set_int (value, _gtk_label_get_cursor_position (label));
1187 case PROP_SELECTION_BOUND:
1188 g_value_set_int (value, _gtk_label_get_selection_bound (label));
1190 case PROP_ELLIPSIZE:
1191 g_value_set_enum (value, priv->ellipsize);
1193 case PROP_WIDTH_CHARS:
1194 g_value_set_int (value, gtk_label_get_width_chars (label));
1196 case PROP_SINGLE_LINE_MODE:
1197 g_value_set_boolean (value, gtk_label_get_single_line_mode (label));
1200 g_value_set_double (value, gtk_label_get_angle (label));
1202 case PROP_MAX_WIDTH_CHARS:
1203 g_value_set_int (value, gtk_label_get_max_width_chars (label));
1205 case PROP_TRACK_VISITED_LINKS:
1206 g_value_set_boolean (value, gtk_label_get_track_visited_links (label));
1209 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1215 gtk_label_init (GtkLabel *label)
1217 GtkLabelPrivate *priv;
1219 label->priv = G_TYPE_INSTANCE_GET_PRIVATE (label,
1224 gtk_widget_set_has_window (GTK_WIDGET (label), FALSE);
1226 priv->width_chars = -1;
1227 priv->max_width_chars = -1;
1230 priv->jtype = GTK_JUSTIFY_LEFT;
1232 priv->wrap_mode = PANGO_WRAP_WORD;
1233 priv->ellipsize = PANGO_ELLIPSIZE_NONE;
1235 priv->use_underline = FALSE;
1236 priv->use_markup = FALSE;
1237 priv->pattern_set = FALSE;
1238 priv->track_links = TRUE;
1240 priv->mnemonic_keyval = GDK_KEY_VoidSymbol;
1241 priv->layout = NULL;
1245 priv->mnemonic_widget = NULL;
1246 priv->mnemonic_window = NULL;
1248 priv->mnemonics_visible = TRUE;
1250 gtk_label_set_text (label, "");
1255 gtk_label_buildable_interface_init (GtkBuildableIface *iface)
1257 buildable_parent_iface = g_type_interface_peek_parent (iface);
1259 iface->custom_tag_start = gtk_label_buildable_custom_tag_start;
1260 iface->custom_finished = gtk_label_buildable_custom_finished;
1264 GtkBuilder *builder;
1266 PangoAttrList *attrs;
1269 static PangoAttribute *
1270 attribute_from_text (GtkBuilder *builder,
1275 PangoAttribute *attribute = NULL;
1277 PangoLanguage *language;
1278 PangoFontDescription *font_desc;
1280 GValue val = G_VALUE_INIT;
1282 if (!gtk_builder_value_from_string_type (builder, PANGO_TYPE_ATTR_TYPE, name, &val, error))
1285 type = g_value_get_enum (&val);
1286 g_value_unset (&val);
1290 /* PangoAttrLanguage */
1291 case PANGO_ATTR_LANGUAGE:
1292 if ((language = pango_language_from_string (value)))
1294 attribute = pango_attr_language_new (language);
1295 g_value_init (&val, G_TYPE_INT);
1299 case PANGO_ATTR_STYLE:
1300 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_STYLE, value, &val, error))
1301 attribute = pango_attr_style_new (g_value_get_enum (&val));
1303 case PANGO_ATTR_WEIGHT:
1304 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_WEIGHT, value, &val, error))
1305 attribute = pango_attr_weight_new (g_value_get_enum (&val));
1307 case PANGO_ATTR_VARIANT:
1308 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_VARIANT, value, &val, error))
1309 attribute = pango_attr_variant_new (g_value_get_enum (&val));
1311 case PANGO_ATTR_STRETCH:
1312 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_STRETCH, value, &val, error))
1313 attribute = pango_attr_stretch_new (g_value_get_enum (&val));
1315 case PANGO_ATTR_UNDERLINE:
1316 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_UNDERLINE, value, &val, NULL))
1317 attribute = pango_attr_underline_new (g_value_get_enum (&val));
1320 /* XXX: allow boolean for backwards compat, so ignore error */
1321 /* Deprecate this somehow */
1322 g_value_unset (&val);
1323 if (gtk_builder_value_from_string_type (builder, G_TYPE_BOOLEAN, value, &val, error))
1324 attribute = pango_attr_underline_new (g_value_get_boolean (&val));
1327 case PANGO_ATTR_STRIKETHROUGH:
1328 if (gtk_builder_value_from_string_type (builder, G_TYPE_BOOLEAN, value, &val, error))
1329 attribute = pango_attr_strikethrough_new (g_value_get_boolean (&val));
1331 case PANGO_ATTR_GRAVITY:
1332 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_GRAVITY, value, &val, error))
1333 attribute = pango_attr_gravity_new (g_value_get_enum (&val));
1335 case PANGO_ATTR_GRAVITY_HINT:
1336 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_GRAVITY_HINT,
1337 value, &val, error))
1338 attribute = pango_attr_gravity_hint_new (g_value_get_enum (&val));
1340 /* PangoAttrString */
1341 case PANGO_ATTR_FAMILY:
1342 attribute = pango_attr_family_new (value);
1343 g_value_init (&val, G_TYPE_INT);
1347 case PANGO_ATTR_SIZE:
1348 if (gtk_builder_value_from_string_type (builder, G_TYPE_INT,
1349 value, &val, error))
1350 attribute = pango_attr_size_new (g_value_get_int (&val));
1352 case PANGO_ATTR_ABSOLUTE_SIZE:
1353 if (gtk_builder_value_from_string_type (builder, G_TYPE_INT,
1354 value, &val, error))
1355 attribute = pango_attr_size_new_absolute (g_value_get_int (&val));
1358 /* PangoAttrFontDesc */
1359 case PANGO_ATTR_FONT_DESC:
1360 if ((font_desc = pango_font_description_from_string (value)))
1362 attribute = pango_attr_font_desc_new (font_desc);
1363 pango_font_description_free (font_desc);
1364 g_value_init (&val, G_TYPE_INT);
1368 /* PangoAttrColor */
1369 case PANGO_ATTR_FOREGROUND:
1370 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
1371 value, &val, error))
1373 color = g_value_get_boxed (&val);
1374 attribute = pango_attr_foreground_new (color->red, color->green, color->blue);
1377 case PANGO_ATTR_BACKGROUND:
1378 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
1379 value, &val, error))
1381 color = g_value_get_boxed (&val);
1382 attribute = pango_attr_background_new (color->red, color->green, color->blue);
1385 case PANGO_ATTR_UNDERLINE_COLOR:
1386 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
1387 value, &val, error))
1389 color = g_value_get_boxed (&val);
1390 attribute = pango_attr_underline_color_new (color->red, color->green, color->blue);
1393 case PANGO_ATTR_STRIKETHROUGH_COLOR:
1394 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
1395 value, &val, error))
1397 color = g_value_get_boxed (&val);
1398 attribute = pango_attr_strikethrough_color_new (color->red, color->green, color->blue);
1402 /* PangoAttrShape */
1403 case PANGO_ATTR_SHAPE:
1404 /* Unsupported for now */
1406 /* PangoAttrFloat */
1407 case PANGO_ATTR_SCALE:
1408 if (gtk_builder_value_from_string_type (builder, G_TYPE_DOUBLE,
1409 value, &val, error))
1410 attribute = pango_attr_scale_new (g_value_get_double (&val));
1413 case PANGO_ATTR_INVALID:
1414 case PANGO_ATTR_LETTER_SPACING:
1415 case PANGO_ATTR_RISE:
1416 case PANGO_ATTR_FALLBACK:
1421 g_value_unset (&val);
1428 pango_start_element (GMarkupParseContext *context,
1429 const gchar *element_name,
1430 const gchar **names,
1431 const gchar **values,
1435 PangoParserData *data = (PangoParserData*)user_data;
1436 GValue val = G_VALUE_INIT;
1438 gint line_number, char_number;
1440 if (strcmp (element_name, "attribute") == 0)
1442 PangoAttribute *attr = NULL;
1443 const gchar *name = NULL;
1444 const gchar *value = NULL;
1445 const gchar *start = NULL;
1446 const gchar *end = NULL;
1447 guint start_val = 0;
1448 guint end_val = G_MAXUINT;
1450 for (i = 0; names[i]; i++)
1452 if (strcmp (names[i], "name") == 0)
1454 else if (strcmp (names[i], "value") == 0)
1456 else if (strcmp (names[i], "start") == 0)
1458 else if (strcmp (names[i], "end") == 0)
1462 g_markup_parse_context_get_position (context,
1467 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
1468 "%s:%d:%d '%s' is not a valid attribute of <%s>",
1470 line_number, char_number, names[i], "attribute");
1475 if (!name || !value)
1477 g_markup_parse_context_get_position (context,
1482 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
1483 "%s:%d:%d <%s> requires attribute \"%s\"",
1485 line_number, char_number, "attribute",
1486 name ? "value" : "name");
1492 if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_UINT,
1493 start, &val, error))
1495 start_val = g_value_get_uint (&val);
1496 g_value_unset (&val);
1501 if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_UINT,
1504 end_val = g_value_get_uint (&val);
1505 g_value_unset (&val);
1508 attr = attribute_from_text (data->builder, name, value, error);
1512 attr->start_index = start_val;
1513 attr->end_index = end_val;
1516 data->attrs = pango_attr_list_new ();
1518 pango_attr_list_insert (data->attrs, attr);
1521 else if (strcmp (element_name, "attributes") == 0)
1524 g_warning ("Unsupported tag for GtkLabel: %s\n", element_name);
1527 static const GMarkupParser pango_parser =
1529 pango_start_element,
1533 gtk_label_buildable_custom_tag_start (GtkBuildable *buildable,
1534 GtkBuilder *builder,
1536 const gchar *tagname,
1537 GMarkupParser *parser,
1540 if (buildable_parent_iface->custom_tag_start (buildable, builder, child,
1541 tagname, parser, data))
1544 if (strcmp (tagname, "attributes") == 0)
1546 PangoParserData *parser_data;
1548 parser_data = g_slice_new0 (PangoParserData);
1549 parser_data->builder = g_object_ref (builder);
1550 parser_data->object = g_object_ref (buildable);
1551 *parser = pango_parser;
1552 *data = parser_data;
1559 gtk_label_buildable_custom_finished (GtkBuildable *buildable,
1560 GtkBuilder *builder,
1562 const gchar *tagname,
1565 PangoParserData *data;
1567 buildable_parent_iface->custom_finished (buildable, builder, child,
1568 tagname, user_data);
1570 if (strcmp (tagname, "attributes") == 0)
1572 data = (PangoParserData*)user_data;
1576 gtk_label_set_attributes (GTK_LABEL (buildable), data->attrs);
1577 pango_attr_list_unref (data->attrs);
1580 g_object_unref (data->object);
1581 g_object_unref (data->builder);
1582 g_slice_free (PangoParserData, data);
1589 * @str: The text of the label
1591 * Creates a new label with the given text inside it. You can
1592 * pass %NULL to get an empty label widget.
1594 * Return value: the new #GtkLabel
1597 gtk_label_new (const gchar *str)
1601 label = g_object_new (GTK_TYPE_LABEL, NULL);
1604 gtk_label_set_text (label, str);
1606 return GTK_WIDGET (label);
1610 * gtk_label_new_with_mnemonic:
1611 * @str: The text of the label, with an underscore in front of the
1612 * mnemonic character
1614 * Creates a new #GtkLabel, containing the text in @str.
1616 * If characters in @str are preceded by an underscore, they are
1617 * underlined. If you need a literal underscore character in a label, use
1618 * '__' (two underscores). The first underlined character represents a
1619 * keyboard accelerator called a mnemonic. The mnemonic key can be used
1620 * to activate another widget, chosen automatically, or explicitly using
1621 * gtk_label_set_mnemonic_widget().
1623 * If gtk_label_set_mnemonic_widget() is not called, then the first
1624 * activatable ancestor of the #GtkLabel will be chosen as the mnemonic
1625 * widget. For instance, if the label is inside a button or menu item,
1626 * the button or menu item will automatically become the mnemonic widget
1627 * and be activated by the mnemonic.
1629 * Return value: the new #GtkLabel
1632 gtk_label_new_with_mnemonic (const gchar *str)
1636 label = g_object_new (GTK_TYPE_LABEL, NULL);
1639 gtk_label_set_text_with_mnemonic (label, str);
1641 return GTK_WIDGET (label);
1645 gtk_label_mnemonic_activate (GtkWidget *widget,
1646 gboolean group_cycling)
1648 GtkLabel *label = GTK_LABEL (widget);
1649 GtkLabelPrivate *priv = label->priv;
1652 if (priv->mnemonic_widget)
1653 return gtk_widget_mnemonic_activate (priv->mnemonic_widget, group_cycling);
1655 /* Try to find the widget to activate by traversing the
1656 * widget's ancestry.
1658 parent = gtk_widget_get_parent (widget);
1660 if (GTK_IS_NOTEBOOK (parent))
1665 if (gtk_widget_get_can_focus (parent) ||
1666 (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
1667 GTK_IS_NOTEBOOK (gtk_widget_get_parent (parent)) ||
1668 GTK_IS_MENU_ITEM (parent))
1669 return gtk_widget_mnemonic_activate (parent, group_cycling);
1670 parent = gtk_widget_get_parent (parent);
1673 /* barf if there was nothing to activate */
1674 g_warning ("Couldn't find a target for a mnemonic activation.");
1675 gtk_widget_error_bell (widget);
1681 gtk_label_setup_mnemonic (GtkLabel *label,
1684 GtkLabelPrivate *priv = label->priv;
1685 GtkWidget *widget = GTK_WIDGET (label);
1686 GtkWidget *toplevel;
1687 GtkWidget *mnemonic_menu;
1689 mnemonic_menu = g_object_get_data (G_OBJECT (label), "gtk-mnemonic-menu");
1691 if (last_key != GDK_KEY_VoidSymbol)
1693 if (priv->mnemonic_window)
1695 gtk_window_remove_mnemonic (priv->mnemonic_window,
1698 priv->mnemonic_window = NULL;
1702 _gtk_menu_shell_remove_mnemonic (GTK_MENU_SHELL (mnemonic_menu),
1705 mnemonic_menu = NULL;
1709 if (priv->mnemonic_keyval == GDK_KEY_VoidSymbol)
1712 connect_mnemonics_visible_notify (GTK_LABEL (widget));
1714 toplevel = gtk_widget_get_toplevel (widget);
1715 if (gtk_widget_is_toplevel (toplevel))
1717 GtkWidget *menu_shell;
1719 menu_shell = gtk_widget_get_ancestor (widget,
1720 GTK_TYPE_MENU_SHELL);
1724 _gtk_menu_shell_add_mnemonic (GTK_MENU_SHELL (menu_shell),
1725 priv->mnemonic_keyval,
1727 mnemonic_menu = menu_shell;
1730 if (!GTK_IS_MENU (menu_shell))
1732 gtk_window_add_mnemonic (GTK_WINDOW (toplevel),
1733 priv->mnemonic_keyval,
1735 priv->mnemonic_window = GTK_WINDOW (toplevel);
1740 g_object_set_data (G_OBJECT (label), I_("gtk-mnemonic-menu"), mnemonic_menu);
1744 gtk_label_hierarchy_changed (GtkWidget *widget,
1745 GtkWidget *old_toplevel)
1747 GtkLabel *label = GTK_LABEL (widget);
1748 GtkLabelPrivate *priv = label->priv;
1750 gtk_label_setup_mnemonic (label, priv->mnemonic_keyval);
1754 label_shortcut_setting_apply (GtkLabel *label)
1756 gtk_label_recalculate (label);
1757 if (GTK_IS_ACCEL_LABEL (label))
1758 gtk_accel_label_refetch (GTK_ACCEL_LABEL (label));
1762 label_shortcut_setting_traverse_container (GtkWidget *widget,
1765 if (GTK_IS_LABEL (widget))
1766 label_shortcut_setting_apply (GTK_LABEL (widget));
1767 else if (GTK_IS_CONTAINER (widget))
1768 gtk_container_forall (GTK_CONTAINER (widget),
1769 label_shortcut_setting_traverse_container, data);
1773 label_shortcut_setting_changed (GtkSettings *settings)
1777 list = gtk_window_list_toplevels ();
1779 for (l = list; l ; l = l->next)
1781 GtkWidget *widget = l->data;
1783 if (gtk_widget_get_settings (widget) == settings)
1784 gtk_container_forall (GTK_CONTAINER (widget),
1785 label_shortcut_setting_traverse_container, NULL);
1792 mnemonics_visible_apply (GtkWidget *widget,
1793 gboolean mnemonics_visible)
1795 GtkLabel *label = GTK_LABEL (widget);
1796 GtkLabelPrivate *priv = label->priv;
1798 mnemonics_visible = mnemonics_visible != FALSE;
1800 if (priv->mnemonics_visible != mnemonics_visible)
1802 priv->mnemonics_visible = mnemonics_visible;
1804 gtk_label_recalculate (label);
1809 label_mnemonics_visible_traverse_container (GtkWidget *widget,
1812 gboolean mnemonics_visible = GPOINTER_TO_INT (data);
1814 _gtk_label_mnemonics_visible_apply_recursively (widget, mnemonics_visible);
1818 _gtk_label_mnemonics_visible_apply_recursively (GtkWidget *widget,
1819 gboolean mnemonics_visible)
1821 if (GTK_IS_LABEL (widget))
1822 mnemonics_visible_apply (widget, mnemonics_visible);
1823 else if (GTK_IS_CONTAINER (widget))
1824 gtk_container_forall (GTK_CONTAINER (widget),
1825 label_mnemonics_visible_traverse_container,
1826 GINT_TO_POINTER (mnemonics_visible));
1830 label_mnemonics_visible_changed (GtkWindow *window,
1834 gboolean mnemonics_visible;
1836 g_object_get (window, "mnemonics-visible", &mnemonics_visible, NULL);
1838 gtk_container_forall (GTK_CONTAINER (window),
1839 label_mnemonics_visible_traverse_container,
1840 GINT_TO_POINTER (mnemonics_visible));
1844 gtk_label_screen_changed (GtkWidget *widget,
1845 GdkScreen *old_screen)
1847 GtkSettings *settings;
1848 gboolean shortcuts_connected;
1850 /* The PangoContext is replaced when the screen changes, so clear the layouts */
1851 gtk_label_clear_layout (GTK_LABEL (widget));
1853 if (!gtk_widget_has_screen (widget))
1856 settings = gtk_widget_get_settings (widget);
1858 shortcuts_connected =
1859 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
1860 "gtk-label-shortcuts-connected"));
1862 if (! shortcuts_connected)
1864 g_signal_connect (settings, "notify::gtk-enable-mnemonics",
1865 G_CALLBACK (label_shortcut_setting_changed),
1867 g_signal_connect (settings, "notify::gtk-enable-accels",
1868 G_CALLBACK (label_shortcut_setting_changed),
1871 g_object_set_data (G_OBJECT (settings), "gtk-label-shortcuts-connected",
1872 GINT_TO_POINTER (TRUE));
1875 label_shortcut_setting_apply (GTK_LABEL (widget));
1880 label_mnemonic_widget_weak_notify (gpointer data,
1881 GObject *where_the_object_was)
1883 GtkLabel *label = data;
1884 GtkLabelPrivate *priv = label->priv;
1886 priv->mnemonic_widget = NULL;
1887 g_object_notify (G_OBJECT (label), "mnemonic-widget");
1891 * gtk_label_set_mnemonic_widget:
1892 * @label: a #GtkLabel
1893 * @widget: (allow-none): the target #GtkWidget
1895 * If the label has been set so that it has an mnemonic key (using
1896 * i.e. gtk_label_set_markup_with_mnemonic(),
1897 * gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
1898 * or the "use_underline" property) the label can be associated with a
1899 * widget that is the target of the mnemonic. When the label is inside
1900 * a widget (like a #GtkButton or a #GtkNotebook tab) it is
1901 * automatically associated with the correct widget, but sometimes
1902 * (i.e. when the target is a #GtkEntry next to the label) you need to
1903 * set it explicitly using this function.
1905 * The target widget will be accelerated by emitting the
1906 * GtkWidget::mnemonic-activate signal on it. The default handler for
1907 * this signal will activate the widget if there are no mnemonic collisions
1908 * and toggle focus between the colliding widgets otherwise.
1911 gtk_label_set_mnemonic_widget (GtkLabel *label,
1914 GtkLabelPrivate *priv;
1916 g_return_if_fail (GTK_IS_LABEL (label));
1921 g_return_if_fail (GTK_IS_WIDGET (widget));
1923 if (priv->mnemonic_widget)
1925 gtk_widget_remove_mnemonic_label (priv->mnemonic_widget, GTK_WIDGET (label));
1926 g_object_weak_unref (G_OBJECT (priv->mnemonic_widget),
1927 label_mnemonic_widget_weak_notify,
1930 priv->mnemonic_widget = widget;
1931 if (priv->mnemonic_widget)
1933 g_object_weak_ref (G_OBJECT (priv->mnemonic_widget),
1934 label_mnemonic_widget_weak_notify,
1936 gtk_widget_add_mnemonic_label (priv->mnemonic_widget, GTK_WIDGET (label));
1939 g_object_notify (G_OBJECT (label), "mnemonic-widget");
1943 * gtk_label_get_mnemonic_widget:
1944 * @label: a #GtkLabel
1946 * Retrieves the target of the mnemonic (keyboard shortcut) of this
1947 * label. See gtk_label_set_mnemonic_widget().
1949 * Return value: (transfer none): the target of the label's mnemonic,
1950 * or %NULL if none has been set and the default algorithm will be used.
1953 gtk_label_get_mnemonic_widget (GtkLabel *label)
1955 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1957 return label->priv->mnemonic_widget;
1961 * gtk_label_get_mnemonic_keyval:
1962 * @label: a #GtkLabel
1964 * If the label has been set so that it has an mnemonic key this function
1965 * returns the keyval used for the mnemonic accelerator. If there is no
1966 * mnemonic set up it returns #GDK_KEY_VoidSymbol.
1968 * Returns: GDK keyval usable for accelerators, or #GDK_KEY_VoidSymbol
1971 gtk_label_get_mnemonic_keyval (GtkLabel *label)
1973 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_KEY_VoidSymbol);
1975 return label->priv->mnemonic_keyval;
1979 gtk_label_set_text_internal (GtkLabel *label,
1982 GtkLabelPrivate *priv = label->priv;
1984 if (g_strcmp0 (priv->text, str) == 0)
1990 g_free (priv->text);
1993 gtk_label_select_region_index (label, 0, 0);
1997 gtk_label_set_label_internal (GtkLabel *label,
2000 GtkLabelPrivate *priv = label->priv;
2002 g_free (priv->label);
2006 g_object_notify (G_OBJECT (label), "label");
2010 gtk_label_set_use_markup_internal (GtkLabel *label,
2013 GtkLabelPrivate *priv = label->priv;
2016 if (priv->use_markup != val)
2018 priv->use_markup = val;
2020 g_object_notify (G_OBJECT (label), "use-markup");
2025 gtk_label_set_use_underline_internal (GtkLabel *label,
2028 GtkLabelPrivate *priv = label->priv;
2031 if (priv->use_underline != val)
2033 priv->use_underline = val;
2035 g_object_notify (G_OBJECT (label), "use-underline");
2040 my_pango_attr_list_merge_filter (PangoAttribute *attribute,
2043 pango_attr_list_change (list, pango_attribute_copy (attribute));
2048 my_pango_attr_list_merge (PangoAttrList *into,
2049 PangoAttrList *from)
2051 pango_attr_list_filter (from, my_pango_attr_list_merge_filter, into);
2054 /* Calculates text, attrs and mnemonic_keyval from
2055 * label, use_underline and use_markup
2058 gtk_label_recalculate (GtkLabel *label)
2060 GtkLabelPrivate *priv = label->priv;
2061 guint keyval = priv->mnemonic_keyval;
2063 gtk_label_clear_links (label);
2065 if (priv->use_markup)
2066 gtk_label_set_markup_internal (label, priv->label, priv->use_underline);
2067 else if (priv->use_underline)
2068 gtk_label_set_uline_text_internal (label, priv->label);
2071 if (!priv->pattern_set)
2073 if (priv->markup_attrs)
2074 pango_attr_list_unref (priv->markup_attrs);
2075 priv->markup_attrs = NULL;
2077 gtk_label_set_text_internal (label, g_strdup (priv->label));
2080 if (!priv->use_underline)
2081 priv->mnemonic_keyval = GDK_KEY_VoidSymbol;
2083 if (keyval != priv->mnemonic_keyval)
2085 gtk_label_setup_mnemonic (label, keyval);
2086 g_object_notify (G_OBJECT (label), "mnemonic-keyval");
2089 gtk_label_clear_layout (label);
2090 gtk_label_clear_select_info (label);
2091 gtk_widget_queue_resize (GTK_WIDGET (label));
2095 * gtk_label_set_text:
2096 * @label: a #GtkLabel
2097 * @str: The text you want to set
2099 * Sets the text within the #GtkLabel widget. It overwrites any text that
2102 * This will also clear any previously set mnemonic accelerators.
2105 gtk_label_set_text (GtkLabel *label,
2108 g_return_if_fail (GTK_IS_LABEL (label));
2110 g_object_freeze_notify (G_OBJECT (label));
2112 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
2113 gtk_label_set_use_markup_internal (label, FALSE);
2114 gtk_label_set_use_underline_internal (label, FALSE);
2116 gtk_label_recalculate (label);
2118 g_object_thaw_notify (G_OBJECT (label));
2122 * gtk_label_set_attributes:
2123 * @label: a #GtkLabel
2124 * @attrs: a #PangoAttrList
2126 * Sets a #PangoAttrList; the attributes in the list are applied to the
2129 * <note><para>The attributes set with this function will be applied
2130 * and merged with any other attributes previously effected by way
2131 * of the #GtkLabel:use-underline or #GtkLabel:use-markup properties.
2132 * While it is not recommended to mix markup strings with manually set
2133 * attributes, if you must; know that the attributes will be applied
2134 * to the label after the markup string is parsed.</para></note>
2137 gtk_label_set_attributes (GtkLabel *label,
2138 PangoAttrList *attrs)
2140 GtkLabelPrivate *priv = label->priv;
2142 g_return_if_fail (GTK_IS_LABEL (label));
2145 pango_attr_list_ref (attrs);
2148 pango_attr_list_unref (priv->attrs);
2149 priv->attrs = attrs;
2151 g_object_notify (G_OBJECT (label), "attributes");
2153 gtk_label_clear_layout (label);
2154 gtk_widget_queue_resize (GTK_WIDGET (label));
2158 * gtk_label_get_attributes:
2159 * @label: a #GtkLabel
2161 * Gets the attribute list that was set on the label using
2162 * gtk_label_set_attributes(), if any. This function does
2163 * not reflect attributes that come from the labels markup
2164 * (see gtk_label_set_markup()). If you want to get the
2165 * effective attributes for the label, use
2166 * pango_layout_get_attribute (gtk_label_get_layout (label)).
2168 * Return value: (transfer none): the attribute list, or %NULL
2172 gtk_label_get_attributes (GtkLabel *label)
2174 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
2176 return label->priv->attrs;
2180 * gtk_label_set_label:
2181 * @label: a #GtkLabel
2182 * @str: the new text to set for the label
2184 * Sets the text of the label. The label is interpreted as
2185 * including embedded underlines and/or Pango markup depending
2186 * on the values of the #GtkLabel:use-underline" and
2187 * #GtkLabel:use-markup properties.
2190 gtk_label_set_label (GtkLabel *label,
2193 g_return_if_fail (GTK_IS_LABEL (label));
2195 g_object_freeze_notify (G_OBJECT (label));
2197 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
2198 gtk_label_recalculate (label);
2200 g_object_thaw_notify (G_OBJECT (label));
2204 * gtk_label_get_label:
2205 * @label: a #GtkLabel
2207 * Fetches the text from a label widget including any embedded
2208 * underlines indicating mnemonics and Pango markup. (See
2209 * gtk_label_get_text()).
2211 * Return value: the text of the label widget. This string is
2212 * owned by the widget and must not be modified or freed.
2215 gtk_label_get_label (GtkLabel *label)
2217 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
2219 return label->priv->label;
2231 start_element_handler (GMarkupParseContext *context,
2232 const gchar *element_name,
2233 const gchar **attribute_names,
2234 const gchar **attribute_values,
2238 GtkLabelPrivate *priv;
2239 UriParserData *pdata = user_data;
2241 if (strcmp (element_name, "a") == 0)
2244 const gchar *uri = NULL;
2245 const gchar *title = NULL;
2246 gboolean visited = FALSE;
2251 g_markup_parse_context_get_position (context, &line_number, &char_number);
2253 for (i = 0; attribute_names[i] != NULL; i++)
2255 const gchar *attr = attribute_names[i];
2257 if (strcmp (attr, "href") == 0)
2258 uri = attribute_values[i];
2259 else if (strcmp (attr, "title") == 0)
2260 title = attribute_values[i];
2265 G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
2266 "Attribute '%s' is not allowed on the <a> tag "
2267 "on line %d char %d",
2268 attr, line_number, char_number);
2277 G_MARKUP_ERROR_INVALID_CONTENT,
2278 "Attribute 'href' was missing on the <a> tag "
2279 "on line %d char %d",
2280 line_number, char_number);
2285 priv = pdata->label->priv;
2286 if (priv->track_links && priv->select_info)
2289 for (l = priv->select_info->links; l; l = l->next)
2292 if (strcmp (uri, link->uri) == 0)
2294 visited = link->visited;
2300 link = g_new0 (GtkLabelLink, 1);
2301 link->uri = g_strdup (uri);
2302 link->title = g_strdup (title);
2303 link->visited = visited;
2304 link->start = pdata->text_len;
2305 pdata->links = g_list_prepend (pdata->links, link);
2311 g_string_append_c (pdata->new_str, '<');
2312 g_string_append (pdata->new_str, element_name);
2314 for (i = 0; attribute_names[i] != NULL; i++)
2316 const gchar *attr = attribute_names[i];
2317 const gchar *value = attribute_values[i];
2320 newvalue = g_markup_escape_text (value, -1);
2322 g_string_append_c (pdata->new_str, ' ');
2323 g_string_append (pdata->new_str, attr);
2324 g_string_append (pdata->new_str, "=\"");
2325 g_string_append (pdata->new_str, newvalue);
2326 g_string_append_c (pdata->new_str, '\"');
2330 g_string_append_c (pdata->new_str, '>');
2335 end_element_handler (GMarkupParseContext *context,
2336 const gchar *element_name,
2340 UriParserData *pdata = user_data;
2342 if (!strcmp (element_name, "a"))
2344 GtkLabelLink *link = pdata->links->data;
2345 link->end = pdata->text_len;
2349 g_string_append (pdata->new_str, "</");
2350 g_string_append (pdata->new_str, element_name);
2351 g_string_append_c (pdata->new_str, '>');
2356 text_handler (GMarkupParseContext *context,
2362 UriParserData *pdata = user_data;
2365 newtext = g_markup_escape_text (text, text_len);
2366 g_string_append (pdata->new_str, newtext);
2367 pdata->text_len += text_len;
2371 static const GMarkupParser markup_parser =
2373 start_element_handler,
2374 end_element_handler,
2381 xml_isspace (gchar c)
2383 return (c == ' ' || c == '\t' || c == '\n' || c == '\r');
2387 link_free (GtkLabelLink *link)
2390 g_free (link->title);
2395 gtk_label_get_link_colors (GtkWidget *widget,
2396 GdkColor *link_color,
2397 GdkColor *visited_link_color)
2399 GtkStyleContext *context;
2400 GdkColor *link, *visited;
2402 context = gtk_widget_get_style_context (widget);
2403 gtk_style_context_get_style (context,
2404 "link-color", &link,
2405 "visited-link-color", &visited,
2409 *link_color = *link;
2410 gdk_color_free (link);
2413 *link_color = default_link_color;
2417 *visited_link_color = *visited;
2418 gdk_color_free (visited);
2421 *visited_link_color = default_visited_link_color;
2425 parse_uri_markup (GtkLabel *label,
2431 GMarkupParseContext *context = NULL;
2432 const gchar *p, *end;
2433 gboolean needs_root = TRUE;
2435 UriParserData pdata;
2437 length = strlen (str);
2441 pdata.label = label;
2443 pdata.new_str = g_string_sized_new (length);
2446 while (p != end && xml_isspace (*p))
2449 if (end - p >= 8 && strncmp (p, "<markup>", 8) == 0)
2452 context = g_markup_parse_context_new (&markup_parser, 0, &pdata, NULL);
2456 if (!g_markup_parse_context_parse (context, "<markup>", -1, error))
2460 if (!g_markup_parse_context_parse (context, str, length, error))
2465 if (!g_markup_parse_context_parse (context, "</markup>", -1, error))
2469 if (!g_markup_parse_context_end_parse (context, error))
2472 g_markup_parse_context_free (context);
2474 *new_str = g_string_free (pdata.new_str, FALSE);
2475 *links = pdata.links;
2480 g_markup_parse_context_free (context);
2481 g_string_free (pdata.new_str, TRUE);
2482 g_list_free_full (pdata.links, (GDestroyNotify) link_free);
2488 gtk_label_ensure_has_tooltip (GtkLabel *label)
2490 GtkLabelPrivate *priv = label->priv;
2492 gboolean has_tooltip = FALSE;
2494 for (l = priv->select_info->links; l; l = l->next)
2496 GtkLabelLink *link = l->data;
2504 gtk_widget_set_has_tooltip (GTK_WIDGET (label), has_tooltip);
2508 gtk_label_set_markup_internal (GtkLabel *label,
2510 gboolean with_uline)
2512 GtkLabelPrivate *priv = label->priv;
2514 GError *error = NULL;
2515 PangoAttrList *attrs = NULL;
2516 gunichar accel_char = 0;
2518 GList *links = NULL;
2520 if (!parse_uri_markup (label, str, &new_str, &links, &error))
2522 g_warning ("Failed to set text from markup due to error parsing markup: %s",
2524 g_error_free (error);
2530 gtk_label_ensure_select_info (label);
2531 priv->select_info->links = g_list_reverse (links);
2532 gtk_label_ensure_has_tooltip (label);
2537 gboolean enable_mnemonics;
2538 gboolean auto_mnemonics;
2540 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
2541 "gtk-enable-mnemonics", &enable_mnemonics,
2542 "gtk-auto-mnemonics", &auto_mnemonics,
2545 if (!(enable_mnemonics && priv->mnemonics_visible &&
2547 (gtk_widget_is_sensitive (GTK_WIDGET (label)) &&
2548 (!priv->mnemonic_widget ||
2549 gtk_widget_is_sensitive (priv->mnemonic_widget))))))
2555 if (separate_uline_pattern (new_str, &key, &tmp, &pattern))
2564 if (!pango_parse_markup (new_str,
2566 with_uline ? '_' : 0,
2569 with_uline ? &accel_char : NULL,
2572 g_warning ("Failed to set text from markup due to error parsing markup: %s",
2575 g_error_free (error);
2582 gtk_label_set_text_internal (label, text);
2586 if (priv->markup_attrs)
2587 pango_attr_list_unref (priv->markup_attrs);
2588 priv->markup_attrs = attrs;
2591 if (accel_char != 0)
2592 priv->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
2594 priv->mnemonic_keyval = GDK_KEY_VoidSymbol;
2598 * gtk_label_set_markup:
2599 * @label: a #GtkLabel
2600 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
2602 * Parses @str which is marked up with the <link
2603 * linkend="PangoMarkupFormat">Pango text markup language</link>, setting the
2604 * label's text and attribute list based on the parse results. If the @str is
2605 * external data, you may need to escape it with g_markup_escape_text() or
2606 * g_markup_printf_escaped()<!-- -->:
2610 * markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str);
2611 * gtk_label_set_markup (GTK_LABEL (label), markup);
2616 gtk_label_set_markup (GtkLabel *label,
2619 g_return_if_fail (GTK_IS_LABEL (label));
2621 g_object_freeze_notify (G_OBJECT (label));
2623 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
2624 gtk_label_set_use_markup_internal (label, TRUE);
2625 gtk_label_set_use_underline_internal (label, FALSE);
2627 gtk_label_recalculate (label);
2629 g_object_thaw_notify (G_OBJECT (label));
2633 * gtk_label_set_markup_with_mnemonic:
2634 * @label: a #GtkLabel
2635 * @str: a markup string (see
2636 * <link linkend="PangoMarkupFormat">Pango markup format</link>)
2638 * Parses @str which is marked up with the
2639 * <link linkend="PangoMarkupFormat">Pango text markup language</link>,
2640 * setting the label's text and attribute list based on the parse results.
2641 * If characters in @str are preceded by an underscore, they are underlined
2642 * indicating that they represent a keyboard accelerator called a mnemonic.
2644 * The mnemonic key can be used to activate another widget, chosen
2645 * automatically, or explicitly using gtk_label_set_mnemonic_widget().
2648 gtk_label_set_markup_with_mnemonic (GtkLabel *label,
2651 g_return_if_fail (GTK_IS_LABEL (label));
2653 g_object_freeze_notify (G_OBJECT (label));
2655 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
2656 gtk_label_set_use_markup_internal (label, TRUE);
2657 gtk_label_set_use_underline_internal (label, TRUE);
2659 gtk_label_recalculate (label);
2661 g_object_thaw_notify (G_OBJECT (label));
2665 * gtk_label_get_text:
2666 * @label: a #GtkLabel
2668 * Fetches the text from a label widget, as displayed on the
2669 * screen. This does not include any embedded underlines
2670 * indicating mnemonics or Pango markup. (See gtk_label_get_label())
2672 * Return value: the text in the label widget. This is the internal
2673 * string used by the label, and must not be modified.
2676 gtk_label_get_text (GtkLabel *label)
2678 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
2680 return label->priv->text;
2683 static PangoAttrList *
2684 gtk_label_pattern_to_attrs (GtkLabel *label,
2685 const gchar *pattern)
2687 GtkLabelPrivate *priv = label->priv;
2689 const char *p = priv->text;
2690 const char *q = pattern;
2691 PangoAttrList *attrs;
2693 attrs = pango_attr_list_new ();
2697 while (*p && *q && *q != '_')
2699 p = g_utf8_next_char (p);
2703 while (*p && *q && *q == '_')
2705 p = g_utf8_next_char (p);
2711 PangoAttribute *attr = pango_attr_underline_new (PANGO_UNDERLINE_LOW);
2712 attr->start_index = start - priv->text;
2713 attr->end_index = p - priv->text;
2715 pango_attr_list_insert (attrs, attr);
2725 gtk_label_set_pattern_internal (GtkLabel *label,
2726 const gchar *pattern,
2727 gboolean is_mnemonic)
2729 GtkLabelPrivate *priv = label->priv;
2730 PangoAttrList *attrs;
2731 gboolean enable_mnemonics;
2732 gboolean auto_mnemonics;
2734 if (priv->pattern_set)
2739 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
2740 "gtk-enable-mnemonics", &enable_mnemonics,
2741 "gtk-auto-mnemonics", &auto_mnemonics,
2744 if (enable_mnemonics && priv->mnemonics_visible && pattern &&
2746 (gtk_widget_is_sensitive (GTK_WIDGET (label)) &&
2747 (!priv->mnemonic_widget ||
2748 gtk_widget_is_sensitive (priv->mnemonic_widget)))))
2749 attrs = gtk_label_pattern_to_attrs (label, pattern);
2754 attrs = gtk_label_pattern_to_attrs (label, pattern);
2756 if (priv->markup_attrs)
2757 pango_attr_list_unref (priv->markup_attrs);
2758 priv->markup_attrs = attrs;
2762 * gtk_label_set_pattern:
2763 * @label: The #GtkLabel you want to set the pattern to.
2764 * @pattern: The pattern as described above.
2766 * The pattern of underlines you want under the existing text within the
2767 * #GtkLabel widget. For example if the current text of the label says
2768 * "FooBarBaz" passing a pattern of "___ ___" will underline
2769 * "Foo" and "Baz" but not "Bar".
2772 gtk_label_set_pattern (GtkLabel *label,
2773 const gchar *pattern)
2775 GtkLabelPrivate *priv;
2777 g_return_if_fail (GTK_IS_LABEL (label));
2781 priv->pattern_set = FALSE;
2785 gtk_label_set_pattern_internal (label, pattern, FALSE);
2786 priv->pattern_set = TRUE;
2789 gtk_label_recalculate (label);
2791 gtk_label_clear_layout (label);
2792 gtk_widget_queue_resize (GTK_WIDGET (label));
2797 * gtk_label_set_justify:
2798 * @label: a #GtkLabel
2799 * @jtype: a #GtkJustification
2801 * Sets the alignment of the lines in the text of the label relative to
2802 * each other. %GTK_JUSTIFY_LEFT is the default value when the
2803 * widget is first created with gtk_label_new(). If you instead want
2804 * to set the alignment of the label as a whole, use
2805 * gtk_misc_set_alignment() instead. gtk_label_set_justify() has no
2806 * effect on labels containing only a single line.
2809 gtk_label_set_justify (GtkLabel *label,
2810 GtkJustification jtype)
2812 GtkLabelPrivate *priv;
2814 g_return_if_fail (GTK_IS_LABEL (label));
2815 g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
2819 if ((GtkJustification) priv->jtype != jtype)
2821 priv->jtype = jtype;
2823 /* No real need to be this drastic, but easier than duplicating the code */
2824 gtk_label_clear_layout (label);
2826 g_object_notify (G_OBJECT (label), "justify");
2827 gtk_widget_queue_resize (GTK_WIDGET (label));
2832 * gtk_label_get_justify:
2833 * @label: a #GtkLabel
2835 * Returns the justification of the label. See gtk_label_set_justify().
2837 * Return value: #GtkJustification
2840 gtk_label_get_justify (GtkLabel *label)
2842 g_return_val_if_fail (GTK_IS_LABEL (label), 0);
2844 return label->priv->jtype;
2848 * gtk_label_set_ellipsize:
2849 * @label: a #GtkLabel
2850 * @mode: a #PangoEllipsizeMode
2852 * Sets the mode used to ellipsize (add an ellipsis: "...") to the text
2853 * if there is not enough space to render the entire string.
2858 gtk_label_set_ellipsize (GtkLabel *label,
2859 PangoEllipsizeMode mode)
2861 GtkLabelPrivate *priv;
2863 g_return_if_fail (GTK_IS_LABEL (label));
2864 g_return_if_fail (mode >= PANGO_ELLIPSIZE_NONE && mode <= PANGO_ELLIPSIZE_END);
2868 if ((PangoEllipsizeMode) priv->ellipsize != mode)
2870 priv->ellipsize = mode;
2872 /* No real need to be this drastic, but easier than duplicating the code */
2873 gtk_label_clear_layout (label);
2875 g_object_notify (G_OBJECT (label), "ellipsize");
2876 gtk_widget_queue_resize (GTK_WIDGET (label));
2881 * gtk_label_get_ellipsize:
2882 * @label: a #GtkLabel
2884 * Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
2886 * Return value: #PangoEllipsizeMode
2891 gtk_label_get_ellipsize (GtkLabel *label)
2893 g_return_val_if_fail (GTK_IS_LABEL (label), PANGO_ELLIPSIZE_NONE);
2895 return label->priv->ellipsize;
2899 * gtk_label_set_width_chars:
2900 * @label: a #GtkLabel
2901 * @n_chars: the new desired width, in characters.
2903 * Sets the desired width in characters of @label to @n_chars.
2908 gtk_label_set_width_chars (GtkLabel *label,
2911 GtkLabelPrivate *priv;
2913 g_return_if_fail (GTK_IS_LABEL (label));
2917 if (priv->width_chars != n_chars)
2919 priv->width_chars = n_chars;
2920 g_object_notify (G_OBJECT (label), "width-chars");
2921 gtk_widget_queue_resize (GTK_WIDGET (label));
2926 * gtk_label_get_width_chars:
2927 * @label: a #GtkLabel
2929 * Retrieves the desired width of @label, in characters. See
2930 * gtk_label_set_width_chars().
2932 * Return value: the width of the label in characters.
2937 gtk_label_get_width_chars (GtkLabel *label)
2939 g_return_val_if_fail (GTK_IS_LABEL (label), -1);
2941 return label->priv->width_chars;
2945 * gtk_label_set_max_width_chars:
2946 * @label: a #GtkLabel
2947 * @n_chars: the new desired maximum width, in characters.
2949 * Sets the desired maximum width in characters of @label to @n_chars.
2954 gtk_label_set_max_width_chars (GtkLabel *label,
2957 GtkLabelPrivate *priv;
2959 g_return_if_fail (GTK_IS_LABEL (label));
2963 if (priv->max_width_chars != n_chars)
2965 priv->max_width_chars = n_chars;
2967 g_object_notify (G_OBJECT (label), "max-width-chars");
2968 gtk_widget_queue_resize (GTK_WIDGET (label));
2973 * gtk_label_get_max_width_chars:
2974 * @label: a #GtkLabel
2976 * Retrieves the desired maximum width of @label, in characters. See
2977 * gtk_label_set_width_chars().
2979 * Return value: the maximum width of the label in characters.
2984 gtk_label_get_max_width_chars (GtkLabel *label)
2986 g_return_val_if_fail (GTK_IS_LABEL (label), -1);
2988 return label->priv->max_width_chars;
2992 * gtk_label_set_line_wrap:
2993 * @label: a #GtkLabel
2994 * @wrap: the setting
2996 * Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
2997 * lines if text exceeds the widget's size. %FALSE lets the text get cut off
2998 * by the edge of the widget if it exceeds the widget size.
3000 * Note that setting line wrapping to %TRUE does not make the label
3001 * wrap at its parent container's width, because GTK+ widgets
3002 * conceptually can't make their requisition depend on the parent
3003 * container's size. For a label that wraps at a specific position,
3004 * set the label's width using gtk_widget_set_size_request().
3007 gtk_label_set_line_wrap (GtkLabel *label,
3010 GtkLabelPrivate *priv;
3012 g_return_if_fail (GTK_IS_LABEL (label));
3016 wrap = wrap != FALSE;
3018 if (priv->wrap != wrap)
3022 gtk_label_clear_layout (label);
3023 gtk_widget_queue_resize (GTK_WIDGET (label));
3024 g_object_notify (G_OBJECT (label), "wrap");
3029 * gtk_label_get_line_wrap:
3030 * @label: a #GtkLabel
3032 * Returns whether lines in the label are automatically wrapped.
3033 * See gtk_label_set_line_wrap().
3035 * Return value: %TRUE if the lines of the label are automatically wrapped.
3038 gtk_label_get_line_wrap (GtkLabel *label)
3040 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3042 return label->priv->wrap;
3046 * gtk_label_set_line_wrap_mode:
3047 * @label: a #GtkLabel
3048 * @wrap_mode: the line wrapping mode
3050 * If line wrapping is on (see gtk_label_set_line_wrap()) this controls how
3051 * the line wrapping is done. The default is %PANGO_WRAP_WORD which means
3052 * wrap on word boundaries.
3057 gtk_label_set_line_wrap_mode (GtkLabel *label,
3058 PangoWrapMode wrap_mode)
3060 GtkLabelPrivate *priv;
3062 g_return_if_fail (GTK_IS_LABEL (label));
3066 if (priv->wrap_mode != wrap_mode)
3068 priv->wrap_mode = wrap_mode;
3069 g_object_notify (G_OBJECT (label), "wrap-mode");
3071 gtk_widget_queue_resize (GTK_WIDGET (label));
3076 * gtk_label_get_line_wrap_mode:
3077 * @label: a #GtkLabel
3079 * Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode().
3081 * Return value: %TRUE if the lines of the label are automatically wrapped.
3086 gtk_label_get_line_wrap_mode (GtkLabel *label)
3088 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3090 return label->priv->wrap_mode;
3094 gtk_label_destroy (GtkWidget *widget)
3096 GtkLabel *label = GTK_LABEL (widget);
3098 gtk_label_set_mnemonic_widget (label, NULL);
3100 GTK_WIDGET_CLASS (gtk_label_parent_class)->destroy (widget);
3104 gtk_label_finalize (GObject *object)
3106 GtkLabel *label = GTK_LABEL (object);
3107 GtkLabelPrivate *priv = label->priv;
3109 g_free (priv->label);
3110 g_free (priv->text);
3113 g_object_unref (priv->layout);
3116 pango_attr_list_unref (priv->attrs);
3118 if (priv->markup_attrs)
3119 pango_attr_list_unref (priv->markup_attrs);
3121 gtk_label_clear_links (label);
3122 g_free (priv->select_info);
3124 G_OBJECT_CLASS (gtk_label_parent_class)->finalize (object);
3128 gtk_label_clear_layout (GtkLabel *label)
3130 GtkLabelPrivate *priv = label->priv;
3134 g_object_unref (priv->layout);
3135 priv->layout = NULL;
3140 * gtk_label_get_measuring_layout:
3142 * @existing_layout: %NULL or an existing layout already in use.
3143 * @width: the width to measure with in pango units, or -1 for infinite
3145 * Gets a layout that can be used for measuring sizes. The returned
3146 * layout will be identical to the label's layout except for the
3147 * layout's width, which will be set to @width. Do not modify the returned
3150 * Returns: a new reference to a pango layout
3152 static PangoLayout *
3153 gtk_label_get_measuring_layout (GtkLabel * label,
3154 PangoLayout *existing_layout,
3157 GtkLabelPrivate *priv = label->priv;
3158 PangoRectangle rect;
3161 if (existing_layout != NULL)
3163 if (existing_layout != priv->layout)
3165 pango_layout_set_width (existing_layout, width);
3166 return existing_layout;
3169 g_object_unref (existing_layout);
3172 gtk_label_ensure_layout (label);
3174 if (pango_layout_get_width (priv->layout) == width)
3176 g_object_ref (priv->layout);
3177 return priv->layout;
3180 /* We can use the label's own layout if we're not allocated a size yet,
3181 * because we don't need it to be properly setup at that point.
3182 * This way we can make use of caching upon the label's creation.
3184 if (gtk_widget_get_allocated_width (GTK_WIDGET (label)) <= 1)
3186 g_object_ref (priv->layout);
3187 pango_layout_set_width (priv->layout, width);
3188 return priv->layout;
3191 /* oftentimes we want to measure a width that is far wider than the current width,
3192 * even though the layout would not change if we made it wider. In that case, we
3193 * can just return the current layout, because for measuring purposes, it will be
3196 pango_layout_get_extents (priv->layout, NULL, &rect);
3197 if ((width == -1 || rect.width <= width) &&
3198 !pango_layout_is_wrapped (priv->layout) &&
3199 !pango_layout_is_ellipsized (priv->layout))
3201 g_object_ref (priv->layout);
3202 return priv->layout;
3205 copy = pango_layout_copy (priv->layout);
3206 pango_layout_set_width (copy, width);
3211 gtk_label_update_layout_width (GtkLabel *label)
3213 GtkLabelPrivate *priv = label->priv;
3214 GtkWidget *widget = GTK_WIDGET (label);
3216 g_assert (priv->layout);
3218 if (priv->ellipsize || priv->wrap)
3221 PangoRectangle logical;
3224 _gtk_misc_get_padding_and_border (GTK_MISC (label), &border);
3226 width = gtk_widget_get_allocated_width (GTK_WIDGET (label)) - border.left - border.right;
3227 height = gtk_widget_get_allocated_height (GTK_WIDGET (label)) - border.top - border.bottom;
3229 if (priv->have_transform)
3231 PangoContext *context = gtk_widget_get_pango_context (widget);
3232 const PangoMatrix *matrix = pango_context_get_matrix (context);
3233 const gdouble dx = matrix->xx; /* cos (M_PI * angle / 180) */
3234 const gdouble dy = matrix->xy; /* sin (M_PI * angle / 180) */
3236 pango_layout_set_width (priv->layout, -1);
3237 pango_layout_get_pixel_extents (priv->layout, NULL, &logical);
3239 if (fabs (dy) < 0.01)
3241 if (logical.width > width)
3242 pango_layout_set_width (priv->layout, width * PANGO_SCALE);
3244 else if (fabs (dx) < 0.01)
3246 if (logical.width > height)
3247 pango_layout_set_width (priv->layout, height * PANGO_SCALE);
3251 gdouble x0, y0, x1, y1, length;
3256 y0 = dx ? x0 * dy / dx : G_MAXDOUBLE;
3257 vertical = fabs (y0) > height / 2;
3262 x0 = dy ? y0 * dx / dy : G_MAXDOUBLE;
3265 length = 2 * sqrt (x0 * x0 + y0 * y0);
3266 pango_layout_set_width (priv->layout, rint (length * PANGO_SCALE));
3267 pango_layout_get_pixel_size (priv->layout, NULL, &cy);
3274 y0 = height/2 + y1 - y0;
3279 x0 = width/2 + x1 - x0;
3283 length = length - sqrt (x0 * x0 + y0 * y0) * 2;
3284 pango_layout_set_width (priv->layout, rint (length * PANGO_SCALE));
3289 pango_layout_set_width (priv->layout, width * PANGO_SCALE);
3294 pango_layout_set_width (priv->layout, -1);
3299 gtk_label_ensure_layout (GtkLabel *label)
3301 GtkLabelPrivate *priv = label->priv;
3305 widget = GTK_WIDGET (label);
3307 rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
3311 PangoAlignment align = PANGO_ALIGN_LEFT; /* Quiet gcc */
3312 PangoAttrList *attrs;
3313 gdouble angle = gtk_label_get_angle (label);
3315 if (angle != 0.0 && !priv->select_info)
3317 PangoMatrix matrix = PANGO_MATRIX_INIT;
3319 /* We rotate the standard singleton PangoContext for the widget,
3320 * depending on the fact that it's meant pretty much exclusively
3323 pango_matrix_rotate (&matrix, angle);
3325 pango_context_set_matrix (gtk_widget_get_pango_context (widget), &matrix);
3327 priv->have_transform = TRUE;
3331 if (priv->have_transform)
3332 pango_context_set_matrix (gtk_widget_get_pango_context (widget), NULL);
3334 priv->have_transform = FALSE;
3337 priv->layout = gtk_widget_create_pango_layout (widget, priv->text);
3339 if (priv->select_info && priv->select_info->links)
3341 GdkColor link_color, visited_color;
3342 PangoAttribute *attribute;
3345 gtk_label_get_link_colors (widget, &link_color, &visited_color);
3346 attrs = pango_attr_list_new ();
3348 for (list = priv->select_info->links; list; list = list->next)
3350 GtkLabelLink *link = list->data;
3352 attribute = pango_attr_underline_new (TRUE);
3353 attribute->start_index = link->start;
3354 attribute->end_index = link->end;
3355 pango_attr_list_insert (attrs, attribute);
3358 attribute = pango_attr_foreground_new (visited_color.red,
3359 visited_color.green,
3360 visited_color.blue);
3362 attribute = pango_attr_foreground_new (link_color.red,
3365 attribute->start_index = link->start;
3366 attribute->end_index = link->end;
3367 pango_attr_list_insert (attrs, attribute);
3370 else if (priv->markup_attrs || priv->attrs)
3371 attrs = pango_attr_list_new ();
3375 if (priv->markup_attrs)
3378 my_pango_attr_list_merge (attrs, priv->markup_attrs);
3380 attrs = pango_attr_list_ref (priv->markup_attrs);
3386 my_pango_attr_list_merge (attrs, priv->attrs);
3388 attrs = pango_attr_list_ref (priv->attrs);
3393 pango_layout_set_attributes (priv->layout, attrs);
3394 pango_attr_list_unref (attrs);
3397 switch (priv->jtype)
3399 case GTK_JUSTIFY_LEFT:
3400 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
3402 case GTK_JUSTIFY_RIGHT:
3403 align = rtl ? PANGO_ALIGN_LEFT : PANGO_ALIGN_RIGHT;
3405 case GTK_JUSTIFY_CENTER:
3406 align = PANGO_ALIGN_CENTER;
3408 case GTK_JUSTIFY_FILL:
3409 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
3410 pango_layout_set_justify (priv->layout, TRUE);
3413 g_assert_not_reached();
3416 pango_layout_set_alignment (priv->layout, align);
3417 pango_layout_set_ellipsize (priv->layout, priv->ellipsize);
3418 pango_layout_set_wrap (priv->layout, priv->wrap_mode);
3419 pango_layout_set_single_paragraph_mode (priv->layout, priv->single_line_mode);
3421 gtk_label_update_layout_width (label);
3425 static GtkSizeRequestMode
3426 gtk_label_get_request_mode (GtkWidget *widget)
3428 GtkLabel *label = GTK_LABEL (widget);
3429 gdouble angle = gtk_label_get_angle (label);
3431 if (label->priv->wrap)
3432 return (angle == 90 || angle == 270) ?
3433 GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT :
3434 GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH;
3436 return GTK_SIZE_REQUEST_CONSTANT_SIZE;
3440 get_size_for_allocation (GtkLabel *label,
3441 GtkOrientation orientation,
3446 PangoLayout *layout;
3449 layout = gtk_label_get_measuring_layout (label, NULL, allocation * PANGO_SCALE);
3451 pango_layout_get_pixel_size (layout, NULL, &text_height);
3454 *minimum_size = text_height;
3457 *natural_size = text_height;
3459 g_object_unref (layout);
3463 get_char_pixels (GtkWidget *label,
3464 PangoLayout *layout)
3466 PangoContext *context;
3467 PangoFontMetrics *metrics;
3468 gint char_width, digit_width;
3470 context = pango_layout_get_context (layout);
3471 metrics = pango_context_get_metrics (context,
3472 pango_context_get_font_description (context),
3473 pango_context_get_language (context));
3474 char_width = pango_font_metrics_get_approximate_char_width (metrics);
3475 digit_width = pango_font_metrics_get_approximate_digit_width (metrics);
3476 pango_font_metrics_unref (metrics);
3478 return MAX (char_width, digit_width);;
3482 gtk_label_get_preferred_layout_size (GtkLabel *label,
3483 PangoRectangle *smallest,
3484 PangoRectangle *widest)
3486 GtkLabelPrivate *priv = label->priv;
3487 PangoLayout *layout;
3490 /* "width-chars" Hard-coded minimum width:
3491 * - minimum size should be MAX (width-chars, strlen ("..."));
3492 * - natural size should be MAX (width-chars, strlen (priv->text));
3494 * "max-width-chars" User specified maximum size requisition
3495 * - minimum size should be MAX (width-chars, 0)
3496 * - natural size should be MIN (max-width-chars, strlen (priv->text))
3498 * For ellipsizing labels; if max-width-chars is specified: either it is used as
3499 * a minimum size or the label text as a minimum size (natural size still overflows).
3501 * For wrapping labels; A reasonable minimum size is useful to naturally layout
3502 * interfaces automatically. In this case if no "width-chars" is specified, the minimum
3503 * width will default to the wrap guess that gtk_label_ensure_layout() does.
3506 /* Start off with the pixel extents of an as-wide-as-possible layout */
3507 layout = gtk_label_get_measuring_layout (label, NULL, -1);
3509 if (priv->width_chars > -1 || priv->max_width_chars > -1)
3510 char_pixels = get_char_pixels (GTK_WIDGET (label), layout);
3514 pango_layout_get_extents (layout, NULL, widest);
3515 widest->width = MAX (widest->width, char_pixels * priv->width_chars);
3516 widest->x = widest->y = 0;
3518 if (priv->ellipsize || priv->wrap)
3520 /* a layout with width 0 will be as small as humanly possible */
3521 layout = gtk_label_get_measuring_layout (label,
3523 priv->width_chars > -1 ? char_pixels * priv->width_chars
3526 pango_layout_get_extents (layout, NULL, smallest);
3527 smallest->width = MAX (smallest->width, char_pixels * priv->width_chars);
3528 smallest->x = smallest->y = 0;
3530 if (priv->max_width_chars > -1 && widest->width > char_pixels * priv->max_width_chars)
3532 layout = gtk_label_get_measuring_layout (label,
3534 MAX (smallest->width, char_pixels * priv->max_width_chars));
3535 pango_layout_get_extents (layout, NULL, widest);
3536 widest->width = MAX (widest->width, char_pixels * priv->width_chars);
3537 widest->x = widest->y = 0;
3542 *smallest = *widest;
3545 if (widest->width < smallest->width)
3546 *smallest = *widest;
3548 g_object_unref (layout);
3552 gtk_label_get_preferred_size (GtkWidget *widget,
3553 GtkOrientation orientation,
3557 GtkLabel *label = GTK_LABEL (widget);
3558 GtkLabelPrivate *priv = label->priv;
3559 PangoRectangle widest_rect;
3560 PangoRectangle smallest_rect;
3563 gtk_label_get_preferred_layout_size (label, &smallest_rect, &widest_rect);
3565 /* Now that we have minimum and natural sizes in pango extents, apply a possible transform */
3566 if (priv->have_transform)
3568 PangoContext *context;
3569 const PangoMatrix *matrix;
3571 context = pango_layout_get_context (priv->layout);
3572 matrix = pango_context_get_matrix (context);
3574 pango_matrix_transform_rectangle (matrix, &widest_rect);
3575 pango_matrix_transform_rectangle (matrix, &smallest_rect);
3577 /* Bump the size in case of ellipsize to ensure pango has
3578 * enough space in the angles (note, we could alternatively set the
3579 * layout to not ellipsize when we know we have been allocated our
3580 * full size, or it may be that pango needs a fix here).
3582 if (priv->ellipsize && priv->angle != 0 && priv->angle != 90 &&
3583 priv->angle != 180 && priv->angle != 270 && priv->angle != 360)
3585 /* For some reason we only need this at about 110 degrees, and only
3586 * when gaining in height
3588 widest_rect.height += ROTATION_ELLIPSIZE_PADDING * 2 * PANGO_SCALE;
3589 widest_rect.width += ROTATION_ELLIPSIZE_PADDING * 2 * PANGO_SCALE;
3590 smallest_rect.height += ROTATION_ELLIPSIZE_PADDING * 2 * PANGO_SCALE;
3591 smallest_rect.width += ROTATION_ELLIPSIZE_PADDING * 2 * PANGO_SCALE;
3595 widest_rect.width = PANGO_PIXELS_CEIL (widest_rect.width);
3596 widest_rect.height = PANGO_PIXELS_CEIL (widest_rect.height);
3598 smallest_rect.width = PANGO_PIXELS_CEIL (smallest_rect.width);
3599 smallest_rect.height = PANGO_PIXELS_CEIL (smallest_rect.height);
3601 _gtk_misc_get_padding_and_border (GTK_MISC (label), &border);
3603 if (orientation == GTK_ORIENTATION_HORIZONTAL)
3605 /* Note, we cant use get_size_for_allocation() when rotating
3606 * ellipsized labels.
3608 if (!(priv->ellipsize && priv->have_transform) &&
3609 (priv->angle == 90 || priv->angle == 270))
3611 /* Doing a h4w request on a rotated label here, return the
3612 * required width for the minimum height.
3614 get_size_for_allocation (label,
3615 GTK_ORIENTATION_VERTICAL,
3616 smallest_rect.height,
3617 minimum_size, natural_size);
3622 /* Normal desired width */
3623 *minimum_size = smallest_rect.width;
3624 *natural_size = widest_rect.width;
3627 *minimum_size += border.left + border.right;
3628 *natural_size += border.left + border.right;
3630 else /* GTK_ORIENTATION_VERTICAL */
3632 /* Note, we cant use get_size_for_allocation() when rotating
3633 * ellipsized labels.
3635 if (!(priv->ellipsize && priv->have_transform) &&
3636 (priv->angle == 0 || priv->angle == 180 || priv->angle == 360))
3638 /* Doing a w4h request on a label here, return the required
3639 * height for the minimum width.
3641 get_size_for_allocation (label,
3642 GTK_ORIENTATION_HORIZONTAL,
3644 minimum_size, natural_size);
3648 /* A vertically rotated label does w4h, so return the base
3649 * desired height (text length)
3651 *minimum_size = MIN (smallest_rect.height, widest_rect.height);
3652 *natural_size = MAX (smallest_rect.height, widest_rect.height);
3655 *minimum_size += border.top + border.bottom;
3656 *natural_size += border.top + border.bottom;
3661 gtk_label_get_preferred_width (GtkWidget *widget,
3665 gtk_label_get_preferred_size (widget, GTK_ORIENTATION_HORIZONTAL, minimum_size, natural_size);
3669 gtk_label_get_preferred_height (GtkWidget *widget,
3673 gtk_label_get_preferred_size (widget, GTK_ORIENTATION_VERTICAL, minimum_size, natural_size);
3677 gtk_label_get_preferred_width_for_height (GtkWidget *widget,
3679 gint *minimum_width,
3680 gint *natural_width)
3682 GtkLabel *label = GTK_LABEL (widget);
3683 GtkLabelPrivate *priv = label->priv;
3685 if (priv->wrap && (priv->angle == 90 || priv->angle == 270))
3689 _gtk_misc_get_padding_and_border (GTK_MISC (label), &border);
3692 gtk_label_clear_layout (label);
3694 get_size_for_allocation (label, GTK_ORIENTATION_VERTICAL,
3695 MAX (1, height - border.top - border.bottom),
3696 minimum_width, natural_width);
3699 *minimum_width += border.right + border.left;
3702 *natural_width += border.right + border.left;
3705 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_width, natural_width);
3709 gtk_label_get_preferred_height_for_width (GtkWidget *widget,
3711 gint *minimum_height,
3712 gint *natural_height)
3714 GtkLabel *label = GTK_LABEL (widget);
3715 GtkLabelPrivate *priv = label->priv;
3717 if (priv->wrap && (priv->angle == 0 || priv->angle == 180 || priv->angle == 360))
3721 _gtk_misc_get_padding_and_border (GTK_MISC (label), &border);
3724 gtk_label_clear_layout (label);
3726 get_size_for_allocation (label, GTK_ORIENTATION_HORIZONTAL,
3727 MAX (1, width - border.left - border.right),
3728 minimum_height, natural_height);
3731 *minimum_height += border.top + border.bottom;
3734 *natural_height += border.top + border.bottom;
3737 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height (widget, minimum_height, natural_height);
3741 gtk_label_size_allocate (GtkWidget *widget,
3742 GtkAllocation *allocation)
3744 GtkLabel *label = GTK_LABEL (widget);
3745 GtkLabelPrivate *priv = label->priv;
3747 GTK_WIDGET_CLASS (gtk_label_parent_class)->size_allocate (widget, allocation);
3750 gtk_label_update_layout_width (label);
3752 if (priv->select_info && priv->select_info->window)
3754 gdk_window_move_resize (priv->select_info->window,
3758 allocation->height);
3763 gtk_label_update_cursor (GtkLabel *label)
3765 GtkLabelPrivate *priv = label->priv;
3768 if (!priv->select_info)
3771 widget = GTK_WIDGET (label);
3773 if (gtk_widget_get_realized (widget))
3775 GdkDisplay *display;
3778 if (gtk_widget_is_sensitive (widget))
3780 display = gtk_widget_get_display (widget);
3782 if (priv->select_info->active_link)
3783 cursor = gdk_cursor_new_for_display (display, GDK_HAND2);
3784 else if (priv->select_info->selectable)
3785 cursor = gdk_cursor_new_for_display (display, GDK_XTERM);
3792 gdk_window_set_cursor (priv->select_info->window, cursor);
3795 g_object_unref (cursor);
3800 gtk_label_state_flags_changed (GtkWidget *widget,
3801 GtkStateFlags prev_state)
3803 GtkLabel *label = GTK_LABEL (widget);
3804 GtkLabelPrivate *priv = label->priv;
3806 if (priv->select_info)
3808 if (!gtk_widget_is_sensitive (widget))
3809 gtk_label_select_region (label, 0, 0);
3811 gtk_label_update_cursor (label);
3814 if (GTK_WIDGET_CLASS (gtk_label_parent_class)->state_flags_changed)
3815 GTK_WIDGET_CLASS (gtk_label_parent_class)->state_flags_changed (widget, prev_state);
3819 get_layout_location (GtkLabel *label,
3823 GtkAllocation allocation;
3826 GtkLabelPrivate *priv;
3828 gint req_width, x, y;
3830 gfloat xalign, yalign;
3831 PangoRectangle logical;
3833 misc = GTK_MISC (label);
3834 widget = GTK_WIDGET (label);
3837 gtk_misc_get_alignment (misc, &xalign, &yalign);
3838 _gtk_misc_get_padding_and_border (GTK_MISC (label), &border);
3840 if (gtk_widget_get_direction (widget) != GTK_TEXT_DIR_LTR)
3841 xalign = 1.0 - xalign;
3843 pango_layout_get_extents (priv->layout, NULL, &logical);
3845 if (priv->have_transform)
3847 PangoContext *context = gtk_widget_get_pango_context (widget);
3848 const PangoMatrix *matrix = pango_context_get_matrix (context);
3849 pango_matrix_transform_rectangle (matrix, &logical);
3852 pango_extents_to_pixels (&logical, NULL);
3854 req_width = logical.width;
3855 req_height = logical.height;
3857 req_width += border.left + border.right;
3858 req_height += border.top + border.bottom;
3860 gtk_widget_get_allocation (widget, &allocation);
3862 x = floor (allocation.x + border.left + xalign * (allocation.width - req_width) - logical.x);
3864 /* bgo#315462 - For single-line labels, *do* align the requisition with
3865 * respect to the allocation, even if we are under-allocated. For multi-line
3866 * labels, always show the top of the text when they are under-allocated. The
3867 * rationale is this:
3869 * - Single-line labels appear in GtkButtons, and it is very easy to get them
3870 * to be smaller than their requisition. The button may clip the label, but
3871 * the label will still be able to show most of itself and the focus
3872 * rectangle. Also, it is fairly easy to read a single line of clipped text.
3874 * - Multi-line labels should not be clipped to showing "something in the
3875 * middle". You want to read the first line, at least, to get some context.
3877 if (pango_layout_get_line_count (priv->layout) == 1)
3878 y = floor (allocation.y + border.top + (allocation.height - req_height) * yalign) - logical.y;
3880 y = floor (allocation.y + border.top + MAX ((allocation.height - req_height) * yalign, 0)) - logical.y;
3889 static PangoDirection
3890 get_cursor_direction (GtkLabel *label)
3892 GtkLabelPrivate *priv = label->priv;
3895 g_assert (priv->select_info);
3897 gtk_label_ensure_layout (label);
3899 for (l = pango_layout_get_lines_readonly (priv->layout); l; l = l->next)
3901 PangoLayoutLine *line = l->data;
3903 /* If priv->select_info->selection_end is at the very end of
3904 * the line, we don't know if the cursor is on this line or
3905 * the next without looking ahead at the next line. (End
3906 * of paragraph is different from line break.) But it's
3907 * definitely in this paragraph, which is good enough
3908 * to figure out the resolved direction.
3910 if (line->start_index + line->length >= priv->select_info->selection_end)
3911 return line->resolved_dir;
3914 return PANGO_DIRECTION_LTR;
3917 static GtkLabelLink *
3918 gtk_label_get_focus_link (GtkLabel *label)
3920 GtkLabelPrivate *priv = label->priv;
3921 GtkLabelSelectionInfo *info = priv->select_info;
3927 if (info->selection_anchor != info->selection_end)
3930 for (l = info->links; l; l = l->next)
3932 GtkLabelLink *link = l->data;
3933 if (link->start <= info->selection_anchor &&
3934 info->selection_anchor <= link->end)
3942 gtk_label_draw (GtkWidget *widget,
3945 GtkLabel *label = GTK_LABEL (widget);
3946 GtkLabelPrivate *priv = label->priv;
3947 GtkLabelSelectionInfo *info = priv->select_info;
3948 GtkAllocation allocation;
3949 GtkStyleContext *context;
3950 GtkStateFlags state;
3953 gtk_label_ensure_layout (label);
3955 context = gtk_widget_get_style_context (widget);
3956 gtk_widget_get_allocation (widget, &allocation);
3958 gtk_render_background (context, cr,
3960 allocation.width, allocation.height);
3961 gtk_render_frame (context, cr,
3963 allocation.width, allocation.height);
3965 if (priv->text && (*priv->text != '\0'))
3967 get_layout_location (label, &x, &y);
3969 cairo_translate (cr, -allocation.x, -allocation.y);
3971 gtk_render_layout (context, cr,
3975 state = gtk_widget_get_state_flags (widget);
3978 (info->selection_anchor != info->selection_end))
3981 cairo_region_t *clip;
3982 GdkRGBA bg_color, fg_color;
3984 range[0] = info->selection_anchor;
3985 range[1] = info->selection_end;
3987 if (range[0] > range[1])
3989 gint tmp = range[0];
3990 range[0] = range[1];
3994 clip = gdk_pango_layout_get_clip_region (priv->layout,
3999 /* FIXME should use gtk_paint, but it can't use a clip region */
4002 gdk_cairo_region (cr, clip);
4005 state |= GTK_STATE_FLAG_SELECTED;
4007 gtk_style_context_get_color (context, state, &fg_color);
4008 gtk_style_context_get_background_color (context, state, &bg_color);
4010 gdk_cairo_set_source_rgba (cr, &bg_color);
4013 gdk_cairo_set_source_rgba (cr, &fg_color);
4014 cairo_move_to (cr, x, y);
4015 _gtk_pango_fill_layout (cr, priv->layout);
4018 cairo_region_destroy (clip);
4022 GtkLabelLink *focus_link;
4023 GtkLabelLink *active_link;
4025 cairo_region_t *clip;
4027 GdkColor *text_color;
4028 GdkColor link_color;
4029 GdkColor visited_link_color;
4031 if (info->selectable &&
4032 gtk_widget_has_focus (widget) &&
4033 gtk_widget_is_drawable (widget))
4035 PangoDirection cursor_direction;
4037 cursor_direction = get_cursor_direction (label);
4038 gtk_render_insertion_cursor (context, cr,
4040 priv->layout, priv->select_info->selection_end,
4044 focus_link = gtk_label_get_focus_link (label);
4045 active_link = info->active_link;
4051 range[0] = active_link->start;
4052 range[1] = active_link->end;
4056 clip = gdk_pango_layout_get_clip_region (priv->layout,
4060 gdk_cairo_region (cr, clip);
4062 cairo_region_destroy (clip);
4064 gtk_label_get_link_colors (widget, &link_color, &visited_link_color);
4065 if (active_link->visited)
4066 text_color = &visited_link_color;
4068 text_color = &link_color;
4070 if (info->link_clicked)
4071 state |= GTK_STATE_FLAG_ACTIVE;
4073 state |= GTK_STATE_FLAG_PRELIGHT;
4075 gtk_style_context_get_background_color (context, state, &bg_color);
4077 gdk_cairo_set_source_rgba (cr, &bg_color);
4080 cairo_set_source_rgb (cr, text_color->red / 65535.,
4081 text_color->green / 65535.,
4082 text_color->blue / 65535.);
4083 cairo_move_to (cr, x, y);
4084 _gtk_pango_fill_layout (cr, priv->layout);
4089 if (focus_link && gtk_widget_has_visible_focus (widget))
4091 range[0] = focus_link->start;
4092 range[1] = focus_link->end;
4094 clip = gdk_pango_layout_get_clip_region (priv->layout,
4098 cairo_region_get_extents (clip, &rect);
4100 gtk_render_focus (context, cr,
4102 rect.width, rect.height);
4104 cairo_region_destroy (clip);
4113 separate_uline_pattern (const gchar *str,
4118 gboolean underscore;
4121 gchar *pattern_dest;
4123 *accel_key = GDK_KEY_VoidSymbol;
4124 *new_str = g_new (gchar, strlen (str) + 1);
4125 *pattern = g_new (gchar, g_utf8_strlen (str, -1) + 1);
4131 pattern_dest = *pattern;
4136 const gchar *next_src;
4138 c = g_utf8_get_char (src);
4139 if (c == (gunichar)-1)
4141 g_warning ("Invalid input string");
4147 next_src = g_utf8_next_char (src);
4152 *pattern_dest++ = ' ';
4155 *pattern_dest++ = '_';
4156 if (*accel_key == GDK_KEY_VoidSymbol)
4157 *accel_key = gdk_keyval_to_lower (gdk_unicode_to_keyval (c));
4160 while (src < next_src)
4174 while (src < next_src)
4177 *pattern_dest++ = ' ';
4189 gtk_label_set_uline_text_internal (GtkLabel *label,
4192 GtkLabelPrivate *priv = label->priv;
4193 guint accel_key = GDK_KEY_VoidSymbol;
4197 g_return_if_fail (GTK_IS_LABEL (label));
4198 g_return_if_fail (str != NULL);
4200 /* Split text into the base text and a separate pattern
4203 if (!separate_uline_pattern (str, &accel_key, &new_str, &pattern))
4206 gtk_label_set_text_internal (label, new_str);
4207 gtk_label_set_pattern_internal (label, pattern, TRUE);
4208 priv->mnemonic_keyval = accel_key;
4214 * gtk_label_set_text_with_mnemonic:
4215 * @label: a #GtkLabel
4218 * Sets the label's text from the string @str.
4219 * If characters in @str are preceded by an underscore, they are underlined
4220 * indicating that they represent a keyboard accelerator called a mnemonic.
4221 * The mnemonic key can be used to activate another widget, chosen
4222 * automatically, or explicitly using gtk_label_set_mnemonic_widget().
4225 gtk_label_set_text_with_mnemonic (GtkLabel *label,
4228 g_return_if_fail (GTK_IS_LABEL (label));
4229 g_return_if_fail (str != NULL);
4231 g_object_freeze_notify (G_OBJECT (label));
4233 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
4234 gtk_label_set_use_markup_internal (label, FALSE);
4235 gtk_label_set_use_underline_internal (label, TRUE);
4237 gtk_label_recalculate (label);
4239 g_object_thaw_notify (G_OBJECT (label));
4243 gtk_label_realize (GtkWidget *widget)
4245 GtkLabel *label = GTK_LABEL (widget);
4246 GtkLabelPrivate *priv = label->priv;
4248 GTK_WIDGET_CLASS (gtk_label_parent_class)->realize (widget);
4250 if (priv->select_info)
4251 gtk_label_create_window (label);
4255 gtk_label_unrealize (GtkWidget *widget)
4257 GtkLabel *label = GTK_LABEL (widget);
4258 GtkLabelPrivate *priv = label->priv;
4260 if (priv->select_info)
4261 gtk_label_destroy_window (label);
4263 GTK_WIDGET_CLASS (gtk_label_parent_class)->unrealize (widget);
4267 gtk_label_map (GtkWidget *widget)
4269 GtkLabel *label = GTK_LABEL (widget);
4270 GtkLabelPrivate *priv = label->priv;
4272 GTK_WIDGET_CLASS (gtk_label_parent_class)->map (widget);
4274 if (priv->select_info)
4275 gdk_window_show (priv->select_info->window);
4279 gtk_label_unmap (GtkWidget *widget)
4281 GtkLabel *label = GTK_LABEL (widget);
4282 GtkLabelPrivate *priv = label->priv;
4284 if (priv->select_info)
4285 gdk_window_hide (priv->select_info->window);
4287 GTK_WIDGET_CLASS (gtk_label_parent_class)->unmap (widget);
4291 window_to_layout_coords (GtkLabel *label,
4295 GtkAllocation allocation;
4299 widget = GTK_WIDGET (label);
4301 /* get layout location in widget->window coords */
4302 get_layout_location (label, &lx, &ly);
4304 gtk_widget_get_allocation (widget, &allocation);
4308 *x += allocation.x; /* go to widget->window */
4309 *x -= lx; /* go to layout */
4314 *y += allocation.y; /* go to widget->window */
4315 *y -= ly; /* go to layout */
4321 layout_to_window_coords (GtkLabel *label,
4328 widget = GTK_WIDGET (label);
4330 /* get layout location in widget->window coords */
4331 get_layout_location (label, &lx, &ly);
4335 *x += lx; /* go to widget->window */
4336 *x -= widget->allocation.x; /* go to selection window */
4341 *y += ly; /* go to widget->window */
4342 *y -= widget->allocation.y; /* go to selection window */
4348 get_layout_index (GtkLabel *label,
4353 GtkLabelPrivate *priv = label->priv;
4355 const gchar *cluster;
4356 const gchar *cluster_end;
4361 gtk_label_ensure_layout (label);
4363 window_to_layout_coords (label, &x, &y);
4368 inside = pango_layout_xy_to_index (priv->layout,
4372 cluster = priv->text + *index;
4373 cluster_end = cluster;
4376 cluster_end = g_utf8_next_char (cluster_end);
4380 *index += (cluster_end - cluster);
4386 gtk_label_select_word (GtkLabel *label)
4388 GtkLabelPrivate *priv = label->priv;
4391 gint start_index = gtk_label_move_backward_word (label, priv->select_info->selection_end);
4392 gint end_index = gtk_label_move_forward_word (label, priv->select_info->selection_end);
4394 min = MIN (priv->select_info->selection_anchor,
4395 priv->select_info->selection_end);
4396 max = MAX (priv->select_info->selection_anchor,
4397 priv->select_info->selection_end);
4399 min = MIN (min, start_index);
4400 max = MAX (max, end_index);
4402 gtk_label_select_region_index (label, min, max);
4406 gtk_label_grab_focus (GtkWidget *widget)
4408 GtkLabel *label = GTK_LABEL (widget);
4409 GtkLabelPrivate *priv = label->priv;
4410 gboolean select_on_focus;
4413 if (priv->select_info == NULL)
4416 GTK_WIDGET_CLASS (gtk_label_parent_class)->grab_focus (widget);
4418 if (priv->select_info->selectable)
4420 g_object_get (gtk_widget_get_settings (widget),
4421 "gtk-label-select-on-focus",
4425 if (select_on_focus && !priv->in_click)
4426 gtk_label_select_region (label, 0, -1);
4430 if (priv->select_info->links && !priv->in_click)
4432 link = priv->select_info->links->data;
4433 priv->select_info->selection_anchor = link->start;
4434 priv->select_info->selection_end = link->start;
4440 gtk_label_focus (GtkWidget *widget,
4441 GtkDirectionType direction)
4443 GtkLabel *label = GTK_LABEL (widget);
4444 GtkLabelPrivate *priv = label->priv;
4445 GtkLabelSelectionInfo *info = priv->select_info;
4446 GtkLabelLink *focus_link;
4449 if (!gtk_widget_is_focus (widget))
4451 gtk_widget_grab_focus (widget);
4454 focus_link = gtk_label_get_focus_link (label);
4455 if (focus_link && direction == GTK_DIR_TAB_BACKWARD)
4457 l = g_list_last (info->links);
4458 focus_link = l->data;
4459 info->selection_anchor = focus_link->start;
4460 info->selection_end = focus_link->start;
4470 if (info->selectable)
4474 if (info->selection_anchor != info->selection_end)
4477 index = info->selection_anchor;
4479 if (direction == GTK_DIR_TAB_FORWARD)
4480 for (l = info->links; l; l = l->next)
4482 GtkLabelLink *link = l->data;
4484 if (link->start > index)
4486 gtk_label_select_region_index (label, link->start, link->start);
4490 else if (direction == GTK_DIR_TAB_BACKWARD)
4491 for (l = g_list_last (info->links); l; l = l->prev)
4493 GtkLabelLink *link = l->data;
4495 if (link->end < index)
4497 gtk_label_select_region_index (label, link->start, link->start);
4506 focus_link = gtk_label_get_focus_link (label);
4509 case GTK_DIR_TAB_FORWARD:
4512 l = g_list_find (info->links, focus_link);
4519 case GTK_DIR_TAB_BACKWARD:
4522 l = g_list_find (info->links, focus_link);
4526 l = g_list_last (info->links);
4535 focus_link = l->data;
4536 info->selection_anchor = focus_link->start;
4537 info->selection_end = focus_link->start;
4538 gtk_widget_queue_draw (widget);
4550 gtk_label_button_press (GtkWidget *widget,
4551 GdkEventButton *event)
4553 GtkLabel *label = GTK_LABEL (widget);
4554 GtkLabelPrivate *priv = label->priv;
4555 GtkLabelSelectionInfo *info = priv->select_info;
4562 if (info->active_link)
4564 if (gdk_event_triggers_context_menu ((GdkEvent *) event))
4566 info->link_clicked = 1;
4567 gtk_label_do_popup (label, event);
4570 else if (event->button == GDK_BUTTON_PRIMARY)
4572 info->link_clicked = 1;
4573 gtk_widget_queue_draw (widget);
4577 if (!info->selectable)
4580 info->in_drag = FALSE;
4581 info->select_words = FALSE;
4583 if (gdk_event_triggers_context_menu ((GdkEvent *) event))
4585 gtk_label_do_popup (label, event);
4589 else if (event->button == GDK_BUTTON_PRIMARY)
4591 if (!gtk_widget_has_focus (widget))
4593 priv->in_click = TRUE;
4594 gtk_widget_grab_focus (widget);
4595 priv->in_click = FALSE;
4598 if (event->type == GDK_3BUTTON_PRESS)
4600 gtk_label_select_region_index (label, 0, strlen (priv->text));
4604 if (event->type == GDK_2BUTTON_PRESS)
4606 info->select_words = TRUE;
4607 gtk_label_select_word (label);
4611 get_layout_index (label, event->x, event->y, &index);
4613 min = MIN (info->selection_anchor, info->selection_end);
4614 max = MAX (info->selection_anchor, info->selection_end);
4616 if ((info->selection_anchor != info->selection_end) &&
4617 (event->state & GDK_SHIFT_MASK))
4619 if (index > min && index < max)
4621 /* truncate selection, but keep it as big as possible */
4622 if (index - min > max - index)
4629 /* extend (same as motion) */
4630 min = MIN (min, index);
4631 max = MAX (max, index);
4634 /* ensure the anchor is opposite index */
4642 gtk_label_select_region_index (label, min, max);
4646 if (event->type == GDK_3BUTTON_PRESS)
4647 gtk_label_select_region_index (label, 0, strlen (priv->text));
4648 else if (event->type == GDK_2BUTTON_PRESS)
4649 gtk_label_select_word (label);
4650 else if (min < max && min <= index && index <= max)
4652 info->in_drag = TRUE;
4653 info->drag_start_x = event->x;
4654 info->drag_start_y = event->y;
4657 /* start a replacement */
4658 gtk_label_select_region_index (label, index, index);
4668 gtk_label_button_release (GtkWidget *widget,
4669 GdkEventButton *event)
4672 GtkLabel *label = GTK_LABEL (widget);
4673 GtkLabelPrivate *priv = label->priv;
4674 GtkLabelSelectionInfo *info = priv->select_info;
4684 get_layout_index (label, event->x, event->y, &index);
4685 gtk_label_select_region_index (label, index, index);
4690 if (event->button != GDK_BUTTON_PRIMARY)
4693 if (info->active_link &&
4694 info->selection_anchor == info->selection_end &&
4697 emit_activate_link (label, info->active_link);
4698 info->link_clicked = 0;
4703 /* The goal here is to return TRUE iff we ate the
4704 * button press to start selecting.
4710 connect_mnemonics_visible_notify (GtkLabel *label)
4712 GtkLabelPrivate *priv = label->priv;
4713 GtkWidget *toplevel;
4716 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (label));
4718 if (!GTK_IS_WINDOW (toplevel))
4721 /* always set up this widgets initial value */
4722 priv->mnemonics_visible =
4723 gtk_window_get_mnemonics_visible (GTK_WINDOW (toplevel));
4726 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (toplevel),
4727 "gtk-label-mnemonics-visible-connected"));
4731 g_signal_connect (toplevel,
4732 "notify::mnemonics-visible",
4733 G_CALLBACK (label_mnemonics_visible_changed),
4735 g_object_set_data (G_OBJECT (toplevel),
4736 "gtk-label-mnemonics-visible-connected",
4737 GINT_TO_POINTER (1));
4742 drag_begin_cb (GtkWidget *widget,
4743 GdkDragContext *context,
4746 GtkLabel *label = GTK_LABEL (widget);
4747 GtkLabelPrivate *priv = label->priv;
4748 cairo_surface_t *surface = NULL;
4750 g_signal_handlers_disconnect_by_func (widget, drag_begin_cb, NULL);
4752 if ((priv->select_info->selection_anchor !=
4753 priv->select_info->selection_end) &&
4759 start = MIN (priv->select_info->selection_anchor,
4760 priv->select_info->selection_end);
4761 end = MAX (priv->select_info->selection_anchor,
4762 priv->select_info->selection_end);
4764 len = strlen (priv->text);
4772 surface = _gtk_text_util_create_drag_icon (widget,
4779 gtk_drag_set_icon_surface (context, surface);
4780 cairo_surface_destroy (surface);
4784 gtk_drag_set_icon_default (context);
4789 gtk_label_motion (GtkWidget *widget,
4790 GdkEventMotion *event)
4792 GtkLabel *label = GTK_LABEL (widget);
4793 GtkLabelPrivate *priv = label->priv;
4794 GtkLabelSelectionInfo *info = priv->select_info;
4800 if (info->links && !info->in_drag)
4804 gboolean found = FALSE;
4806 if (info->selection_anchor == info->selection_end)
4808 if (get_layout_index (label, event->x, event->y, &index))
4810 for (l = info->links; l != NULL; l = l->next)
4813 if (index >= link->start && index <= link->end)
4824 if (info->active_link != link)
4826 info->link_clicked = 0;
4827 info->active_link = link;
4828 gtk_label_update_cursor (label);
4829 gtk_widget_queue_draw (widget);
4834 if (info->active_link != NULL)
4836 info->link_clicked = 0;
4837 info->active_link = NULL;
4838 gtk_label_update_cursor (label);
4839 gtk_widget_queue_draw (widget);
4844 if (!info->selectable)
4847 if ((event->state & GDK_BUTTON1_MASK) == 0)
4852 if (gtk_drag_check_threshold (widget,
4855 event->x, event->y))
4857 GtkTargetList *target_list = gtk_target_list_new (NULL, 0);
4859 gtk_target_list_add_text_targets (target_list, 0);
4861 g_signal_connect (widget, "drag-begin",
4862 G_CALLBACK (drag_begin_cb), NULL);
4863 gtk_drag_begin (widget, target_list,
4865 1, (GdkEvent *)event);
4867 info->in_drag = FALSE;
4869 gtk_target_list_unref (target_list);
4876 gdk_window_get_device_position (info->window, event->device, &x, &y, NULL);
4877 get_layout_index (label, x, y, &index);
4879 if (info->select_words)
4882 gint old_min, old_max;
4885 min = gtk_label_move_backward_word (label, index);
4886 max = gtk_label_move_forward_word (label, index);
4888 anchor = info->selection_anchor;
4889 end = info->selection_end;
4891 old_min = MIN (anchor, end);
4892 old_max = MAX (anchor, end);
4899 else if (old_max < max)
4904 else if (anchor == old_min)
4915 gtk_label_select_region_index (label, anchor, end);
4918 gtk_label_select_region_index (label, info->selection_anchor, index);
4925 gtk_label_leave_notify (GtkWidget *widget,
4926 GdkEventCrossing *event)
4928 GtkLabel *label = GTK_LABEL (widget);
4929 GtkLabelPrivate *priv = label->priv;
4931 if (priv->select_info)
4933 priv->select_info->active_link = NULL;
4934 gtk_label_update_cursor (label);
4935 gtk_widget_queue_draw (widget);
4938 if (GTK_WIDGET_CLASS (gtk_label_parent_class)->leave_notify_event)
4939 return GTK_WIDGET_CLASS (gtk_label_parent_class)->leave_notify_event (widget, event);
4945 gtk_label_create_window (GtkLabel *label)
4947 GtkLabelPrivate *priv = label->priv;
4948 GtkAllocation allocation;
4950 GdkWindowAttr attributes;
4951 gint attributes_mask;
4953 g_assert (priv->select_info);
4954 widget = GTK_WIDGET (label);
4955 g_assert (gtk_widget_get_realized (widget));
4957 if (priv->select_info->window)
4960 gtk_widget_get_allocation (widget, &allocation);
4962 attributes.x = allocation.x;
4963 attributes.y = allocation.y;
4964 attributes.width = allocation.width;
4965 attributes.height = allocation.height;
4966 attributes.window_type = GDK_WINDOW_CHILD;
4967 attributes.wclass = GDK_INPUT_ONLY;
4968 attributes.override_redirect = TRUE;
4969 attributes.event_mask = gtk_widget_get_events (widget) |
4970 GDK_BUTTON_PRESS_MASK |
4971 GDK_BUTTON_RELEASE_MASK |
4972 GDK_LEAVE_NOTIFY_MASK |
4973 GDK_BUTTON_MOTION_MASK |
4974 GDK_POINTER_MOTION_MASK |
4975 GDK_POINTER_MOTION_HINT_MASK;
4976 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
4977 if (gtk_widget_is_sensitive (widget))
4979 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
4981 attributes_mask |= GDK_WA_CURSOR;
4985 priv->select_info->window = gdk_window_new (gtk_widget_get_window (widget),
4986 &attributes, attributes_mask);
4987 gtk_widget_register_window (widget, priv->select_info->window);
4989 if (attributes_mask & GDK_WA_CURSOR)
4990 g_object_unref (attributes.cursor);
4994 gtk_label_destroy_window (GtkLabel *label)
4996 GtkLabelPrivate *priv = label->priv;
4998 g_assert (priv->select_info);
5000 if (priv->select_info->window == NULL)
5003 gtk_widget_unregister_window (GTK_WIDGET (label), priv->select_info->window);
5004 gdk_window_destroy (priv->select_info->window);
5005 priv->select_info->window = NULL;
5009 gtk_label_ensure_select_info (GtkLabel *label)
5011 GtkLabelPrivate *priv = label->priv;
5013 if (priv->select_info == NULL)
5015 priv->select_info = g_new0 (GtkLabelSelectionInfo, 1);
5017 gtk_widget_set_can_focus (GTK_WIDGET (label), TRUE);
5019 if (gtk_widget_get_realized (GTK_WIDGET (label)))
5020 gtk_label_create_window (label);
5022 if (gtk_widget_get_mapped (GTK_WIDGET (label)))
5023 gdk_window_show (priv->select_info->window);
5028 gtk_label_clear_select_info (GtkLabel *label)
5030 GtkLabelPrivate *priv = label->priv;
5032 if (priv->select_info == NULL)
5035 if (!priv->select_info->selectable && !priv->select_info->links)
5037 gtk_label_destroy_window (label);
5039 g_free (priv->select_info);
5040 priv->select_info = NULL;
5042 gtk_widget_set_can_focus (GTK_WIDGET (label), FALSE);
5047 * gtk_label_set_selectable:
5048 * @label: a #GtkLabel
5049 * @setting: %TRUE to allow selecting text in the label
5051 * Selectable labels allow the user to select text from the label, for
5055 gtk_label_set_selectable (GtkLabel *label,
5058 GtkLabelPrivate *priv;
5059 gboolean old_setting;
5061 g_return_if_fail (GTK_IS_LABEL (label));
5065 setting = setting != FALSE;
5066 old_setting = priv->select_info && priv->select_info->selectable;
5070 gtk_label_ensure_select_info (label);
5071 priv->select_info->selectable = TRUE;
5072 gtk_label_update_cursor (label);
5078 /* unselect, to give up the selection */
5079 gtk_label_select_region (label, 0, 0);
5081 priv->select_info->selectable = FALSE;
5082 gtk_label_clear_select_info (label);
5083 gtk_label_update_cursor (label);
5086 if (setting != old_setting)
5088 g_object_freeze_notify (G_OBJECT (label));
5089 g_object_notify (G_OBJECT (label), "selectable");
5090 g_object_notify (G_OBJECT (label), "cursor-position");
5091 g_object_notify (G_OBJECT (label), "selection-bound");
5092 g_object_thaw_notify (G_OBJECT (label));
5093 gtk_widget_queue_draw (GTK_WIDGET (label));
5098 * gtk_label_get_selectable:
5099 * @label: a #GtkLabel
5101 * Gets the value set by gtk_label_set_selectable().
5103 * Return value: %TRUE if the user can copy text from the label
5106 gtk_label_get_selectable (GtkLabel *label)
5108 GtkLabelPrivate *priv;
5110 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
5114 return priv->select_info && priv->select_info->selectable;
5118 * gtk_label_set_angle:
5119 * @label: a #GtkLabel
5120 * @angle: the angle that the baseline of the label makes with
5121 * the horizontal, in degrees, measured counterclockwise
5123 * Sets the angle of rotation for the label. An angle of 90 reads from
5124 * from bottom to top, an angle of 270, from top to bottom. The angle
5125 * setting for the label is ignored if the label is selectable,
5126 * wrapped, or ellipsized.
5131 gtk_label_set_angle (GtkLabel *label,
5134 GtkLabelPrivate *priv;
5136 g_return_if_fail (GTK_IS_LABEL (label));
5140 /* Canonicalize to [0,360]. We don't canonicalize 360 to 0, because
5141 * double property ranges are inclusive, and changing 360 to 0 would
5142 * make a property editor behave strangely.
5144 if (angle < 0 || angle > 360.0)
5145 angle = angle - 360. * floor (angle / 360.);
5147 if (priv->angle != angle)
5149 priv->angle = angle;
5151 gtk_label_clear_layout (label);
5152 gtk_widget_queue_resize (GTK_WIDGET (label));
5154 g_object_notify (G_OBJECT (label), "angle");
5159 * gtk_label_get_angle:
5160 * @label: a #GtkLabel
5162 * Gets the angle of rotation for the label. See
5163 * gtk_label_set_angle().
5165 * Return value: the angle of rotation for the label
5170 gtk_label_get_angle (GtkLabel *label)
5172 g_return_val_if_fail (GTK_IS_LABEL (label), 0.0);
5174 return label->priv->angle;
5178 gtk_label_set_selection_text (GtkLabel *label,
5179 GtkSelectionData *selection_data)
5181 GtkLabelPrivate *priv = label->priv;
5183 if (priv->select_info &&
5184 (priv->select_info->selection_anchor !=
5185 priv->select_info->selection_end) &&
5191 start = MIN (priv->select_info->selection_anchor,
5192 priv->select_info->selection_end);
5193 end = MAX (priv->select_info->selection_anchor,
5194 priv->select_info->selection_end);
5196 len = strlen (priv->text);
5204 gtk_selection_data_set_text (selection_data,
5211 gtk_label_drag_data_get (GtkWidget *widget,
5212 GdkDragContext *context,
5213 GtkSelectionData *selection_data,
5217 gtk_label_set_selection_text (GTK_LABEL (widget), selection_data);
5221 get_text_callback (GtkClipboard *clipboard,
5222 GtkSelectionData *selection_data,
5224 gpointer user_data_or_owner)
5226 gtk_label_set_selection_text (GTK_LABEL (user_data_or_owner), selection_data);
5230 clear_text_callback (GtkClipboard *clipboard,
5231 gpointer user_data_or_owner)
5234 GtkLabelPrivate *priv;
5236 label = GTK_LABEL (user_data_or_owner);
5239 if (priv->select_info)
5241 priv->select_info->selection_anchor = priv->select_info->selection_end;
5243 gtk_widget_queue_draw (GTK_WIDGET (label));
5248 gtk_label_select_region_index (GtkLabel *label,
5252 GtkLabelPrivate *priv;
5254 g_return_if_fail (GTK_IS_LABEL (label));
5258 if (priv->select_info && priv->select_info->selectable)
5260 GtkClipboard *clipboard;
5262 if (priv->select_info->selection_anchor == anchor_index &&
5263 priv->select_info->selection_end == end_index)
5266 g_object_freeze_notify (G_OBJECT (label));
5268 if (priv->select_info->selection_anchor != anchor_index)
5269 g_object_notify (G_OBJECT (label), "selection-bound");
5270 if (priv->select_info->selection_end != end_index)
5271 g_object_notify (G_OBJECT (label), "cursor-position");
5273 priv->select_info->selection_anchor = anchor_index;
5274 priv->select_info->selection_end = end_index;
5276 if (gtk_widget_has_screen (GTK_WIDGET (label)))
5277 clipboard = gtk_widget_get_clipboard (GTK_WIDGET (label),
5278 GDK_SELECTION_PRIMARY);
5282 if (anchor_index != end_index)
5284 GtkTargetList *list;
5285 GtkTargetEntry *targets;
5288 list = gtk_target_list_new (NULL, 0);
5289 gtk_target_list_add_text_targets (list, 0);
5290 targets = gtk_target_table_new_from_list (list, &n_targets);
5293 gtk_clipboard_set_with_owner (clipboard,
5296 clear_text_callback,
5299 gtk_target_table_free (targets, n_targets);
5300 gtk_target_list_unref (list);
5305 gtk_clipboard_get_owner (clipboard) == G_OBJECT (label))
5306 gtk_clipboard_clear (clipboard);
5309 gtk_widget_queue_draw (GTK_WIDGET (label));
5311 g_object_thaw_notify (G_OBJECT (label));
5316 * gtk_label_select_region:
5317 * @label: a #GtkLabel
5318 * @start_offset: start offset (in characters not bytes)
5319 * @end_offset: end offset (in characters not bytes)
5321 * Selects a range of characters in the label, if the label is selectable.
5322 * See gtk_label_set_selectable(). If the label is not selectable,
5323 * this function has no effect. If @start_offset or
5324 * @end_offset are -1, then the end of the label will be substituted.
5327 gtk_label_select_region (GtkLabel *label,
5331 GtkLabelPrivate *priv;
5333 g_return_if_fail (GTK_IS_LABEL (label));
5337 if (priv->text && priv->select_info)
5339 if (start_offset < 0)
5340 start_offset = g_utf8_strlen (priv->text, -1);
5343 end_offset = g_utf8_strlen (priv->text, -1);
5345 gtk_label_select_region_index (label,
5346 g_utf8_offset_to_pointer (priv->text, start_offset) - priv->text,
5347 g_utf8_offset_to_pointer (priv->text, end_offset) - priv->text);
5352 * gtk_label_get_selection_bounds:
5353 * @label: a #GtkLabel
5354 * @start: (out): return location for start of selection, as a character offset
5355 * @end: (out): return location for end of selection, as a character offset
5357 * Gets the selected range of characters in the label, returning %TRUE
5358 * if there's a selection.
5360 * Return value: %TRUE if selection is non-empty
5363 gtk_label_get_selection_bounds (GtkLabel *label,
5367 GtkLabelPrivate *priv;
5369 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
5373 if (priv->select_info == NULL)
5375 /* not a selectable label */
5385 gint start_index, end_index;
5386 gint start_offset, end_offset;
5389 start_index = MIN (priv->select_info->selection_anchor,
5390 priv->select_info->selection_end);
5391 end_index = MAX (priv->select_info->selection_anchor,
5392 priv->select_info->selection_end);
5394 len = strlen (priv->text);
5396 if (end_index > len)
5399 if (start_index > len)
5402 start_offset = g_utf8_strlen (priv->text, start_index);
5403 end_offset = g_utf8_strlen (priv->text, end_index);
5405 if (start_offset > end_offset)
5407 gint tmp = start_offset;
5408 start_offset = end_offset;
5413 *start = start_offset;
5418 return start_offset != end_offset;
5424 * gtk_label_get_layout:
5425 * @label: a #GtkLabel
5427 * Gets the #PangoLayout used to display the label.
5428 * The layout is useful to e.g. convert text positions to
5429 * pixel positions, in combination with gtk_label_get_layout_offsets().
5430 * The returned layout is owned by the @label so need not be
5431 * freed by the caller. The @label is free to recreate its layout at
5432 * any time, so it should be considered read-only.
5434 * Return value: (transfer none): the #PangoLayout for this label
5437 gtk_label_get_layout (GtkLabel *label)
5439 GtkLabelPrivate *priv;
5441 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
5445 gtk_label_ensure_layout (label);
5447 return priv->layout;
5451 * gtk_label_get_layout_offsets:
5452 * @label: a #GtkLabel
5453 * @x: (out) (allow-none): location to store X offset of layout, or %NULL
5454 * @y: (out) (allow-none): location to store Y offset of layout, or %NULL
5456 * Obtains the coordinates where the label will draw the #PangoLayout
5457 * representing the text in the label; useful to convert mouse events
5458 * into coordinates inside the #PangoLayout, e.g. to take some action
5459 * if some part of the label is clicked. Of course you will need to
5460 * create a #GtkEventBox to receive the events, and pack the label
5461 * inside it, since labels are a #GTK_NO_WINDOW widget. Remember
5462 * when using the #PangoLayout functions you need to convert to
5463 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
5466 gtk_label_get_layout_offsets (GtkLabel *label,
5470 g_return_if_fail (GTK_IS_LABEL (label));
5472 gtk_label_ensure_layout (label);
5474 get_layout_location (label, x, y);
5478 * gtk_label_set_use_markup:
5479 * @label: a #GtkLabel
5480 * @setting: %TRUE if the label's text should be parsed for markup.
5482 * Sets whether the text of the label contains markup in <link
5483 * linkend="PangoMarkupFormat">Pango's text markup
5484 * language</link>. See gtk_label_set_markup().
5487 gtk_label_set_use_markup (GtkLabel *label,
5490 g_return_if_fail (GTK_IS_LABEL (label));
5492 g_object_freeze_notify (G_OBJECT (label));
5494 gtk_label_set_use_markup_internal (label, setting);
5495 gtk_label_recalculate (label);
5497 g_object_thaw_notify (G_OBJECT (label));
5501 * gtk_label_get_use_markup:
5502 * @label: a #GtkLabel
5504 * Returns whether the label's text is interpreted as marked up with
5505 * the <link linkend="PangoMarkupFormat">Pango text markup
5506 * language</link>. See gtk_label_set_use_markup ().
5508 * Return value: %TRUE if the label's text will be parsed for markup.
5511 gtk_label_get_use_markup (GtkLabel *label)
5513 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
5515 return label->priv->use_markup;
5519 * gtk_label_set_use_underline:
5520 * @label: a #GtkLabel
5521 * @setting: %TRUE if underlines in the text indicate mnemonics
5523 * If true, an underline in the text indicates the next character should be
5524 * used for the mnemonic accelerator key.
5527 gtk_label_set_use_underline (GtkLabel *label,
5530 g_return_if_fail (GTK_IS_LABEL (label));
5532 g_object_freeze_notify (G_OBJECT (label));
5534 gtk_label_set_use_underline_internal (label, setting);
5535 gtk_label_recalculate (label);
5537 g_object_thaw_notify (G_OBJECT (label));
5541 * gtk_label_get_use_underline:
5542 * @label: a #GtkLabel
5544 * Returns whether an embedded underline in the label indicates a
5545 * mnemonic. See gtk_label_set_use_underline().
5547 * Return value: %TRUE whether an embedded underline in the label indicates
5548 * the mnemonic accelerator keys.
5551 gtk_label_get_use_underline (GtkLabel *label)
5553 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
5555 return label->priv->use_underline;
5559 * gtk_label_set_single_line_mode:
5560 * @label: a #GtkLabel
5561 * @single_line_mode: %TRUE if the label should be in single line mode
5563 * Sets whether the label is in single line mode.
5568 gtk_label_set_single_line_mode (GtkLabel *label,
5569 gboolean single_line_mode)
5571 GtkLabelPrivate *priv;
5573 g_return_if_fail (GTK_IS_LABEL (label));
5577 single_line_mode = single_line_mode != FALSE;
5579 if (priv->single_line_mode != single_line_mode)
5581 priv->single_line_mode = single_line_mode;
5583 gtk_label_clear_layout (label);
5584 gtk_widget_queue_resize (GTK_WIDGET (label));
5586 g_object_notify (G_OBJECT (label), "single-line-mode");
5591 * gtk_label_get_single_line_mode:
5592 * @label: a #GtkLabel
5594 * Returns whether the label is in single line mode.
5596 * Return value: %TRUE when the label is in single line mode.
5601 gtk_label_get_single_line_mode (GtkLabel *label)
5603 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
5605 return label->priv->single_line_mode;
5608 /* Compute the X position for an offset that corresponds to the "more important
5609 * cursor position for that offset. We use this when trying to guess to which
5610 * end of the selection we should go to when the user hits the left or
5614 get_better_cursor (GtkLabel *label,
5619 GtkLabelPrivate *priv = label->priv;
5620 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
5621 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
5622 PangoDirection cursor_direction = get_cursor_direction (label);
5623 gboolean split_cursor;
5624 PangoRectangle strong_pos, weak_pos;
5626 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
5627 "gtk-split-cursor", &split_cursor,
5630 gtk_label_ensure_layout (label);
5632 pango_layout_get_cursor_pos (priv->layout, index,
5633 &strong_pos, &weak_pos);
5637 *x = strong_pos.x / PANGO_SCALE;
5638 *y = strong_pos.y / PANGO_SCALE;
5642 if (keymap_direction == cursor_direction)
5644 *x = strong_pos.x / PANGO_SCALE;
5645 *y = strong_pos.y / PANGO_SCALE;
5649 *x = weak_pos.x / PANGO_SCALE;
5650 *y = weak_pos.y / PANGO_SCALE;
5657 gtk_label_move_logically (GtkLabel *label,
5661 GtkLabelPrivate *priv = label->priv;
5662 gint offset = g_utf8_pointer_to_offset (priv->text,
5663 priv->text + start);
5667 PangoLogAttr *log_attrs;
5671 gtk_label_ensure_layout (label);
5673 length = g_utf8_strlen (priv->text, -1);
5675 pango_layout_get_log_attrs (priv->layout, &log_attrs, &n_attrs);
5677 while (count > 0 && offset < length)
5681 while (offset < length && !log_attrs[offset].is_cursor_position);
5685 while (count < 0 && offset > 0)
5689 while (offset > 0 && !log_attrs[offset].is_cursor_position);
5697 return g_utf8_offset_to_pointer (priv->text, offset) - priv->text;
5701 gtk_label_move_visually (GtkLabel *label,
5705 GtkLabelPrivate *priv = label->priv;
5712 int new_index, new_trailing;
5713 gboolean split_cursor;
5716 gtk_label_ensure_layout (label);
5718 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
5719 "gtk-split-cursor", &split_cursor,
5726 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
5727 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
5729 strong = keymap_direction == get_cursor_direction (label);
5734 pango_layout_move_cursor_visually (priv->layout, strong, index, 0, 1, &new_index, &new_trailing);
5739 pango_layout_move_cursor_visually (priv->layout, strong, index, 0, -1, &new_index, &new_trailing);
5743 if (new_index < 0 || new_index == G_MAXINT)
5748 while (new_trailing--)
5749 index = g_utf8_next_char (priv->text + new_index) - priv->text;
5756 gtk_label_move_forward_word (GtkLabel *label,
5759 GtkLabelPrivate *priv = label->priv;
5760 gint new_pos = g_utf8_pointer_to_offset (priv->text,
5761 priv->text + start);
5764 length = g_utf8_strlen (priv->text, -1);
5765 if (new_pos < length)
5767 PangoLogAttr *log_attrs;
5770 gtk_label_ensure_layout (label);
5772 pango_layout_get_log_attrs (priv->layout, &log_attrs, &n_attrs);
5774 /* Find the next word end */
5776 while (new_pos < n_attrs && !log_attrs[new_pos].is_word_end)
5782 return g_utf8_offset_to_pointer (priv->text, new_pos) - priv->text;
5787 gtk_label_move_backward_word (GtkLabel *label,
5790 GtkLabelPrivate *priv = label->priv;
5791 gint new_pos = g_utf8_pointer_to_offset (priv->text,
5792 priv->text + start);
5796 PangoLogAttr *log_attrs;
5799 gtk_label_ensure_layout (label);
5801 pango_layout_get_log_attrs (priv->layout, &log_attrs, &n_attrs);
5805 /* Find the previous word beginning */
5806 while (new_pos > 0 && !log_attrs[new_pos].is_word_start)
5812 return g_utf8_offset_to_pointer (priv->text, new_pos) - priv->text;
5816 gtk_label_move_cursor (GtkLabel *label,
5817 GtkMovementStep step,
5819 gboolean extend_selection)
5821 GtkLabelPrivate *priv = label->priv;
5825 if (priv->select_info == NULL)
5828 old_pos = new_pos = priv->select_info->selection_end;
5830 if (priv->select_info->selection_end != priv->select_info->selection_anchor &&
5833 /* If we have a current selection and aren't extending it, move to the
5834 * start/or end of the selection as appropriate
5838 case GTK_MOVEMENT_VISUAL_POSITIONS:
5841 gint anchor_x, anchor_y;
5842 gboolean end_is_left;
5844 get_better_cursor (label, priv->select_info->selection_end, &end_x, &end_y);
5845 get_better_cursor (label, priv->select_info->selection_anchor, &anchor_x, &anchor_y);
5847 end_is_left = (end_y < anchor_y) || (end_y == anchor_y && end_x < anchor_x);
5850 new_pos = end_is_left ? priv->select_info->selection_end : priv->select_info->selection_anchor;
5852 new_pos = !end_is_left ? priv->select_info->selection_end : priv->select_info->selection_anchor;
5855 case GTK_MOVEMENT_LOGICAL_POSITIONS:
5856 case GTK_MOVEMENT_WORDS:
5858 new_pos = MIN (priv->select_info->selection_end, priv->select_info->selection_anchor);
5860 new_pos = MAX (priv->select_info->selection_end, priv->select_info->selection_anchor);
5862 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
5863 case GTK_MOVEMENT_PARAGRAPH_ENDS:
5864 case GTK_MOVEMENT_BUFFER_ENDS:
5865 /* FIXME: Can do better here */
5866 new_pos = count < 0 ? 0 : strlen (priv->text);
5868 case GTK_MOVEMENT_DISPLAY_LINES:
5869 case GTK_MOVEMENT_PARAGRAPHS:
5870 case GTK_MOVEMENT_PAGES:
5871 case GTK_MOVEMENT_HORIZONTAL_PAGES:
5879 case GTK_MOVEMENT_LOGICAL_POSITIONS:
5880 new_pos = gtk_label_move_logically (label, new_pos, count);
5882 case GTK_MOVEMENT_VISUAL_POSITIONS:
5883 new_pos = gtk_label_move_visually (label, new_pos, count);
5884 if (new_pos == old_pos)
5886 if (!extend_selection)
5888 if (!gtk_widget_keynav_failed (GTK_WIDGET (label),
5890 GTK_DIR_RIGHT : GTK_DIR_LEFT))
5892 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (label));
5895 gtk_widget_child_focus (toplevel,
5897 GTK_DIR_RIGHT : GTK_DIR_LEFT);
5902 gtk_widget_error_bell (GTK_WIDGET (label));
5906 case GTK_MOVEMENT_WORDS:
5909 new_pos = gtk_label_move_forward_word (label, new_pos);
5914 new_pos = gtk_label_move_backward_word (label, new_pos);
5917 if (new_pos == old_pos)
5918 gtk_widget_error_bell (GTK_WIDGET (label));
5920 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
5921 case GTK_MOVEMENT_PARAGRAPH_ENDS:
5922 case GTK_MOVEMENT_BUFFER_ENDS:
5923 /* FIXME: Can do better here */
5924 new_pos = count < 0 ? 0 : strlen (priv->text);
5925 if (new_pos == old_pos)
5926 gtk_widget_error_bell (GTK_WIDGET (label));
5928 case GTK_MOVEMENT_DISPLAY_LINES:
5929 case GTK_MOVEMENT_PARAGRAPHS:
5930 case GTK_MOVEMENT_PAGES:
5931 case GTK_MOVEMENT_HORIZONTAL_PAGES:
5936 if (extend_selection)
5937 gtk_label_select_region_index (label,
5938 priv->select_info->selection_anchor,
5941 gtk_label_select_region_index (label, new_pos, new_pos);
5945 gtk_label_copy_clipboard (GtkLabel *label)
5947 GtkLabelPrivate *priv = label->priv;
5949 if (priv->text && priv->select_info)
5953 GtkClipboard *clipboard;
5955 start = MIN (priv->select_info->selection_anchor,
5956 priv->select_info->selection_end);
5957 end = MAX (priv->select_info->selection_anchor,
5958 priv->select_info->selection_end);
5960 len = strlen (priv->text);
5968 clipboard = gtk_widget_get_clipboard (GTK_WIDGET (label), GDK_SELECTION_CLIPBOARD);
5971 gtk_clipboard_set_text (clipboard, priv->text + start, end - start);
5976 link = gtk_label_get_focus_link (label);
5978 gtk_clipboard_set_text (clipboard, link->uri, -1);
5984 gtk_label_select_all (GtkLabel *label)
5986 GtkLabelPrivate *priv = label->priv;
5988 gtk_label_select_region_index (label, 0, strlen (priv->text));
5991 /* Quick hack of a popup menu
5994 activate_cb (GtkWidget *menuitem,
5997 const gchar *signal = g_object_get_data (G_OBJECT (menuitem), "gtk-signal");
5998 g_signal_emit_by_name (label, signal);
6002 append_action_signal (GtkLabel *label,
6004 const gchar *stock_id,
6005 const gchar *signal,
6008 GtkWidget *menuitem = gtk_image_menu_item_new_from_stock (stock_id, NULL);
6010 g_object_set_data (G_OBJECT (menuitem), I_("gtk-signal"), (char *)signal);
6011 g_signal_connect (menuitem, "activate",
6012 G_CALLBACK (activate_cb), label);
6014 gtk_widget_set_sensitive (menuitem, sensitive);
6016 gtk_widget_show (menuitem);
6017 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
6021 popup_menu_detach (GtkWidget *attach_widget,
6024 GtkLabel *label = GTK_LABEL (attach_widget);
6025 GtkLabelPrivate *priv = label->priv;
6027 if (priv->select_info)
6028 priv->select_info->popup_menu = NULL;
6032 popup_position_func (GtkMenu *menu,
6040 GtkAllocation allocation;
6044 label = GTK_LABEL (user_data);
6045 widget = GTK_WIDGET (label);
6047 g_return_if_fail (gtk_widget_get_realized (widget));
6049 screen = gtk_widget_get_screen (widget);
6050 gdk_window_get_origin (gtk_widget_get_window (widget), x, y);
6052 gtk_widget_get_allocation (widget, &allocation);
6057 gtk_widget_get_preferred_size (GTK_WIDGET (menu),
6060 gtk_widget_get_allocation (widget, &allocation);
6062 *x += allocation.width / 2;
6063 *y += allocation.height;
6065 *x = CLAMP (*x, 0, MAX (0, gdk_screen_get_width (screen) - req.width));
6066 *y = CLAMP (*y, 0, MAX (0, gdk_screen_get_height (screen) - req.height));
6070 open_link_activate_cb (GtkMenuItem *menu_item,
6075 link = gtk_label_get_current_link (label);
6078 emit_activate_link (label, link);
6082 copy_link_activate_cb (GtkMenuItem *menu_item,
6085 GtkClipboard *clipboard;
6088 uri = gtk_label_get_current_uri (label);
6091 clipboard = gtk_widget_get_clipboard (GTK_WIDGET (label), GDK_SELECTION_CLIPBOARD);
6092 gtk_clipboard_set_text (clipboard, uri, -1);
6097 gtk_label_popup_menu (GtkWidget *widget)
6099 gtk_label_do_popup (GTK_LABEL (widget), NULL);
6105 gtk_label_do_popup (GtkLabel *label,
6106 GdkEventButton *event)
6108 GtkLabelPrivate *priv = label->priv;
6109 GtkWidget *menuitem;
6112 gboolean have_selection;
6115 if (!priv->select_info)
6118 if (priv->select_info->popup_menu)
6119 gtk_widget_destroy (priv->select_info->popup_menu);
6121 priv->select_info->popup_menu = menu = gtk_menu_new ();
6123 gtk_menu_attach_to_widget (GTK_MENU (menu), GTK_WIDGET (label), popup_menu_detach);
6126 priv->select_info->selection_anchor != priv->select_info->selection_end;
6130 if (priv->select_info->link_clicked)
6131 link = priv->select_info->active_link;
6136 link = gtk_label_get_focus_link (label);
6138 if (!have_selection && link)
6141 menuitem = gtk_image_menu_item_new_with_mnemonic (_("_Open Link"));
6142 gtk_widget_show (menuitem);
6143 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
6145 g_signal_connect (G_OBJECT (menuitem), "activate",
6146 G_CALLBACK (open_link_activate_cb), label);
6148 image = gtk_image_new_from_stock (GTK_STOCK_JUMP_TO, GTK_ICON_SIZE_MENU);
6149 gtk_widget_show (image);
6150 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menuitem), image);
6152 /* Copy Link Address */
6153 menuitem = gtk_image_menu_item_new_with_mnemonic (_("Copy _Link Address"));
6154 gtk_widget_show (menuitem);
6155 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
6157 g_signal_connect (G_OBJECT (menuitem), "activate",
6158 G_CALLBACK (copy_link_activate_cb), label);
6160 image = gtk_image_new_from_stock (GTK_STOCK_COPY, GTK_ICON_SIZE_MENU);
6161 gtk_widget_show (image);
6162 gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (menuitem), image);
6166 append_action_signal (label, menu, GTK_STOCK_CUT, "cut-clipboard", FALSE);
6167 append_action_signal (label, menu, GTK_STOCK_COPY, "copy-clipboard", have_selection);
6168 append_action_signal (label, menu, GTK_STOCK_PASTE, "paste-clipboard", FALSE);
6170 menuitem = gtk_image_menu_item_new_from_stock (GTK_STOCK_DELETE, NULL);
6171 gtk_widget_set_sensitive (menuitem, FALSE);
6172 gtk_widget_show (menuitem);
6173 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
6175 menuitem = gtk_separator_menu_item_new ();
6176 gtk_widget_show (menuitem);
6177 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
6179 menuitem = gtk_image_menu_item_new_from_stock (GTK_STOCK_SELECT_ALL, NULL);
6180 g_signal_connect_swapped (menuitem, "activate",
6181 G_CALLBACK (gtk_label_select_all), label);
6182 gtk_widget_show (menuitem);
6183 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
6186 g_signal_emit (label, signals[POPULATE_POPUP], 0, menu);
6189 gtk_menu_popup (GTK_MENU (menu), NULL, NULL,
6191 event->button, event->time);
6194 gtk_menu_popup (GTK_MENU (menu), NULL, NULL,
6195 popup_position_func, label,
6196 0, gtk_get_current_event_time ());
6197 gtk_menu_shell_select_first (GTK_MENU_SHELL (menu), FALSE);
6202 gtk_label_clear_links (GtkLabel *label)
6204 GtkLabelPrivate *priv = label->priv;
6206 if (!priv->select_info)
6209 g_list_free_full (priv->select_info->links, (GDestroyNotify) link_free);
6210 priv->select_info->links = NULL;
6211 priv->select_info->active_link = NULL;
6215 gtk_label_activate_link (GtkLabel *label,
6218 GtkWidget *widget = GTK_WIDGET (label);
6219 GError *error = NULL;
6221 if (!gtk_show_uri (gtk_widget_get_screen (widget),
6222 uri, gtk_get_current_event_time (), &error))
6224 g_warning ("Unable to show '%s': %s", uri, error->message);
6225 g_error_free (error);
6232 emit_activate_link (GtkLabel *label,
6235 GtkLabelPrivate *priv = label->priv;
6238 g_signal_emit (label, signals[ACTIVATE_LINK], 0, link->uri, &handled);
6239 if (handled && priv->track_links && !link->visited)
6241 link->visited = TRUE;
6242 /* FIXME: shouldn't have to redo everything here */
6243 gtk_label_clear_layout (label);
6248 gtk_label_activate_current_link (GtkLabel *label)
6251 GtkWidget *widget = GTK_WIDGET (label);
6253 link = gtk_label_get_focus_link (label);
6257 emit_activate_link (label, link);
6261 GtkWidget *toplevel;
6263 GtkWidget *default_widget, *focus_widget;
6265 toplevel = gtk_widget_get_toplevel (widget);
6266 if (GTK_IS_WINDOW (toplevel))
6268 window = GTK_WINDOW (toplevel);
6272 default_widget = gtk_window_get_default_widget (window);
6273 focus_widget = gtk_window_get_focus (window);
6275 if (default_widget != widget &&
6276 !(widget == focus_widget && (!default_widget || !gtk_widget_is_sensitive (default_widget))))
6277 gtk_window_activate_default (window);
6283 static GtkLabelLink *
6284 gtk_label_get_current_link (GtkLabel *label)
6286 GtkLabelPrivate *priv = label->priv;
6289 if (!priv->select_info)
6292 if (priv->select_info->link_clicked)
6293 link = priv->select_info->active_link;
6295 link = gtk_label_get_focus_link (label);
6301 * gtk_label_get_current_uri:
6302 * @label: a #GtkLabel
6304 * Returns the URI for the currently active link in the label.
6305 * The active link is the one under the mouse pointer or, in a
6306 * selectable label, the link in which the text cursor is currently
6309 * This function is intended for use in a #GtkLabel::activate-link handler
6310 * or for use in a #GtkWidget::query-tooltip handler.
6312 * Returns: the currently active URI. The string is owned by GTK+ and must
6313 * not be freed or modified.
6318 gtk_label_get_current_uri (GtkLabel *label)
6322 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
6324 link = gtk_label_get_current_link (label);
6333 * gtk_label_set_track_visited_links:
6334 * @label: a #GtkLabel
6335 * @track_links: %TRUE to track visited links
6337 * Sets whether the label should keep track of clicked
6338 * links (and use a different color for them).
6343 gtk_label_set_track_visited_links (GtkLabel *label,
6344 gboolean track_links)
6346 GtkLabelPrivate *priv;
6348 g_return_if_fail (GTK_IS_LABEL (label));
6352 track_links = track_links != FALSE;
6354 if (priv->track_links != track_links)
6356 priv->track_links = track_links;
6358 /* FIXME: shouldn't have to redo everything here */
6359 gtk_label_recalculate (label);
6361 g_object_notify (G_OBJECT (label), "track-visited-links");
6366 * gtk_label_get_track_visited_links:
6367 * @label: a #GtkLabel
6369 * Returns whether the label is currently keeping track
6372 * Returns: %TRUE if clicked links are remembered
6377 gtk_label_get_track_visited_links (GtkLabel *label)
6379 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
6381 return label->priv->track_links;
6385 gtk_label_query_tooltip (GtkWidget *widget,
6388 gboolean keyboard_tip,
6389 GtkTooltip *tooltip)
6391 GtkLabel *label = GTK_LABEL (widget);
6392 GtkLabelPrivate *priv = label->priv;
6393 GtkLabelSelectionInfo *info = priv->select_info;
6397 if (info && info->links)
6401 if (info->selection_anchor == info->selection_end)
6402 index = info->selection_anchor;
6406 if (!get_layout_index (label, x, y, &index))
6412 for (l = info->links; l != NULL; l = l->next)
6414 GtkLabelLink *link = l->data;
6415 if (index >= link->start && index <= link->end)
6419 gtk_tooltip_set_markup (tooltip, link->title);
6428 return GTK_WIDGET_CLASS (gtk_label_parent_class)->query_tooltip (widget,
6435 _gtk_label_get_cursor_position (GtkLabel *label)
6437 GtkLabelPrivate *priv = label->priv;
6439 if (priv->select_info && priv->select_info->selectable)
6440 return g_utf8_pointer_to_offset (priv->text,
6441 priv->text + priv->select_info->selection_end);
6447 _gtk_label_get_selection_bound (GtkLabel *label)
6449 GtkLabelPrivate *priv = label->priv;
6451 if (priv->select_info && priv->select_info->selectable)
6452 return g_utf8_pointer_to_offset (priv->text,
6453 priv->text + priv->select_info->selection_anchor);