gtklabel.c 51.8 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);
77 78 79 80 81 82
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
83

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

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

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);
114
static void gtk_label_hierarchy_changed          (GtkWidget     *widget);
115

116 117 118 119 120 121 122 123 124 125
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);

126
static gboolean gtk_label_mnemonic_activate (GtkWidget *widget,
127
					     gboolean   group_cycling);
128 129
static void     gtk_label_setup_mnemonic    (GtkLabel  *label,
					     guint      last_key);
130

131

132 133
static GtkMiscClass *parent_class = NULL;

Elliot Lee's avatar
Elliot Lee committed
134

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

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

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

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

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

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

270 271 272 273
static void 
gtk_label_set_property (GObject      *object,
			guint         prop_id,
			const GValue *value,
274
			GParamSpec   *pspec)
275
{
276
  GtkLabel *label;
277 278
  guint last_keyval;

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

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

365
    default:
366
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
367 368 369 370
      break;
    }
}

371
static void
Elliot Lee's avatar
Elliot Lee committed
372 373 374
gtk_label_init (GtkLabel *label)
{
  GTK_WIDGET_SET_FLAGS (label, GTK_NO_WINDOW);
Tim Janik's avatar
Tim Janik committed
375
  
Elliot Lee's avatar
Elliot Lee committed
376
  label->label = NULL;
377

Elliot Lee's avatar
Elliot Lee committed
378
  label->jtype = GTK_JUSTIFY_CENTER;
Owen Taylor's avatar
Owen Taylor committed
379
  label->wrap = FALSE;
380 381 382

  label->use_underline = FALSE;
  label->use_markup = FALSE;
383
  
384
  label->mnemonic_keyval = GDK_VoidSymbol;
385
  label->layout = NULL;
386
  label->text = NULL;
387
  label->attrs = NULL;
388 389 390

  label->mnemonic_widget = NULL;
  label->mnemonic_window = NULL;
391
  
Owen Taylor's avatar
Owen Taylor committed
392
  gtk_label_set_text (label, "");
Elliot Lee's avatar
Elliot Lee committed
393 394
}

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

  if (str && *str)
    gtk_label_set_text (label, str);
411
  
Elliot Lee's avatar
Elliot Lee committed
412 413 414
  return GTK_WIDGET (label);
}

415
/**
416 417 418 419 420 421 422 423 424 425
 * gtk_label_new_with_mnemonic:
 * @str: The text of the label, with an underscore in front of the
 *       mnemonic character
 * @returns: a new #GtkLabel
 *
 * Creates a new #GtkLabel, containing the text in @str.
 *
 * 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,
426
 * or explicitly using gtk_label_set_mnemonic_widget().
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
 **/
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
442
gtk_label_mnemonic_activate (GtkWidget *widget,
443 444 445 446 447
			     gboolean   group_cycling)
{
  GtkWidget *parent;

  if (GTK_LABEL (widget)->mnemonic_widget)
448
    return gtk_widget_mnemonic_activate (GTK_LABEL (widget)->mnemonic_widget, group_cycling);
449

450 451
  /* Try to find the widget to activate by traversing the
   * widget's ancestry.
452 453 454 455 456 457
   */
  parent = widget->parent;
  while (parent)
    {
      if (GTK_WIDGET_CAN_FOCUS (parent) ||
	  (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
458
          (parent->parent && GTK_IS_NOTEBOOK (parent->parent)) ||
459
	  (GTK_IS_MENU_ITEM (parent)))
460
	return gtk_widget_mnemonic_activate (parent, group_cycling);
461 462 463
      parent = parent->parent;
    }

464
  /* barf if there was nothing to activate */
465 466 467 468 469 470 471
  g_warning ("Couldn't find a target for a mnemonic activation.");
  gdk_beep ();
  
  return FALSE;
}

static void
472 473
gtk_label_setup_mnemonic (GtkLabel *label,
			  guint     last_key)
474 475 476
{
  GtkWidget *toplevel;

477
  if (last_key != GDK_VoidSymbol && label->mnemonic_window)
478 479 480 481 482 483
    {
      gtk_window_remove_mnemonic  (label->mnemonic_window,
				   last_key,
				   GTK_WIDGET (label));
      label->mnemonic_window = NULL;
    }
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
  
  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
gtk_label_hierarchy_changed (GtkWidget *widget)
{
  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 
 *
513 514 515 516 517 518 519 520 521
 * 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.
522
 *
523
 * The target widget will be accelerated by emitting "mnemonic_activate" on it.
524 525 526 527
 * 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
528 529
gtk_label_set_mnemonic_widget (GtkLabel  *label,
			       GtkWidget *widget)
530 531
{
  g_return_if_fail (GTK_IS_LABEL (label));
532 533
  if (widget)
    g_return_if_fail (GTK_IS_WIDGET (widget));
534

535 536
  if (label->mnemonic_widget)
    gtk_widget_unref (label->mnemonic_widget);
537
  label->mnemonic_widget = widget;
538 539
  if (label->mnemonic_widget)
    gtk_widget_ref (label->mnemonic_widget);
540 541 542 543 544
}


/**
 * gtk_label_get_mnemonic_keyval:
545 546
 * @label: a #GtkLabel
 *
547 548 549
 * 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
550 551
 *
 * Returns: GDK keyval usable for accelerators, or GDK_VoidSymbol
552 553
 **/
guint
554
gtk_label_get_mnemonic_keyval (GtkLabel *label)
555 556 557
{
  g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);

558
  return label->mnemonic_keyval;
559 560 561
}

static void
562
gtk_label_set_text_internal (GtkLabel *label,
563
			     gchar    *str)
564 565 566 567 568 569 570 571 572 573 574
{
  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
575
{
576
  g_free (label->label);
577
  
578
  label->label = str;
579

580 581
  g_object_notify (G_OBJECT (label), "label");
}
582

583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
static void
gtk_label_set_use_markup_internal (GtkLabel *label,
				   gboolean val)
{
  val = val != FALSE;
  if (label->use_markup != val)
    g_object_notify (G_OBJECT (label), "use_markup");
  label->use_markup = val;
}

static void
gtk_label_set_use_underline_internal (GtkLabel *label,
				      gboolean val)
{
  val = val != FALSE;
  if (label->use_underline != val)
    g_object_notify (G_OBJECT (label), "use_underline");
  label->use_underline = val;
}

static void
gtk_label_set_attributes_internal (GtkLabel         *label,
				   PangoAttrList    *attrs)
{
  if (attrs)
    pango_attr_list_ref (attrs);
609
  
610 611 612 613 614 615 616 617
  if (label->attrs)
    pango_attr_list_unref (label->attrs);

  label->attrs = attrs;
  g_object_notify (G_OBJECT (label), "attributes");
}


618
/* Calculates text, attrs and mnemonic_keyval from
619 620
 * label, use_underline and use_markup
 */
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
static void
gtk_label_recalculate (GtkLabel *label)
{
  if (label->use_markup)
      set_markup (label, label->label, label->use_underline);
  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));
	  gtk_label_set_attributes_internal (label, NULL);
	}
    }

  if (!label->use_underline)
638 639
    {
      guint keyval = label->mnemonic_keyval;
640

641 642 643
      label->mnemonic_keyval = GDK_VoidSymbol;
      gtk_label_setup_mnemonic (label, keyval);
    }
644 645

  gtk_label_clear_layout (label);  
646
  gtk_widget_queue_resize (GTK_WIDGET (label));
647 648
}

649 650
/**
 * gtk_label_set_text:
Havoc Pennington's avatar
Havoc Pennington committed
651 652
 * @label: a #GtkLabel
 * @str: a string
653 654 655 656 657
 *
 * Sets the text of the label to @str.
 *
 * This will also clear any previously set mnemonic accelerators.
 **/
658
void
659 660
gtk_label_set_text (GtkLabel    *label,
		    const gchar *str)
661 662
{
  g_return_if_fail (GTK_IS_LABEL (label));
663
  
664 665 666 667 668
  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);
669 670
}

671 672 673 674 675 676 677 678 679 680 681 682 683 684
/**
 * gtk_label_set_attributes:
 * @label: a #GtkLabel
 * @attrs: a #PangoAttrList
 * 
 * Sets a #PangoAttrList; the attributes in the list are applied to the
 * label text.
 **/
void
gtk_label_set_attributes (GtkLabel         *label,
                          PangoAttrList    *attrs)
{
  g_return_if_fail (GTK_IS_LABEL (label));

685
  gtk_label_set_attributes_internal (label, attrs);
686
  
687 688
  gtk_label_clear_layout (label);  
  gtk_widget_queue_resize (GTK_WIDGET (label));
689 690
}

691
static void
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711
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
712
      return;
713 714 715
    }

  if (text)
716
    gtk_label_set_text_internal (label, text);
717 718 719

  if (attrs)
    {
720
      gtk_label_set_attributes_internal (label, attrs);
721 722 723 724
      pango_attr_list_unref (attrs);
    }

  if (accel_char != 0)
725
    label->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
726
  else
727
    label->mnemonic_keyval = GDK_VoidSymbol;
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
}

/**
 * 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));

744 745 746 747 748
  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);
749 750 751
}

/**
752
 * gtk_label_set_markup_with_mnemonic:
753 754 755 756 757 758
 * @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
759
 * indicating that they represent a keyboard accelerator called a mnemonic.
760
 *
761
 * The mnemonic key can be used to activate another widget, chosen automatically,
762
 * or explicitly using gtk_label_set_mnemonic_widget().
763
 **/
764 765 766
void
gtk_label_set_markup_with_mnemonic (GtkLabel    *label,
				    const gchar *str)
767
{
768 769
  guint last_keyval;
  g_return_if_fail (GTK_IS_LABEL (label));
770

771
  last_keyval = label->mnemonic_keyval;
772 773 774 775 776
  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);
777
  gtk_label_setup_mnemonic (label, last_keyval);
778 779
}

780 781 782 783 784 785
/**
 * gtk_label_get_text:
 * @label: a #GtkLabel
 * 
 * Fetches the text from a label widget
 * 
786 787
 * Return value: the text in the label widget. This is the internal
 * string used by the label, and must not be modified.
788
 **/
789
G_CONST_RETURN gchar *
790 791
gtk_label_get_text (GtkLabel *label)
{
792 793
  g_return_val_if_fail (label != NULL, NULL);
  g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
794

795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
  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);
848 849
}

850 851 852 853 854 855
void
gtk_label_set_pattern (GtkLabel	   *label,
		       const gchar *pattern)
{
  g_return_if_fail (GTK_IS_LABEL (label));
  
856
  gtk_label_set_pattern_internal (label, pattern);
857

858
  gtk_label_clear_layout (label);  
859
  gtk_widget_queue_resize (GTK_WIDGET (label));
Elliot Lee's avatar
Elliot Lee committed
860 861
}

862

Elliot Lee's avatar
Elliot Lee committed
863
void
864 865
gtk_label_set_justify (GtkLabel        *label,
		       GtkJustification jtype)
Elliot Lee's avatar
Elliot Lee committed
866 867
{
  g_return_if_fail (GTK_IS_LABEL (label));
868
  g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
869
  
Elliot Lee's avatar
Elliot Lee committed
870 871 872
  if ((GtkJustification) label->jtype != jtype)
    {
      label->jtype = jtype;
873

874 875
      /* No real need to be this drastic, but easier than duplicating the code */
      gtk_label_clear_layout (label);
876
      
877
      g_object_notify (G_OBJECT (label), "justify");
878
      gtk_widget_queue_resize (GTK_WIDGET (label));
Elliot Lee's avatar
Elliot Lee committed
879 880 881 882
    }
}

void
883 884
gtk_label_set_line_wrap (GtkLabel *label,
			 gboolean  wrap)
Owen Taylor's avatar
Owen Taylor committed
885 886
{
  g_return_if_fail (GTK_IS_LABEL (label));
887
  
888 889 890 891 892
  wrap = wrap != FALSE;
  
  if (label->wrap != wrap)
    {
      label->wrap = wrap;
893 894
      g_object_notify (G_OBJECT (label), "wrap");
      
895 896
      gtk_widget_queue_resize (GTK_WIDGET (label));
    }
Owen Taylor's avatar
Owen Taylor committed
897 898 899
}

void
900 901
gtk_label_get (GtkLabel *label,
	       gchar   **str)
Elliot Lee's avatar
Elliot Lee committed
902 903 904 905
{
  g_return_if_fail (label != NULL);
  g_return_if_fail (GTK_IS_LABEL (label));
  g_return_if_fail (str != NULL);
906
  
907
  *str = label->text;
Elliot Lee's avatar
Elliot Lee committed
908 909
}

910 911 912 913 914 915 916 917 918 919
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
920
static void
921
gtk_label_finalize (GObject *object)
Elliot Lee's avatar
Elliot Lee committed
922 923
{
  GtkLabel *label;
924
  
Elliot Lee's avatar
Elliot Lee committed
925
  g_return_if_fail (GTK_IS_LABEL (object));
926
  
Elliot Lee's avatar
Elliot Lee committed
927
  label = GTK_LABEL (object);
928
  
Elliot Lee's avatar
Elliot Lee committed
929
  g_free (label->label);
930
  g_free (label->text);
931

932
  if (label->layout)
933
    g_object_unref (G_OBJECT (label->layout));
934

935 936
  if (label->attrs)
    pango_attr_list_unref (label->attrs);
937 938

  g_free (label->select_info);
939

940
  G_OBJECT_CLASS (parent_class)->finalize (object);
Elliot Lee's avatar
Elliot Lee committed
941 942 943
}

static void
944
gtk_label_clear_layout (GtkLabel *label)
Elliot Lee's avatar
Elliot Lee committed
945
{
946 947 948 949 950 951 952 953 954 955 956 957 958
  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;
959
  PangoRectangle logical_rect;
960
  gint rwidth, rheight;
961 962

  widget = GTK_WIDGET (label);
963

Owen Taylor's avatar
Owen Taylor committed
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
  /*
   * 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.
   */
984

985 986
  rwidth = label->misc.xpad * 2;
  rheight = label->misc.ypad * 2;
987 988 989 990 991

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

992
      label->layout = gtk_widget_create_pango_layout (widget, label->text);
993

994
      if (label->attrs)
995
	pango_layout_set_attributes (label->layout, label->attrs);
996
      
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
      switch (label->jtype)
	{
	case GTK_JUSTIFY_LEFT:
	  align = PANGO_ALIGN_LEFT;
	  break;
	case GTK_JUSTIFY_RIGHT:
	  align = PANGO_ALIGN_RIGHT;
	  break;
	case GTK_JUSTIFY_CENTER:
	  align = PANGO_ALIGN_LEFT;
	  break;
	case GTK_JUSTIFY_FILL:
	  /* FIXME: This just doesn't work to do this */
	  align = PANGO_ALIGN_LEFT;
	  pango_layout_set_justify (label->layout, TRUE);
	  break;
	default:
	  g_assert_not_reached();
	}

      pango_layout_set_alignment (label->layout, align);
    }

Owen Taylor's avatar
Owen Taylor committed
1020
  if (label->wrap)
Elliot Lee's avatar
Elliot Lee committed
1021
    {
Owen Taylor's avatar
Owen Taylor committed
1022 1023
      GtkWidgetAuxInfo *aux_info;
      gint longest_paragraph;
1024 1025 1026
      gint width, height;
      gint real_width;

1027
      aux_info = _gtk_widget_get_aux_info (widget, FALSE);
Owen Taylor's avatar
Owen Taylor committed
1028 1029
      if (aux_info && aux_info->width > 0)
	{
1030 1031 1032
	  pango_layout_set_width (label->layout, aux_info->width * PANGO_SCALE);
	  pango_layout_get_extents (label->layout, NULL, &logical_rect);

1033 1034
	  rwidth += aux_info->width;
	  rheight += PANGO_PIXELS (logical_rect.height);
Owen Taylor's avatar
Owen Taylor committed
1035 1036 1037
	}
      else
	{
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
	  pango_layout_set_width (label->layout, -1);
	  pango_layout_get_extents (label->layout, NULL, &logical_rect);
      
	  width = logical_rect.width;
	  height = logical_rect.height;
	  
	  /* Try to guess a reasonable maximum width
	   */
	  longest_paragraph = width;

	  width = MIN (width,
		       PANGO_SCALE * gdk_string_width (GTK_WIDGET (label)->style->font,
						"This long string gives a good enough length for any line to have."));
	  width = MIN (width,
		       PANGO_SCALE * (gdk_screen_width () + 1) / 2);

	  pango_layout_set_width (label->layout, width);
	  pango_layout_get_extents (label->layout, NULL, &logical_rect);
	  real_width = logical_rect.width;
	  height = logical_rect.height;
	  
	  /* Unfortunately, the above may leave us with a very unbalanced looking paragraph,
	   * so we try short search for a narrower width that leaves us with the same height
	   */
Owen Taylor's avatar
Owen Taylor committed
1062 1063 1064
	  if (longest_paragraph > 0)
	    {
	      gint nlines, perfect_width;
1065 1066

	      nlines = pango_layout_get_line_count (label->layout);
Owen Taylor's avatar
Owen Taylor committed
1067
	      perfect_width = (longest_paragraph + nlines - 1) / nlines;
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
	      
	      if (perfect_width < width)
		{
		  pango_layout_set_width (label->layout, perfect_width);
		  pango_layout_get_extents (label->layout, NULL, &logical_rect);
		  
		  if (logical_rect.height <= height)
		    {
		      width = perfect_width;
		      real_width = logical_rect.width;
		      height = logical_rect.height;
		    }
		  else
		    {
		      gint mid_width = (perfect_width + width) / 2;

		      if (mid_width > perfect_width)
			{
			  pango_layout_set_width (label->layout, mid_width);
			  pango_layout_get_extents (label->layout, NULL, &logical_rect);

			  if (logical_rect.height <= height)
			    {
			      width = mid_width;
			      real_width = logical_rect.width;
			      height = logical_rect.height;
			    }
			}
		    }
		}
Owen Taylor's avatar
Owen Taylor committed
1098
	    }
1099 1100
	  pango_layout_set_width (label->layout, width);

1101 1102
	  rwidth += PANGO_PIXELS (real_width);
	  rheight += PANGO_PIXELS (height);
Owen Taylor's avatar
Owen Taylor committed
1103 1104
	}
    }
1105
  else				/* !label->wrap */
Owen Taylor's avatar
Owen Taylor committed
1106
    {
1107 1108 1109
      pango_layout_set_width (label->layout, -1);
      pango_layout_get_extents (label->layout, NULL, &logical_rect);

1110 1111
      rwidth += PANGO_PIXELS (logical_rect.width);
      rheight += PANGO_PIXELS (logical_rect.height);
1112 1113 1114
    }

  if (widthp)
1115
    *widthp = rwidth;
1116 1117

  if (heightp)
1118
    *heightp = rheight;
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
}

static void
gtk_label_size_request (GtkWidget      *widget,
			GtkRequisition *requisition)
{
  GtkLabel *label;
  gint width, height;
  
  g_return_if_fail (GTK_IS_LABEL (widget));
  g_return_if_fail (requisition != NULL);
  
  label = GTK_LABEL (widget);

  gtk_label_ensure_layout (label, &width, &height);

  requisition->width = width;
  requisition->height = height;
}

static void
gtk_label_size_allocate (GtkWidget     *widget,
                         GtkAllocation *allocation)
{
  GtkLabel *label;

  label = GTK_LABEL (widget);
  
  (* GTK_WIDGET_CLASS (parent_class)->size_allocate) (widget, allocation);

  if (label->select_info && label->select_info->window)
    {
      gdk_window_move_resize (label->select_info->window,
                              allocation->x,
                              allocation->y,
                              allocation->width,
                              allocation->height);
Owen Taylor's avatar
Owen Taylor committed
1156 1157
    }
}
1158

1159
static void 
1160 1161
gtk_label_style_set (GtkWidget *widget,
		     GtkStyle  *previous_style)
1162 1163
{
  GtkLabel *label;