gtklabel.c 51.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 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 128
					     gboolean   group_cycling);

129

130 131
static GtkMiscClass *parent_class = NULL;

Elliot Lee's avatar
Elliot Lee committed
132

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

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

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

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

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

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

268 269 270 271
static void 
gtk_label_set_property (GObject      *object,
			guint         prop_id,
			const GValue *value,
272
			GParamSpec   *pspec)
273
{
274
  GtkLabel *label;
275
  
276
  label = GTK_LABEL (object);
277
  
278
  switch (prop_id)
279
    {
280 281 282 283 284 285 286 287 288 289 290
    case PROP_LABEL:
      gtk_label_set_label_internal (label,
				    g_strdup (g_value_get_string (value)));
      gtk_label_recalculate (label);
      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);
291
      break;
292 293 294
    case PROP_USE_UNDERLINE:
      gtk_label_set_use_underline_internal (label, g_value_get_boolean (value));
      gtk_label_recalculate (label);
295
      break;
296 297
    case PROP_JUSTIFY:
      gtk_label_set_justify (label, g_value_get_enum (value));
298
      break;
299 300 301 302 303 304 305 306
    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));
307
      break;	  
308 309 310
    case PROP_MNEMONIC_WIDGET:
      gtk_label_set_mnemonic_widget (label, (GtkWidget*) g_value_get_object (value));
      break;
Tim Janik's avatar
Tim Janik committed
311
    default:
312
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Tim Janik's avatar
Tim Janik committed
313
      break;
314 315 316
    }
}

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

357
    default:
358
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
359 360 361 362
      break;
    }
}

363
static void
Elliot Lee's avatar
Elliot Lee committed
364 365 366
gtk_label_init (GtkLabel *label)
{
  GTK_WIDGET_SET_FLAGS (label, GTK_NO_WINDOW);
Tim Janik's avatar
Tim Janik committed
367
  
Elliot Lee's avatar
Elliot Lee committed
368
  label->label = NULL;
369

Elliot Lee's avatar
Elliot Lee committed
370
  label->jtype = GTK_JUSTIFY_CENTER;
Owen Taylor's avatar
Owen Taylor committed
371
  label->wrap = FALSE;
372 373 374

  label->use_underline = FALSE;
  label->use_markup = FALSE;
375
  
376
  label->mnemonic_keyval = GDK_VoidSymbol;
377
  label->layout = NULL;
378
  label->text = NULL;
379
  label->attrs = NULL;
380 381 382

  label->mnemonic_widget = NULL;
  label->mnemonic_window = NULL;
383
  
Owen Taylor's avatar
Owen Taylor committed
384
  gtk_label_set_text (label, "");
Elliot Lee's avatar
Elliot Lee committed
385 386
}

387 388 389 390 391 392 393
/**
 * 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
394
GtkWidget*
395
gtk_label_new (const gchar *str)
Elliot Lee's avatar
Elliot Lee committed
396 397
{
  GtkLabel *label;
398
  
399 400 401 402
  label = gtk_type_new (GTK_TYPE_LABEL);

  if (str && *str)
    gtk_label_set_text (label, str);
403
  
Elliot Lee's avatar
Elliot Lee committed
404 405 406
  return GTK_WIDGET (label);
}

407
/**
408 409 410 411 412 413 414 415 416 417
 * 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,
418
 * or explicitly using gtk_label_set_mnemonic_widget().
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
 **/
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
434
gtk_label_mnemonic_activate (GtkWidget *widget,
435 436 437 438 439
			     gboolean   group_cycling)
{
  GtkWidget *parent;

  if (GTK_LABEL (widget)->mnemonic_widget)
440
    return gtk_widget_mnemonic_activate (GTK_LABEL (widget)->mnemonic_widget, group_cycling);
441

442 443
  /* Try to find the widget to activate by traversing the
   * widget's ancestry.
444 445 446 447 448 449
   */
  parent = widget->parent;
  while (parent)
    {
      if (GTK_WIDGET_CAN_FOCUS (parent) ||
	  (!group_cycling && GTK_WIDGET_GET_CLASS (parent)->activate_signal) ||
450
          (parent->parent && GTK_IS_NOTEBOOK (parent->parent)) ||
451
	  (GTK_IS_MENU_ITEM (parent)))
452
	return gtk_widget_mnemonic_activate (parent, group_cycling);
453 454 455
      parent = parent->parent;
    }

456
  /* barf if there was nothing to activate */
457 458 459 460 461 462 463
  g_warning ("Couldn't find a target for a mnemonic activation.");
  gdk_beep ();
  
  return FALSE;
}

static void
464 465
gtk_label_setup_mnemonic (GtkLabel *label,
			  guint     last_key)
466 467 468
{
  GtkWidget *toplevel;

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

524 525
  if (label->mnemonic_widget)
    gtk_widget_unref (label->mnemonic_widget);
526
  label->mnemonic_widget = widget;
527 528
  if (label->mnemonic_widget)
    gtk_widget_ref (label->mnemonic_widget);
529 530 531 532 533
}


/**
 * gtk_label_get_mnemonic_keyval:
534 535
 * @label: a #GtkLabel
 *
536 537 538
 * 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
539 540
 *
 * Returns: GDK keyval usable for accelerators, or GDK_VoidSymbol
541 542
 **/
guint
543
gtk_label_get_mnemonic_keyval (GtkLabel *label)
544 545 546
{
  g_return_val_if_fail (GTK_IS_LABEL (label), GDK_VoidSymbol);

547
  return label->mnemonic_keyval;
548 549 550
}

static void
551
gtk_label_set_text_internal (GtkLabel *label,
552
			     gchar    *str)
553 554 555 556 557 558 559 560 561 562 563
{
  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
564
{
565
  g_free (label->label);
566
  
567
  label->label = str;
568

569 570
  g_object_notify (G_OBJECT (label), "label");
}
571

572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
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);
598
  
599 600 601 602 603 604 605 606
  if (label->attrs)
    pango_attr_list_unref (label->attrs);

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


607
/* Calculates text, attrs and mnemonic_keyval from
608 609
 * label, use_underline and use_markup
 */
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
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)
627 628
    {
      guint keyval = label->mnemonic_keyval;
629

630 631 632
      label->mnemonic_keyval = GDK_VoidSymbol;
      gtk_label_setup_mnemonic (label, keyval);
    }
633 634

  gtk_label_clear_layout (label);  
635
  gtk_widget_queue_resize (GTK_WIDGET (label));
636 637
}

638 639
/**
 * gtk_label_set_text:
Havoc Pennington's avatar
Havoc Pennington committed
640 641
 * @label: a #GtkLabel
 * @str: a string
642 643 644 645 646
 *
 * Sets the text of the label to @str.
 *
 * This will also clear any previously set mnemonic accelerators.
 **/
647
void
648 649
gtk_label_set_text (GtkLabel    *label,
		    const gchar *str)
650 651
{
  g_return_if_fail (GTK_IS_LABEL (label));
652
  
653 654 655 656 657
  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);
658 659
}

660 661 662 663 664 665 666 667 668 669 670 671 672 673
/**
 * 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));

674
  gtk_label_set_attributes_internal (label, attrs);
675
  
676 677
  gtk_label_clear_layout (label);  
  gtk_widget_queue_resize (GTK_WIDGET (label));
678 679
}

680
static void
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700
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
701
      return;
702 703 704
    }

  if (text)
705
    gtk_label_set_text_internal (label, text);
706 707 708

  if (attrs)
    {
709
      gtk_label_set_attributes_internal (label, attrs);
710 711 712 713
      pango_attr_list_unref (attrs);
    }

  if (accel_char != 0)
714
    label->mnemonic_keyval = gdk_keyval_to_lower (gdk_unicode_to_keyval (accel_char));
715
  else
716
    label->mnemonic_keyval = GDK_VoidSymbol;
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
}

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

733 734 735 736 737
  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);
738 739 740
}

/**
741
 * gtk_label_set_markup_with_mnemonic:
742 743 744 745 746 747
 * @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
748
 * indicating that they represent a keyboard accelerator called a mnemonic.
749
 *
750
 * The mnemonic key can be used to activate another widget, chosen automatically,
751
 * or explicitly using gtk_label_set_mnemonic_widget().
752
 **/
753 754 755
void
gtk_label_set_markup_with_mnemonic (GtkLabel    *label,
				    const gchar *str)
756
{
757 758
  guint last_keyval;
  g_return_if_fail (GTK_IS_LABEL (label));
759

760
  last_keyval = label->mnemonic_keyval;
761 762 763 764 765
  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);
766
  gtk_label_setup_mnemonic (label, last_keyval);
767 768
}

769 770 771 772 773 774
/**
 * gtk_label_get_text:
 * @label: a #GtkLabel
 * 
 * Fetches the text from a label widget
 * 
775 776
 * Return value: the text in the label widget. This is the internal
 * string used by the label, and must not be modified.
777
 **/
778
G_CONST_RETURN gchar *
779 780
gtk_label_get_text (GtkLabel *label)
{
781 782
  g_return_val_if_fail (label != NULL, NULL);
  g_return_val_if_fail (GTK_IS_LABEL (label), NULL);
783

784 785 786 787 788 789 790 791 792 793 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
  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);
837 838
}

839 840 841 842 843 844
void
gtk_label_set_pattern (GtkLabel	   *label,
		       const gchar *pattern)
{
  g_return_if_fail (GTK_IS_LABEL (label));
  
845
  gtk_label_set_pattern_internal (label, pattern);
846

847
  gtk_label_clear_layout (label);  
848
  gtk_widget_queue_resize (GTK_WIDGET (label));
Elliot Lee's avatar
Elliot Lee committed
849 850
}

851

Elliot Lee's avatar
Elliot Lee committed
852
void
853 854
gtk_label_set_justify (GtkLabel        *label,
		       GtkJustification jtype)
Elliot Lee's avatar
Elliot Lee committed
855 856
{
  g_return_if_fail (GTK_IS_LABEL (label));
857
  g_return_if_fail (jtype >= GTK_JUSTIFY_LEFT && jtype <= GTK_JUSTIFY_FILL);
858
  
Elliot Lee's avatar
Elliot Lee committed
859 860 861
  if ((GtkJustification) label->jtype != jtype)
    {
      label->jtype = jtype;
862

863 864
      /* No real need to be this drastic, but easier than duplicating the code */
      gtk_label_clear_layout (label);
865
      
866
      g_object_notify (G_OBJECT (label), "justify");
867
      gtk_widget_queue_resize (GTK_WIDGET (label));
Elliot Lee's avatar
Elliot Lee committed
868 869 870 871
    }
}

void
872 873
gtk_label_set_line_wrap (GtkLabel *label,
			 gboolean  wrap)
Owen Taylor's avatar
Owen Taylor committed
874 875
{
  g_return_if_fail (GTK_IS_LABEL (label));
876
  
877 878 879 880 881
  wrap = wrap != FALSE;
  
  if (label->wrap != wrap)
    {
      label->wrap = wrap;
882 883
      g_object_notify (G_OBJECT (label), "wrap");
      
884 885
      gtk_widget_queue_resize (GTK_WIDGET (label));
    }
Owen Taylor's avatar
Owen Taylor committed
886 887 888
}

void
889 890
gtk_label_get (GtkLabel *label,
	       gchar   **str)
Elliot Lee's avatar
Elliot Lee committed
891 892 893 894
{
  g_return_if_fail (label != NULL);
  g_return_if_fail (GTK_IS_LABEL (label));
  g_return_if_fail (str != NULL);
895
  
896
  *str = label->text;
Elliot Lee's avatar
Elliot Lee committed
897 898
}

899 900 901 902 903 904 905 906 907 908
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
909
static void
910
gtk_label_finalize (GObject *object)
Elliot Lee's avatar
Elliot Lee committed
911 912
{
  GtkLabel *label;
913
  
Elliot Lee's avatar
Elliot Lee committed
914
  g_return_if_fail (GTK_IS_LABEL (object));
915
  
Elliot Lee's avatar
Elliot Lee committed
916
  label = GTK_LABEL (object);
917
  
Elliot Lee's avatar
Elliot Lee committed
918
  g_free (label->label);
919
  g_free (label->text);
920

921
  if (label->layout)
922
    g_object_unref (G_OBJECT (label->layout));
923

924 925
  if (label->attrs)
    pango_attr_list_unref (label->attrs);
926 927

  g_free (label->select_info);
928

929
  G_OBJECT_CLASS (parent_class)->finalize (object);
Elliot Lee's avatar
Elliot Lee committed
930 931 932
}

static void
933
gtk_label_clear_layout (GtkLabel *label)
Elliot Lee's avatar
Elliot Lee committed
934
{
935 936 937 938 939 940 941 942 943 944 945 946 947
  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;
948
  PangoRectangle logical_rect;
949
  gint rwidth, rheight;
950 951

  widget = GTK_WIDGET (label);
952

Owen Taylor's avatar
Owen Taylor committed
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972
  /*
   * 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.
   */
973

974 975
  rwidth = label->misc.xpad * 2;
  rheight = label->misc.ypad * 2;
976 977 978 979 980

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

981
      label->layout = gtk_widget_create_pango_layout (widget, label->text);
982

983
      if (label->attrs)
984
	pango_layout_set_attributes (label->layout, label->attrs);
985
      
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
      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
1009
  if (label->wrap)
Elliot Lee's avatar
Elliot Lee committed
1010
    {
Owen Taylor's avatar
Owen Taylor committed
1011 1012
      GtkWidgetAuxInfo *aux_info;
      gint longest_paragraph;
1013 1014 1015
      gint width, height;
      gint real_width;

1016
      aux_info = _gtk_widget_get_aux_info (widget, FALSE);
Owen Taylor's avatar
Owen Taylor committed
1017 1018
      if (aux_info && aux_info->width > 0)
	{
1019 1020 1021
	  pango_layout_set_width (label->layout, aux_info->width * PANGO_SCALE);
	  pango_layout_get_extents (label->layout, NULL, &logical_rect);

1022 1023
	  rwidth += aux_info->width;
	  rheight += PANGO_PIXELS (logical_rect.height);
Owen Taylor's avatar
Owen Taylor committed
1024 1025 1026
	}
      else
	{
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
	  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
1051 1052 1053
	  if (longest_paragraph > 0)
	    {
	      gint nlines, perfect_width;
1054 1055

	      nlines = pango_layout_get_line_count (label->layout);
Owen Taylor's avatar
Owen Taylor committed
1056
	      perfect_width = (longest_paragraph + nlines - 1) / nlines;
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
	      
	      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
1087
	    }
1088 1089
	  pango_layout_set_width (label->layout, width);

1090 1091
	  rwidth += PANGO_PIXELS (real_width);
	  rheight += PANGO_PIXELS (height);
Owen Taylor's avatar
Owen Taylor committed
1092 1093
	}
    }
1094
  else				/* !label->wrap */
Owen Taylor's avatar
Owen Taylor committed
1095
    {
1096 1097 1098
      pango_layout_set_width (label->layout, -1);
      pango_layout_get_extents (label->layout, NULL, &logical_rect);

1099 1100
      rwidth += PANGO_PIXELS (logical_rect.width);
      rheight += PANGO_PIXELS (logical_rect.height);
1101 1102 1103
    }

  if (widthp)
1104
    *widthp = rwidth;
1105 1106

  if (heightp)
1107
    *heightp = rheight;
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 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
}

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
1145 1146
    }
}
1147

1148
static void 
1149 1150
gtk_label_style_set (GtkWidget *widget,
		     GtkStyle  *previous_style)
1151 1152
{
  GtkLabel *label;
1153
  
1154
  g_return_if_fail (GTK_IS_LABEL (widget));
1155
  
1156
  label = GTK_LABEL (widget);
1157

1158 1159
  /* We have to clear the layout, fonts etc. may have changed */
  gtk_label_clear_layout (label);
1160 1161
}

1162 1163 1164 1165