gtklabel.c 87.5 KB
Newer Older
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Owen Taylor's avatar
Owen Taylor committed
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Owen Taylor's avatar
Owen Taylor committed
15 16
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Elliot Lee's avatar
Elliot Lee committed
17
 */
18 19

/*
20
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
21 22 23 24 25
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

26
#include <math.h>
Elliot Lee's avatar
Elliot Lee committed
27 28
#include <string.h>
#include "gtklabel.h"
29
#include "gtkmain.h"
30
#include "gtkmarshalers.h"
31 32
#include "gtksignal.h"
#include "gtkwindow.h"
33
#include "gdk/gdkkeysyms.h"
34
#include "gtkclipboard.h"
35
#include <pango/pango.h>
36
#include "gtkimagemenuitem.h"
37
#include "gtkintl.h"
38
#include "gtkseparatormenuitem.h"
39 40
#include "gtkmenuitem.h"
#include "gtknotebook.h"
41
#include "gtkstock.h"
42
#include "gtkbindings.h"
43

44 45 46 47 48
struct _GtkLabelSelectionInfo
{
  GdkWindow *window;
  gint selection_anchor;
  gint selection_end;
49
  GtkWidget *popup_menu;
50
};
Elliot Lee's avatar
Elliot Lee committed
51

52 53 54 55 56 57
enum {
  MOVE_CURSOR,
  COPY_CLIPBOARD,
  POPULATE_POPUP,
  LAST_SIGNAL
};
58

59
enum {
60 61 62 63 64 65 66 67 68
  PROP_0,
  PROP_LABEL,
  PROP_ATTRIBUTES,
  PROP_USE_MARKUP,
  PROP_USE_UNDERLINE,
  PROP_JUSTIFY,
  PROP_PATTERN,
  PROP_WRAP,
  PROP_SELECTABLE,
69
  PROP_MNEMONIC_KEYVAL,
70 71 72
  PROP_MNEMONIC_WIDGET,
  PROP_CURSOR_POSITION,
  PROP_SELECTION_BOUND
73 74
};

75 76
static guint signals[LAST_SIGNAL] = { 0 };

77 78
static void gtk_label_class_init        (GtkLabelClass    *klass);
static void gtk_label_init              (GtkLabel         *label);
79 80 81
static void gtk_label_set_property      (GObject          *object,
					 guint             prop_id,
					 const GValue     *value,
82
					 GParamSpec       *pspec);
83 84 85
static void gtk_label_get_property      (GObject          *object,
					 guint             prop_id,
					 GValue           *value,
86
					 GParamSpec       *pspec);
87
static void gtk_label_destroy           (GtkObject        *object);
88 89 90
static void gtk_label_finalize          (GObject          *object);
static void gtk_label_size_request      (GtkWidget        *widget,
					 GtkRequisition   *requisition);
91 92
static void gtk_label_size_allocate     (GtkWidget        *widget,
                                         GtkAllocation    *allocation);
Havoc Pennington's avatar
Havoc Pennington committed
93 94
static void gtk_label_state_changed     (GtkWidget        *widget,
                                         GtkStateType      state);
95 96 97 98 99 100
static void gtk_label_style_set         (GtkWidget        *widget,
					 GtkStyle         *previous_style);
static void gtk_label_direction_changed (GtkWidget        *widget,
					 GtkTextDirection  previous_dir);
static gint gtk_label_expose            (GtkWidget        *widget,
					 GdkEventExpose   *event);
Elliot Lee's avatar
Elliot Lee committed
101

102 103 104 105 106 107 108 109 110 111 112
static void gtk_label_realize           (GtkWidget        *widget);
static void gtk_label_unrealize         (GtkWidget        *widget);
static void gtk_label_map               (GtkWidget        *widget);
static void gtk_label_unmap             (GtkWidget        *widget);
static gint gtk_label_button_press      (GtkWidget        *widget,
                                         GdkEventButton   *event);
static gint gtk_label_button_release    (GtkWidget        *widget,
                                         GdkEventButton   *event);
static gint gtk_label_motion            (GtkWidget        *widget,
                                         GdkEventMotion   *event);

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131

static void gtk_label_set_text_internal          (GtkLabel      *label,
						  gchar         *str);
static void gtk_label_set_label_internal         (GtkLabel      *label,
						  gchar         *str);
static void gtk_label_set_use_markup_internal    (GtkLabel      *label,
						  gboolean       val);
static void gtk_label_set_use_underline_internal (GtkLabel      *label,
						  gboolean       val);
static void gtk_label_set_attributes_internal    (GtkLabel      *label,
						  PangoAttrList *attrs);
static void gtk_label_set_uline_text_internal    (GtkLabel      *label,
						  const gchar   *str);
static void gtk_label_set_pattern_internal       (GtkLabel      *label,
				                  const gchar   *pattern);
static void set_markup                           (GtkLabel      *label,
						  const gchar   *str,
						  gboolean       with_uline);
static void gtk_label_recalculate                (GtkLabel      *label);
132 133
static void gtk_label_hierarchy_changed          (GtkWidget     *widget,
						  GtkWidget     *old_toplevel);
134

135 136 137
static void gtk_label_create_window       (GtkLabel *label);
static void gtk_label_destroy_window      (GtkLabel *label);
static void gtk_label_clear_layout        (GtkLabel *label);
138
static void gtk_label_ensure_layout       (GtkLabel *label);
139 140 141 142
static void gtk_label_select_region_index (GtkLabel *label,
                                           gint      anchor_index,
                                           gint      end_index);

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
static gboolean gtk_label_mnemonic_activate (GtkWidget         *widget,
					     gboolean           group_cycling);
static void     gtk_label_setup_mnemonic    (GtkLabel          *label,
					     guint              last_key);
static gboolean gtk_label_focus             (GtkWidget         *widget,
					     GtkDirectionType   direction);

/* For selectable lables: */
static void gtk_label_move_cursor        (GtkLabel        *label,
					  GtkMovementStep  step,
					  gint             count,
					  gboolean         extend_selection);
static void gtk_label_copy_clipboard     (GtkLabel        *label);
static void gtk_label_select_all         (GtkLabel        *label);
static void gtk_label_do_popup           (GtkLabel        *label,
					  GdkEventButton  *event);

static gint gtk_label_move_forward_word  (GtkLabel        *label,
					  gint             start);
static gint gtk_label_move_backward_word (GtkLabel        *label,
					  gint             start);
164

165 166
static GtkMiscClass *parent_class = NULL;

Elliot Lee's avatar
Elliot Lee committed
167

Tim Janik's avatar
Tim Janik committed
168
GtkType
169
gtk_label_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
170
{
Tim Janik's avatar
Tim Janik committed
171 172
  static GtkType label_type = 0;
  
Elliot Lee's avatar
Elliot Lee committed
173 174
  if (!label_type)
    {
175
      static const GTypeInfo label_info =
Elliot Lee's avatar
Elliot Lee committed
176 177
      {
	sizeof (GtkLabelClass),
178 179 180 181 182 183 184 185
	NULL,           /* base_init */
	NULL,           /* base_finalize */
	(GClassInitFunc) gtk_label_class_init,
	NULL,           /* class_finalize */
	NULL,           /* class_data */
	sizeof (GtkLabel),
	32,             /* n_preallocs */
	(GInstanceInitFunc) gtk_label_init,
Elliot Lee's avatar
Elliot Lee committed
186
      };
187

188
      label_type = g_type_register_static (GTK_TYPE_MISC, "GtkLabel", &label_info, 0);
Elliot Lee's avatar
Elliot Lee committed
189
    }
Tim Janik's avatar
Tim Janik committed
190
  
Elliot Lee's avatar
Elliot Lee committed
191 192 193
  return label_type;
}

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
static void
add_move_binding (GtkBindingSet  *binding_set,
		  guint           keyval,
		  guint           modmask,
		  GtkMovementStep step,
		  gint            count)
{
  g_return_if_fail ((modmask & GDK_SHIFT_MASK) == 0);
  
  gtk_binding_entry_add_signal (binding_set, keyval, modmask,
				"move_cursor", 3,
				GTK_TYPE_ENUM, step,
				G_TYPE_INT, count,
                                G_TYPE_BOOLEAN, FALSE);

  /* Selection-extending version */
  gtk_binding_entry_add_signal (binding_set, keyval, modmask | GDK_SHIFT_MASK,
				"move_cursor", 3,
				GTK_TYPE_ENUM, step,
				G_TYPE_INT, count,
                                G_TYPE_BOOLEAN, TRUE);
}

217
static void
Elliot Lee's avatar
Elliot Lee committed
218 219
gtk_label_class_init (GtkLabelClass *class)
{
220
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
221 222
  GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
223
  GtkBindingSet *binding_set;
224

225
  parent_class = gtk_type_class (GTK_TYPE_MISC);
Tim Janik's avatar
Tim Janik committed
226
  
227 228
  gobject_class->set_property = gtk_label_set_property;
  gobject_class->get_property = gtk_label_get_property;
229
  gobject_class->finalize = gtk_label_finalize;
230 231

  object_class->destroy = gtk_label_destroy;
Tim Janik's avatar
Tim Janik committed
232
  
Elliot Lee's avatar
Elliot Lee committed
233
  widget_class->size_request = gtk_label_size_request;
234
  widget_class->size_allocate = gtk_label_size_allocate;
Havoc Pennington's avatar
Havoc Pennington committed
235
  widget_class->state_changed = gtk_label_state_changed;
236
  widget_class->style_set = gtk_label_style_set;
237
  widget_class->direction_changed = gtk_label_direction_changed;
Elliot Lee's avatar
Elliot Lee committed
238
  widget_class->expose_event = gtk_label_expose;
239 240 241 242 243 244 245
  widget_class->realize = gtk_label_realize;
  widget_class->unrealize = gtk_label_unrealize;
  widget_class->map = gtk_label_map;
  widget_class->unmap = gtk_label_unmap;
  widget_class->button_press_event = gtk_label_button_press;
  widget_class->button_release_event = gtk_label_button_release;
  widget_class->motion_notify_event = gtk_label_motion;
246
  widget_class->hierarchy_changed = gtk_label_hierarchy_changed;
247
  widget_class->mnemonic_activate = gtk_label_mnemonic_activate;
248 249 250 251 252 253 254 255 256 257
  widget_class->focus = gtk_label_focus;

  class->move_cursor = gtk_label_move_cursor;
  class->copy_clipboard = gtk_label_copy_clipboard;
  
  signals[MOVE_CURSOR] = 
      gtk_signal_new ("move_cursor",
                      GTK_RUN_LAST | GTK_RUN_ACTION,
                      GTK_CLASS_TYPE (object_class),
                      GTK_SIGNAL_OFFSET (GtkLabelClass, move_cursor),
258
                      _gtk_marshal_VOID__ENUM_INT_BOOLEAN,
259 260 261 262 263 264 265
                      GTK_TYPE_NONE, 3, GTK_TYPE_MOVEMENT_STEP, GTK_TYPE_INT, GTK_TYPE_BOOL);
  
  signals[COPY_CLIPBOARD] =
    gtk_signal_new ("copy_clipboard",
                    GTK_RUN_LAST | GTK_RUN_ACTION,
                    GTK_CLASS_TYPE (object_class),
                    GTK_SIGNAL_OFFSET (GtkLabelClass, copy_clipboard),
266
                    _gtk_marshal_VOID__VOID,
267 268 269 270 271 272 273
                    GTK_TYPE_NONE, 0);
  
  signals[POPULATE_POPUP] =
    gtk_signal_new ("populate_popup",
		    GTK_RUN_LAST,
		    GTK_CLASS_TYPE (object_class),
		    GTK_SIGNAL_OFFSET (GtkLabelClass, populate_popup),
274
		    _gtk_marshal_VOID__OBJECT,
275
		    GTK_TYPE_NONE, 1, GTK_TYPE_MENU);
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301

  g_object_class_install_property (G_OBJECT_CLASS(object_class),
                                   PROP_LABEL,
                                   g_param_spec_string ("label",
                                                        _("Label"),
                                                        _("The text of the label."),
                                                        NULL,
                                                        G_PARAM_READWRITE));
  g_object_class_install_property (gobject_class,
				   PROP_ATTRIBUTES,
				   g_param_spec_boxed ("attributes",
						       _("Attributes"),
						       _("A list of style attributes to apply to the text of the label."),
						       PANGO_TYPE_ATTR_LIST,
						       G_PARAM_READWRITE));
  g_object_class_install_property (gobject_class,
                                   PROP_USE_MARKUP,
                                   g_param_spec_boolean ("use_markup",
							 _("Use markup"),
							 _("The text of the label includes XML markup. See pango_parse_markup()."),
                                                        FALSE,
                                                        G_PARAM_READWRITE));
  g_object_class_install_property (gobject_class,
                                   PROP_USE_UNDERLINE,
                                   g_param_spec_boolean ("use_underline",
							 _("Use underline"),
302
							 _("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
                                                        FALSE,
                                                        G_PARAM_READWRITE));

  g_object_class_install_property (gobject_class,
				   PROP_JUSTIFY,
                                   g_param_spec_enum ("justify",
                                                      _("Justification"),
                                                      _("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."),
						      GTK_TYPE_JUSTIFICATION,
						      GTK_JUSTIFY_LEFT,
                                                      G_PARAM_READWRITE));

  g_object_class_install_property (gobject_class,
                                   PROP_PATTERN,
                                   g_param_spec_string ("pattern",
                                                        _("Pattern"),
Hans Breuer's avatar
updated  
Hans Breuer committed
319
                                                        _("A string with _ characters in positions correspond to characters in the text to underline."),
320 321 322 323 324 325 326 327
                                                        NULL,
                                                        G_PARAM_WRITABLE));

  g_object_class_install_property (gobject_class,
                                   PROP_WRAP,
                                   g_param_spec_boolean ("wrap",
                                                        _("Line wrap"),
                                                        _("If set, wrap lines if the text becomes too wide."),
328
                                                        FALSE,
329 330 331 332 333 334 335 336 337
                                                        G_PARAM_READWRITE));
  g_object_class_install_property (gobject_class,
                                   PROP_SELECTABLE,
                                   g_param_spec_boolean ("selectable",
                                                        _("Selectable"),
                                                        _("Whether the label text can be selected with the mouse."),
                                                        FALSE,
                                                        G_PARAM_READWRITE));
  g_object_class_install_property (gobject_class,
338 339
                                   PROP_MNEMONIC_KEYVAL,
                                   g_param_spec_uint ("mnemonic_keyval",
340
						      _("Mnemonic key"),
341
						      _("The mnemonic accelerator key for this label."),
342 343 344 345
						      0,
						      G_MAXUINT,
						      GDK_VoidSymbol,
						      G_PARAM_READABLE));
346 347 348 349 350 351 352 353
  g_object_class_install_property (gobject_class,
                                   PROP_MNEMONIC_WIDGET,
                                   g_param_spec_object ("mnemonic_widget",
							_("Mnemonic widget"),
							_("The widget to be activated when the label's mnemonic "
							  "key is pressed."),
							GTK_TYPE_WIDGET,
							G_PARAM_READWRITE));
354

355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
  g_object_class_install_property (gobject_class,
                                   PROP_CURSOR_POSITION,
                                   g_param_spec_int ("cursor_position",
                                                     _("Cursor Position"),
                                                     _("The current position of the insertion cursor in chars."),
                                                     0,
                                                     G_MAXINT,
                                                     0,
                                                     G_PARAM_READABLE));
  
  g_object_class_install_property (gobject_class,
                                   PROP_SELECTION_BOUND,
                                   g_param_spec_int ("selection_bound",
                                                     _("Selection Bound"),
                                                     _("The position of the opposite end of the selection from the cursor in chars."),
                                                     0,
                                                     G_MAXINT,
                                                     0,
                                                     G_PARAM_READABLE));
  
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
  /*
   * Key bindings
   */

  binding_set = gtk_binding_set_by_class (class);

  /* Moving the insertion point */
  add_move_binding (binding_set, GDK_Right, 0,
		    GTK_MOVEMENT_VISUAL_POSITIONS, 1);
  
  add_move_binding (binding_set, GDK_Left, 0,
		    GTK_MOVEMENT_VISUAL_POSITIONS, -1);

  add_move_binding (binding_set, GDK_KP_Right, 0,
		    GTK_MOVEMENT_VISUAL_POSITIONS, 1);
  
  add_move_binding (binding_set, GDK_KP_Left, 0,
		    GTK_MOVEMENT_VISUAL_POSITIONS, -1);
  
  add_move_binding (binding_set, GDK_f, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_LOGICAL_POSITIONS, 1);
  
  add_move_binding (binding_set, GDK_b, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_LOGICAL_POSITIONS, -1);
  
  add_move_binding (binding_set, GDK_Right, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_WORDS, 1);

  add_move_binding (binding_set, GDK_Left, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_WORDS, -1);

  add_move_binding (binding_set, GDK_KP_Right, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_WORDS, 1);

  add_move_binding (binding_set, GDK_KP_Left, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_WORDS, -1);
  
  add_move_binding (binding_set, GDK_a, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_PARAGRAPH_ENDS, -1);

  add_move_binding (binding_set, GDK_e, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_PARAGRAPH_ENDS, 1);

  add_move_binding (binding_set, GDK_f, GDK_MOD1_MASK,
		    GTK_MOVEMENT_WORDS, 1);

  add_move_binding (binding_set, GDK_b, GDK_MOD1_MASK,
		    GTK_MOVEMENT_WORDS, -1);

  add_move_binding (binding_set, GDK_Home, 0,
		    GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);

  add_move_binding (binding_set, GDK_End, 0,
		    GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);

  add_move_binding (binding_set, GDK_KP_Home, 0,
		    GTK_MOVEMENT_DISPLAY_LINE_ENDS, -1);

  add_move_binding (binding_set, GDK_KP_End, 0,
		    GTK_MOVEMENT_DISPLAY_LINE_ENDS, 1);
  
  add_move_binding (binding_set, GDK_Home, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_BUFFER_ENDS, -1);

  add_move_binding (binding_set, GDK_End, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_BUFFER_ENDS, 1);

  add_move_binding (binding_set, GDK_KP_Home, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_BUFFER_ENDS, -1);

  add_move_binding (binding_set, GDK_KP_End, GDK_CONTROL_MASK,
		    GTK_MOVEMENT_BUFFER_ENDS, 1);

  /* copy */
  gtk_binding_entry_add_signal (binding_set, GDK_c, GDK_CONTROL_MASK,
				"copy_clipboard", 0);
Elliot Lee's avatar
Elliot Lee committed
451 452
}

453 454 455 456
static void 
gtk_label_set_property (GObject      *object,
			guint         prop_id,
			const GValue *value,
457
			GParamSpec   *pspec)
458
{
459
  GtkLabel *label;
460 461
  guint last_keyval;

462
  label = GTK_LABEL (object);
463
  last_keyval = label->mnemonic_keyval;
464
  
465
  switch (prop_id)
466
    {
467
    case PROP_LABEL:
468
      gtk_label_set_label (label, g_value_get_string (value));
469 470 471 472 473
      break;
    case PROP_ATTRIBUTES:
      gtk_label_set_attributes (label, g_value_get_boxed (value));
      break;
    case PROP_USE_MARKUP:
474
      gtk_label_set_use_markup (label, g_value_get_boolean (value));
475
      break;
476
    case PROP_USE_UNDERLINE:
477
      gtk_label_set_use_underline (label, g_value_get_boolean (value));
478
      break;
479 480
    case PROP_JUSTIFY:
      gtk_label_set_justify (label, g_value_get_enum (value));
481
      break;
482 483 484 485 486 487 488 489
    case PROP_PATTERN:
      gtk_label_set_pattern (label, g_value_get_string (value));
      break;
    case PROP_WRAP:
      gtk_label_set_line_wrap (label, g_value_get_boolean (value));
      break;	  
    case PROP_SELECTABLE:
      gtk_label_set_selectable (label, g_value_get_boolean (value));
490
      break;	  
491 492 493
    case PROP_MNEMONIC_WIDGET:
      gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
      break;
Tim Janik's avatar
Tim Janik committed
494
    default:
495
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
496
      break;
497 498 499
    }
}

500 501 502 503
static void 
gtk_label_get_property (GObject     *object,
			guint        prop_id,
			GValue      *value,
504
			GParamSpec  *pspec)
505
{
506
  GtkLabel *label;
507
  
508
  label = GTK_LABEL (object);
509
  
510
  switch (prop_id)
511
    {
512
    case PROP_LABEL:
Alexander Larsson's avatar
Alexander Larsson committed
513
      g_value_set_string (value, label->label);
514 515 516 517 518 519 520 521 522
      break;
    case PROP_ATTRIBUTES:
      g_value_set_boxed (value, label->attrs);
      break;
    case PROP_USE_MARKUP:
      g_value_set_boolean (value, label->use_markup);
      break;
    case PROP_USE_UNDERLINE:
      g_value_set_boolean (value, label->use_underline);
523
      break;
524 525
    case PROP_JUSTIFY:
      g_value_set_enum (value, label->jtype);
526
      break;
527 528
    case PROP_WRAP:
      g_value_set_boolean (value, label->wrap);
529
      break;
530 531 532
    case PROP_SELECTABLE:
      g_value_set_boolean (value, gtk_label_get_selectable (label));
      break;
533 534
    case PROP_MNEMONIC_KEYVAL:
      g_value_set_uint (value, label->mnemonic_keyval);
535
      break;
536 537 538
    case PROP_MNEMONIC_WIDGET:
      g_value_set_object (value, (GObject*) label->mnemonic_widget);
      break;
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
    case PROP_CURSOR_POSITION:
      if (label->select_info)
	{
	  gint offset = g_utf8_pointer_to_offset (label->label,
						  label->label + label->select_info->selection_end);
	  g_value_set_int (value, offset);
	}
      else
	g_value_set_int (value, 0);
      break;
    case PROP_SELECTION_BOUND:
      if (label->select_info)
	{
	  gint offset = g_utf8_pointer_to_offset (label->label,
						  label->label + label->select_info->selection_anchor);
	  g_value_set_int (value, offset);
	}
      else
	g_value_set_int (value, 0);
      break;
559

560
    default:
561
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
562 563 564 565
      break;
    }
}

566
static void
Elliot Lee's avatar
Elliot Lee committed
567 568 569
gtk_label_init (GtkLabel *label)
{
  GTK_WIDGET_SET_FLAGS (label, GTK_NO_WINDOW);
Tim Janik's avatar
Tim Janik committed
570
  
Elliot Lee's avatar
Elliot Lee committed
571
  label->label = NULL;
572

573
  label->jtype = GTK_JUSTIFY_LEFT;
Owen Taylor's avatar
Owen Taylor committed
574
  label->wrap = FALSE;
575 576 577

  label->use_underline = FALSE;
  label->use_markup = FALSE;
578
  
579
  label->mnemonic_keyval = GDK_VoidSymbol;
580
  label->layout = NULL;
581
  label->text = NULL;
582
  label->attrs = NULL;
583 584 585

  label->mnemonic_widget = NULL;
  label->mnemonic_window = NULL;
586
  
Owen Taylor's avatar
Owen Taylor committed
587
  gtk_label_set_text (label, "");
Elliot Lee's avatar
Elliot Lee committed
588 589
}

590 591 592 593
/**
 * gtk_label_new:
 * @str: The text of the label
 *
Matthias Clasen's avatar
Matthias Clasen committed
594 595
 * Creates a new label with the given text inside it. You can
 * pass %NULL to get an empty label widget.
596 597
 *
 * Return value: the new #GtkLabel
598
 **/
Elliot Lee's avatar
Elliot Lee committed
599
GtkWidget*
600
gtk_label_new (const gchar *str)
Elliot Lee's avatar
Elliot Lee committed
601 602
{
  GtkLabel *label;
603
  
604 605 606 607
  label = gtk_type_new (GTK_TYPE_LABEL);

  if (str && *str)
    gtk_label_set_text (label, str);
608
  
Elliot Lee's avatar
Elliot Lee committed
609 610 611
  return GTK_WIDGET (label);
}

612
/**
613 614 615 616 617 618
 * gtk_label_new_with_mnemonic:
 * @str: The text of the label, with an underscore in front of the
 *       mnemonic character
 *
 * Creates a new #GtkLabel, containing the text in @str.
 *
619
 * If characters in @str are preceded by an underscore, they are
620 621 622 623
 * underlined. If you need a literal underscore character in a label, use
 * '__' (two underscores). The first underlined character represents a 
 * keyboard accelerator called a mnemonic. The mnemonic key can be used 
 * to activate another widget, chosen automatically, or explicitly using
624 625 626 627 628 629 630 631
 * gtk_label_set_mnemonic_widget().
 * 
 * If gtk_label_set_mnemonic_widget()
 * is not called, then the first activatable ancestor of the #GtkLabel
 * will be chosen as the mnemonic widget. For instance, if the
 * label is inside a button or menu item, the button or menu item will
 * automatically become the mnemonic widget and be activated by
 * the mnemonic.
632 633
 *
 * Return value: the new #GtkLabel
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
 **/
GtkWidget*
gtk_label_new_with_mnemonic (const gchar *str)
{
  GtkLabel *label;
  
  label = gtk_type_new (GTK_TYPE_LABEL);

  if (str && *str)
    gtk_label_set_text_with_mnemonic (label, str);
  
  return GTK_WIDGET (label);
}

static gboolean
649
gtk_label_mnemonic_activate (GtkWidget *widget,
650 651 652 653 654
			     gboolean   group_cycling)
{
  GtkWidget *parent;

  if (GTK_LABEL (widget)->mnemonic_widget)
655
    return gtk_widget_mnemonic_activate (GTK_LABEL (widget)->mnemonic_widget, group_cycling);
656

657 658
  /* Try to find the widget to activate by traversing the
   * widget's ancestry.
659 660
   */
  parent = widget->parent;
661 662

  if (parent && GTK_IS_NOTEBOOK (parent))
663
    return FALSE;
664
  
665 666 667 668
  while (parent)
    {
      if (GTK_WIDGET_CAN_FOCUS (parent) ||
	  (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
669
          (parent->parent && GTK_IS_NOTEBOOK (parent->parent)) ||
670
	  (GTK_IS_MENU_ITEM (parent)))
671
	return gtk_widget_mnemonic_activate (parent, group_cycling);
672 673 674
      parent = parent->parent;
    }

675
  /* barf if there was nothing to activate */
676
  g_warning ("Couldn't find a target for a mnemonic activation.");
677
  gdk_display_beep (gtk_widget_get_display (widget));
678 679 680 681 682
  
  return FALSE;
}

static void
683 684
gtk_label_setup_mnemonic (GtkLabel *label,
			  guint     last_key)
685 686 687
{
  GtkWidget *toplevel;

688
  if (last_key != GDK_VoidSymbol && label->mnemonic_window)
689 690 691 692 693 694
    {
      gtk_window_remove_mnemonic  (label->mnemonic_window,
				   last_key,
				   GTK_WIDGET (label));
      label->mnemonic_window = NULL;
    }
695 696 697 698 699
  
  if (label->mnemonic_keyval == GDK_VoidSymbol)
    return;
  
  toplevel = gtk_widget_get_toplevel (GTK_WIDGET (label));
700
  if (GTK_WIDGET_TOPLEVEL (toplevel))
701 702 703 704 705 706 707 708 709
    {
      gtk_window_add_mnemonic (GTK_WINDOW (toplevel),
			       label->mnemonic_keyval,
			       GTK_WIDGET (label));
      label->mnemonic_window = GTK_WINDOW (toplevel);
    }
}

static void
710 711
gtk_label_hierarchy_changed (GtkWidget *widget,
			     GtkWidget *old_toplevel)
712 713
{
  GtkLabel *label = GTK_LABEL (widget);
714 715 716

  /* in case the label has been reparented to another screen */
  gtk_label_clear_layout (label);
717 718 719 720 721 722 723 724 725 726
  
  gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
}


/**
 * gtk_label_set_mnemonic_widget:
 * @label: a #GtkLabel
 * @widget: the target #GtkWidget 
 *
727 728 729 730 731 732 733 734 735
 * If the label has been set so that it has an mnemonic key (using
 * i.e.  gtk_label_set_markup_with_mnemonic(),
 * gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
 * or the "use_underline" property) the label can be associated with a
 * widget that is the target of the mnemonic. When the label is inside
 * a widget (like a #GtkButton or a #GtkNotebook tab) it is
 * automatically associated with the correct widget, but sometimes
 * (i.e. when the target is a #GtkEntry next to the label) you need to
 * set it explicitly using this function.
736
 *
737
 * The target widget will be accelerated by emitting "mnemonic_activate" on it.
738 739 740 741
 * The default handler for this signal will activate the widget if there are no
 * mnemonic collisions and toggle focus between the colliding widgets otherwise.
 **/
void
742 743
gtk_label_set_mnemonic_widget (GtkLabel  *label,
			       GtkWidget *widget)
744 745
{
  g_return_if_fail (GTK_IS_LABEL (label));
746 747
  if (widget)
    g_return_if_fail (GTK_IS_WIDGET (widget));
748

749 750
  if (label->mnemonic_widget)
    gtk_widget_unref (label->mnemonic_widget);
751
  label->mnemonic_widget = widget;
752 753
  if (label->mnemonic_widget)
    gtk_widget_ref (label->mnemonic_widget);
754 755
  
  g_object_notify (G_OBJECT (label), "mnemonic_widget");
756 757
}

758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774
/**
 * gtk_label_get_mnemonic_widget:
 * @label: a #GtkLabel
 *
 * Retrieves the target of the mnemonic (keyboard shortcut) of this
 * label. See gtk_label_set_mnemonic_widget ().
 *
 * Return value: the target of the label's mnemonic, or %NULL if none
 *               has been set and the default algorithm will be used.
 **/
GtkWidget *
gtk_label_get_mnemonic_widget (GtkLabel *label)
{
  g_return_val_if_fail (GTK_IS_LABEL (label), NULL);

  return label->mnemonic_widget;
}
775 776 777

/**
 * gtk_label_get_mnemonic_keyval:
778 779
 * @label: a #GtkLabel
 *
780 781 782
 * If the label has been set so that it has an mnemonic key this function
 * returns the keyval used for the mnemonic accelerator. If there is no
 * mnemonic set up it returns #GDK_VoidSymbol.
Havoc Pennington's avatar
Havoc Pennington committed
783
 *
Matthias Clasen's avatar
Matthias Clasen committed
784
 * Returns: GDK keyval usable for accelerators, or #GDK_VoidSymbol
785 786
 **/
guint
787
gtk_label_get_mnemonic_keyval (GtkLabel *label)
788 789 790
{
  g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);

791
  return label->mnemonic_keyval;
792 793 794
}

static void
795
gtk_label_set_text_internal (GtkLabel *label,
796
			     gchar    *str)
797 798 799 800 801 802 803 804 805 806 807
{
  g_free (label->text);
  
  label->text = str;

  gtk_label_select_region_index (label, 0, 0);
}

static void
gtk_label_set_label_internal (GtkLabel *label,
			      gchar    *str)
Elliot Lee's avatar
Elliot Lee committed
808
{
809
  g_free (label->label);
810
  
811
  label->label = str;
812

813 814
  g_object_notify (G_OBJECT (label), "label");
}
815

816 817
static void
gtk_label_set_use_markup_internal (GtkLabel *label,
818
				   gboolean  val)
819 820 821
{
  val = val != FALSE;
  if (label->use_markup != val)
822 823 824 825
    {
      g_object_notify (G_OBJECT (label), "use_markup");
      label->use_markup = val;
    }
826 827 828 829 830 831 832 833
}

static void
gtk_label_set_use_underline_internal (GtkLabel *label,
				      gboolean val)
{
  val = val != FALSE;
  if (label->use_underline != val)
834 835 836 837
    {
      g_object_notify (G_OBJECT (label), "use_underline");
      label->use_underline = val;
    }
838 839 840
}

static void
841 842
gtk_label_set_attributes_internal (GtkLabel      *label,
				   PangoAttrList *attrs)
843 844 845
{
  if (attrs)
    pango_attr_list_ref (attrs);
846
  
847 848 849
  if (label->attrs)
    pango_attr_list_unref (label->attrs);

850 851 852 853 854 855 856 857
  if (!label->use_markup && !label->use_underline)
    {
      pango_attr_list_ref (attrs);
      if (label->effective_attrs)
	pango_attr_list_unref (label->effective_attrs);
      label->effective_attrs = attrs;
    }

858 859 860 861 862
  label->attrs = attrs;
  g_object_notify (G_OBJECT (label), "attributes");
}


863
/* Calculates text, attrs and mnemonic_keyval from
864 865
 * label, use_underline and use_markup
 */
866 867 868 869
static void
gtk_label_recalculate (GtkLabel *label)
{
  if (label->use_markup)
870
    set_markup (label, label->label, label->use_underline);
871 872 873 874 875 876 877
  else
    {
      if (label->use_underline)
	gtk_label_set_uline_text_internal (label, label->label);
      else
	{
	  gtk_label_set_text_internal (label, g_strdup (label->label));
878 879 880 881 882
	  if (label->attrs)
	    pango_attr_list_ref (label->attrs);
	  if (label->effective_attrs)
	    pango_attr_list_unref (label->effective_attrs);
	  label->effective_attrs = label->attrs;
883 884 885 886
	}
    }

  if (!label->use_underline)
887 888
    {
      guint keyval = label->mnemonic_keyval;
889

890 891 892
      label->mnemonic_keyval = GDK_VoidSymbol;
      gtk_label_setup_mnemonic (label, keyval);
    }
893 894

  gtk_label_clear_layout (label);  
895
  gtk_widget_queue_resize (GTK_WIDGET (label));
896 897
}

898 899
/**
 * gtk_label_set_text:
Havoc Pennington's avatar
Havoc Pennington committed
900
 * @label: a #GtkLabel
Matthias Clasen's avatar
Matthias Clasen committed
901
 * @str: The text you want to set.
902
 *
Matthias Clasen's avatar
Matthias Clasen committed
903 904
 * Sets the text within the #GtkLabel widget.  It overwrites any text that
 * was there before.  
905 906 907
 *
 * This will also clear any previously set mnemonic accelerators.
 **/
908
void
909 910
gtk_label_set_text (GtkLabel    *label,
		    const gchar *str)
911 912
{
  g_return_if_fail (GTK_IS_LABEL (label));
913
  
914 915
  g_object_freeze_notify (G_OBJECT (label));

916 917 918 919 920
  gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
  gtk_label_set_use_markup_internal (label, FALSE);
  gtk_label_set_use_underline_internal (label, FALSE);
  
  gtk_label_recalculate (label);
921 922

  g_object_thaw_notify (G_OBJECT (label));
923 924
}

925 926 927 928 929 930
/**
 * gtk_label_set_attributes:
 * @label: a #GtkLabel
 * @attrs: a #PangoAttrList
 * 
 * Sets a #PangoAttrList; the attributes in the list are applied to the
931 932
 * label text. The attributes set with this function will be ignored
 * if label->use_underline or label->use_markup is %TRUE.
933 934 935 936 937 938 939
 **/
void
gtk_label_set_attributes (GtkLabel         *label,
                          PangoAttrList    *attrs)
{
  g_return_if_fail (GTK_IS_LABEL (label));

940
  gtk_label_set_attributes_internal (label, attrs);
941
  
942 943
  gtk_label_clear_layout (label);  
  gtk_widget_queue_resize (GTK_WIDGET (label));
944 945
}

946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
/**
 * gtk_label_get_attributes:
 * @label: a #GtkLabel
 *
 * Gets the attribute list that was set on the label using
 * gtk_label_set_attributes(), if any. This function does
 * not reflect attributes that come from the labels markup
 * (see gtk_label_set_markup()). If you want to get the
 * effective attributes for the label, use
 * pango_layout_get_attribute (gtk_label_get_layout (label)).
 *
 * Return value: the attribute list, or %NULL if none was set.
 **/
PangoAttrList *
gtk_label_get_attributes (GtkLabel *label)
{
  g_return_val_if_fail (GTK_IS_LABEL (label), NULL);

  return label->attrs;
}

/**
 * gtk_label_set_label:
 * @label: a #GtkLabel
 * @str: the new text to set for the label
 *
 * Sets the text of the label. The label is interpreted as
 * including embedded underlines and/or Pango markup depending
 * on the values of label->use_underline and label->use_markup.
 **/
void
gtk_label_set_label (GtkLabel    *label,
		     const gchar *str)
{
  guint last_keyval;

  g_return_if_fail (GTK_IS_LABEL (label));
  g_return_if_fail (str != NULL);

  last_keyval = label->mnemonic_keyval;

  gtk_label_set_label_internal (label, g_strdup (str));
  gtk_label_recalculate (label);
  if (last_keyval != label->mnemonic_keyval)
    gtk_label_setup_mnemonic (label, last_keyval);
}

/**
 * gtk_label_get_label:
 * @label: a #GtkLabel
 *
 * Fetches the text from a label widget including any embedded
 * underlines indicating mnemonics and Pango markup. (See
 * gtk_label_get_text ()).
 *
 * Return value: the text of the label widget. This string is
 *   owned by the widget and must not be modified or freed.
 **/
G_CONST_RETURN gchar *
gtk_label_get_label (GtkLabel *label)
{
  g_return_val_if_fail (GTK_IS_LABEL (label), NULL);

  return label->label;
}

1012
static void
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
set_markup (GtkLabel    *label,
            const gchar *str,
            gboolean     with_uline)
{
  gchar *text = NULL;
  GError *error = NULL;
  PangoAttrList *attrs = NULL;
  gunichar accel_char = 0;

  if (!pango_parse_markup (str,
                           -1,
                           with_uline ? '_' : 0,
                           &attrs,
                           &text,
                           with_uline ? &accel_char : NULL,
                           &error))
    {
      g_warning ("Failed to set label from markup due to error parsing markup: %s",
                 error->message);
      g_error_free (error);
Alexander Larsson's avatar
Alexander Larsson committed
1033
      return;
1034 1035 1036
    }

  if (text)
1037
    gtk_label_set_text_internal (label, text);
1038 1039 1040

  if (attrs)
    {
1041 1042 1043
      if (label->effective_attrs)
	pango_attr_list_unref (label->effective_attrs);
      label->effective_attrs = attrs;
1044 1045 1046
    }

  if (accel_char != 0)
1047
    label->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
1048
  else
1049
    label->mnemonic_keyval = GDK_VoidSymbol;
1050 1051 1052 1053 1054 1055 1056
}

/**
 * gtk_label_set_markup:
 * @label: a #GtkLabel
 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
 * 
Havoc Pennington's avatar
Havoc Pennington committed
1057
 * Parses @str which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>,
1058 1059 1060 1061 1062 1063 1064 1065
 * setting the label's text and attribute list based on the parse results.
 **/
void
gtk_label_set_markup (GtkLabel    *label,
                      const gchar *str)
{  
  g_return_if_fail (GTK_IS_LABEL (label));

1066 1067 1068 1069 1070
  gtk_label_set_label_internal (label, g_strdup (str ? str : ""));
  gtk_label_set_use_markup_internal (label, TRUE);
  gtk_label_set_use_underline_internal (label, FALSE);
  
  gtk_label_recalculate (label);
1071 1072 1073
}

/**
1074
 * gtk_label_set_markup_with_mnemonic:
1075 1076 1077
 * @label: a #GtkLabel
 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
 * 
Havoc Pennington's avatar
Havoc Pennington committed
1078
 * Parses @str which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>,
1079 1080
 * setting the label's text and attribute list based on the parse results.
 * If characters in @str are preceded by an underscore, they are underlined