GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GtkLabel

## Name

GtkLabel -- A widget that displays a small to medium amount of text.

## Synopsis

    #include <gtk/gtk.h>

    struct      GtkLabel;
    struct      GtkLabelWord;
    GtkWidget*  gtk_label_new                   (const gchar *str);
    #define     gtk_label_set
    void        gtk_label_set_pattern           (GtkLabel *label,
                                                 const gchar *pattern);
    void        gtk_label_set_justify           (GtkLabel *label,
                                                 GtkJustification jtype);
    void        gtk_label_get                   (GtkLabel *label,
                                                 gchar **str);
    guint       gtk_label_parse_uline           (GtkLabel *label,
                                                 const gchar *string);
    void        gtk_label_set_line_wrap         (GtkLabel *label,
                                                 gboolean wrap);
    void        gtk_label_set_text              (GtkLabel *label,
                                                 const gchar *str);

## Object Hierarchy

      GtkObject
       +----GtkWidget
             +----GtkMisc
                   +----GtkLabel

## Args

      "label"                gchar*               : Read / Write
      "pattern"              gchar*               : Read / Write
      "justify"              GtkJustification     : Read / Write

## Description

The GtkLabel widget is usually used directly by the programmer to display word(s) describing an adjacent widget or its use. It is also used internally by Gtk+ as GtkButton labels, GtkMenu items, and many other widgets which use text.

## Details

### struct GtkLabel

    struct GtkLabel;

This should not be accessed directly. Use the accessor functions as described below.

### struct GtkLabelWord

    struct GtkLabelWord;

Internal to GtkLabel.

### gtk_label_new ()

    GtkWidget*  gtk_label_new                   (const gchar *str);

Creates a new label with the given string of text inside it. You can pass NULL to get an empty label widget.

`str` : | The string you want to display in the GtkLabel
Returns : | The newly allocated GtkLabel widget

### gtk_label_set

    #  define gtk_label_set				gtk_label_set_text

Aliases gtk_label_set_text. Probably used for backward compatibility with Gtk+ 1.0.x.

### gtk_label_set_pattern ()

    void        gtk_label_set_pattern           (GtkLabel *label,
                                                 const gchar *pattern);

The pattern of underlines you want under the existing text within the GtkLabel widget. For example if the current text of the label says "FooBarBaz" passing a pattern of "___ ___" will underline "Foo" and "Baz" but not "Bar".

`label` : | The GtkLabel you want to set the pattern to.
`pattern` : | The pattern as described above.

### gtk_label_set_justify ()

    void        gtk_label_set_justify           (GtkLabel *label,
                                                 GtkJustification jtype);

Set where the text within the GtkLabel will align to. This can be one of four values: GTK_JUSTIFY_LEFT, GTK_JUSTIFY_RIGHT, GTK_JUSTIFY_CENTER, and GTK_JUSTIFY_FILL. GTK_JUSTIFY_CENTER is the default value when the widget is first created with gtk_label_new().

`label` : | The GtkLabel widget you want to set justification for.
`jtype` : | The GtkJustification type as described above.

### gtk_label_get ()

    void        gtk_label_get                   (GtkLabel *label,
                                                 gchar **str);

Gets the current string of text within the GtkLabel and writes it to the given str argument. It does not make a copy of this string so you must not write to it.

`label` : | The GtkLabel widget you want to get the text from.
`str` : | The reference to the pointer you want to point to the text.

### gtk_label_parse_uline ()

    guint       gtk_label_parse_uline           (GtkLabel *label,
                                                 const gchar *string);

Parses the given string for underscores and converts the next character to an underlined character. The last character that was underlined will have its lower-cased accelerator keyval returned (i.e. "_File" would return the keyval for "f". This is probably only used within the Gtk+ library itself for menu items and such.

`label` : | The GtkLabel you want to affect.
`string` : | The string you want to parse for underlines.
Returns : | The lowercase keyval of the last character underlined.

### gtk_label_set_line_wrap ()

    void        gtk_label_set_line_wrap         (GtkLabel *label,
                                                 gboolean wrap);

Toggles line wrapping within the GtkLabel widget. TRUE makes it break lines if text exceeds the widget's size. FALSE lets the text get cut off by the edge of the widget if it exceeds the widget size.

`label` : | The GtkLabel you want to set line wrapping for.
`wrap` : | TRUE turns it on; FALSE turns it off.

### gtk_label_set_text ()

    void        gtk_label_set_text              (GtkLabel *label,
                                                 const gchar *str);

Sets the text within the GtkLabel widget. It overwrites any text that was there before. Note that underlines that were there before do not get overwritten. If you want to erase underlines just send NULL to gtk_label_set_pattern().

`label` : | The GtkLabel you want to set the text for.
`str` : | The text you want to add.

## Args

"`label`" (gchar* : Read / Write)

  The actual label text. Do not write to this pointer, it is not copied.

"`pattern`" (gchar* : Read / Write)

  The pattern of underlines under the existing text. Do not change the pointer, it isn't copied.

"`justify`" (GtkJustification : Read / Write)

  The GtkJustification setting. See gtk_label_set_justify() for more info.

<<< Previous Page | Home | Up | Next Page >>>
GtkItemFactory | GtkLayout