Details
struct GtkLabel
This should not be accessed directly. Use the accessor functions as
described below.
gtk_label_new ()
Creates a new label with the given text inside it. You can
pass NULL to get an empty label widget.
gtk_label_set_text ()
void gtk_label_set_text (GtkLabel *label,
const char *str); |
Sets the text within the GtkLabel widget. It overwrites any text that
was there before.
This will also clear any previously set mnemonic accelerators.
gtk_label_set_attributes ()
Sets a PangoAttrList; the attributes in the list are applied to the
label text. The attributes set with this function will be ignored
if label->use_underline or label->use_markup is TRUE.
gtk_label_set_markup ()
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.
gtk_label_set_markup_with_mnemonic ()
void gtk_label_set_markup_with_mnemonic
(GtkLabel *label,
const gchar *str); |
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
indicating that they represent a keyboard accelerator called a mnemonic.
The mnemonic key can be used to activate another widget, chosen automatically,
or explicitly using gtk_label_set_mnemonic_widget().
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".
gtk_label_set_justify ()
Sets the alignment of the lines in the text of the label relative to
each other. GTK_JUSTIFY_LEFT is the default value when the
widget is first created with gtk_label_new().
gtk_label_get ()
void gtk_label_get (GtkLabel *label,
char **str); |
Warning |
gtk_label_get is deprecated and should not be used in newly-written code. |
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.
gtk_label_parse_uline ()
Warning |
gtk_label_parse_uline is deprecated and should not be used in newly-written code. |
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.
gtk_label_set_line_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.
gtk_label_set
#define gtk_label_set gtk_label_set_text |
Warning |
gtk_label_set is deprecated and should not be used in newly-written code. |
Aliases gtk_label_set_text(). Probably used for backward compatibility with
Gtk+ 1.0.x.
gtk_label_get_layout_offsets ()
Obtains the coordinates where the label will draw the PangoLayout
representing the text in the label; useful to convert mouse events
into coordinates inside the PangoLayout, e.g. to take some action
if some part of the label is clicked. Of course you will need to
create a GtkEventBox to receive the events, and pack the label
inside it, since labels are a GTK_NO_WINDOW widget. Remember
when using the PangoLayout functions you need to convert to
and from pixels using PANGO_PIXELS() or PANGO_SCALE.
gtk_label_get_mnemonic_keyval ()
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.
gtk_label_get_text ()
Fetches the text from a label widget, as displayed on the
screen. This does not include any embedded underlines
indicating mnemonics or Pango markup. (See gtk_label_get_label())
gtk_label_new_with_mnemonic ()
GtkWidget* gtk_label_new_with_mnemonic (const char *str); |
Creates a new GtkLabel, containing the text in str.
If characters in str are preceded by an underscore, they are
underlined. If you need a literal underscore character in a label, use
'__' (two underscores). The first underlined character represents a
keyboard accelerator called a mnemonic. The mnemonic key can be used
to activate another widget, chosen automatically, or explicitly using
gtk_label_set_mnemonic_widget().
If gtk_label_set_mnemonic_widget()
is not called, then the first activatable ancestor of the GtkLabel
will be chosen as the mnemonic widget. For instance, if the
label is inside a button or menu item, the button or menu item will
automatically become the mnemonic widget and be activated by
the mnemonic.
gtk_label_select_region ()
void gtk_label_select_region (GtkLabel *label,
gint start_offset,
gint end_offset); |
Selects a range of characters in the label, if the label is selectable.
See gtk_label_set_selectable(). If the label is not selectable,
this function has no effect. If start_offset or
end_offset are -1, then the end of the label will be substituted.
gtk_label_set_mnemonic_widget ()
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.
The target widget will be accelerated by emitting "mnemonic_activate" on it.
The default handler for this signal will activate the widget if there are no
mnemonic collisions and toggle focus between the colliding widgets otherwise.
gtk_label_set_selectable ()
Selectable labels allow the user to select text from the label, for
copy-and-paste.
gtk_label_set_text_with_mnemonic ()
void gtk_label_set_text_with_mnemonic
(GtkLabel *label,
const gchar *str); |
Sets the label's text from the string 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,
or explicitly using gtk_label_set_mnemonic_widget().
gtk_label_get_attributes ()
Gets the attribute list that was set on the label using
gtk_label_set_attributes(), if any. This function does
not reflect attributes that come from the labels markup
(see gtk_label_set_markup()). If you want to get the
effective attributes for the label, use
pango_layout_get_attribute (gtk_label_get_layout (label)).
gtk_label_get_label ()
Fetches the text from a label widget including any embedded
underlines indicating mnemonics and Pango markup. (See
gtk_label_get_text()).
gtk_label_get_layout ()
Gets the PangoLayout used to display the label.
The layout is useful to e.g. convert text positions to
pixel positions, in combination with gtk_label_get_layout_offsets().
The returned layout is owned by the label so need not be
freed by the caller.
gtk_label_get_line_wrap ()
Returns whether lines in the label are automatically wrapped. See gtk_label_set_line_wrap().
gtk_label_get_selection_bounds ()
Gets the selected range of characters in the label, returning TRUE
if there's a selection.
gtk_label_get_use_markup ()
Returns whether the label's text is interpreted as marked up with the
Pango text markup language. See gtk_label_set_use_markup().
gtk_label_get_use_underline ()
Returns whether an embedded underline in the label indicates a
mnemonic. See gtk_label_set_use_underline().
gtk_label_set_label ()
Sets the text of the label. The label is interpreted as
including embedded underlines and/or Pango markup depending
on the values of label->use_underline and label->use_markup.
gtk_label_set_use_markup ()
Sets whether the text of the label contains markup in Pango's
text markup lango. See gtk_label_set_markup().
gtk_label_set_use_underline ()
If true, an underline in the text indicates the next character should be
used for the mnemonic accelerator key.