gtklabel.c 61.9 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 30
#include "gtksignal.h"
#include "gtkwindow.h"
31
#include "gdk/gdkkeysyms.h"
32
#include "gtkclipboard.h"
Owen Taylor's avatar
Owen Taylor committed
33
#include "gdk/gdki18n.h"
34
#include <pango/pango.h>
35
#include "gtkintl.h"
36 37
#include "gtkmenuitem.h"
#include "gtknotebook.h"
38

39 40 41 42 43 44
struct _GtkLabelSelectionInfo
{
  GdkWindow *window;
  gint selection_anchor;
  gint selection_end;
};
Elliot Lee's avatar
Elliot Lee committed
45

46

47
enum {
48 49 50 51 52 53 54 55 56
  PROP_0,
  PROP_LABEL,
  PROP_ATTRIBUTES,
  PROP_USE_MARKUP,
  PROP_USE_UNDERLINE,
  PROP_JUSTIFY,
  PROP_PATTERN,
  PROP_WRAP,
  PROP_SELECTABLE,
57 58
  PROP_MNEMONIC_KEYVAL,
  PROP_MNEMONIC_WIDGET
59 60
};

61 62
static void gtk_label_class_init        (GtkLabelClass    *klass);
static void gtk_label_init              (GtkLabel         *label);
63 64 65
static void gtk_label_set_property      (GObject          *object,
					 guint             prop_id,
					 const GValue     *value,
66
					 GParamSpec       *pspec);
67 68 69
static void gtk_label_get_property      (GObject          *object,
					 guint             prop_id,
					 GValue           *value,
70
					 GParamSpec       *pspec);
71
static void gtk_label_destroy           (GtkObject        *object);
72 73 74
static void gtk_label_finalize          (GObject          *object);
static void gtk_label_size_request      (GtkWidget        *widget,
					 GtkRequisition   *requisition);
75 76
static void gtk_label_size_allocate     (GtkWidget        *widget,
                                         GtkAllocation    *allocation);
Havoc Pennington's avatar
Havoc Pennington committed
77 78
static void gtk_label_state_changed     (GtkWidget        *widget,
                                         GtkStateType      state);
79 80 81 82 83 84
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
85

86 87 88 89 90 91 92 93 94 95 96
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);

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

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);
116 117
static void gtk_label_hierarchy_changed          (GtkWidget     *widget,
						  GtkWidget     *old_toplevel);
118

119 120 121 122 123 124 125 126 127 128
static void gtk_label_create_window       (GtkLabel *label);
static void gtk_label_destroy_window      (GtkLabel *label);
static void gtk_label_clear_layout        (GtkLabel *label);
static void gtk_label_ensure_layout       (GtkLabel *label,
                                           gint     *widthp,
                                           gint     *heightp);
static void gtk_label_select_region_index (GtkLabel *label,
                                           gint      anchor_index,
                                           gint      end_index);

129
static gboolean gtk_label_mnemonic_activate (GtkWidget *widget,
130
					     gboolean   group_cycling);
131 132
static void     gtk_label_setup_mnemonic    (GtkLabel  *label,
					     guint      last_key);
133

134

135 136
static GtkMiscClass *parent_class = NULL;

Elliot Lee's avatar
Elliot Lee committed
137

Tim Janik's avatar
Tim Janik committed
138
GtkType
139
gtk_label_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
140
{
Tim Janik's avatar
Tim Janik committed
141 142
  static GtkType label_type = 0;
  
Elliot Lee's avatar
Elliot Lee committed
143 144
  if (!label_type)
    {
145
      static const GTypeInfo label_info =
Elliot Lee's avatar
Elliot Lee committed
146 147
      {
	sizeof (GtkLabelClass),
148 149 150 151 152 153 154 155
	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
156
      };
157

158
      label_type = g_type_register_static (GTK_TYPE_MISC, "GtkLabel", &label_info, 0);
Elliot Lee's avatar
Elliot Lee committed
159
    }
Tim Janik's avatar
Tim Janik committed
160
  
Elliot Lee's avatar
Elliot Lee committed
161 162 163
  return label_type;
}

164
static void
Elliot Lee's avatar
Elliot Lee committed
165 166
gtk_label_class_init (GtkLabelClass *class)
{
167
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
168 169 170
  GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);

171
  parent_class = gtk_type_class (GTK_TYPE_MISC);
Tim Janik's avatar
Tim Janik committed
172
  
173 174
  gobject_class->set_property = gtk_label_set_property;
  gobject_class->get_property = gtk_label_get_property;
175
  gobject_class->finalize = gtk_label_finalize;
176 177

  object_class->destroy = gtk_label_destroy;
Tim Janik's avatar
Tim Janik committed
178
  
Elliot Lee's avatar
Elliot Lee committed
179
  widget_class->size_request = gtk_label_size_request;
180
  widget_class->size_allocate = gtk_label_size_allocate;
Havoc Pennington's avatar
Havoc Pennington committed
181
  widget_class->state_changed = gtk_label_state_changed;
182
  widget_class->style_set = gtk_label_style_set;
183
  widget_class->direction_changed = gtk_label_direction_changed;
Elliot Lee's avatar
Elliot Lee committed
184
  widget_class->expose_event = gtk_label_expose;
185 186 187 188 189 190 191
  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;
192
  widget_class->hierarchy_changed = gtk_label_hierarchy_changed;
193
  widget_class->mnemonic_activate = gtk_label_mnemonic_activate;
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

  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"),
220
							 _("If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key"),
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
                                                        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
237
                                                        _("A string with _ characters in positions correspond to characters in the text to underline."),
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
                                                        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."),
                                                        TRUE,
                                                        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,
256 257
                                   PROP_MNEMONIC_KEYVAL,
                                   g_param_spec_uint ("mnemonic_keyval",
258
						      _("Mnemonic key"),
259
						      _("The mnemonic accelerator key for this label."),
260 261 262 263
						      0,
						      G_MAXUINT,
						      GDK_VoidSymbol,
						      G_PARAM_READABLE));
264 265 266 267 268 269 270 271
  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));
Elliot Lee's avatar
Elliot Lee committed
272 273
}

274 275 276 277
static void 
gtk_label_set_property (GObject      *object,
			guint         prop_id,
			const GValue *value,
278
			GParamSpec   *pspec)
279
{
280
  GtkLabel *label;
281 282
  guint last_keyval;

283
  label = GTK_LABEL (object);
284
  last_keyval = label->mnemonic_keyval;
285
  
286
  switch (prop_id)
287
    {
288
    case PROP_LABEL:
289
      gtk_label_set_label (label, g_value_get_string (value));
290 291 292 293 294
      break;
    case PROP_ATTRIBUTES:
      gtk_label_set_attributes (label, g_value_get_boxed (value));
      break;
    case PROP_USE_MARKUP:
295
      gtk_label_set_use_markup (label, g_value_get_boolean (value));
296
      break;
297
    case PROP_USE_UNDERLINE:
298
      gtk_label_set_use_underline (label, g_value_get_boolean (value));
299
      break;
300 301
    case PROP_JUSTIFY:
      gtk_label_set_justify (label, g_value_get_enum (value));
302
      break;
303 304 305 306 307 308 309 310
    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));
311
      break;	  
312 313 314
    case PROP_MNEMONIC_WIDGET:
      gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
      break;
Tim Janik's avatar
Tim Janik committed
315
    default:
316
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
317
      break;
318 319 320
    }
}

321 322 323 324
static void 
gtk_label_get_property (GObject     *object,
			guint        prop_id,
			GValue      *value,
325
			GParamSpec  *pspec)
326
{
327
  GtkLabel *label;
328
  
329
  label = GTK_LABEL (object);
330
  
331
  switch (prop_id)
332
    {
333
    case PROP_LABEL:
Alexander Larsson's avatar
Alexander Larsson committed
334
      g_value_set_string (value, label->label);
335 336 337 338 339 340 341 342 343
      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);
344
      break;
345 346
    case PROP_JUSTIFY:
      g_value_set_enum (value, label->jtype);
347
      break;
348 349
    case PROP_WRAP:
      g_value_set_boolean (value, label->wrap);
350
      break;
351 352 353
    case PROP_SELECTABLE:
      g_value_set_boolean (value, gtk_label_get_selectable (label));
      break;
354 355
    case PROP_MNEMONIC_KEYVAL:
      g_value_set_uint (value, label->mnemonic_keyval);
356
      break;
357 358 359
    case PROP_MNEMONIC_WIDGET:
      g_value_set_object (value, (GObject*) label->mnemonic_widget);
      break;
360

361
    default:
362
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
363 364 365 366
      break;
    }
}

367
static void
Elliot Lee's avatar
Elliot Lee committed
368 369 370
gtk_label_init (GtkLabel *label)
{
  GTK_WIDGET_SET_FLAGS (label, GTK_NO_WINDOW);
Tim Janik's avatar
Tim Janik committed
371
  
Elliot Lee's avatar
Elliot Lee committed
372
  label->label = NULL;
373

Elliot Lee's avatar
Elliot Lee committed
374
  label->jtype = GTK_JUSTIFY_CENTER;
Owen Taylor's avatar
Owen Taylor committed
375
  label->wrap = FALSE;
376 377 378

  label->use_underline = FALSE;
  label->use_markup = FALSE;
379
  
380
  label->mnemonic_keyval = GDK_VoidSymbol;
381
  label->layout = NULL;
382
  label->text = NULL;
383
  label->attrs = NULL;
384 385 386

  label->mnemonic_widget = NULL;
  label->mnemonic_window = NULL;
387
  
Owen Taylor's avatar
Owen Taylor committed
388
  gtk_label_set_text (label, "");
Elliot Lee's avatar
Elliot Lee committed
389 390
}

391 392 393 394 395
/**
 * gtk_label_new:
 * @str: The text of the label
 *
 * Creates a new #GtkLabel, containing the text in @str.
396 397
 *
 * Return value: the new #GtkLabel
398
 **/
Elliot Lee's avatar
Elliot Lee committed
399
GtkWidget*
400
gtk_label_new (const gchar *str)
Elliot Lee's avatar
Elliot Lee committed
401 402
{
  GtkLabel *label;
403
  
404 405 406 407
  label = gtk_type_new (GTK_TYPE_LABEL);

  if (str && *str)
    gtk_label_set_text (label, str);
408
  
Elliot Lee's avatar
Elliot Lee committed
409 410 411
  return GTK_WIDGET (label);
}

412
/**
413 414 415 416 417 418
 * 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.
 *
419 420 421 422 423 424 425 426 427 428 429 430
 * If characters in @str are preceded by an underscore, they are
 * underlined indicating that they represent a keyboard accelerator
 * called a mnemonic.  The mnemonic key can be used to activate
 * another widget, chosen automatically, or explicitly using
 * 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.
431 432
 *
 * Return value: the new #GtkLabel
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
 **/
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
448
gtk_label_mnemonic_activate (GtkWidget *widget,
449 450 451 452 453
			     gboolean   group_cycling)
{
  GtkWidget *parent;

  if (GTK_LABEL (widget)->mnemonic_widget)
454
    return gtk_widget_mnemonic_activate (GTK_LABEL (widget)->mnemonic_widget, group_cycling);
455

456 457
  /* Try to find the widget to activate by traversing the
   * widget's ancestry.
458 459 460 461 462 463
   */
  parent = widget->parent;
  while (parent)
    {
      if (GTK_WIDGET_CAN_FOCUS (parent) ||
	  (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
464
          (parent->parent && GTK_IS_NOTEBOOK (parent->parent)) ||
465
	  (GTK_IS_MENU_ITEM (parent)))
466
	return gtk_widget_mnemonic_activate (parent, group_cycling);
467 468 469
      parent = parent->parent;
    }

470
  /* barf if there was nothing to activate */
471 472 473 474 475 476 477
  g_warning ("Couldn't find a target for a mnemonic activation.");
  gdk_beep ();
  
  return FALSE;
}

static void
478 479
gtk_label_setup_mnemonic (GtkLabel *label,
			  guint     last_key)
480 481 482
{
  GtkWidget *toplevel;

483
  if (last_key != GDK_VoidSymbol && label->mnemonic_window)
484 485 486 487 488 489
    {
      gtk_window_remove_mnemonic  (label->mnemonic_window,
				   last_key,
				   GTK_WIDGET (label));
      label->mnemonic_window = NULL;
    }
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
  
  if (label->mnemonic_keyval == GDK_VoidSymbol)
    return;
  
  toplevel = gtk_widget_get_toplevel (GTK_WIDGET (label));
  
  if (GTK_IS_WINDOW (toplevel))
    {
      gtk_window_add_mnemonic (GTK_WINDOW (toplevel),
			       label->mnemonic_keyval,
			       GTK_WIDGET (label));
      label->mnemonic_window = GTK_WINDOW (toplevel);
    }
}

static void
506 507
gtk_label_hierarchy_changed (GtkWidget *widget,
			     GtkWidget *old_toplevel)
508 509 510 511 512 513 514 515 516 517 518 519
{
  GtkLabel *label = GTK_LABEL (widget);
  
  gtk_label_setup_mnemonic (label, label->mnemonic_keyval);
}


/**
 * gtk_label_set_mnemonic_widget:
 * @label: a #GtkLabel
 * @widget: the target #GtkWidget 
 *
520 521 522 523 524 525 526 527 528
 * 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.
529
 *
530
 * The target widget will be accelerated by emitting "mnemonic_activate" on it.
531 532 533 534
 * 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
535 536
gtk_label_set_mnemonic_widget (GtkLabel  *label,
			       GtkWidget *widget)
537 538
{
  g_return_if_fail (GTK_IS_LABEL (label));
539 540
  if (widget)
    g_return_if_fail (GTK_IS_WIDGET (widget));
541

542 543
  if (label->mnemonic_widget)
    gtk_widget_unref (label->mnemonic_widget);
544
  label->mnemonic_widget = widget;
545 546
  if (label->mnemonic_widget)
    gtk_widget_ref (label->mnemonic_widget);
547 548
}

549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
/**
 * 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;
}
566 567 568

/**
 * gtk_label_get_mnemonic_keyval:
569 570
 * @label: a #GtkLabel
 *
571 572 573
 * 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
574 575
 *
 * Returns: GDK keyval usable for accelerators, or GDK_VoidSymbol
576 577
 **/
guint
578
gtk_label_get_mnemonic_keyval (GtkLabel *label)
579 580 581
{
  g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);

582
  return label->mnemonic_keyval;
583 584 585
}

static void
586
gtk_label_set_text_internal (GtkLabel *label,
587
			     gchar    *str)
588 589 590 591 592 593 594 595 596 597 598
{
  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
599
{
600
  g_free (label->label);
601
  
602
  label->label = str;
603

604 605
  g_object_notify (G_OBJECT (label), "label");
}
606

607 608
static void
gtk_label_set_use_markup_internal (GtkLabel *label,
609
				   gboolean  val)
610 611 612
{
  val = val != FALSE;
  if (label->use_markup != val)
613 614 615 616
    {
      g_object_notify (G_OBJECT (label), "use_markup");
      label->use_markup = val;
    }
617 618 619 620 621 622 623 624
}

static void
gtk_label_set_use_underline_internal (GtkLabel *label,
				      gboolean val)
{
  val = val != FALSE;
  if (label->use_underline != val)
625 626 627 628
    {
      g_object_notify (G_OBJECT (label), "use_underline");
      label->use_underline = val;
    }
629 630 631
}

static void
632 633
gtk_label_set_attributes_internal (GtkLabel      *label,
				   PangoAttrList *attrs)
634 635 636
{
  if (attrs)
    pango_attr_list_ref (attrs);
637
  
638 639 640
  if (label->attrs)
    pango_attr_list_unref (label->attrs);

641 642 643 644 645 646 647 648
  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;
    }

649 650 651 652 653
  label->attrs = attrs;
  g_object_notify (G_OBJECT (label), "attributes");
}


654
/* Calculates text, attrs and mnemonic_keyval from
655 656
 * label, use_underline and use_markup
 */
657 658 659 660
static void
gtk_label_recalculate (GtkLabel *label)
{
  if (label->use_markup)
661
    set_markup (label, label->label, label->use_underline);
662 663 664 665 666 667 668
  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));
669 670 671 672 673
	  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;
674 675 676 677
	}
    }

  if (!label->use_underline)
678 679
    {
      guint keyval = label->mnemonic_keyval;
680

681 682 683
      label->mnemonic_keyval = GDK_VoidSymbol;
      gtk_label_setup_mnemonic (label, keyval);
    }
684 685

  gtk_label_clear_layout (label);  
686
  gtk_widget_queue_resize (GTK_WIDGET (label));
687 688
}

689 690
/**
 * gtk_label_set_text:
Havoc Pennington's avatar
Havoc Pennington committed
691 692
 * @label: a #GtkLabel
 * @str: a string
693 694 695 696 697
 *
 * Sets the text of the label to @str.
 *
 * This will also clear any previously set mnemonic accelerators.
 **/
698
void
699 700
gtk_label_set_text (GtkLabel    *label,
		    const gchar *str)
701 702
{
  g_return_if_fail (GTK_IS_LABEL (label));
703
  
704 705 706 707 708
  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);
709 710
}

711 712 713 714 715 716
/**
 * gtk_label_set_attributes:
 * @label: a #GtkLabel
 * @attrs: a #PangoAttrList
 * 
 * Sets a #PangoAttrList; the attributes in the list are applied to the
717 718
 * label text. The attributes set with this function will be ignored
 * if label->use_underline or label->use_markup is %TRUE.
719 720 721 722 723 724 725
 **/
void
gtk_label_set_attributes (GtkLabel         *label,
                          PangoAttrList    *attrs)
{
  g_return_if_fail (GTK_IS_LABEL (label));

726
  gtk_label_set_attributes_internal (label, attrs);
727
  
728 729
  gtk_label_clear_layout (label);  
  gtk_widget_queue_resize (GTK_WIDGET (label));
730 731
}

732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
/**
 * 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;
}

798
static void
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
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
819
      return;
820 821 822
    }

  if (text)
823
    gtk_label_set_text_internal (label, text);
824 825 826

  if (attrs)
    {
827 828 829
      if (label->effective_attrs)
	pango_attr_list_unref (label->effective_attrs);
      label->effective_attrs = attrs;
830 831 832
    }

  if (accel_char != 0)
833
    label->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
834
  else
835
    label->mnemonic_keyval = GDK_VoidSymbol;
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
}

/**
 * gtk_label_set_markup:
 * @label: a #GtkLabel
 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
 * 
 * Parses @str which is marked up with the Pango text markup language,
 * 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));

852 853 854 855 856
  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);
857 858 859
}

/**
860
 * gtk_label_set_markup_with_mnemonic:
861 862 863 864 865 866
 * @label: a #GtkLabel
 * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
 * 
 * Parses @str which is marked up with the Pango text markup language,
 * 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
867
 * indicating that they represent a keyboard accelerator called a mnemonic.
868
 *
869
 * The mnemonic key can be used to activate another widget, chosen automatically,
870
 * or explicitly using gtk_label_set_mnemonic_widget().
871
 **/
872 873 874
void
gtk_label_set_markup_with_mnemonic (GtkLabel    *label,
				    const gchar *str)
875
{
876 877
  guint last_keyval;
  g_return_if_fail (GTK_IS_LABEL (label));
878

879
  last_keyval = label->mnemonic_keyval;
880 881 882 883 884
  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, TRUE);
  
  gtk_label_recalculate (label);
885
  gtk_label_setup_mnemonic (label, last_keyval);
886 887
}

888 889 890 891
/**
 * gtk_label_get_text:
 * @label: a #GtkLabel
 * 
892 893 894
 * Fetches the text from a label widget, as displayed on the
 * screen. This does not include any embedded underlines
 * indicating mnemonics or Pango markup. (See gtk_label_get_label())
895
 * 
896
 * Return value: the text in the label widget. This is the internal
897
 *   string used by the label, and must not be modified.
898
 **/
899
G_CONST_RETURN gchar *
900 901
gtk_label_get_text (GtkLabel *label)
{
902 903
  g_return_val_if_fail (label != NULL, NULL);
  g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
904

905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
  return label->text;
}

static PangoAttrList *
gtk_label_pattern_to_attrs (GtkLabel      *label,
			    const gchar   *pattern)
{
  const char *start;
  const char *p = label->text;
  const char *q = pattern;
  PangoAttrList *attrs;

  attrs = pango_attr_list_new ();

  while (1)
    {
      while (*p && *q && *q != '_')
	{
	  p = g_utf8_next_char (p);
	  q++;
	}
      start = p;
      while (*p && *q && *q == '_')
	{
	  p = g_utf8_next_char (p);
	  q++;
	}
      
      if (p > start)
	{
	  PangoAttribute *attr = pango_attr_underline_new (PANGO_UNDERLINE_LOW);
	  attr->start_index = start - label->text;
	  attr->end_index = p - label->text;
	  
	  pango_attr_list_insert (attrs, attr);
	}
      else
	break;
    }

  return attrs;
}

static void
gtk_label_set_pattern_internal (GtkLabel    *label,
				const gchar *pattern)
{
  PangoAttrList *attrs;
  g_return_if_fail (GTK_IS_LABEL (label));
  
  attrs = gtk_label_pattern_to_attrs (label, pattern);
  gtk_label_set_attributes_internal (label, attrs);
957 958
}

959 960 961 962 963 964
void
gtk_label_set_pattern (GtkLabel	   *label,
		       const gchar *pattern)
{
  g_return_if_fail (GTK_IS_LABEL (label));
  
965
  gtk_label_set_pattern_internal (label, pattern);
966

967
  gtk_label_clear_layout (label);  
968
  gtk_widget_queue_resize (GTK_WIDGET (label));
Elliot Lee's avatar
Elliot Lee committed
969 970
}

971

972 973 974 975 976 977 978 979
/**
 * gtk_label_set_justify:
 * @label: a #GtkLabel
 * @jtype: a #GtkJustification
 *
 * Sets the alignment of the lines in the text of the label relative to
 * each other.
 **/
Elliot Lee's avatar
Elliot Lee committed
980
void
981 982
gtk_label_set_justify (GtkLabel        *label,
		       GtkJustification jtype)
Elliot Lee's avatar
Elliot Lee committed
983 984
{
  g_return_if_fail (GTK_IS_LABEL (label));
985
  g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
986
  
Elliot Lee's avatar
Elliot Lee committed
987 988 989
  if ((GtkJustification) label->jtype != jtype)
    {
      label->jtype = jtype;
990

991 992
      /* No real need to be this drastic, but easier than duplicating the code */
      gtk_label_clear_layout (label);
993
      
994
      g_object_notify (G_OBJECT (label), "justify");
995
      gtk_widget_queue_resize (GTK_WIDGET (label));
Elliot Lee's avatar
Elliot Lee committed
996 997 998
    }
}

999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
/**
 * gtk_label_get_justify:
 * @label: a #GtkLabel
 *
 * Returns the justification of the label. See gtk_label_set_justification ().
 *
 * Return value: GtkJustification
 **/
GtkJustification
gtk_label_get_justify (GtkLabel *label)
{
  g_return_val_if_fail (GTK_IS_LABEL (label), 0);

  return label->jtype;
}

/**
 * gtk_label_set_line_wrap:
 * @label: a #GtkLabel
 * @wrap: the setting
 *
 * If true, the lines will be wrapped if the text becomes too wide.
 */
Elliot Lee's avatar
Elliot Lee committed
1022
void
1023 1024
gtk_label_set_line_wrap (GtkLabel *label,
			 gboolean  wrap)
Owen Taylor's avatar
Owen Taylor committed
1025 1026
{
  g_return_if_fail (GTK_IS_LABEL (label));
1027
  
1028 1029 1030 1031 1032
  wrap = wrap != FALSE;
  
  if (label->wrap != wrap)
    {
      label->wrap = wrap;
1033 1034
      g_object_notify (G_OBJECT (label), "wrap");
      
1035 1036
      gtk_widget_queue_resize (GTK_WIDGET (label));
    }
Owen Taylor's avatar
Owen Taylor committed
1037 1038
}

1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054
/**
 * gtk_label_get_line_wrap:
 * @label: a #GtkLabel
 *
 * Returns whether lines in the label are automatically wrapped. See gtk_label_set_line_wrap ().
 *
 * Return value: %TRUE if the lines of the label are automatically wrapped.
 */
gboolean
gtk_label_get_line_wrap (GtkLabel *label)
{
  g_return_val_if_fail (GTK_IS_LABEL (label), FALSE);

  return label->wrap;
}

Owen Taylor's avatar
Owen Taylor committed
1055
void
1056 1057
gtk_label_get (GtkLabel *label,
	       gchar   **str)
Elliot Lee's avatar
Elliot Lee committed
1058 1059 1060 1061
{
  g_return_if_fail (label != NULL);
  g_return_if_fail (GTK_IS_LABEL (label));
  g_return_if_fail (str != NULL);
1062
  
1063
  *str = label->text;
Elliot Lee's avatar
Elliot Lee committed
1064 1065
}

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
static void
gtk_label_destroy (GtkObject *object)
{
  GtkLabel *label = GTK_LABEL (object);

  gtk_label_set_mnemonic_widget (label, NULL);

  GTK_OBJECT_CLASS (parent_class)->destroy (object);
}

Elliot Lee's avatar
Elliot Lee committed
1076
static void
1077
gtk_label_finalize (GObject *object)
Elliot Lee's avatar
Elliot Lee committed
1078 1079
{
  GtkLabel *label;
1080
  
Elliot Lee's avatar
Elliot Lee committed
1081
  g_return_if_fail (GTK_IS_LABEL (object));
1082
  
Elliot Lee's avatar
Elliot Lee committed
1083
  label = GTK_LABEL (object);
1084
  
Elliot Lee's avatar
Elliot Lee committed
1085
  g_free (label->label);
1086
  g_free (label->text);
1087

1088
  if (label->layout)
1089
    g_object_unref (G_OBJECT (label->layout));
1090

1091 1092
  if (label->attrs)
    pango_attr_list_unref (label->attrs);
1093

1094 1095 1096
  if (label->effective_attrs)
    pango_attr_list_unref (label->attrs);

1097
  g_free (label->select_info);
1098

1099
  G_OBJECT_CLASS (parent_class)->finalize (object);
Elliot Lee's avatar
Elliot Lee committed
1100 1101 1102
}

static void
1103
gtk_label_clear_layout (GtkLabel *label)
Elliot Lee's avatar
Elliot Lee committed
1104
{
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
  if (label->layout)
    {
      g_object_unref (G_OBJECT (label->layout));
      label->layout = NULL;
    }
}

static void
gtk_label_ensure_layout (GtkLabel *label,
                         gint     *widthp,
                         gint     *heightp)
{
  GtkWidget *widget;
1118
  PangoRectangle logical_rect;
1119
  gint rwidth, rheight;
1120 1121

  widget = GTK_WIDGET (label);
1122

Owen Taylor's avatar
Owen Taylor committed
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
  /*
   * There are a number of conditions which will necessitate re-filling
   * our text:
   *
   *     1. text changed.
   *     2. justification changed either from to to GTK_JUSTIFY_FILL.
   *     3. font changed.
   *
   * These have been detected elsewhere, and label->words will be zero,
   * if one of the above has occured.
   *
   * Additionally, though, if GTK_JUSTIFY_FILL, we need to re-fill if:
   *
   *     4. gtk_widget_set_usize has changed the requested width.
   *     5. gtk_misc_set_padding has changed xpad.
   *     6.  maybe others?...
   *
   * Too much of a pain to detect all these case, so always re-fill.  I
   * don't think it's really that slow.
   */
1143

1144 1145
  rwidth = label->misc.xpad * 2;
  rheight = label->misc.ypad * 2;
1146 1147 1148 1149 1150

  if (!label->layout)
    {
      PangoAlignment align = PANGO_ALIGN_LEFT; /* Quiet gcc */

1151
      label->layout = gtk_widget_create_pango_layout (widget, label->text);
1152

1153 1154
      if (label->effective_attrs)
	pango_layout_set_attributes (label->layout, label->effective_attrs);
1155
      
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172