gtklabel.sgml 4.36 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
<!-- ##### SECTION Title ##### -->
GtkLabel

<!-- ##### SECTION Short_Description ##### -->
A widget that displays a small to medium amount of text.

<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### STRUCT GtkLabel ##### -->
<para>
This should not be accessed directly.  Use the accessor functions as
described below.
</para>


<!-- ##### FUNCTION gtk_label_new ##### -->
<para>
Creates a new label with the given string of text inside it.  You can
pass NULL to get an empty label widget.
</para>

@str: The string you want to display in the #GtkLabel
@Returns: The newly allocated #GtkLabel widget


37
<!-- ##### FUNCTION gtk_label_set_text ##### -->
Owen Taylor's avatar
Owen Taylor committed
38
<para>
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
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().
</para>

@label: The #GtkLabel you want to set the text for.
@str: The text you want to add.


<!-- ##### FUNCTION gtk_label_set_attributes ##### -->
<para>

</para>

@label: 
@attrs: 


<!-- ##### FUNCTION gtk_label_set_markup ##### -->
<para>

</para>

@label: 
@str: 


<!-- ##### FUNCTION gtk_label_set_markup_with_accel ##### -->
<para>

Owen Taylor's avatar
Owen Taylor committed
70 71
</para>

72 73 74
@label: 
@str: 
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136


<!-- ##### FUNCTION gtk_label_set_pattern ##### -->
<para>
The pattern of underlines you want under the existing text within the
#GtkLabel widget.  For example if the current text of the label says
&quot;FooBarBaz&quot; passing a pattern of &quot;___   ___&quot; will underline
&quot;Foo&quot; and &quot;Baz&quot; but not &quot;Bar&quot;.
</para>

@label: The #GtkLabel you want to set the pattern to.
@pattern: The pattern as described above.


<!-- ##### FUNCTION gtk_label_set_justify ##### -->
<para>
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().
</para>

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


<!-- ##### FUNCTION gtk_label_get ##### -->
<para>
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.
</para>

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


<!-- ##### FUNCTION gtk_label_parse_uline ##### -->
<para>
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.
&quot;_File&quot; would return the keyval for &quot;f&quot;.  This is
probably only used within the Gtk+ library itself for menu items and such.
</para>

@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.


<!-- ##### FUNCTION gtk_label_set_line_wrap ##### -->
<para>
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.
</para>

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


137
<!-- ##### MACRO gtk_label_set ##### -->
Owen Taylor's avatar
Owen Taylor committed
138
<para>
139 140
Aliases gtk_label_set_text.  Probably used for backward compatibility with
Gtk+ 1.0.x.
Owen Taylor's avatar
Owen Taylor committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
</para>



<!-- ##### ARG GtkLabel:label ##### -->
<para>
The actual label text.  Do not write to this pointer, it is not copied.
</para>

<!-- ##### ARG GtkLabel:pattern ##### -->
<para>
The pattern of underlines under the existing text.  Do not change the
pointer, it isn't copied.
</para>

<!-- ##### ARG GtkLabel:justify ##### -->
<para>
The #GtkJustification setting.  See gtk_label_set_justify() for more info.
</para>

161 162 163 164 165
<!-- ##### ARG GtkLabel:wrap ##### -->
<para>

</para>