1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free
16 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
21 * file for a list of people on the GTK+ Team. See the ChangeLog
22 * files for a list of changes. These files are distributed with
23 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
30 #include "gtkaccellabel.h"
33 #include "gtkmarshalers.h"
34 #include "gtkwindow.h"
35 #include "gdk/gdkkeysyms.h"
36 #include "gtkclipboard.h"
37 #include <pango/pango.h>
38 #include "gtkimagemenuitem.h"
40 #include "gtkseparatormenuitem.h"
41 #include "gtktextutil.h"
42 #include "gtkmenuitem.h"
43 #include "gtknotebook.h"
45 #include "gtkbindings.h"
46 #include "gtkbuildable.h"
47 #include "gtkprivate.h"
50 #define GTK_LABEL_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_LABEL, GtkLabelPrivate))
60 struct _GtkLabelSelectionInfo
63 gint selection_anchor;
65 GtkWidget *popup_menu;
97 PROP_SINGLE_LINE_MODE,
102 static guint signals[LAST_SIGNAL] = { 0 };
104 static void gtk_label_set_property (GObject *object,
108 static void gtk_label_get_property (GObject *object,
112 static void gtk_label_destroy (GtkObject *object);
113 static void gtk_label_finalize (GObject *object);
114 static void gtk_label_size_request (GtkWidget *widget,
115 GtkRequisition *requisition);
116 static void gtk_label_size_allocate (GtkWidget *widget,
117 GtkAllocation *allocation);
118 static void gtk_label_state_changed (GtkWidget *widget,
120 static void gtk_label_style_set (GtkWidget *widget,
121 GtkStyle *previous_style);
122 static void gtk_label_direction_changed (GtkWidget *widget,
123 GtkTextDirection previous_dir);
124 static gint gtk_label_expose (GtkWidget *widget,
125 GdkEventExpose *event);
127 static void gtk_label_realize (GtkWidget *widget);
128 static void gtk_label_unrealize (GtkWidget *widget);
129 static void gtk_label_map (GtkWidget *widget);
130 static void gtk_label_unmap (GtkWidget *widget);
132 static gboolean gtk_label_button_press (GtkWidget *widget,
133 GdkEventButton *event);
134 static gboolean gtk_label_button_release (GtkWidget *widget,
135 GdkEventButton *event);
136 static gboolean gtk_label_motion (GtkWidget *widget,
137 GdkEventMotion *event);
138 static void gtk_label_grab_focus (GtkWidget *widget);
141 static void gtk_label_set_text_internal (GtkLabel *label,
143 static void gtk_label_set_label_internal (GtkLabel *label,
145 static void gtk_label_set_use_markup_internal (GtkLabel *label,
147 static void gtk_label_set_use_underline_internal (GtkLabel *label,
149 static void gtk_label_set_attributes_internal (GtkLabel *label,
150 PangoAttrList *attrs);
151 static void gtk_label_set_uline_text_internal (GtkLabel *label,
153 static void gtk_label_set_pattern_internal (GtkLabel *label,
154 const gchar *pattern);
155 static void set_markup (GtkLabel *label,
157 gboolean with_uline);
158 static void gtk_label_recalculate (GtkLabel *label);
159 static void gtk_label_hierarchy_changed (GtkWidget *widget,
160 GtkWidget *old_toplevel);
161 static void gtk_label_screen_changed (GtkWidget *widget,
162 GdkScreen *old_screen);
164 static void gtk_label_create_window (GtkLabel *label);
165 static void gtk_label_destroy_window (GtkLabel *label);
166 static void gtk_label_clear_layout (GtkLabel *label);
167 static void gtk_label_ensure_layout (GtkLabel *label);
168 static void gtk_label_invalidate_wrap_width (GtkLabel *label);
169 static void gtk_label_select_region_index (GtkLabel *label,
173 static gboolean gtk_label_mnemonic_activate (GtkWidget *widget,
174 gboolean group_cycling);
175 static void gtk_label_setup_mnemonic (GtkLabel *label,
177 static void gtk_label_drag_data_get (GtkWidget *widget,
178 GdkDragContext *context,
179 GtkSelectionData *selection_data,
183 static void gtk_label_buildable_interface_init (GtkBuildableIface *iface);
184 static gboolean gtk_label_buildable_custom_tag_start (GtkBuildable *buildable,
187 const gchar *tagname,
188 GMarkupParser *parser,
191 static void gtk_label_buildable_custom_finished (GtkBuildable *buildable,
194 const gchar *tagname,
198 /* For selectable lables: */
199 static void gtk_label_move_cursor (GtkLabel *label,
200 GtkMovementStep step,
202 gboolean extend_selection);
203 static void gtk_label_copy_clipboard (GtkLabel *label);
204 static void gtk_label_select_all (GtkLabel *label);
205 static void gtk_label_do_popup (GtkLabel *label,
206 GdkEventButton *event);
208 static gint gtk_label_move_forward_word (GtkLabel *label,
210 static gint gtk_label_move_backward_word (GtkLabel *label,
213 static GQuark quark_angle = 0;
215 static GtkBuildableIface *buildable_parent_iface = NULL;
217 G_DEFINE_TYPE_WITH_CODE (GtkLabel, gtk_label, GTK_TYPE_MISC,
218 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
219 gtk_label_buildable_interface_init));
222 add_move_binding (GtkBindingSet *binding_set,
225 GtkMovementStep step,
228 g_return_if_fail ((modmask & GDK_SHIFT_MASK) == 0);
230 gtk_binding_entry_add_signal (binding_set, keyval, modmask,
234 G_TYPE_BOOLEAN, FALSE);
236 /* Selection-extending version */
237 gtk_binding_entry_add_signal (binding_set, keyval, modmask | GDK_SHIFT_MASK,
241 G_TYPE_BOOLEAN, TRUE);
245 gtk_label_class_init (GtkLabelClass *class)
247 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
248 GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
249 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
250 GtkBindingSet *binding_set;
252 quark_angle = g_quark_from_static_string ("angle");
254 gobject_class->set_property = gtk_label_set_property;
255 gobject_class->get_property = gtk_label_get_property;
256 gobject_class->finalize = gtk_label_finalize;
258 object_class->destroy = gtk_label_destroy;
260 widget_class->size_request = gtk_label_size_request;
261 widget_class->size_allocate = gtk_label_size_allocate;
262 widget_class->state_changed = gtk_label_state_changed;
263 widget_class->style_set = gtk_label_style_set;
264 widget_class->direction_changed = gtk_label_direction_changed;
265 widget_class->expose_event = gtk_label_expose;
266 widget_class->realize = gtk_label_realize;
267 widget_class->unrealize = gtk_label_unrealize;
268 widget_class->map = gtk_label_map;
269 widget_class->unmap = gtk_label_unmap;
270 widget_class->button_press_event = gtk_label_button_press;
271 widget_class->button_release_event = gtk_label_button_release;
272 widget_class->motion_notify_event = gtk_label_motion;
273 widget_class->hierarchy_changed = gtk_label_hierarchy_changed;
274 widget_class->screen_changed = gtk_label_screen_changed;
275 widget_class->mnemonic_activate = gtk_label_mnemonic_activate;
276 widget_class->drag_data_get = gtk_label_drag_data_get;
277 widget_class->grab_focus = gtk_label_grab_focus;
279 class->move_cursor = gtk_label_move_cursor;
280 class->copy_clipboard = gtk_label_copy_clipboard;
282 signals[MOVE_CURSOR] =
283 g_signal_new (I_("move_cursor"),
284 G_OBJECT_CLASS_TYPE (gobject_class),
285 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
286 G_STRUCT_OFFSET (GtkLabelClass, move_cursor),
288 _gtk_marshal_VOID__ENUM_INT_BOOLEAN,
290 GTK_TYPE_MOVEMENT_STEP,
294 signals[COPY_CLIPBOARD] =
295 g_signal_new (I_("copy_clipboard"),
296 G_OBJECT_CLASS_TYPE (gobject_class),
297 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
298 G_STRUCT_OFFSET (GtkLabelClass, copy_clipboard),
300 _gtk_marshal_VOID__VOID,
303 signals[POPULATE_POPUP] =
304 g_signal_new (I_("populate_popup"),
305 G_OBJECT_CLASS_TYPE (gobject_class),
307 G_STRUCT_OFFSET (GtkLabelClass, populate_popup),
309 _gtk_marshal_VOID__OBJECT,
313 g_object_class_install_property (gobject_class,
315 g_param_spec_string ("label",
317 P_("The text of the label"),
319 GTK_PARAM_READWRITE));
320 g_object_class_install_property (gobject_class,
322 g_param_spec_boxed ("attributes",
324 P_("A list of style attributes to apply to the text of the label"),
325 PANGO_TYPE_ATTR_LIST,
326 GTK_PARAM_READWRITE));
327 g_object_class_install_property (gobject_class,
329 g_param_spec_boolean ("use-markup",
331 P_("The text of the label includes XML markup. See pango_parse_markup()"),
333 GTK_PARAM_READWRITE));
334 g_object_class_install_property (gobject_class,
336 g_param_spec_boolean ("use-underline",
338 P_("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
340 GTK_PARAM_READWRITE));
342 g_object_class_install_property (gobject_class,
344 g_param_spec_enum ("justify",
346 P_("The alignment of the lines in the text of the label relative to each other. This does NOT affect the alignment of the label within its allocation. See GtkMisc::xalign for that"),
347 GTK_TYPE_JUSTIFICATION,
349 GTK_PARAM_READWRITE));
351 g_object_class_install_property (gobject_class,
353 g_param_spec_string ("pattern",
355 P_("A string with _ characters in positions correspond to characters in the text to underline"),
357 GTK_PARAM_WRITABLE));
359 g_object_class_install_property (gobject_class,
361 g_param_spec_boolean ("wrap",
363 P_("If set, wrap lines if the text becomes too wide"),
365 GTK_PARAM_READWRITE));
367 * GtkLabel:wrap-mode:
369 * If line wrapping is on (see the #GtkLabel:wrap property) this controls
370 * how the line wrapping is done. The default is %PANGO_WRAP_WORD, which
371 * means wrap on word boundaries.
375 g_object_class_install_property (gobject_class,
377 g_param_spec_enum ("wrap-mode",
378 P_("Line wrap mode"),
379 P_("If wrap is set, controls how linewrapping is done"),
380 PANGO_TYPE_WRAP_MODE,
382 GTK_PARAM_READWRITE));
383 g_object_class_install_property (gobject_class,
385 g_param_spec_boolean ("selectable",
387 P_("Whether the label text can be selected with the mouse"),
389 GTK_PARAM_READWRITE));
390 g_object_class_install_property (gobject_class,
391 PROP_MNEMONIC_KEYVAL,
392 g_param_spec_uint ("mnemonic-keyval",
394 P_("The mnemonic accelerator key for this label"),
398 GTK_PARAM_READABLE));
399 g_object_class_install_property (gobject_class,
400 PROP_MNEMONIC_WIDGET,
401 g_param_spec_object ("mnemonic-widget",
402 P_("Mnemonic widget"),
403 P_("The widget to be activated when the label's mnemonic "
406 GTK_PARAM_READWRITE));
408 g_object_class_install_property (gobject_class,
409 PROP_CURSOR_POSITION,
410 g_param_spec_int ("cursor-position",
411 P_("Cursor Position"),
412 P_("The current position of the insertion cursor in chars"),
416 GTK_PARAM_READABLE));
418 g_object_class_install_property (gobject_class,
419 PROP_SELECTION_BOUND,
420 g_param_spec_int ("selection-bound",
421 P_("Selection Bound"),
422 P_("The position of the opposite end of the selection from the cursor in chars"),
426 GTK_PARAM_READABLE));
429 * GtkLabel:ellipsize:
431 * The preferred place to ellipsize the string, if the label does
432 * not have enough room to display the entire string, specified as a
433 * #PangoEllisizeMode.
435 * Note that setting this property to a value other than
436 * %PANGO_ELLIPSIZE_NONE has the side-effect that the label requests
437 * only enough space to display the ellipsis "...". In particular, this
438 * means that ellipsizing labels do not work well in notebook tabs, unless
439 * the tab's #GtkNotebook:tab-expand property is set to %TRUE. Other ways
440 * to set a label's width are gtk_widget_set_size_request() and
441 * gtk_label_set_width_chars().
445 g_object_class_install_property (gobject_class,
447 g_param_spec_enum ("ellipsize",
449 P_("The preferred place to ellipsize the string, if the label does not have enough room to display the entire string"),
450 PANGO_TYPE_ELLIPSIZE_MODE,
451 PANGO_ELLIPSIZE_NONE,
452 GTK_PARAM_READWRITE));
455 * GtkLabel:width-chars:
457 * The desired width of the label, in characters. If this property is set to
458 * -1, the width will be calculated automatically, otherwise the label will
459 * request either 3 characters or the property value, whichever is greater.
460 * If the "width-chars" property is set to a positive value, then the
461 * #GtkLabel:max-width-chars property is ignored.
465 g_object_class_install_property (gobject_class,
467 g_param_spec_int ("width-chars",
468 P_("Width In Characters"),
469 P_("The desired width of the label, in characters"),
473 GTK_PARAM_READWRITE));
476 * GtkLabel:single-line-mode:
478 * Whether the label is in single line mode. In single line mode,
479 * the height of the label does not depend on the actual text, it
480 * is always set to ascent + descent of the font. This can be an
481 * advantage in situations where resizing the label because of text
482 * changes would be distracting, e.g. in a statusbar.
486 g_object_class_install_property (gobject_class,
487 PROP_SINGLE_LINE_MODE,
488 g_param_spec_boolean ("single-line-mode",
489 P_("Single Line Mode"),
490 P_("Whether the label is in single line mode"),
492 GTK_PARAM_READWRITE));
497 * The angle that the baseline of the label makes with the horizontal,
498 * in degrees, measured counterclockwise. An angle of 90 reads from
499 * from bottom to top, an angle of 270, from top to bottom. Ignored
500 * if the label is selectable, wrapped, or ellipsized.
504 g_object_class_install_property (gobject_class,
506 g_param_spec_double ("angle",
508 P_("Angle at which the label is rotated"),
512 GTK_PARAM_READWRITE));
515 * GtkLabel:max-width-chars:
517 * The desired maximum width of the label, in characters. If this property
518 * is set to -1, the width will be calculated automatically, otherwise the
519 * label will request space for no more than the requested number of
520 * characters. If the #GtkLabel:width-chars property is set to a positive
521 * value, then the "max-width-chars" property is ignored.
525 g_object_class_install_property (gobject_class,
526 PROP_MAX_WIDTH_CHARS,
527 g_param_spec_int ("max-width-chars",
528 P_("Maximum Width In Characters"),
529 P_("The desired maximum width of the label, in characters"),
533 GTK_PARAM_READWRITE));
538 binding_set = gtk_binding_set_by_class (class);
540 /* Moving the insertion point */
541 add_move_binding (binding_set, GDK_Right, 0,
542 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
544 add_move_binding (binding_set, GDK_Left, 0,
545 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
547 add_move_binding (binding_set, GDK_KP_Right, 0,
548 GTK_MOVEMENT_VISUAL_POSITIONS, 1);
550 add_move_binding (binding_set, GDK_KP_Left, 0,
551 GTK_MOVEMENT_VISUAL_POSITIONS, -1);
553 add_move_binding (binding_set, GDK_f, GDK_CONTROL_MASK,
554 GTK_MOVEMENT_LOGICAL_POSITIONS, 1);
556 add_move_binding (binding_set, GDK_b, GDK_CONTROL_MASK,
557 GTK_MOVEMENT_LOGICAL_POSITIONS, -1);
559 add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
560 GTK_MOVEMENT_WORDS, 1);
562 add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
563 GTK_MOVEMENT_WORDS, -1);
565 add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
566 GTK_MOVEMENT_WORDS, 1);
568 add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
569 GTK_MOVEMENT_WORDS, -1);
572 gtk_binding_entry_add_signal (binding_set, GDK_a, GDK_CONTROL_MASK,
574 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
576 G_TYPE_BOOLEAN, FALSE);
578 gtk_binding_entry_add_signal (binding_set, GDK_a, GDK_CONTROL_MASK,
580 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
582 G_TYPE_BOOLEAN, TRUE);
584 gtk_binding_entry_add_signal (binding_set, GDK_slash, GDK_CONTROL_MASK,
586 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
588 G_TYPE_BOOLEAN, FALSE);
590 gtk_binding_entry_add_signal (binding_set, GDK_slash, GDK_CONTROL_MASK,
592 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
594 G_TYPE_BOOLEAN, TRUE);
597 gtk_binding_entry_add_signal (binding_set, GDK_a, GDK_SHIFT_MASK | GDK_CONTROL_MASK,
599 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
601 G_TYPE_BOOLEAN, FALSE);
603 gtk_binding_entry_add_signal (binding_set, GDK_backslash, GDK_CONTROL_MASK,
605 G_TYPE_ENUM, GTK_MOVEMENT_PARAGRAPH_ENDS,
607 G_TYPE_BOOLEAN, FALSE);
609 add_move_binding (binding_set, GDK_f, GDK_MOD1_MASK,
610 GTK_MOVEMENT_WORDS, 1);
612 add_move_binding (binding_set, GDK_b, GDK_MOD1_MASK,
613 GTK_MOVEMENT_WORDS, -1);
615 add_move_binding (binding_set, GDK_Home, 0,
616 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
618 add_move_binding (binding_set, GDK_End, 0,
619 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
621 add_move_binding (binding_set, GDK_KP_Home, 0,
622 GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);
624 add_move_binding (binding_set, GDK_KP_End, 0,
625 GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
627 add_move_binding (binding_set, GDK_Home, GDK_CONTROL_MASK,
628 GTK_MOVEMENT_BUFFER_ENDS, -1);
630 add_move_binding (binding_set, GDK_End, GDK_CONTROL_MASK,
631 GTK_MOVEMENT_BUFFER_ENDS, 1);
633 add_move_binding (binding_set, GDK_KP_Home, GDK_CONTROL_MASK,
634 GTK_MOVEMENT_BUFFER_ENDS, -1);
636 add_move_binding (binding_set, GDK_KP_End, GDK_CONTROL_MASK,
637 GTK_MOVEMENT_BUFFER_ENDS, 1);
640 gtk_binding_entry_add_signal (binding_set, GDK_c, GDK_CONTROL_MASK,
641 "copy_clipboard", 0);
643 gtk_settings_install_property (g_param_spec_boolean ("gtk-label-select-on-focus",
644 P_("Select on focus"),
645 P_("Whether to select the contents of a selectable label when it is focused"),
647 GTK_PARAM_READWRITE));
650 g_type_class_add_private (class, sizeof (GtkLabelPrivate));
654 gtk_label_set_property (GObject *object,
661 label = GTK_LABEL (object);
666 gtk_label_set_label (label, g_value_get_string (value));
668 case PROP_ATTRIBUTES:
669 gtk_label_set_attributes (label, g_value_get_boxed (value));
671 case PROP_USE_MARKUP:
672 gtk_label_set_use_markup (label, g_value_get_boolean (value));
674 case PROP_USE_UNDERLINE:
675 gtk_label_set_use_underline (label, g_value_get_boolean (value));
678 gtk_label_set_justify (label, g_value_get_enum (value));
681 gtk_label_set_pattern (label, g_value_get_string (value));
684 gtk_label_set_line_wrap (label, g_value_get_boolean (value));
687 gtk_label_set_line_wrap_mode (label, g_value_get_enum (value));
689 case PROP_SELECTABLE:
690 gtk_label_set_selectable (label, g_value_get_boolean (value));
692 case PROP_MNEMONIC_WIDGET:
693 gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
696 gtk_label_set_ellipsize (label, g_value_get_enum (value));
698 case PROP_WIDTH_CHARS:
699 gtk_label_set_width_chars (label, g_value_get_int (value));
701 case PROP_SINGLE_LINE_MODE:
702 gtk_label_set_single_line_mode (label, g_value_get_boolean (value));
705 gtk_label_set_angle (label, g_value_get_double (value));
707 case PROP_MAX_WIDTH_CHARS:
708 gtk_label_set_max_width_chars (label, g_value_get_int (value));
711 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
717 gtk_label_get_property (GObject *object,
724 label = GTK_LABEL (object);
729 g_value_set_string (value, label->label);
731 case PROP_ATTRIBUTES:
732 g_value_set_boxed (value, label->attrs);
734 case PROP_USE_MARKUP:
735 g_value_set_boolean (value, label->use_markup);
737 case PROP_USE_UNDERLINE:
738 g_value_set_boolean (value, label->use_underline);
741 g_value_set_enum (value, label->jtype);
744 g_value_set_boolean (value, label->wrap);
747 g_value_set_enum (value, label->wrap_mode);
749 case PROP_SELECTABLE:
750 g_value_set_boolean (value, gtk_label_get_selectable (label));
752 case PROP_MNEMONIC_KEYVAL:
753 g_value_set_uint (value, label->mnemonic_keyval);
755 case PROP_MNEMONIC_WIDGET:
756 g_value_set_object (value, (GObject*) label->mnemonic_widget);
758 case PROP_CURSOR_POSITION:
759 if (label->select_info)
761 gint offset = g_utf8_pointer_to_offset (label->text,
762 label->text + label->select_info->selection_end);
763 g_value_set_int (value, offset);
766 g_value_set_int (value, 0);
768 case PROP_SELECTION_BOUND:
769 if (label->select_info)
771 gint offset = g_utf8_pointer_to_offset (label->text,
772 label->text + label->select_info->selection_anchor);
773 g_value_set_int (value, offset);
776 g_value_set_int (value, 0);
779 g_value_set_enum (value, label->ellipsize);
781 case PROP_WIDTH_CHARS:
782 g_value_set_int (value, gtk_label_get_width_chars (label));
784 case PROP_SINGLE_LINE_MODE:
785 g_value_set_boolean (value, gtk_label_get_single_line_mode (label));
788 g_value_set_double (value, gtk_label_get_angle (label));
790 case PROP_MAX_WIDTH_CHARS:
791 g_value_set_int (value, gtk_label_get_max_width_chars (label));
795 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
801 gtk_label_init (GtkLabel *label)
803 GtkLabelPrivate *priv;
805 GTK_WIDGET_SET_FLAGS (label, GTK_NO_WINDOW);
807 priv = GTK_LABEL_GET_PRIVATE (label);
808 priv->width_chars = -1;
809 priv->max_width_chars = -1;
810 priv->wrap_width = -1;
813 label->jtype = GTK_JUSTIFY_LEFT;
815 label->wrap_mode = PANGO_WRAP_WORD;
816 label->ellipsize = PANGO_ELLIPSIZE_NONE;
818 label->use_underline = FALSE;
819 label->use_markup = FALSE;
820 label->pattern_set = FALSE;
822 label->mnemonic_keyval = GDK_VoidSymbol;
823 label->layout = NULL;
827 label->mnemonic_widget = NULL;
828 label->mnemonic_window = NULL;
830 gtk_label_set_text (label, "");
835 gtk_label_buildable_interface_init (GtkBuildableIface *iface)
837 buildable_parent_iface = g_type_interface_peek_parent (iface);
839 iface->custom_tag_start = gtk_label_buildable_custom_tag_start;
840 iface->custom_finished = gtk_label_buildable_custom_finished;
846 PangoAttrList *attrs;
849 static PangoAttribute *
850 attribute_from_text (GtkBuilder *builder,
855 PangoAttribute *attribute = NULL;
857 PangoLanguage *language;
858 PangoFontDescription *font_desc;
862 if (!gtk_builder_value_from_string_type (builder, PANGO_TYPE_ATTR_TYPE, name, &val, error))
865 type = g_value_get_enum (&val);
866 g_value_unset (&val);
870 /* PangoAttrLanguage */
871 case PANGO_ATTR_LANGUAGE:
872 if ((language = pango_language_from_string (value)))
874 attribute = pango_attr_language_new (language);
875 g_value_init (&val, G_TYPE_INT);
879 case PANGO_ATTR_STYLE:
880 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_STYLE, value, &val, error))
881 attribute = pango_attr_style_new (g_value_get_enum (&val));
883 case PANGO_ATTR_WEIGHT:
884 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_WEIGHT, value, &val, error))
885 attribute = pango_attr_weight_new (g_value_get_enum (&val));
887 case PANGO_ATTR_VARIANT:
888 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_VARIANT, value, &val, error))
889 attribute = pango_attr_variant_new (g_value_get_enum (&val));
891 case PANGO_ATTR_STRETCH:
892 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_STRETCH, value, &val, error))
893 attribute = pango_attr_stretch_new (g_value_get_enum (&val));
895 case PANGO_ATTR_UNDERLINE:
896 if (gtk_builder_value_from_string_type (builder, G_TYPE_BOOLEAN, value, &val, error))
897 attribute = pango_attr_underline_new (g_value_get_boolean (&val));
899 case PANGO_ATTR_STRIKETHROUGH:
900 if (gtk_builder_value_from_string_type (builder, G_TYPE_BOOLEAN, value, &val, error))
901 attribute = pango_attr_strikethrough_new (g_value_get_boolean (&val));
903 case PANGO_ATTR_GRAVITY:
904 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_GRAVITY, value, &val, error))
905 attribute = pango_attr_gravity_new (g_value_get_enum (&val));
907 case PANGO_ATTR_GRAVITY_HINT:
908 if (gtk_builder_value_from_string_type (builder, PANGO_TYPE_GRAVITY_HINT,
910 attribute = pango_attr_gravity_hint_new (g_value_get_enum (&val));
913 /* PangoAttrString */
914 case PANGO_ATTR_FAMILY:
915 attribute = pango_attr_family_new (value);
916 g_value_init (&val, G_TYPE_INT);
920 case PANGO_ATTR_SIZE:
921 if (gtk_builder_value_from_string_type (builder, G_TYPE_INT,
923 attribute = pango_attr_size_new (g_value_get_int (&val));
925 case PANGO_ATTR_ABSOLUTE_SIZE:
926 if (gtk_builder_value_from_string_type (builder, G_TYPE_INT,
928 attribute = pango_attr_size_new_absolute (g_value_get_int (&val));
931 /* PangoAttrFontDesc */
932 case PANGO_ATTR_FONT_DESC:
933 if ((font_desc = pango_font_description_from_string (value)))
935 attribute = pango_attr_font_desc_new (font_desc);
936 pango_font_description_free (font_desc);
937 g_value_init (&val, G_TYPE_INT);
942 case PANGO_ATTR_FOREGROUND:
943 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
946 color = g_value_get_boxed (&val);
947 attribute = pango_attr_foreground_new (color->red, color->green, color->blue);
950 case PANGO_ATTR_BACKGROUND:
951 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
954 color = g_value_get_boxed (&val);
955 attribute = pango_attr_background_new (color->red, color->green, color->blue);
958 case PANGO_ATTR_UNDERLINE_COLOR:
959 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
962 color = g_value_get_boxed (&val);
963 attribute = pango_attr_underline_color_new (color->red, color->green, color->blue);
966 case PANGO_ATTR_STRIKETHROUGH_COLOR:
967 if (gtk_builder_value_from_string_type (builder, GDK_TYPE_COLOR,
970 color = g_value_get_boxed (&val);
971 attribute = pango_attr_strikethrough_color_new (color->red, color->green, color->blue);
976 case PANGO_ATTR_SHAPE:
977 /* Unsupported for now */
980 case PANGO_ATTR_SCALE:
981 if (gtk_builder_value_from_string_type (builder, G_TYPE_DOUBLE,
983 attribute = pango_attr_scale_new (g_value_get_double (&val));
986 case PANGO_ATTR_INVALID:
987 case PANGO_ATTR_LETTER_SPACING:
988 case PANGO_ATTR_RISE:
989 case PANGO_ATTR_FALLBACK:
994 g_value_unset (&val);
1001 pango_start_element (GMarkupParseContext *context,
1002 const gchar *element_name,
1003 const gchar **names,
1004 const gchar **values,
1008 PangoParserData *data = (PangoParserData*)user_data;
1009 GValue val = { 0, };
1011 gint line_number, char_number;
1013 if (strcmp (element_name, "attribute") == 0)
1015 PangoAttribute *attr = NULL;
1016 const gchar *name = NULL;
1017 const gchar *value = NULL;
1018 const gchar *start = NULL;
1019 const gchar *end = NULL;
1020 guint start_val = 0;
1021 guint end_val = G_MAXUINT;
1023 for (i = 0; names[i]; i++)
1025 if (strcmp (names[i], "name") == 0)
1027 else if (strcmp (names[i], "value") == 0)
1029 else if (strcmp (names[i], "start") == 0)
1031 else if (strcmp (names[i], "end") == 0)
1035 g_markup_parse_context_get_position (context,
1040 GTK_BUILDER_ERROR_INVALID_ATTRIBUTE,
1041 "%s:%d:%d '%s' is not a valid attribute of <%s>",
1043 line_number, char_number, names[i], "attribute");
1048 if (!name || !value)
1050 g_markup_parse_context_get_position (context,
1055 GTK_BUILDER_ERROR_MISSING_ATTRIBUTE,
1056 "%s:%d:%d <%s> requires attribute \"%s\"",
1058 line_number, char_number, "attribute",
1059 name ? "value" : "name");
1065 if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_UINT,
1066 start, &val, error))
1068 start_val = g_value_get_uint (&val);
1069 g_value_unset (&val);
1074 if (!gtk_builder_value_from_string_type (data->builder, G_TYPE_UINT,
1077 end_val = g_value_get_uint (&val);
1078 g_value_unset (&val);
1081 attr = attribute_from_text (data->builder, name, value, error);
1082 attr->start_index = start_val;
1083 attr->end_index = end_val;
1088 data->attrs = pango_attr_list_new ();
1090 pango_attr_list_insert (data->attrs, attr);
1093 else if (strcmp (element_name, "attributes") == 0)
1096 g_warning ("Unsupported tag for GtkLabel: %s\n", element_name);
1099 static const GMarkupParser pango_parser =
1101 pango_start_element,
1105 gtk_label_buildable_custom_tag_start (GtkBuildable *buildable,
1106 GtkBuilder *builder,
1108 const gchar *tagname,
1109 GMarkupParser *parser,
1112 if (buildable_parent_iface->custom_tag_start (buildable, builder, child,
1113 tagname, parser, data))
1116 if (strcmp (tagname, "attributes") == 0)
1118 PangoParserData *parser_data;
1120 parser_data = g_slice_new0 (PangoParserData);
1121 parser_data->builder = g_object_ref (builder);
1122 parser_data->object = g_object_ref (buildable);
1123 *parser = pango_parser;
1124 *data = parser_data;
1131 gtk_label_buildable_custom_finished (GtkBuildable *buildable,
1132 GtkBuilder *builder,
1134 const gchar *tagname,
1137 PangoParserData *data;
1139 buildable_parent_iface->custom_finished (buildable, builder, child,
1140 tagname, user_data);
1142 if (strcmp (tagname, "attributes") == 0)
1144 data = (PangoParserData*)user_data;
1148 gtk_label_set_attributes (GTK_LABEL (buildable), data->attrs);
1149 pango_attr_list_unref (data->attrs);
1152 g_object_unref (data->object);
1153 g_object_unref (data->builder);
1154 g_slice_free (PangoParserData, data);
1161 * @str: The text of the label
1163 * Creates a new label with the given text inside it. You can
1164 * pass %NULL to get an empty label widget.
1166 * Return value: the new #GtkLabel
1169 gtk_label_new (const gchar *str)
1173 label = g_object_new (GTK_TYPE_LABEL, NULL);
1176 gtk_label_set_text (label, str);
1178 return GTK_WIDGET (label);
1182 * gtk_label_new_with_mnemonic:
1183 * @str: The text of the label, with an underscore in front of the
1184 * mnemonic character
1186 * Creates a new #GtkLabel, containing the text in @str.
1188 * If characters in @str are preceded by an underscore, they are
1189 * underlined. If you need a literal underscore character in a label, use
1190 * '__' (two underscores). The first underlined character represents a
1191 * keyboard accelerator called a mnemonic. The mnemonic key can be used
1192 * to activate another widget, chosen automatically, or explicitly using
1193 * gtk_label_set_mnemonic_widget().
1195 * If gtk_label_set_mnemonic_widget() is not called, then the first
1196 * activatable ancestor of the #GtkLabel will be chosen as the mnemonic
1197 * widget. For instance, if the label is inside a button or menu item,
1198 * the button or menu item will automatically become the mnemonic widget
1199 * and be activated by the mnemonic.
1201 * Return value: the new #GtkLabel
1204 gtk_label_new_with_mnemonic (const gchar *str)
1208 label = g_object_new (GTK_TYPE_LABEL, NULL);
1211 gtk_label_set_text_with_mnemonic (label, str);
1213 return GTK_WIDGET (label);
1217 gtk_label_mnemonic_activate (GtkWidget *widget,
1218 gboolean group_cycling)
1222 if (GTK_LABEL (widget)->mnemonic_widget)
1223 return gtk_widget_mnemonic_activate (GTK_LABEL (widget)->mnemonic_widget, group_cycling);
1225 /* Try to find the widget to activate by traversing the
1226 * widget's ancestry.
1228 parent = widget->parent;
1230 if (GTK_IS_NOTEBOOK (parent))
1235 if (GTK_WIDGET_CAN_FOCUS (parent) ||
1236 (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
1237 GTK_IS_NOTEBOOK (parent->parent) ||
1238 GTK_IS_MENU_ITEM (parent))
1239 return gtk_widget_mnemonic_activate (parent, group_cycling);
1240 parent = parent->parent;
1243 /* barf if there was nothing to activate */
1244 g_warning ("Couldn't find a target for a mnemonic activation.");
1245 gtk_widget_error_bell (widget);
1251 gtk_label_setup_mnemonic (GtkLabel *label,
1254 GtkWidget *widget = GTK_WIDGET (label);
1255 GtkWidget *toplevel;
1256 GtkWidget *mnemonic_menu;
1258 mnemonic_menu = g_object_get_data (G_OBJECT (label), "gtk-mnemonic-menu");
1260 if (last_key != GDK_VoidSymbol)
1262 if (label->mnemonic_window)
1264 gtk_window_remove_mnemonic (label->mnemonic_window,
1267 label->mnemonic_window = NULL;
1271 _gtk_menu_shell_remove_mnemonic (GTK_MENU_SHELL (mnemonic_menu),
1274 mnemonic_menu = NULL;
1278 if (label->mnemonic_keyval == GDK_VoidSymbol)
1281 toplevel = gtk_widget_get_toplevel (widget);
1282 if (GTK_WIDGET_TOPLEVEL (toplevel))
1284 GtkWidget *menu_shell;
1286 menu_shell = gtk_widget_get_ancestor (widget,
1287 GTK_TYPE_MENU_SHELL);
1291 _gtk_menu_shell_add_mnemonic (GTK_MENU_SHELL (menu_shell),
1292 label->mnemonic_keyval,
1294 mnemonic_menu = menu_shell;
1297 if (!GTK_IS_MENU (menu_shell))
1299 gtk_window_add_mnemonic (GTK_WINDOW (toplevel),
1300 label->mnemonic_keyval,
1302 label->mnemonic_window = GTK_WINDOW (toplevel);
1307 g_object_set_data (G_OBJECT (label), I_("gtk-mnemonic-menu"), mnemonic_menu);
1311 gtk_label_hierarchy_changed (GtkWidget *widget,
1312 GtkWidget *old_toplevel)
1314 GtkLabel *label = GTK_LABEL (widget);
1316 gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
1320 label_shortcut_setting_apply (GtkLabel *label)
1322 gtk_label_recalculate (label);
1323 if (GTK_IS_ACCEL_LABEL (label))
1324 gtk_accel_label_refetch (GTK_ACCEL_LABEL (label));
1328 label_shortcut_setting_traverse_container (GtkWidget *widget,
1331 if (GTK_IS_LABEL (widget))
1332 label_shortcut_setting_apply (GTK_LABEL (widget));
1333 else if (GTK_IS_CONTAINER (widget))
1334 gtk_container_forall (GTK_CONTAINER (widget),
1335 label_shortcut_setting_traverse_container, data);
1339 label_shortcut_setting_changed (GtkSettings *settings)
1343 list = gtk_window_list_toplevels ();
1345 for (l = list; l ; l = l->next)
1347 GtkWidget *widget = l->data;
1349 if (gtk_widget_get_settings (widget) == settings)
1350 gtk_container_forall (GTK_CONTAINER (widget),
1351 label_shortcut_setting_traverse_container, NULL);
1358 gtk_label_screen_changed (GtkWidget *widget,
1359 GdkScreen *old_screen)
1361 GtkSettings *settings;
1362 gboolean shortcuts_connected;
1364 if (!gtk_widget_has_screen (widget))
1367 settings = gtk_widget_get_settings (widget);
1369 shortcuts_connected =
1370 GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
1371 "gtk-label-shortcuts-connected"));
1373 if (! shortcuts_connected)
1375 g_signal_connect (settings, "notify::gtk-enable-mnemonics",
1376 G_CALLBACK (label_shortcut_setting_changed),
1378 g_signal_connect (settings, "notify::gtk-enable-accels",
1379 G_CALLBACK (label_shortcut_setting_changed),
1382 g_object_set_data (G_OBJECT (settings), "gtk-label-shortcuts-connected",
1383 GINT_TO_POINTER (TRUE));
1386 label_shortcut_setting_apply (GTK_LABEL (widget));
1391 label_mnemonic_widget_weak_notify (gpointer data,
1392 GObject *where_the_object_was)
1394 GtkLabel *label = data;
1396 label->mnemonic_widget = NULL;
1397 g_object_notify (G_OBJECT (label), "mnemonic-widget");
1401 * gtk_label_set_mnemonic_widget:
1402 * @label: a #GtkLabel
1403 * @widget: the target #GtkWidget
1405 * If the label has been set so that it has an mnemonic key (using
1406 * i.e. gtk_label_set_markup_with_mnemonic(),
1407 * gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
1408 * or the "use_underline" property) the label can be associated with a
1409 * widget that is the target of the mnemonic. When the label is inside
1410 * a widget (like a #GtkButton or a #GtkNotebook tab) it is
1411 * automatically associated with the correct widget, but sometimes
1412 * (i.e. when the target is a #GtkEntry next to the label) you need to
1413 * set it explicitly using this function.
1415 * The target widget will be accelerated by emitting the
1416 * GtkWidget::mnemonic-activate signal on it. The default handler for
1417 * this signal will activate the widget if there are no mnemonic collisions
1418 * and toggle focus between the colliding widgets otherwise.
1421 gtk_label_set_mnemonic_widget (GtkLabel *label,
1424 g_return_if_fail (GTK_IS_LABEL (label));
1426 g_return_if_fail (GTK_IS_WIDGET (widget));
1428 if (label->mnemonic_widget)
1430 gtk_widget_remove_mnemonic_label (label->mnemonic_widget, GTK_WIDGET (label));
1431 g_object_weak_unref (G_OBJECT (label->mnemonic_widget),
1432 label_mnemonic_widget_weak_notify,
1435 label->mnemonic_widget = widget;
1436 if (label->mnemonic_widget)
1438 g_object_weak_ref (G_OBJECT (label->mnemonic_widget),
1439 label_mnemonic_widget_weak_notify,
1441 gtk_widget_add_mnemonic_label (label->mnemonic_widget, GTK_WIDGET (label));
1444 g_object_notify (G_OBJECT (label), "mnemonic-widget");
1448 * gtk_label_get_mnemonic_widget:
1449 * @label: a #GtkLabel
1451 * Retrieves the target of the mnemonic (keyboard shortcut) of this
1452 * label. See gtk_label_set_mnemonic_widget().
1454 * Return value: the target of the label's mnemonic, or %NULL if none
1455 * has been set and the default algorithm will be used.
1458 gtk_label_get_mnemonic_widget (GtkLabel *label)
1460 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1462 return label->mnemonic_widget;
1466 * gtk_label_get_mnemonic_keyval:
1467 * @label: a #GtkLabel
1469 * If the label has been set so that it has an mnemonic key this function
1470 * returns the keyval used for the mnemonic accelerator. If there is no
1471 * mnemonic set up it returns #GDK_VoidSymbol.
1473 * Returns: GDK keyval usable for accelerators, or #GDK_VoidSymbol
1476 gtk_label_get_mnemonic_keyval (GtkLabel *label)
1478 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);
1480 return label->mnemonic_keyval;
1484 gtk_label_set_text_internal (GtkLabel *label,
1487 g_free (label->text);
1491 gtk_label_select_region_index (label, 0, 0);
1495 gtk_label_set_label_internal (GtkLabel *label,
1498 g_free (label->label);
1502 g_object_notify (G_OBJECT (label), "label");
1506 gtk_label_set_use_markup_internal (GtkLabel *label,
1510 if (label->use_markup != val)
1512 label->use_markup = val;
1514 g_object_notify (G_OBJECT (label), "use-markup");
1519 gtk_label_set_use_underline_internal (GtkLabel *label,
1523 if (label->use_underline != val)
1525 label->use_underline = val;
1527 g_object_notify (G_OBJECT (label), "use-underline");
1532 gtk_label_set_attributes_internal (GtkLabel *label,
1533 PangoAttrList *attrs)
1536 pango_attr_list_ref (attrs);
1539 pango_attr_list_unref (label->attrs);
1541 if (!label->use_markup && !label->use_underline)
1544 pango_attr_list_ref (attrs);
1545 if (label->effective_attrs)
1546 pango_attr_list_unref (label->effective_attrs);
1547 label->effective_attrs = attrs;
1550 label->attrs = attrs;
1551 g_object_notify (G_OBJECT (label), "attributes");
1555 /* Calculates text, attrs and mnemonic_keyval from
1556 * label, use_underline and use_markup
1559 gtk_label_recalculate (GtkLabel *label)
1561 guint keyval = label->mnemonic_keyval;
1563 if (label->use_markup)
1564 set_markup (label, label->label, label->use_underline);
1567 if (label->use_underline)
1568 gtk_label_set_uline_text_internal (label, label->label);
1571 gtk_label_set_text_internal (label, g_strdup (label->label));
1573 pango_attr_list_ref (label->attrs);
1574 if (label->effective_attrs)
1575 pango_attr_list_unref (label->effective_attrs);
1576 label->effective_attrs = label->attrs;
1580 if (!label->use_underline)
1581 label->mnemonic_keyval = GDK_VoidSymbol;
1583 if (keyval != label->mnemonic_keyval)
1585 gtk_label_setup_mnemonic (label, keyval);
1586 g_object_notify (G_OBJECT (label), "mnemonic-keyval");
1589 gtk_label_clear_layout (label);
1590 gtk_widget_queue_resize (GTK_WIDGET (label));
1594 * gtk_label_set_text:
1595 * @label: a #GtkLabel
1596 * @str: The text you want to set
1598 * Sets the text within the #GtkLabel widget. It overwrites any text that
1601 * This will also clear any previously set mnemonic accelerators.
1604 gtk_label_set_text (GtkLabel *label,
1607 g_return_if_fail (GTK_IS_LABEL (label));
1609 g_object_freeze_notify (G_OBJECT (label));
1611 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1612 gtk_label_set_use_markup_internal (label, FALSE);
1613 gtk_label_set_use_underline_internal (label, FALSE);
1615 gtk_label_recalculate (label);
1617 g_object_thaw_notify (G_OBJECT (label));
1621 * gtk_label_set_attributes:
1622 * @label: a #GtkLabel
1623 * @attrs: a #PangoAttrList
1625 * Sets a #PangoAttrList; the attributes in the list are applied to the
1626 * label text. The attributes set with this function will be ignored
1627 * if the #GtkLabel:use-underline" or #GtkLabel:use-markup properties
1631 gtk_label_set_attributes (GtkLabel *label,
1632 PangoAttrList *attrs)
1634 g_return_if_fail (GTK_IS_LABEL (label));
1636 gtk_label_set_attributes_internal (label, attrs);
1638 gtk_label_clear_layout (label);
1639 gtk_widget_queue_resize (GTK_WIDGET (label));
1643 * gtk_label_get_attributes:
1644 * @label: a #GtkLabel
1646 * Gets the attribute list that was set on the label using
1647 * gtk_label_set_attributes(), if any. This function does
1648 * not reflect attributes that come from the labels markup
1649 * (see gtk_label_set_markup()). If you want to get the
1650 * effective attributes for the label, use
1651 * pango_layout_get_attribute (gtk_label_get_layout (label)).
1653 * Return value: the attribute list, or %NULL if none was set.
1656 gtk_label_get_attributes (GtkLabel *label)
1658 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1660 return label->attrs;
1664 * gtk_label_set_label:
1665 * @label: a #GtkLabel
1666 * @str: the new text to set for the label
1668 * Sets the text of the label. The label is interpreted as
1669 * including embedded underlines and/or Pango markup depending
1670 * on the values of the #GtkLabel:use-underline" and
1671 * #GtkLabel:use-markup properties.
1674 gtk_label_set_label (GtkLabel *label,
1677 g_return_if_fail (GTK_IS_LABEL (label));
1678 g_return_if_fail (str != NULL);
1680 g_object_freeze_notify (G_OBJECT (label));
1682 gtk_label_set_label_internal (label, g_strdup (str));
1683 gtk_label_recalculate (label);
1685 g_object_thaw_notify (G_OBJECT (label));
1689 * gtk_label_get_label:
1690 * @label: a #GtkLabel
1692 * Fetches the text from a label widget including any embedded
1693 * underlines indicating mnemonics and Pango markup. (See
1694 * gtk_label_get_text()).
1696 * Return value: the text of the label widget. This string is
1697 * owned by the widget and must not be modified or freed.
1699 G_CONST_RETURN gchar *
1700 gtk_label_get_label (GtkLabel *label)
1702 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1704 return label->label;
1708 set_markup (GtkLabel *label,
1710 gboolean with_uline)
1713 GError *error = NULL;
1714 PangoAttrList *attrs = NULL;
1715 gunichar accel_char = 0;
1717 if (!pango_parse_markup (str,
1719 with_uline ? '_' : 0,
1722 with_uline ? &accel_char : NULL,
1725 g_warning ("Failed to set text from markup due to error parsing markup: %s",
1727 g_error_free (error);
1732 gtk_label_set_text_internal (label, text);
1736 if (label->effective_attrs)
1737 pango_attr_list_unref (label->effective_attrs);
1738 label->effective_attrs = attrs;
1741 if (accel_char != 0)
1742 label->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
1744 label->mnemonic_keyval = GDK_VoidSymbol;
1748 * gtk_label_set_markup:
1749 * @label: a #GtkLabel
1750 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
1752 * Parses @str which is marked up with the <link
1753 * linkend="PangoMarkupFormat">Pango text markup language</link>, setting the
1754 * label's text and attribute list based on the parse results. If the @str is
1755 * external data, you may need to escape it with g_markup_escape_text() or
1756 * g_markup_printf_escaped()<!-- -->:
1760 * markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str);
1761 * gtk_label_set_markup (GTK_LABEL (label), markup);
1766 gtk_label_set_markup (GtkLabel *label,
1769 g_return_if_fail (GTK_IS_LABEL (label));
1771 g_object_freeze_notify (G_OBJECT (label));
1773 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1774 gtk_label_set_use_markup_internal (label, TRUE);
1775 gtk_label_set_use_underline_internal (label, FALSE);
1777 gtk_label_recalculate (label);
1779 g_object_thaw_notify (G_OBJECT (label));
1783 * gtk_label_set_markup_with_mnemonic:
1784 * @label: a #GtkLabel
1785 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
1787 * Parses @str which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>,
1788 * setting the label's text and attribute list based on the parse results.
1789 * If characters in @str are preceded by an underscore, they are underlined
1790 * indicating that they represent a keyboard accelerator called a mnemonic.
1792 * The mnemonic key can be used to activate another widget, chosen
1793 * automatically, or explicitly using gtk_label_set_mnemonic_widget().
1796 gtk_label_set_markup_with_mnemonic (GtkLabel *label,
1799 g_return_if_fail (GTK_IS_LABEL (label));
1801 g_object_freeze_notify (G_OBJECT (label));
1803 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
1804 gtk_label_set_use_markup_internal (label, TRUE);
1805 gtk_label_set_use_underline_internal (label, TRUE);
1807 gtk_label_recalculate (label);
1809 g_object_thaw_notify (G_OBJECT (label));
1813 * gtk_label_get_text:
1814 * @label: a #GtkLabel
1816 * Fetches the text from a label widget, as displayed on the
1817 * screen. This does not include any embedded underlines
1818 * indicating mnemonics or Pango markup. (See gtk_label_get_label())
1820 * Return value: the text in the label widget. This is the internal
1821 * string used by the label, and must not be modified.
1823 G_CONST_RETURN gchar *
1824 gtk_label_get_text (GtkLabel *label)
1826 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
1831 static PangoAttrList *
1832 gtk_label_pattern_to_attrs (GtkLabel *label,
1833 const gchar *pattern)
1836 const char *p = label->text;
1837 const char *q = pattern;
1838 PangoAttrList *attrs;
1840 attrs = pango_attr_list_new ();
1844 while (*p && *q && *q != '_')
1846 p = g_utf8_next_char (p);
1850 while (*p && *q && *q == '_')
1852 p = g_utf8_next_char (p);
1858 PangoAttribute *attr = pango_attr_underline_new (PANGO_UNDERLINE_LOW);
1859 attr->start_index = start - label->text;
1860 attr->end_index = p - label->text;
1862 pango_attr_list_insert (attrs, attr);
1872 gtk_label_set_pattern_internal (GtkLabel *label,
1873 const gchar *pattern)
1875 PangoAttrList *attrs;
1876 gboolean enable_mnemonics;
1878 g_return_if_fail (GTK_IS_LABEL (label));
1880 if (label->pattern_set)
1883 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
1884 "gtk-enable-mnemonics", &enable_mnemonics,
1887 if (enable_mnemonics && pattern)
1888 attrs = gtk_label_pattern_to_attrs (label, pattern);
1892 if (label->effective_attrs)
1893 pango_attr_list_unref (label->effective_attrs);
1894 label->effective_attrs = attrs;
1898 gtk_label_set_pattern (GtkLabel *label,
1899 const gchar *pattern)
1901 g_return_if_fail (GTK_IS_LABEL (label));
1903 label->pattern_set = FALSE;
1907 gtk_label_set_pattern_internal (label, pattern);
1908 label->pattern_set = TRUE;
1911 gtk_label_recalculate (label);
1913 gtk_label_clear_layout (label);
1914 gtk_widget_queue_resize (GTK_WIDGET (label));
1919 * gtk_label_set_justify:
1920 * @label: a #GtkLabel
1921 * @jtype: a #GtkJustification
1923 * Sets the alignment of the lines in the text of the label relative to
1924 * each other. %GTK_JUSTIFY_LEFT is the default value when the
1925 * widget is first created with gtk_label_new(). If you instead want
1926 * to set the alignment of the label as a whole, use
1927 * gtk_misc_set_alignment() instead. gtk_label_set_justify() has no
1928 * effect on labels containing only a single line.
1931 gtk_label_set_justify (GtkLabel *label,
1932 GtkJustification jtype)
1934 g_return_if_fail (GTK_IS_LABEL (label));
1935 g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
1937 if ((GtkJustification) label->jtype != jtype)
1939 label->jtype = jtype;
1941 /* No real need to be this drastic, but easier than duplicating the code */
1942 gtk_label_clear_layout (label);
1944 g_object_notify (G_OBJECT (label), "justify");
1945 gtk_widget_queue_resize (GTK_WIDGET (label));
1950 * gtk_label_get_justify:
1951 * @label: a #GtkLabel
1953 * Returns the justification of the label. See gtk_label_set_justify().
1955 * Return value: #GtkJustification
1958 gtk_label_get_justify (GtkLabel *label)
1960 g_return_val_if_fail (GTK_IS_LABEL (label), 0);
1962 return label->jtype;
1966 * gtk_label_set_ellipsize:
1967 * @label: a #GtkLabel
1968 * @mode: a #PangoEllipsizeMode
1970 * Sets the mode used to ellipsize (add an ellipsis: "...") to the text
1971 * if there is not enough space to render the entire string.
1976 gtk_label_set_ellipsize (GtkLabel *label,
1977 PangoEllipsizeMode mode)
1979 g_return_if_fail (GTK_IS_LABEL (label));
1980 g_return_if_fail (mode >= PANGO_ELLIPSIZE_NONE && mode <= PANGO_ELLIPSIZE_END);
1982 if ((PangoEllipsizeMode) label->ellipsize != mode)
1984 label->ellipsize = mode;
1986 /* No real need to be this drastic, but easier than duplicating the code */
1987 gtk_label_clear_layout (label);
1989 g_object_notify (G_OBJECT (label), "ellipsize");
1990 gtk_widget_queue_resize (GTK_WIDGET (label));
1995 * gtk_label_get_ellipsize:
1996 * @label: a #GtkLabel
1998 * Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
2000 * Return value: #PangoEllipsizeMode
2005 gtk_label_get_ellipsize (GtkLabel *label)
2007 g_return_val_if_fail (GTK_IS_LABEL (label), PANGO_ELLIPSIZE_NONE);
2009 return label->ellipsize;
2013 * gtk_label_set_width_chars:
2014 * @label: a #GtkLabel
2015 * @n_chars: the new desired width, in characters.
2017 * Sets the desired width in characters of @label to @n_chars.
2022 gtk_label_set_width_chars (GtkLabel *label,
2025 GtkLabelPrivate *priv;
2027 g_return_if_fail (GTK_IS_LABEL (label));
2029 priv = GTK_LABEL_GET_PRIVATE (label);
2031 if (priv->width_chars != n_chars)
2033 priv->width_chars = n_chars;
2034 g_object_notify (G_OBJECT (label), "width-chars");
2035 gtk_label_invalidate_wrap_width (label);
2036 gtk_widget_queue_resize (GTK_WIDGET (label));
2041 * gtk_label_get_width_chars:
2042 * @label: a #GtkLabel
2044 * Retrieves the desired width of @label, in characters. See
2045 * gtk_label_set_width_chars().
2047 * Return value: the width of the label in characters.
2052 gtk_label_get_width_chars (GtkLabel *label)
2054 g_return_val_if_fail (GTK_IS_LABEL (label), -1);
2056 return GTK_LABEL_GET_PRIVATE (label)->width_chars;
2060 * gtk_label_set_max_width_chars:
2061 * @label: a #GtkLabel
2062 * @n_chars: the new desired maximum width, in characters.
2064 * Sets the desired maximum width in characters of @label to @n_chars.
2069 gtk_label_set_max_width_chars (GtkLabel *label,
2072 GtkLabelPrivate *priv;
2074 g_return_if_fail (GTK_IS_LABEL (label));
2076 priv = GTK_LABEL_GET_PRIVATE (label);
2078 if (priv->max_width_chars != n_chars)
2080 priv->max_width_chars = n_chars;
2082 g_object_notify (G_OBJECT (label), "max-width-chars");
2083 gtk_label_invalidate_wrap_width (label);
2084 gtk_widget_queue_resize (GTK_WIDGET (label));
2089 * gtk_label_get_max_width_chars:
2090 * @label: a #GtkLabel
2092 * Retrieves the desired maximum width of @label, in characters. See
2093 * gtk_label_set_width_chars().
2095 * Return value: the maximum width of the label in characters.
2100 gtk_label_get_max_width_chars (GtkLabel *label)
2102 g_return_val_if_fail (GTK_IS_LABEL (label), -1);
2104 return GTK_LABEL_GET_PRIVATE (label)->max_width_chars;
2108 * gtk_label_set_line_wrap:
2109 * @label: a #GtkLabel
2110 * @wrap: the setting
2112 * Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
2113 * lines if text exceeds the widget's size. %FALSE lets the text get cut off
2114 * by the edge of the widget if it exceeds the widget size.
2116 * Note that setting line wrapping to %TRUE does not make the label
2117 * wrap at its parent container's width, because GTK+ widgets
2118 * conceptually can't make their requisition depend on the parent
2119 * container's size. For a label that wraps at a specific position,
2120 * set the label's width using gtk_widget_set_size_request().
2123 gtk_label_set_line_wrap (GtkLabel *label,
2126 g_return_if_fail (GTK_IS_LABEL (label));
2128 wrap = wrap != FALSE;
2130 if (label->wrap != wrap)
2134 gtk_label_clear_layout (label);
2135 gtk_widget_queue_resize (GTK_WIDGET (label));
2136 g_object_notify (G_OBJECT (label), "wrap");
2141 * gtk_label_get_line_wrap:
2142 * @label: a #GtkLabel
2144 * Returns whether lines in the label are automatically wrapped.
2145 * See gtk_label_set_line_wrap().
2147 * Return value: %TRUE if the lines of the label are automatically wrapped.
2150 gtk_label_get_line_wrap (GtkLabel *label)
2152 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
2158 * gtk_label_set_line_wrap_mode:
2159 * @label: a #GtkLabel
2160 * @wrap_mode: the line wrapping mode
2162 * If line wrapping is on (see gtk_label_set_line_wrap()) this controls how
2163 * the line wrapping is done. The default is %PANGO_WRAP_WORD which means
2164 * wrap on word boundaries.
2169 gtk_label_set_line_wrap_mode (GtkLabel *label,
2170 PangoWrapMode wrap_mode)
2172 g_return_if_fail (GTK_IS_LABEL (label));
2174 if (label->wrap_mode != wrap_mode)
2176 label->wrap_mode = wrap_mode;
2177 g_object_notify (G_OBJECT (label), "wrap-mode");
2179 gtk_widget_queue_resize (GTK_WIDGET (label));
2184 * gtk_label_get_line_wrap_mode:
2185 * @label: a #GtkLabel
2187 * Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode().
2189 * Return value: %TRUE if the lines of the label are automatically wrapped.
2194 gtk_label_get_line_wrap_mode (GtkLabel *label)
2196 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
2198 return label->wrap_mode;
2203 gtk_label_get (GtkLabel *label,
2206 g_return_if_fail (GTK_IS_LABEL (label));
2207 g_return_if_fail (str != NULL);
2213 gtk_label_destroy (GtkObject *object)
2215 GtkLabel *label = GTK_LABEL (object);
2217 gtk_label_set_mnemonic_widget (label, NULL);
2219 GTK_OBJECT_CLASS (gtk_label_parent_class)->destroy (object);
2223 gtk_label_finalize (GObject *object)
2225 GtkLabel *label = GTK_LABEL (object);
2227 g_free (label->label);
2228 g_free (label->text);
2231 g_object_unref (label->layout);
2234 pango_attr_list_unref (label->attrs);
2236 if (label->effective_attrs)
2237 pango_attr_list_unref (label->effective_attrs);
2239 g_free (label->select_info);
2241 G_OBJECT_CLASS (gtk_label_parent_class)->finalize (object);
2245 gtk_label_clear_layout (GtkLabel *label)
2249 g_object_unref (label->layout);
2250 label->layout = NULL;
2255 get_label_char_width (GtkLabel *label)
2257 GtkLabelPrivate *priv;
2258 PangoContext *context;
2259 PangoFontMetrics *metrics;
2260 gint char_width, digit_width, char_pixels, w;
2262 priv = GTK_LABEL_GET_PRIVATE (label);
2264 context = pango_layout_get_context (label->layout);
2265 metrics = pango_context_get_metrics (context, GTK_WIDGET (label)->style->font_desc,
2266 pango_context_get_language (context));
2268 char_width = pango_font_metrics_get_approximate_char_width (metrics);
2269 digit_width = pango_font_metrics_get_approximate_digit_width (metrics);
2270 char_pixels = MAX (char_width, digit_width);
2271 pango_font_metrics_unref (metrics);
2273 if (priv->width_chars < 0)
2275 PangoRectangle rect;
2277 pango_layout_set_width (label->layout, -1);
2278 pango_layout_get_extents (label->layout, NULL, &rect);
2280 w = char_pixels * MAX (priv->max_width_chars, 3);
2281 w = MIN (rect.width, w);
2285 /* enforce minimum width for ellipsized labels at ~3 chars */
2286 w = char_pixels * MAX (priv->width_chars, 3);
2293 gtk_label_invalidate_wrap_width (GtkLabel *label)
2295 GtkLabelPrivate *priv;
2297 priv = GTK_LABEL_GET_PRIVATE (label);
2299 priv->wrap_width = -1;
2303 get_label_wrap_width (GtkLabel *label)
2305 GtkLabelPrivate *priv;
2307 priv = GTK_LABEL_GET_PRIVATE (label);
2309 if (priv->wrap_width < 0)
2311 if (priv->width_chars > 0 || priv->max_width_chars > 0)
2312 priv->wrap_width = get_label_char_width (label);
2315 PangoLayout *layout;
2317 layout = gtk_widget_create_pango_layout (GTK_WIDGET (label),
2318 "This long string gives a good enough length for any line to have.");
2319 pango_layout_get_size (layout, &priv->wrap_width, NULL);
2320 g_object_unref (layout);
2324 return priv->wrap_width;
2328 gtk_label_ensure_layout (GtkLabel *label)
2331 PangoRectangle logical_rect;
2334 widget = GTK_WIDGET (label);
2336 rtl = gtk_widget_get_direction(widget) == GTK_TEXT_DIR_RTL;
2340 PangoAlignment align = PANGO_ALIGN_LEFT; /* Quiet gcc */
2341 gdouble angle = gtk_label_get_angle (label);
2343 if (angle != 0.0 && !label->wrap && !label->ellipsize && !label->select_info)
2345 /* We rotate the standard singleton PangoContext for the widget,
2346 * depending on the fact that it's meant pretty much exclusively
2349 PangoMatrix matrix = PANGO_MATRIX_INIT;
2351 pango_matrix_rotate (&matrix, angle);
2353 pango_context_set_matrix (gtk_widget_get_pango_context (widget), &matrix);
2355 label->have_transform = TRUE;
2359 if (label->have_transform)
2360 pango_context_set_matrix (gtk_widget_get_pango_context (widget), NULL);
2362 label->have_transform = FALSE;
2365 label->layout = gtk_widget_create_pango_layout (widget, label->text);
2367 if (label->effective_attrs)
2368 pango_layout_set_attributes (label->layout, label->effective_attrs);
2370 switch (label->jtype)
2372 case GTK_JUSTIFY_LEFT:
2373 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
2375 case GTK_JUSTIFY_RIGHT:
2376 align = rtl ? PANGO_ALIGN_LEFT : PANGO_ALIGN_RIGHT;
2378 case GTK_JUSTIFY_CENTER:
2379 align = PANGO_ALIGN_CENTER;
2381 case GTK_JUSTIFY_FILL:
2382 align = rtl ? PANGO_ALIGN_RIGHT : PANGO_ALIGN_LEFT;
2383 pango_layout_set_justify (label->layout, TRUE);
2386 g_assert_not_reached();
2389 pango_layout_set_alignment (label->layout, align);
2390 pango_layout_set_ellipsize (label->layout, label->ellipsize);
2391 pango_layout_set_single_paragraph_mode (label->layout, label->single_line_mode);
2393 if (label->ellipsize)
2394 pango_layout_set_width (label->layout,
2395 widget->allocation.width * PANGO_SCALE);
2396 else if (label->wrap)
2398 GtkWidgetAuxInfo *aux_info;
2399 gint longest_paragraph;
2402 pango_layout_set_wrap (label->layout, label->wrap_mode);
2404 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
2405 if (aux_info && aux_info->width > 0)
2406 pango_layout_set_width (label->layout, aux_info->width * PANGO_SCALE);
2409 GdkScreen *screen = gtk_widget_get_screen (GTK_WIDGET (label));
2412 pango_layout_set_width (label->layout, -1);
2413 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2415 width = logical_rect.width;
2417 /* Try to guess a reasonable maximum width */
2418 longest_paragraph = width;
2420 wrap_width = get_label_wrap_width (label);
2421 width = MIN (width, wrap_width);
2423 PANGO_SCALE * (gdk_screen_get_width (screen) + 1) / 2);
2425 pango_layout_set_width (label->layout, width);
2426 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2427 width = logical_rect.width;
2428 height = logical_rect.height;
2430 /* Unfortunately, the above may leave us with a very unbalanced looking paragraph,
2431 * so we try short search for a narrower width that leaves us with the same height
2433 if (longest_paragraph > 0)
2435 gint nlines, perfect_width;
2437 nlines = pango_layout_get_line_count (label->layout);
2438 perfect_width = (longest_paragraph + nlines - 1) / nlines;
2440 if (perfect_width < width)
2442 pango_layout_set_width (label->layout, perfect_width);
2443 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2445 if (logical_rect.height <= height)
2446 width = logical_rect.width;
2449 gint mid_width = (perfect_width + width) / 2;
2451 if (mid_width > perfect_width)
2453 pango_layout_set_width (label->layout, mid_width);
2454 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2456 if (logical_rect.height <= height)
2457 width = logical_rect.width;
2462 pango_layout_set_width (label->layout, width);
2465 else /* !label->wrap */
2466 pango_layout_set_width (label->layout, -1);
2471 gtk_label_size_request (GtkWidget *widget,
2472 GtkRequisition *requisition)
2474 GtkLabel *label = GTK_LABEL (widget);
2475 GtkLabelPrivate *priv;
2477 PangoRectangle logical_rect;
2478 GtkWidgetAuxInfo *aux_info;
2480 priv = GTK_LABEL_GET_PRIVATE (widget);
2483 * If word wrapping is on, then the height requisition can depend
2486 * - Any width set on the widget via gtk_widget_set_size_request().
2487 * - The padding of the widget (xpad, set by gtk_misc_set_padding)
2489 * Instead of trying to detect changes to these quantities, if we
2490 * are wrapping, we just rewrap for each size request. Since
2491 * size requisitions are cached by the GTK+ core, this is not
2496 gtk_label_clear_layout (label);
2498 gtk_label_ensure_layout (label);
2500 width = label->misc.xpad * 2;
2501 height = label->misc.ypad * 2;
2503 aux_info = _gtk_widget_get_aux_info (widget, FALSE);
2505 if (label->have_transform)
2507 PangoRectangle rect;
2508 PangoContext *context = pango_layout_get_context (label->layout);
2509 const PangoMatrix *matrix = pango_context_get_matrix (context);
2511 pango_layout_get_extents (label->layout, NULL, &rect);
2512 pango_matrix_transform_rectangle (matrix, &rect);
2513 pango_extents_to_pixels (&rect, NULL);
2515 requisition->width = width + rect.width;
2516 requisition->height = height + rect.height;
2521 pango_layout_get_extents (label->layout, NULL, &logical_rect);
2523 if ((label->wrap || label->ellipsize ||
2524 priv->width_chars > 0 || priv->max_width_chars > 0) &&
2525 aux_info && aux_info->width > 0)
2526 width += aux_info->width;
2527 else if (label->ellipsize || priv->width_chars > 0 || priv->max_width_chars > 0)
2529 width += PANGO_PIXELS (get_label_char_width (label));
2532 width += PANGO_PIXELS (logical_rect.width);
2534 if (label->single_line_mode)
2536 PangoContext *context;
2537 PangoFontMetrics *metrics;
2538 gint ascent, descent;
2540 context = pango_layout_get_context (label->layout);
2541 metrics = pango_context_get_metrics (context, widget->style->font_desc,
2542 pango_context_get_language (context));
2544 ascent = pango_font_metrics_get_ascent (metrics);
2545 descent = pango_font_metrics_get_descent (metrics);
2546 pango_font_metrics_unref (metrics);
2548 height += PANGO_PIXELS (ascent + descent);
2551 height += PANGO_PIXELS (logical_rect.height);
2553 requisition->width = width;
2554 requisition->height = height;
2558 gtk_label_size_allocate (GtkWidget *widget,
2559 GtkAllocation *allocation)
2563 label = GTK_LABEL (widget);
2565 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->size_allocate) (widget, allocation);
2567 if (label->ellipsize)
2572 PangoRectangle logical;
2574 width = (allocation->width - label->misc.xpad * 2) * PANGO_SCALE;
2576 pango_layout_set_width (label->layout, -1);
2577 pango_layout_get_extents (label->layout, NULL, &logical);
2579 if (logical.width > width)
2580 pango_layout_set_width (label->layout, width);
2584 if (label->select_info && label->select_info->window)
2586 gdk_window_move_resize (label->select_info->window,
2590 allocation->height);
2595 gtk_label_state_changed (GtkWidget *widget,
2596 GtkStateType prev_state)
2601 label = GTK_LABEL (widget);
2603 if (label->select_info)
2605 gtk_label_select_region (label, 0, 0);
2607 if (GTK_WIDGET_REALIZED (widget))
2609 if (GTK_WIDGET_IS_SENSITIVE (widget))
2610 cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget), GDK_XTERM);
2614 gdk_window_set_cursor (label->select_info->window, cursor);
2617 gdk_cursor_unref (cursor);
2621 if (GTK_WIDGET_CLASS (gtk_label_parent_class)->state_changed)
2622 GTK_WIDGET_CLASS (gtk_label_parent_class)->state_changed (widget, prev_state);
2626 gtk_label_style_set (GtkWidget *widget,
2627 GtkStyle *previous_style)
2629 GtkLabel *label = GTK_LABEL (widget);
2631 /* We have to clear the layout, fonts etc. may have changed */
2632 gtk_label_clear_layout (label);
2633 gtk_label_invalidate_wrap_width (label);
2637 gtk_label_direction_changed (GtkWidget *widget,
2638 GtkTextDirection previous_dir)
2640 GtkLabel *label = GTK_LABEL (widget);
2643 pango_layout_context_changed (label->layout);
2645 GTK_WIDGET_CLASS (gtk_label_parent_class)->direction_changed (widget, previous_dir);
2649 get_layout_location (GtkLabel *label,
2655 GtkLabelPrivate *priv;
2657 gint req_width, x, y;
2658 PangoRectangle logical;
2660 misc = GTK_MISC (label);
2661 widget = GTK_WIDGET (label);
2662 priv = GTK_LABEL_GET_PRIVATE (label);
2664 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
2665 xalign = misc->xalign;
2667 xalign = 1.0 - misc->xalign;
2669 pango_layout_get_pixel_extents (label->layout, NULL, &logical);
2671 if (label->ellipsize || priv->width_chars > 0)
2675 width = pango_layout_get_width (label->layout);
2677 req_width = logical.width;
2679 req_width = MIN(PANGO_PIXELS (width), req_width);
2680 req_width += 2 * misc->xpad;
2683 req_width = widget->requisition.width;
2685 x = floor (widget->allocation.x + (gint)misc->xpad +
2686 xalign * (widget->allocation.width - req_width));
2688 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
2689 x = MAX (x, widget->allocation.x + misc->xpad);
2691 x = MIN (x, widget->allocation.x + widget->allocation.width - misc->xpad);
2694 y = floor (widget->allocation.y + (gint)misc->ypad
2695 + MAX (((widget->allocation.height - widget->requisition.height) * misc->yalign),
2706 draw_insertion_cursor (GtkLabel *label,
2707 GdkRectangle *cursor_location,
2708 gboolean is_primary,
2709 PangoDirection direction,
2710 gboolean draw_arrow)
2712 GtkWidget *widget = GTK_WIDGET (label);
2713 GtkTextDirection text_dir;
2715 if (direction == PANGO_DIRECTION_LTR)
2716 text_dir = GTK_TEXT_DIR_LTR;
2718 text_dir = GTK_TEXT_DIR_RTL;
2720 gtk_draw_insertion_cursor (widget, widget->window, &(widget->allocation),
2722 is_primary, text_dir, draw_arrow);
2725 static PangoDirection
2726 get_cursor_direction (GtkLabel *label)
2730 g_assert (label->select_info);
2732 gtk_label_ensure_layout (label);
2734 for (l = pango_layout_get_lines_readonly (label->layout); l; l = l->next)
2736 PangoLayoutLine *line = l->data;
2738 /* If label->select_info->selection_end is at the very end of
2739 * the line, we don't know if the cursor is on this line or
2740 * the next without looking ahead at the next line. (End
2741 * of paragraph is different from line break.) But it's
2742 * definitely in this paragraph, which is good enough
2743 * to figure out the resolved direction.
2745 if (line->start_index + line->length >= label->select_info->selection_end)
2746 return line->resolved_dir;
2749 return PANGO_DIRECTION_LTR;
2753 gtk_label_draw_cursor (GtkLabel *label, gint xoffset, gint yoffset)
2755 if (label->select_info == NULL)
2758 if (GTK_WIDGET_DRAWABLE (label))
2760 GtkWidget *widget = GTK_WIDGET (label);
2762 PangoDirection keymap_direction;
2763 PangoDirection cursor_direction;
2764 PangoRectangle strong_pos, weak_pos;
2765 gboolean split_cursor;
2766 PangoRectangle *cursor1 = NULL;
2767 PangoRectangle *cursor2 = NULL;
2768 GdkRectangle cursor_location;
2769 PangoDirection dir1 = PANGO_DIRECTION_NEUTRAL;
2770 PangoDirection dir2 = PANGO_DIRECTION_NEUTRAL;
2772 keymap_direction = gdk_keymap_get_direction (gdk_keymap_get_for_display (gtk_widget_get_display (widget)));
2773 cursor_direction = get_cursor_direction (label);
2775 gtk_label_ensure_layout (label);
2777 pango_layout_get_cursor_pos (label->layout, label->select_info->selection_end,
2778 &strong_pos, &weak_pos);
2780 g_object_get (gtk_widget_get_settings (widget),
2781 "gtk-split-cursor", &split_cursor,
2784 dir1 = cursor_direction;
2788 cursor1 = &strong_pos;
2790 if (strong_pos.x != weak_pos.x ||
2791 strong_pos.y != weak_pos.y)
2793 dir2 = (cursor_direction == PANGO_DIRECTION_LTR) ? PANGO_DIRECTION_RTL : PANGO_DIRECTION_LTR;
2794 cursor2 = &weak_pos;
2799 if (keymap_direction == cursor_direction)
2800 cursor1 = &strong_pos;
2802 cursor1 = &weak_pos;
2805 cursor_location.x = xoffset + PANGO_PIXELS (cursor1->x);
2806 cursor_location.y = yoffset + PANGO_PIXELS (cursor1->y);
2807 cursor_location.width = 0;
2808 cursor_location.height = PANGO_PIXELS (cursor1->height);
2810 draw_insertion_cursor (label,
2811 &cursor_location, TRUE, dir1,
2812 dir2 != PANGO_DIRECTION_NEUTRAL);
2814 if (dir2 != PANGO_DIRECTION_NEUTRAL)
2816 cursor_location.x = xoffset + PANGO_PIXELS (cursor2->x);
2817 cursor_location.y = yoffset + PANGO_PIXELS (cursor2->y);
2818 cursor_location.width = 0;
2819 cursor_location.height = PANGO_PIXELS (cursor2->height);
2821 draw_insertion_cursor (label,
2822 &cursor_location, FALSE, dir2,
2830 gtk_label_expose (GtkWidget *widget,
2831 GdkEventExpose *event)
2836 g_return_val_if_fail (GTK_IS_LABEL (widget), FALSE);
2837 g_return_val_if_fail (event != NULL, FALSE);
2839 label = GTK_LABEL (widget);
2841 gtk_label_ensure_layout (label);
2843 if (GTK_WIDGET_VISIBLE (widget) && GTK_WIDGET_MAPPED (widget) &&
2844 label->text && (*label->text != '\0'))
2846 get_layout_location (label, &x, &y);
2848 gtk_paint_layout (widget->style,
2850 GTK_WIDGET_STATE (widget),
2858 if (label->select_info &&
2859 (label->select_info->selection_anchor !=
2860 label->select_info->selection_end))
2866 range[0] = label->select_info->selection_anchor;
2867 range[1] = label->select_info->selection_end;
2869 if (range[0] > range[1])
2871 gint tmp = range[0];
2872 range[0] = range[1];
2876 clip = gdk_pango_layout_get_clip_region (label->layout,
2880 gdk_region_intersect (clip, event->region);
2882 /* FIXME should use gtk_paint, but it can't use a clip
2886 gdk_gc_set_clip_region (widget->style->black_gc, clip);
2889 state = GTK_STATE_SELECTED;
2890 if (!GTK_WIDGET_HAS_FOCUS (widget))
2891 state = GTK_STATE_ACTIVE;
2893 gdk_draw_layout_with_colors (widget->window,
2894 widget->style->black_gc,
2897 &widget->style->text[state],
2898 &widget->style->base[state]);
2900 gdk_gc_set_clip_region (widget->style->black_gc, NULL);
2901 gdk_region_destroy (clip);
2903 else if (label->select_info && GTK_WIDGET_HAS_FOCUS (widget))
2904 gtk_label_draw_cursor (label, x, y);
2911 gtk_label_set_uline_text_internal (GtkLabel *label,
2914 guint accel_key = GDK_VoidSymbol;
2919 gchar *dest, *pattern_dest;
2920 gboolean underscore;
2922 g_return_if_fail (GTK_IS_LABEL (label));
2923 g_return_if_fail (str != NULL);
2925 /* Split text into the base text and a separate pattern
2929 new_str = g_new (gchar, strlen (str) + 1);
2930 pattern = g_new (gchar, g_utf8_strlen (str, -1) + 1);
2939 pattern_dest = pattern;
2946 c = g_utf8_get_char (src);
2947 if (c == (gunichar)-1)
2949 g_warning ("Invalid input string");
2954 next_src = g_utf8_next_char (src);
2959 *pattern_dest++ = ' ';
2962 *pattern_dest++ = '_';
2963 if (accel_key == GDK_VoidSymbol)
2964 accel_key = gdk_keyval_to_lower (gdk_unicode_to_keyval (c));
2967 while (src < next_src)
2981 while (src < next_src)
2984 *pattern_dest++ = ' ';
2991 gtk_label_set_text_internal (label, new_str);
2992 gtk_label_set_pattern_internal (label, pattern);
2996 label->mnemonic_keyval = accel_key;
3000 gtk_label_parse_uline (GtkLabel *label,
3005 g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);
3006 g_return_val_if_fail (str != NULL, GDK_VoidSymbol);
3008 g_object_freeze_notify (G_OBJECT (label));
3010 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
3011 gtk_label_set_use_markup_internal (label, FALSE);
3012 gtk_label_set_use_underline_internal (label, TRUE);
3014 gtk_label_recalculate (label);
3016 keyval = label->mnemonic_keyval;
3017 if (keyval != GDK_VoidSymbol)
3019 label->mnemonic_keyval = GDK_VoidSymbol;
3020 gtk_label_setup_mnemonic (label, keyval);
3021 g_object_notify (G_OBJECT (label), "mnemonic-keyval");
3024 g_object_thaw_notify (G_OBJECT (label));
3030 * gtk_label_set_text_with_mnemonic:
3031 * @label: a #GtkLabel
3034 * Sets the label's text from the string @str.
3035 * If characters in @str are preceded by an underscore, they are underlined
3036 * indicating that they represent a keyboard accelerator called a mnemonic.
3037 * The mnemonic key can be used to activate another widget, chosen
3038 * automatically, or explicitly using gtk_label_set_mnemonic_widget().
3041 gtk_label_set_text_with_mnemonic (GtkLabel *label,
3044 g_return_if_fail (GTK_IS_LABEL (label));
3045 g_return_if_fail (str != NULL);
3047 g_object_freeze_notify (G_OBJECT (label));
3049 gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
3050 gtk_label_set_use_markup_internal (label, FALSE);
3051 gtk_label_set_use_underline_internal (label, TRUE);
3053 gtk_label_recalculate (label);
3055 g_object_thaw_notify (G_OBJECT (label));
3059 gtk_label_realize (GtkWidget *widget)
3063 label = GTK_LABEL (widget);
3065 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->realize) (widget);
3067 if (label->select_info)
3068 gtk_label_create_window (label);
3072 gtk_label_unrealize (GtkWidget *widget)
3076 label = GTK_LABEL (widget);
3078 if (label->select_info)
3079 gtk_label_destroy_window (label);
3081 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->unrealize) (widget);
3085 gtk_label_map (GtkWidget *widget)
3089 label = GTK_LABEL (widget);
3091 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->map) (widget);
3093 if (label->select_info)
3094 gdk_window_show (label->select_info->window);
3098 gtk_label_unmap (GtkWidget *widget)
3102 label = GTK_LABEL (widget);
3104 if (label->select_info)
3105 gdk_window_hide (label->select_info->window);
3107 (* GTK_WIDGET_CLASS (gtk_label_parent_class)->unmap) (widget);
3111 window_to_layout_coords (GtkLabel *label,
3118 widget = GTK_WIDGET (label);
3120 /* get layout location in widget->window coords */
3121 get_layout_location (label, &lx, &ly);
3125 *x += widget->allocation.x; /* go to widget->window */
3126 *x -= lx; /* go to layout */
3131 *y += widget->allocation.y; /* go to widget->window */
3132 *y -= ly; /* go to layout */
3138 layout_to_window_coords (GtkLabel *label,
3145 widget = GTK_WIDGET (label);
3147 /* get layout location in widget->window coords */
3148 get_layout_location (label, &lx, &ly);
3152 *x += lx; /* go to widget->window */
3153 *x -= widget->allocation.x; /* go to selection window */
3158 *y += ly; /* go to widget->window */
3159 *y -= widget->allocation.y; /* go to selection window */
3165 get_layout_index (GtkLabel *label,
3171 const gchar *cluster;
3172 const gchar *cluster_end;
3176 gtk_label_ensure_layout (label);
3178 window_to_layout_coords (label, &x, &y);
3183 pango_layout_xy_to_index (label->layout,
3188 cluster = label->text + *index;
3189 cluster_end = cluster;
3192 cluster_end = g_utf8_next_char (cluster_end);
3196 *index += (cluster_end - cluster);
3200 gtk_label_select_word (GtkLabel *label)
3204 gint start_index = gtk_label_move_backward_word (label, label->select_info->selection_end);
3205 gint end_index = gtk_label_move_forward_word (label, label->select_info->selection_end);
3207 min = MIN (label->select_info->selection_anchor,
3208 label->select_info->selection_end);
3209 max = MAX (label->select_info->selection_anchor,
3210 label->select_info->selection_end);
3212 min = MIN (min, start_index);
3213 max = MAX (max, end_index);
3215 gtk_label_select_region_index (label, min, max);
3219 gtk_label_grab_focus (GtkWidget *widget)
3222 gboolean select_on_focus;
3224 label = GTK_LABEL (widget);
3226 if (label->select_info == NULL)
3229 GTK_WIDGET_CLASS (gtk_label_parent_class)->grab_focus (widget);
3231 g_object_get (gtk_widget_get_settings (widget),
3232 "gtk-label-select-on-focus",
3236 if (select_on_focus && !label->in_click)
3237 gtk_label_select_region (label, 0, -1);
3241 gtk_label_button_press (GtkWidget *widget,
3242 GdkEventButton *event)
3248 label = GTK_LABEL (widget);
3250 if (label->select_info == NULL)
3253 label->select_info->in_drag = FALSE;
3254 if (event->button == 1)
3256 if (!GTK_WIDGET_HAS_FOCUS (widget))
3258 label->in_click = TRUE;
3259 gtk_widget_grab_focus (widget);
3260 label->in_click = FALSE;
3263 if (event->type == GDK_3BUTTON_PRESS)
3265 gtk_label_select_region_index (label, 0, strlen (label->text));
3269 if (event->type == GDK_2BUTTON_PRESS)
3271 gtk_label_select_word (label);
3275 get_layout_index (label, event->x, event->y, &index);
3277 min = MIN (label->select_info->selection_anchor,
3278 label->select_info->selection_end);
3279 max = MAX (label->select_info->selection_anchor,
3280 label->select_info->selection_end);
3282 if ((label->select_info->selection_anchor !=
3283 label->select_info->selection_end) &&
3284 (event->state & GDK_SHIFT_MASK))
3286 /* extend (same as motion) */
3287 min = MIN (min, index);
3288 max = MAX (max, index);
3290 /* ensure the anchor is opposite index */
3298 gtk_label_select_region_index (label, min, max);
3302 if (event->type == GDK_3BUTTON_PRESS)
3303 gtk_label_select_region_index (label, 0, strlen (label->text));
3304 else if (event->type == GDK_2BUTTON_PRESS)
3305 gtk_label_select_word (label);
3306 else if (min < max && min <= index && index <= max)
3308 label->select_info->in_drag = TRUE;
3309 label->select_info->drag_start_x = event->x;
3310 label->select_info->drag_start_y = event->y;
3313 /* start a replacement */
3314 gtk_label_select_region_index (label, index, index);
3319 else if (event->button == 3 && event->type == GDK_BUTTON_PRESS)
3321 gtk_label_do_popup (label, event);
3330 gtk_label_button_release (GtkWidget *widget,
3331 GdkEventButton *event)
3334 GtkLabel *label = GTK_LABEL (widget);
3337 if (label->select_info == NULL)
3340 if (label->select_info->in_drag)
3342 label->select_info->in_drag = 0;
3344 get_layout_index (label, event->x, event->y, &index);
3345 gtk_label_select_region_index (label, index, index);
3350 if (event->button != 1)
3353 /* The goal here is to return TRUE iff we ate the
3354 * button press to start selecting.
3361 drag_begin_cb (GtkWidget *widget,
3362 GdkDragContext *context,
3366 GdkPixmap *pixmap = NULL;
3368 g_signal_handlers_disconnect_by_func (widget, drag_begin_cb, NULL);
3370 label = GTK_LABEL (widget);
3372 if ((label->select_info->selection_anchor !=
3373 label->select_info->selection_end) &&
3379 start = MIN (label->select_info->selection_anchor,
3380 label->select_info->selection_end);
3381 end = MAX (label->select_info->selection_anchor,
3382 label->select_info->selection_end);
3384 len = strlen (label->text);
3392 pixmap = _gtk_text_util_create_drag_icon (widget,
3393 label->text + start,
3398 gtk_drag_set_icon_pixmap (context,
3399 gdk_drawable_get_colormap (pixmap),
3404 gtk_drag_set_icon_default (context);
3407 g_object_unref (pixmap);
3411 gtk_label_motion (GtkWidget *widget,
3412 GdkEventMotion *event)
3418 label = GTK_LABEL (widget);
3420 if (label->select_info == NULL)
3424 if ((event->state & GDK_BUTTON1_MASK) == 0)
3427 gdk_window_get_pointer (label->select_info->window,
3430 if (label->select_info->in_drag)
3432 if (gtk_drag_check_threshold (widget,
3433 label->select_info->drag_start_x,
3434 label->select_info->drag_start_y,
3435 event->x, event->y))
3437 GtkTargetList *target_list = gtk_target_list_new (NULL, 0);
3439 gtk_target_list_add_text_targets (target_list, 0);
3441 g_signal_connect (widget, "drag_begin",
3442 G_CALLBACK (drag_begin_cb), NULL);
3443 gtk_drag_begin (widget, target_list,
3445 1, (GdkEvent *)event);
3447 label->select_info->in_drag = FALSE;
3449 gtk_target_list_unref (target_list);
3454 get_layout_index (label, x, y, &index);
3456 gtk_label_select_region_index (label,
3457 label->select_info->selection_anchor,
3465 gtk_label_create_window (GtkLabel *label)
3468 GdkWindowAttr attributes;
3469 gint attributes_mask;
3471 g_assert (label->select_info);
3472 g_assert (GTK_WIDGET_REALIZED (label));
3474 if (label->select_info->window)
3477 widget = GTK_WIDGET (label);
3479 attributes.x = widget->allocation.x;
3480 attributes.y = widget->allocation.y;
3481 attributes.width = widget->allocation.width;
3482 attributes.height = widget->allocation.height;
3483 attributes.window_type = GDK_WINDOW_CHILD;
3484 attributes.wclass = GDK_INPUT_ONLY;
3485 attributes.override_redirect = TRUE;
3486 attributes.event_mask = gtk_widget_get_events (widget) |
3487 GDK_BUTTON_PRESS_MASK |
3488 GDK_BUTTON_RELEASE_MASK |
3489 GDK_BUTTON_MOTION_MASK;
3490 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_NOREDIR;
3491 if (GTK_WIDGET_IS_SENSITIVE (widget))
3493 attributes.cursor = gdk_cursor_new_for_display (gtk_widget_get_display (widget),
3495 attributes_mask |= GDK_WA_CURSOR;
3499 label->select_info->window = gdk_window_new (widget->window,
3500 &attributes, attributes_mask);
3501 gdk_window_set_user_data (label->select_info->window, widget);
3503 if (attributes_mask & GDK_WA_CURSOR)
3504 gdk_cursor_unref (attributes.cursor);
3508 gtk_label_destroy_window (GtkLabel *label)
3510 g_assert (label->select_info);
3512 if (label->select_info->window == NULL)
3515 gdk_window_set_user_data (label->select_info->window, NULL);
3516 gdk_window_destroy (label->select_info->window);
3517 label->select_info->window = NULL;
3521 * gtk_label_set_selectable:
3522 * @label: a #GtkLabel
3523 * @setting: %TRUE to allow selecting text in the label
3525 * Selectable labels allow the user to select text from the label, for
3529 gtk_label_set_selectable (GtkLabel *label,
3532 gboolean old_setting;
3534 g_return_if_fail (GTK_IS_LABEL (label));
3536 setting = setting != FALSE;
3537 old_setting = label->select_info != NULL;
3541 if (label->select_info == NULL)
3543 label->select_info = g_new0 (GtkLabelSelectionInfo, 1);
3545 GTK_WIDGET_SET_FLAGS (label, GTK_CAN_FOCUS);
3547 if (GTK_WIDGET_REALIZED (label))
3548 gtk_label_create_window (label);
3550 if (GTK_WIDGET_MAPPED (label))
3551 gdk_window_show (label->select_info->window);
3556 if (label->select_info)
3558 /* unselect, to give up the selection */
3559 gtk_label_select_region (label, 0, 0);
3561 if (label->select_info->window)
3563 gtk_label_destroy_window (label);
3566 g_free (label->select_info);
3568 label->select_info = NULL;
3570 GTK_WIDGET_UNSET_FLAGS (label, GTK_CAN_FOCUS);
3573 if (setting != old_setting)
3575 g_object_freeze_notify (G_OBJECT (label));
3576 g_object_notify (G_OBJECT (label), "selectable");
3577 g_object_notify (G_OBJECT (label), "cursor-position");
3578 g_object_notify (G_OBJECT (label), "selection-bound");
3579 g_object_thaw_notify (G_OBJECT (label));
3580 gtk_widget_queue_draw (GTK_WIDGET (label));
3585 * gtk_label_get_selectable:
3586 * @label: a #GtkLabel
3588 * Gets the value set by gtk_label_set_selectable().
3590 * Return value: %TRUE if the user can copy text from the label
3593 gtk_label_get_selectable (GtkLabel *label)
3595 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3597 return label->select_info != NULL;
3601 free_angle (gpointer angle)
3603 g_slice_free (gdouble, angle);
3607 * gtk_label_set_angle:
3608 * @label: a #GtkLabel
3609 * @angle: the angle that the baseline of the label makes with
3610 * the horizontal, in degrees, measured counterclockwise
3612 * Sets the angle of rotation for the label. An angle of 90 reads from
3613 * from bottom to top, an angle of 270, from top to bottom. The angle
3614 * setting for the label is ignored if the label is selectable,
3615 * wrapped, or ellipsized.
3620 gtk_label_set_angle (GtkLabel *label,
3623 gdouble *label_angle;
3625 g_return_if_fail (GTK_IS_LABEL (label));
3627 label_angle = (gdouble *)g_object_get_qdata (G_OBJECT (label), quark_angle);
3631 label_angle = g_slice_new (gdouble);
3633 g_object_set_qdata_full (G_OBJECT (label), quark_angle,
3634 label_angle, free_angle);
3637 /* Canonicalize to [0,360]. We don't canonicalize 360 to 0, because
3638 * double property ranges are inclusive, and changing 360 to 0 would
3639 * make a property editor behave strangely.
3641 if (angle < 0 || angle > 360.0)
3642 angle = angle - 360. * floor (angle / 360.);
3644 if (*label_angle != angle)
3646 *label_angle = angle;
3648 gtk_label_clear_layout (label);
3649 gtk_widget_queue_resize (GTK_WIDGET (label));
3651 g_object_notify (G_OBJECT (label), "angle");
3656 * gtk_label_get_angle:
3657 * @label: a #GtkLabel
3659 * Gets the angle of rotation for the label. See
3660 * gtk_label_set_angle().
3662 * Return value: the angle of rotation for the label
3667 gtk_label_get_angle (GtkLabel *label)
3671 g_return_val_if_fail (GTK_IS_LABEL (label), 0.0);
3673 angle = (gdouble *)g_object_get_qdata (G_OBJECT (label), quark_angle);
3682 gtk_label_set_selection_text (GtkLabel *label,
3683 GtkSelectionData *selection_data)
3685 if ((label->select_info->selection_anchor !=
3686 label->select_info->selection_end) &&
3692 start = MIN (label->select_info->selection_anchor,
3693 label->select_info->selection_end);
3694 end = MAX (label->select_info->selection_anchor,
3695 label->select_info->selection_end);
3697 len = strlen (label->text);
3705 gtk_selection_data_set_text (selection_data,
3706 label->text + start,
3712 gtk_label_drag_data_get (GtkWidget *widget,
3713 GdkDragContext *context,
3714 GtkSelectionData *selection_data,
3718 gtk_label_set_selection_text (GTK_LABEL (widget), selection_data);
3722 get_text_callback (GtkClipboard *clipboard,
3723 GtkSelectionData *selection_data,
3725 gpointer user_data_or_owner)
3727 gtk_label_set_selection_text (GTK_LABEL (user_data_or_owner), selection_data);
3731 clear_text_callback (GtkClipboard *clipboard,
3732 gpointer user_data_or_owner)
3736 label = GTK_LABEL (user_data_or_owner);
3738 if (label->select_info)
3740 label->select_info->selection_anchor = label->select_info->selection_end;
3742 gtk_widget_queue_draw (GTK_WIDGET (label));
3747 gtk_label_select_region_index (GtkLabel *label,
3751 g_return_if_fail (GTK_IS_LABEL (label));
3753 if (label->select_info)
3755 GtkClipboard *clipboard;
3757 if (label->select_info->selection_anchor == anchor_index &&
3758 label->select_info->selection_end == end_index)
3761 label->select_info->selection_anchor = anchor_index;
3762 label->select_info->selection_end = end_index;
3764 clipboard = gtk_widget_get_clipboard (GTK_WIDGET (label),
3765 GDK_SELECTION_PRIMARY);
3767 if (anchor_index != end_index)
3769 GtkTargetList *list;
3770 GtkTargetEntry *targets;
3773 list = gtk_target_list_new (NULL, 0);
3774 gtk_target_list_add_text_targets (list, 0);
3775 targets = gtk_target_table_new_from_list (list, &n_targets);
3777 gtk_clipboard_set_with_owner (clipboard,
3780 clear_text_callback,
3783 gtk_target_table_free (targets, n_targets);
3784 gtk_target_list_unref (list);
3788 if (gtk_clipboard_get_owner (clipboard) == G_OBJECT (label))
3789 gtk_clipboard_clear (clipboard);
3792 gtk_widget_queue_draw (GTK_WIDGET (label));
3794 g_object_freeze_notify (G_OBJECT (label));
3795 g_object_notify (G_OBJECT (label), "cursor-position");
3796 g_object_notify (G_OBJECT (label), "selection-bound");
3797 g_object_thaw_notify (G_OBJECT (label));
3802 * gtk_label_select_region:
3803 * @label: a #GtkLabel
3804 * @start_offset: start offset (in characters not bytes)
3805 * @end_offset: end offset (in characters not bytes)
3807 * Selects a range of characters in the label, if the label is selectable.
3808 * See gtk_label_set_selectable(). If the label is not selectable,
3809 * this function has no effect. If @start_offset or
3810 * @end_offset are -1, then the end of the label will be substituted.
3813 gtk_label_select_region (GtkLabel *label,
3817 g_return_if_fail (GTK_IS_LABEL (label));
3819 if (label->text && label->select_info)
3821 if (start_offset < 0)
3822 start_offset = g_utf8_strlen (label->text, -1);
3825 end_offset = g_utf8_strlen (label->text, -1);
3827 gtk_label_select_region_index (label,
3828 g_utf8_offset_to_pointer (label->text, start_offset) - label->text,
3829 g_utf8_offset_to_pointer (label->text, end_offset) - label->text);
3834 * gtk_label_get_selection_bounds:
3835 * @label: a #GtkLabel
3836 * @start: return location for start of selection, as a character offset
3837 * @end: return location for end of selection, as a character offset
3839 * Gets the selected range of characters in the label, returning %TRUE
3840 * if there's a selection.
3842 * Return value: %TRUE if selection is non-empty
3845 gtk_label_get_selection_bounds (GtkLabel *label,
3849 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3851 if (label->select_info == NULL)
3853 /* not a selectable label */
3863 gint start_index, end_index;
3864 gint start_offset, end_offset;
3867 start_index = MIN (label->select_info->selection_anchor,
3868 label->select_info->selection_end);
3869 end_index = MAX (label->select_info->selection_anchor,
3870 label->select_info->selection_end);
3872 len = strlen (label->text);
3874 if (end_index > len)
3877 if (start_index > len)
3880 start_offset = g_utf8_strlen (label->text, start_index);
3881 end_offset = g_utf8_strlen (label->text, end_index);
3883 if (start_offset > end_offset)
3885 gint tmp = start_offset;
3886 start_offset = end_offset;
3891 *start = start_offset;
3896 return start_offset != end_offset;
3902 * gtk_label_get_layout:
3903 * @label: a #GtkLabel
3905 * Gets the #PangoLayout used to display the label.
3906 * The layout is useful to e.g. convert text positions to
3907 * pixel positions, in combination with gtk_label_get_layout_offsets().
3908 * The returned layout is owned by the label so need not be
3909 * freed by the caller.
3911 * Return value: the #PangoLayout for this label
3914 gtk_label_get_layout (GtkLabel *label)
3916 g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
3918 gtk_label_ensure_layout (label);
3920 return label->layout;
3924 * gtk_label_get_layout_offsets:
3925 * @label: a #GtkLabel
3926 * @x: location to store X offset of layout, or %NULL
3927 * @y: location to store Y offset of layout, or %NULL
3929 * Obtains the coordinates where the label will draw the #PangoLayout
3930 * representing the text in the label; useful to convert mouse events
3931 * into coordinates inside the #PangoLayout, e.g. to take some action
3932 * if some part of the label is clicked. Of course you will need to
3933 * create a #GtkEventBox to receive the events, and pack the label
3934 * inside it, since labels are a #GTK_NO_WINDOW widget. Remember
3935 * when using the #PangoLayout functions you need to convert to
3936 * and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
3939 gtk_label_get_layout_offsets (GtkLabel *label,
3943 g_return_if_fail (GTK_IS_LABEL (label));
3945 gtk_label_ensure_layout (label);
3947 get_layout_location (label, x, y);
3951 * gtk_label_set_use_markup:
3952 * @label: a #GtkLabel
3953 * @setting: %TRUE if the label's text should be parsed for markup.
3955 * Sets whether the text of the label contains markup in <link
3956 * linkend="PangoMarkupFormat">Pango's text markup
3957 * language</link>. See gtk_label_set_markup().
3960 gtk_label_set_use_markup (GtkLabel *label,
3963 g_return_if_fail (GTK_IS_LABEL (label));
3965 gtk_label_set_use_markup_internal (label, setting);
3966 gtk_label_recalculate (label);
3970 * gtk_label_get_use_markup:
3971 * @label: a #GtkLabel
3973 * Returns whether the label's text is interpreted as marked up with
3974 * the <link linkend="PangoMarkupFormat">Pango text markup
3975 * language</link>. See gtk_label_set_use_markup ().
3977 * Return value: %TRUE if the label's text will be parsed for markup.
3980 gtk_label_get_use_markup (GtkLabel *label)
3982 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
3984 return label->use_markup;
3988 * gtk_label_set_use_underline:
3989 * @label: a #GtkLabel
3990 * @setting: %TRUE if underlines in the text indicate mnemonics
3992 * If true, an underline in the text indicates the next character should be
3993 * used for the mnemonic accelerator key.
3996 gtk_label_set_use_underline (GtkLabel *label,
3999 g_return_if_fail (GTK_IS_LABEL (label));
4001 gtk_label_set_use_underline_internal (label, setting);
4002 gtk_label_recalculate (label);
4006 * gtk_label_get_use_underline:
4007 * @label: a #GtkLabel
4009 * Returns whether an embedded underline in the label indicates a
4010 * mnemonic. See gtk_label_set_use_underline().
4012 * Return value: %TRUE whether an embedded underline in the label indicates
4013 * the mnemonic accelerator keys.
4016 gtk_label_get_use_underline (GtkLabel *label)
4018 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
4020 return label->use_underline;
4024 * gtk_label_set_single_line_mode:
4025 * @label: a #GtkLabel
4026 * @single_line_mode: %TRUE if the label should be in single line mode
4028 * Sets whether the label is in single line mode.
4033 gtk_label_set_single_line_mode (GtkLabel *label,
4034 gboolean single_line_mode)
4036 g_return_if_fail (GTK_IS_LABEL (label));
4038 single_line_mode = single_line_mode != FALSE;
4040 if (label->single_line_mode != single_line_mode)
4042 label->single_line_mode = single_line_mode;
4044 gtk_label_clear_layout (label);
4045 gtk_widget_queue_resize (GTK_WIDGET (label));
4047 g_object_notify (G_OBJECT (label), "single-line-mode");
4052 * gtk_label_get_single_line_mode:
4053 * @label: a #GtkLabel
4055 * Returns whether the label is in single line mode.
4057 * Return value: %TRUE when the label is in single line mode.
4062 gtk_label_get_single_line_mode (GtkLabel *label)
4064 g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);
4066 return label->single_line_mode;
4069 /* Compute the X position for an offset that corresponds to the "more important
4070 * cursor position for that offset. We use this when trying to guess to which
4071 * end of the selection we should go to when the user hits the left or
4075 get_better_cursor (GtkLabel *label,
4080 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
4081 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
4082 PangoDirection cursor_direction = get_cursor_direction (label);
4083 gboolean split_cursor;
4084 PangoRectangle strong_pos, weak_pos;
4086 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
4087 "gtk-split-cursor", &split_cursor,
4090 gtk_label_ensure_layout (label);
4092 pango_layout_get_cursor_pos (label->layout, index,
4093 &strong_pos, &weak_pos);
4097 *x = strong_pos.x / PANGO_SCALE;
4098 *y = strong_pos.y / PANGO_SCALE;
4102 if (keymap_direction == cursor_direction)
4104 *x = strong_pos.x / PANGO_SCALE;
4105 *y = strong_pos.y / PANGO_SCALE;
4109 *x = weak_pos.x / PANGO_SCALE;
4110 *y = weak_pos.y / PANGO_SCALE;
4117 gtk_label_move_logically (GtkLabel *label,
4121 gint offset = g_utf8_pointer_to_offset (label->text,
4122 label->text + start);
4126 PangoLogAttr *log_attrs;
4130 gtk_label_ensure_layout (label);
4132 length = g_utf8_strlen (label->text, -1);
4134 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
4136 while (count > 0 && offset < length)
4140 while (offset < length && !log_attrs[offset].is_cursor_position);
4144 while (count < 0 && offset > 0)
4148 while (offset > 0 && !log_attrs[offset].is_cursor_position);
4156 return g_utf8_offset_to_pointer (label->text, offset) - label->text;
4160 gtk_label_move_visually (GtkLabel *label,
4170 int new_index, new_trailing;
4171 gboolean split_cursor;
4174 gtk_label_ensure_layout (label);
4176 g_object_get (gtk_widget_get_settings (GTK_WIDGET (label)),
4177 "gtk-split-cursor", &split_cursor,
4184 GdkKeymap *keymap = gdk_keymap_get_for_display (gtk_widget_get_display (GTK_WIDGET (label)));
4185 PangoDirection keymap_direction = gdk_keymap_get_direction (keymap);
4187 strong = keymap_direction == get_cursor_direction (label);
4192 pango_layout_move_cursor_visually (label->layout, strong, index, 0, 1, &new_index, &new_trailing);
4197 pango_layout_move_cursor_visually (label->layout, strong, index, 0, -1, &new_index, &new_trailing);
4201 if (new_index < 0 || new_index == G_MAXINT)
4206 while (new_trailing--)
4207 index = g_utf8_next_char (label->text + new_index) - label->text;
4214 gtk_label_move_forward_word (GtkLabel *label,
4217 gint new_pos = g_utf8_pointer_to_offset (label->text,
4218 label->text + start);
4221 length = g_utf8_strlen (label->text, -1);
4222 if (new_pos < length)
4224 PangoLogAttr *log_attrs;
4227 gtk_label_ensure_layout (label);
4229 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
4231 /* Find the next word end */
4233 while (new_pos < n_attrs && !log_attrs[new_pos].is_word_end)
4239 return g_utf8_offset_to_pointer (label->text, new_pos) - label->text;
4244 gtk_label_move_backward_word (GtkLabel *label,
4247 gint new_pos = g_utf8_pointer_to_offset (label->text,
4248 label->text + start);
4252 PangoLogAttr *log_attrs;
4255 gtk_label_ensure_layout (label);
4257 pango_layout_get_log_attrs (label->layout, &log_attrs, &n_attrs);
4261 /* Find the previous word beginning */
4262 while (new_pos > 0 && !log_attrs[new_pos].is_word_start)
4268 return g_utf8_offset_to_pointer (label->text, new_pos) - label->text;
4272 gtk_label_move_cursor (GtkLabel *label,
4273 GtkMovementStep step,
4275 gboolean extend_selection)
4280 if (label->select_info == NULL)
4283 old_pos = new_pos = label->select_info->selection_end;
4285 if (label->select_info->selection_end != label->select_info->selection_anchor &&
4288 /* If we have a current selection and aren't extending it, move to the
4289 * start/or end of the selection as appropriate
4293 case GTK_MOVEMENT_VISUAL_POSITIONS:
4296 gint anchor_x, anchor_y;
4297 gboolean end_is_left;
4299 get_better_cursor (label, label->select_info->selection_end, &end_x, &end_y);
4300 get_better_cursor (label, label->select_info->selection_anchor, &anchor_x, &anchor_y);
4302 end_is_left = (end_y < anchor_y) || (end_y == anchor_y && end_x < anchor_x);
4305 new_pos = end_is_left ? label->select_info->selection_end : label->select_info->selection_anchor;
4307 new_pos = !end_is_left ? label->select_info->selection_end : label->select_info->selection_anchor;
4310 case GTK_MOVEMENT_LOGICAL_POSITIONS:
4311 case GTK_MOVEMENT_WORDS:
4313 new_pos = MIN (label->select_info->selection_end, label->select_info->selection_anchor);
4315 new_pos = MAX (label->select_info->selection_end, label->select_info->selection_anchor);
4317 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
4318 case GTK_MOVEMENT_PARAGRAPH_ENDS:
4319 case GTK_MOVEMENT_BUFFER_ENDS:
4320 /* FIXME: Can do better here */
4321 new_pos = count < 0 ? 0 : strlen (label->text);
4323 case GTK_MOVEMENT_DISPLAY_LINES:
4324 case GTK_MOVEMENT_PARAGRAPHS:
4325 case GTK_MOVEMENT_PAGES:
4326 case GTK_MOVEMENT_HORIZONTAL_PAGES:
4334 case GTK_MOVEMENT_LOGICAL_POSITIONS:
4335 new_pos = gtk_label_move_logically (label, new_pos, count);
4337 case GTK_MOVEMENT_VISUAL_POSITIONS:
4338 new_pos = gtk_label_move_visually (label, new_pos, count);
4339 if (new_pos == old_pos)
4341 if (!extend_selection)
4343 if (!gtk_widget_keynav_failed (GTK_WIDGET (label),
4345 GTK_DIR_RIGHT : GTK_DIR_LEFT))
4347 GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (label));
4350 gtk_widget_child_focus (toplevel,
4352 GTK_DIR_RIGHT : GTK_DIR_LEFT);
4357 gtk_widget_error_bell (GTK_WIDGET (label));
4361 case GTK_MOVEMENT_WORDS:
4364 new_pos = gtk_label_move_forward_word (label, new_pos);
4369 new_pos = gtk_label_move_backward_word (label, new_pos);
4372 if (new_pos == old_pos)
4373 gtk_widget_error_bell (GTK_WIDGET (label));
4375 case GTK_MOVEMENT_DISPLAY_LINE_ENDS:
4376 case GTK_MOVEMENT_PARAGRAPH_ENDS:
4377 case GTK_MOVEMENT_BUFFER_ENDS:
4378 /* FIXME: Can do better here */
4379 new_pos = count < 0 ? 0 : strlen (label->text);
4380 if (new_pos == old_pos)
4381 gtk_widget_error_bell (GTK_WIDGET (label));
4383 case GTK_MOVEMENT_DISPLAY_LINES:
4384 case GTK_MOVEMENT_PARAGRAPHS:
4385 case GTK_MOVEMENT_PAGES:
4386 case GTK_MOVEMENT_HORIZONTAL_PAGES:
4391 if (extend_selection)
4392 gtk_label_select_region_index (label,
4393 label->select_info->selection_anchor,
4396 gtk_label_select_region_index (label, new_pos, new_pos);
4400 gtk_label_copy_clipboard (GtkLabel *label)
4402 if (label->text && label->select_info)
4407 start = MIN (label->select_info->selection_anchor,
4408 label->select_info->selection_end);
4409 end = MAX (label->select_info->selection_anchor,
4410 label->select_info->selection_end);
4412 len = strlen (label->text);
4421 gtk_clipboard_set_text (gtk_widget_get_clipboard (GTK_WIDGET (label),
4422 GDK_SELECTION_CLIPBOARD),
4423 label->text + start, end - start);
4428 gtk_label_select_all (GtkLabel *label)
4430 gtk_label_select_region_index (label, 0, strlen (label->text));
4433 /* Quick hack of a popup menu
4436 activate_cb (GtkWidget *menuitem,
4439 const gchar *signal = g_object_get_data (G_OBJECT (menuitem), "gtk-signal");
4440 g_signal_emit_by_name (label, signal);
4444 append_action_signal (GtkLabel *label,
4446 const gchar *stock_id,
4447 const gchar *signal,
4450 GtkWidget *menuitem = gtk_image_menu_item_new_from_stock (stock_id, NULL);
4452 g_object_set_data (G_OBJECT (menuitem), I_("gtk-signal"), (char *)signal);
4453 g_signal_connect (menuitem, "activate",
4454 G_CALLBACK (activate_cb), label);
4456 gtk_widget_set_sensitive (menuitem, sensitive);
4458 gtk_widget_show (menuitem);
4459 gtk_menu_shell_append (GTK_MENU_SHELL (menu), menuitem);
4463 popup_menu_detach (GtkWidget *attach_widget,
4467 label = GTK_LABEL (attach_widget);
4469 if (label->select_info)
4470 label->select_info->popup_menu = NULL;
4474 popup_position_func (GtkMenu *menu,
4485 label = GTK_LABEL (user_data);
4486 widget = GTK_WIDGET (label);
4488 if (label->select_info == NULL)
4491 g_return_if_fail (GTK_WIDGET_REALIZED (label));
4493 screen = gtk_widget_get_screen (widget);
4494 gdk_window_get_origin (widget->window, x, y);
4496 gtk_widget_size_request (label->select_info->popup_menu, &req);
4498 *x += widget->allocation.width / 2;
4499 *y += widget->allocation.height;
4501 *x = CLAMP (*x, 0, MAX (0, gdk_screen_get_width (screen) - req.width));
4502 *y = CLAMP (*y, 0, MAX (0, gdk_screen_get_height (screen) - req.height));
4507 gtk_label_do_popup (GtkLabel *label,
4508 GdkEventButton *event)
4510 GtkWidget *menuitem;
4511 gboolean have_selection;
4513 if (label->select_info == NULL)
4516 if (label->select_info->popup_menu)
4517 gtk_widget_destroy (label->select_info->popup_menu);
4519 label->select_info->popup_menu = gtk_menu_new ();
4521 gtk_menu_attach_to_widget (GTK_MENU (label->select_info->popup_menu),
4526 label->select_info->selection_anchor != label->select_info->selection_end;
4529 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_CUT, "cut_clipboard",
4531 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_COPY, "copy_clipboard",
4533 append_action_signal (label, label->select_info->popup_menu, GTK_STOCK_PASTE, "paste_clipboard",
4536 menuitem = gtk_image_menu_item_new_from_stock (GTK_STOCK_DELETE, NULL);
4537 gtk_widget_set_sensitive (menuitem, FALSE);
4538 gtk_widget_show (menuitem);
4539 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
4541 menuitem = gtk_separator_menu_item_new ();
4542 gtk_widget_show (menuitem);
4543 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
4545 menuitem = gtk_image_menu_item_new_from_stock (GTK_STOCK_SELECT_ALL, NULL);
4546 g_signal_connect_swapped (menuitem, "activate",
4547 G_CALLBACK (gtk_label_select_all), label);
4548 gtk_widget_show (menuitem);
4549 gtk_menu_shell_append (GTK_MENU_SHELL (label->select_info->popup_menu), menuitem);
4551 g_signal_emit (label,
4552 signals[POPULATE_POPUP],
4554 label->select_info->popup_menu);
4557 gtk_menu_popup (GTK_MENU (label->select_info->popup_menu), NULL, NULL,
4559 event->button, event->time);
4561 gtk_menu_popup (GTK_MENU (label->select_info->popup_menu), NULL, NULL,
4562 popup_position_func, label,
4563 0, gtk_get_current_event_time ());
4566 #define __GTK_LABEL_C__
4567 #include "gtkaliasdef.c"