Top |
double | angle | Read / Write |
PangoAttrList * | attributes | Read / Write |
int | cursor-position | Read |
PangoEllipsizeMode | ellipsize | Read / Write |
GtkJustification | justify | Read / Write |
char * | label | Read / Write |
int | max-width-chars | Read / Write |
guint | mnemonic-keyval | Read |
GtkWidget * | mnemonic-widget | Read / Write |
char * | pattern | Write |
gboolean | selectable | Read / Write |
int | selection-bound | Read |
gboolean | single-line-mode | Read / Write |
gboolean | track-visited-links | Read / Write |
gboolean | use-markup | Read / Write |
gboolean | use-underline | Read / Write |
int | width-chars | Read / Write |
gboolean | wrap | Read / Write |
PangoWrapMode | wrap-mode | Read / Write |
void | activate-current-link | Action |
gboolean | activate-link | Run Last |
void | copy-clipboard | Action |
void | move-cursor | Action |
void | populate-popup | Run Last |
GObject ╰── GInitiallyUnowned ╰── GtkObject ╰── GtkWidget ╰── GtkMisc ╰── GtkLabel ├── GtkAccelLabel ╰── GtkTipsQuery
GtkWidget *
gtk_label_new (const gchar *str
);
Creates a new label with the given text inside it. You can
pass NULL
to get an empty label widget.
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.
This will also clear any previously set mnemonic accelerators.
void gtk_label_set_attributes (GtkLabel *label
,PangoAttrList *attrs
);
Sets a PangoAttrList; the attributes in the list are applied to the label text.
The attributes set with this function will be applied and merged with any other attributes previously effected by way of the “use-underline” or “use-markup” properties. While it is not recommended to mix markup strings with manually set attributes, if you must; know that the attributes will be applied to the label after the markup string is parsed.
void gtk_label_set_markup (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 the str
is
external data, you may need to escape it with g_markup_escape_text()
or
g_markup_printf_escaped()
:
1 2 3 4 5 |
char *markup; markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str); gtk_label_set_markup (GTK_LABEL (label), markup); g_free (markup); |
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()
.
void gtk_label_set_justify (GtkLabel *label
,GtkJustification jtype
);
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()
. If you instead want
to set the alignment of the label as a whole, use
gtk_misc_set_alignment()
instead. gtk_label_set_justify()
has no
effect on labels containing only a single line.
void gtk_label_set_ellipsize (GtkLabel *label
,PangoEllipsizeMode mode
);
Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there is not enough space to render the entire string.
Since: 2.6
void gtk_label_set_width_chars (GtkLabel *label
,gint n_chars
);
Sets the desired width in characters of label
to n_chars
.
Since: 2.6
void gtk_label_set_max_width_chars (GtkLabel *label
,gint n_chars
);
Sets the desired maximum width in characters of label
to n_chars
.
Since: 2.6
void gtk_label_get (GtkLabel *label
,gchar **str
);
gtk_label_get
is deprecated and should not be used in newly-written code.
guint gtk_label_parse_uline (GtkLabel *label
,const gchar *string
);
gtk_label_parse_uline
is deprecated and should not be used in newly-written code.
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.
Note that setting line wrapping to TRUE
does not make the label
wrap at its parent container's width, because GTK+ widgets
conceptually can't make their requisition depend on the parent
container's size. For a label that wraps at a specific position,
set the label's width using gtk_widget_set_size_request()
.
void gtk_label_set_line_wrap_mode (GtkLabel *label
,PangoWrapMode wrap_mode
);
If line wrapping is on (see gtk_label_set_line_wrap()
) this controls how
the line wrapping is done. The default is PANGO_WRAP_WORD
which means
wrap on word boundaries.
Since: 2.10
void gtk_label_get_layout_offsets (GtkLabel *label
,gint *x
,gint *y
);
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.
label |
a GtkLabel |
|
x |
location to store X offset of layout, or |
[out][allow-none] |
y |
location to store Y offset of layout, or |
[out][allow-none] |
guint
gtk_label_get_mnemonic_keyval (GtkLabel *label
);
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.
gboolean
gtk_label_get_selectable (GtkLabel *label
);
Gets the value set by gtk_label_set_selectable()
.
const gchar *
gtk_label_get_text (GtkLabel *label
);
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()
)
GtkWidget *
gtk_label_new_with_mnemonic (const gchar *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.
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.
label |
a GtkLabel |
|
start_offset |
start offset (in characters not bytes) |
|
end_offset |
end offset (in characters not bytes) |
void gtk_label_set_mnemonic_widget (GtkLabel *label
,GtkWidget *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 the GtkWidget::mnemonic-activate signal 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.
void gtk_label_set_selectable (GtkLabel *label
,gboolean setting
);
Selectable labels allow the user to select text from the label, for copy-and-paste.
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()
.
PangoAttrList *
gtk_label_get_attributes (GtkLabel *label
);
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)).
GtkJustification
gtk_label_get_justify (GtkLabel *label
);
Returns the justification of the label. See gtk_label_set_justify()
.
PangoEllipsizeMode
gtk_label_get_ellipsize (GtkLabel *label
);
Returns the ellipsizing position of the label. See gtk_label_set_ellipsize()
.
Since: 2.6
gint
gtk_label_get_width_chars (GtkLabel *label
);
Retrieves the desired width of label
, in characters. See
gtk_label_set_width_chars()
.
Since: 2.6
gint
gtk_label_get_max_width_chars (GtkLabel *label
);
Retrieves the desired maximum width of label
, in characters. See
gtk_label_set_width_chars()
.
Since: 2.6
const gchar *
gtk_label_get_label (GtkLabel *label
);
Fetches the text from a label widget including any embedded
underlines indicating mnemonics and Pango markup. (See
gtk_label_get_text()
).
PangoLayout *
gtk_label_get_layout (GtkLabel *label
);
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.
gboolean
gtk_label_get_line_wrap (GtkLabel *label
);
Returns whether lines in the label are automatically wrapped.
See gtk_label_set_line_wrap()
.
PangoWrapMode
gtk_label_get_line_wrap_mode (GtkLabel *label
);
Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode()
.
Since: 2.10
GtkWidget *
gtk_label_get_mnemonic_widget (GtkLabel *label
);
Retrieves the target of the mnemonic (keyboard shortcut) of this
label. See gtk_label_set_mnemonic_widget()
.
gboolean gtk_label_get_selection_bounds (GtkLabel *label
,gint *start
,gint *end
);
Gets the selected range of characters in the label, returning TRUE
if there's a selection.
label |
a GtkLabel |
|
start |
return location for start of selection, as a character offset. |
[out] |
end |
return location for end of selection, as a character offset. |
[out] |
gboolean
gtk_label_get_use_markup (GtkLabel *label
);
Returns whether the label's text is interpreted as marked up with
the gtk_label_set_use_markup()
.
gboolean
gtk_label_get_use_underline (GtkLabel *label
);
Returns whether an embedded underline in the label indicates a
mnemonic. See gtk_label_set_use_underline()
.
gboolean
gtk_label_get_single_line_mode (GtkLabel *label
);
Returns whether the label is in single line mode.
Since: 2.6
gdouble
gtk_label_get_angle (GtkLabel *label
);
Gets the angle of rotation for the label. See
gtk_label_set_angle()
.
Since: 2.6
void gtk_label_set_label (GtkLabel *label
,const gchar *str
);
Sets the text of the label. The label is interpreted as including embedded underlines and/or Pango markup depending on the values of the “use-underline”" and “use-markup” properties.
void gtk_label_set_use_markup (GtkLabel *label
,gboolean setting
);
Sets whether the text of the label contains markup in gtk_label_set_markup()
.
void gtk_label_set_use_underline (GtkLabel *label
,gboolean setting
);
If true, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
void gtk_label_set_single_line_mode (GtkLabel *label
,gboolean single_line_mode
);
Sets whether the label is in single line mode.
Since: 2.6
void gtk_label_set_angle (GtkLabel *label
,gdouble angle
);
Sets the angle of rotation for the label. An angle of 90 reads from from bottom to top, an angle of 270, from top to bottom. The angle setting for the label is ignored if the label is selectable, wrapped, or ellipsized.
label |
a GtkLabel |
|
angle |
the angle that the baseline of the label makes with the horizontal, in degrees, measured counterclockwise |
Since: 2.6
const gchar *
gtk_label_get_current_uri (GtkLabel *label
);
Returns the URI for the currently active link in the label. The active link is the one under the mouse pointer or, in a selectable label, the link in which the text cursor is currently positioned.
This function is intended for use in a “activate-link” handler or for use in a “query-tooltip” handler.
Since: 2.18
void gtk_label_set_track_visited_links (GtkLabel *label
,gboolean track_links
);
Sets whether the label should keep track of clicked links (and use a different color for them).
Since: 2.18
“angle”
property “angle” double
The angle that the baseline of the label makes with the horizontal, in degrees, measured counterclockwise. An angle of 90 reads from from bottom to top, an angle of 270, from top to bottom. Ignored if the label is selectable, wrapped, or ellipsized.
Owner: GtkLabel
Flags: Read / Write
Allowed values: [0,360]
Default value: 0
Since: 2.6
“attributes”
property“attributes” PangoAttrList *
A list of style attributes to apply to the text of the label.
Owner: GtkLabel
Flags: Read / Write
“cursor-position”
property “cursor-position” int
The current position of the insertion cursor in chars.
Owner: GtkLabel
Flags: Read
Allowed values: >= 0
Default value: 0
“ellipsize”
property“ellipsize” PangoEllipsizeMode
The preferred place to ellipsize the string, if the label does not have enough room to display the entire string, specified as a PangoEllisizeMode.
Note that setting this property to a value other than
PANGO_ELLIPSIZE_NONE
has the side-effect that the label requests
only enough space to display the ellipsis "...". In particular, this
means that ellipsizing labels do not work well in notebook tabs, unless
the tab's “tab-expand” property is set to TRUE
. Other ways
to set a label's width are gtk_widget_set_size_request()
and
gtk_label_set_width_chars()
.
Owner: GtkLabel
Flags: Read / Write
Default value: PANGO_ELLIPSIZE_NONE
Since: 2.6
“justify”
property“justify” GtkJustification
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.
Owner: GtkLabel
Flags: Read / Write
Default value: GTK_JUSTIFY_LEFT
“label”
property “label” char *
The text of the label.
Owner: GtkLabel
Flags: Read / Write
Default value: ""
“max-width-chars”
property “max-width-chars” int
The desired maximum width of the label, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the label will request space for no more than the requested number of characters. If the “width-chars” property is set to a positive value, then the "max-width-chars" property is ignored.
Owner: GtkLabel
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 2.6
“mnemonic-keyval”
property “mnemonic-keyval” guint
The mnemonic accelerator key for this label.
Owner: GtkLabel
Flags: Read
Default value: 16777215
“mnemonic-widget”
property“mnemonic-widget” GtkWidget *
The widget to be activated when the label's mnemonic key is pressed.
Owner: GtkLabel
Flags: Read / Write
“pattern”
property “pattern” char *
A string with _ characters in positions correspond to characters in the text to underline.
Owner: GtkLabel
Flags: Write
Default value: NULL
“selectable”
property “selectable” gboolean
Whether the label text can be selected with the mouse.
Owner: GtkLabel
Flags: Read / Write
Default value: FALSE
“selection-bound”
property “selection-bound” int
The position of the opposite end of the selection from the cursor in chars.
Owner: GtkLabel
Flags: Read
Allowed values: >= 0
Default value: 0
“single-line-mode”
property “single-line-mode” gboolean
Whether the label is in single line mode. In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This can be an advantage in situations where resizing the label because of text changes would be distracting, e.g. in a statusbar.
Owner: GtkLabel
Flags: Read / Write
Default value: FALSE
Since: 2.6
“track-visited-links”
property “track-visited-links” gboolean
Set this property to TRUE
to make the label track which links
have been clicked. It will then apply the ::visited-link-color
color, instead of ::link-color.
Owner: GtkLabel
Flags: Read / Write
Default value: TRUE
Since: 2.18
“use-markup”
property “use-markup” gboolean
The text of the label includes XML markup. See pango_parse_markup().
Owner: GtkLabel
Flags: Read / Write
Default value: FALSE
“use-underline”
property “use-underline” gboolean
If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
Owner: GtkLabel
Flags: Read / Write
Default value: FALSE
“width-chars”
property “width-chars” int
The desired width of the label, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the label will request either 3 characters or the property value, whichever is greater. If the "width-chars" property is set to a positive value, then the “max-width-chars” property is ignored.
Owner: GtkLabel
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 2.6
“wrap”
property “wrap” gboolean
If set, wrap lines if the text becomes too wide.
Owner: GtkLabel
Flags: Read / Write
Default value: FALSE
“wrap-mode”
property“wrap-mode” PangoWrapMode
If line wrapping is on (see the “wrap” property) this controls
how the line wrapping is done. The default is PANGO_WRAP_WORD
, which
means wrap on word boundaries.
Owner: GtkLabel
Flags: Read / Write
Default value: PANGO_WRAP_WORD
Since: 2.10
“activate-current-link”
signalvoid user_function (GtkLabel *label, gpointer user_data)
A keybinding signal which gets emitted when the user activates a link in the label.
Applications may also emit the signal with g_signal_emit_by_name()
if they need to control activation of URIs programmatically.
The default bindings for this signal are all forms of the Enter key.
label |
The label on which the signal was emitted |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
Since: 2.18
“activate-link”
signalgboolean user_function (GtkLabel *label, char *uri, gpointer user_data)
The signal which gets emitted to activate a URI.
Applications may connect to it to override the default behaviour,
which is to call gtk_show_uri()
.
label |
The label on which the signal was emitted |
|
uri |
the URI that is activated |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 2.18
“copy-clipboard”
signalvoid user_function (GtkLabel *label, gpointer user_data)
The ::copy-clipboard signal is a
keybinding signalwhich gets emitted to copy the selection to the clipboard.
The default binding for this signal is Ctrl-c.
label |
the object which received the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“move-cursor”
signalvoid user_function (GtkLabel *entry, GtkMovementStep step, int count, gboolean extend_selection, gpointer user_data)
The ::move-cursor signal is a
keybinding signalwhich gets emitted when the user initiates a cursor movement.
If the cursor is not visible in entry
, this signal causes
the viewport to be moved instead.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control the cursor
programmatically.
The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifer does not. There are too many key combinations to list them all here.
entry |
the object which received the signal |
|
step |
the granularity of the move, as a GtkMovementStep |
|
count |
the number of |
|
extend_selection |
|
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“populate-popup”
signalvoid user_function (GtkLabel *label, GtkMenu *menu, gpointer user_data)
The ::populate-popup signal gets emitted before showing the context menu of the label. Note that only selectable labels have context menus.
If you need to add items to the context menu, connect
to this signal and append your menuitems to the menu
.
label |
The label on which the signal is emitted |
|
menu |
the menu that is being populated |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last