gtkLabelNew(str = NULL, show = TRUE)
gtkLabelSetText(object, str)
gtkLabelSetAttributes(object, attrs)
gtkLabelSetMarkup(object, str)
gtkLabelSetMarkupWithMnemonic(object, str)
gtkLabelSetPattern(object, pattern)
gtkLabelSetJustify(object, jtype)
gtkLabelSetEllipsize(object, mode)
gtkLabelSetWidthChars(object, n.chars)
gtkLabelSetMaxWidthChars(object, n.chars)
gtkLabelGet(object)
gtkLabelParseUline(object, string)
gtkLabelSetLineWrap(object, wrap)
gtkLabelSetLineWrapMode(object, wrap.mode)
gtkLabelGetLayoutOffsets(object)
gtkLabelGetMnemonicKeyval(object)
gtkLabelGetSelectable(object)
gtkLabelGetText(object)
gtkLabelNewWithMnemonic(str = NULL, show = TRUE)
gtkLabelSelectRegion(object, start.offset, end.offset)
gtkLabelSetMnemonicWidget(object, widget)
gtkLabelSetSelectable(object, setting)
gtkLabelSetTextWithMnemonic(object, str)
gtkLabelGetAttributes(object)
gtkLabelGetJustify(object)
gtkLabelGetEllipsize(object)
gtkLabelGetWidthChars(object)
gtkLabelGetMaxWidthChars(object)
gtkLabelGetLabel(object)
gtkLabelGetLayout(object)
gtkLabelGetLineWrap(object)
gtkLabelGetLineWrapMode(object)
gtkLabelGetMnemonicWidget(object)
gtkLabelGetSelectionBounds(object)
gtkLabelGetUseMarkup(object)
gtkLabelGetUseUnderline(object)
gtkLabelGetSingleLineMode(object)
gtkLabelGetAngle(object)
gtkLabelSetLabel(object, str)
gtkLabelSetUseMarkup(object, setting)
gtkLabelSetUseUnderline(object, setting)
gtkLabelSetSingleLineMode(object, single.line.mode)
gtkLabelSetAngle(object, angle)
gtkLabelGetCurrentUri(object)
gtkLabelSetTrackVisitedLinks(object, track.links)
gtkLabelGetTrackVisitedLinks(object)
gtkLabel(str = NULL, show = TRUE)
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkMisc +----GtkLabel +----GtkAccelLabel +----GtkTipsQuery
GtkBuildable
.GtkLabel
widget displays a small amount of text. As the name
implies, most labels are used to label another widget such as a
GtkButton
, a GtkMenuItem
, or a GtkOptionMenu
.PangoAttribute
values for this label. A UI definition fragment specifying Pango attributesThe start and end attributes specify the range of characters to which the Pango attribute applies. If start and end are not specified, the attribute is applied to the whole text. Note that specifying ranges does not make much sense with translatable attributes. Use markup embedded in the translatable content instead.
"_File"
, to the
functions gtkLabelNewWithMnemonic
or
gtkLabelSetTextWithMnemonic
. Mnemonics automatically activate any activatable widget the label is
inside, such as a GtkButton
; if the label is not inside the
mnemonic's target widget, you have to tell the label about the target
using gtkLabelSetMnemonicWidget
. Here's a simple example where
the label is inside a button:
## Pressing Alt-H will activate this button button <- gtkButton() label <- gtkLabelNewWithMnemonic("_Hello") button$add(label)There's a convenience function to create buttons with a mnemonic label already inside:
## Pressing Alt+H will activate this button button <- gtkButtonNewWithMnemonic("_Hello")To create a mnemonic for a widget alongside the label, such as a
GtkEntry
, you have to point the label at the entry with
gtkLabelSetMnemonicWidget
:
## Pressing Alt+H will focus the entry entry <- gtkEntry() label <- gtkLabelNewWithMnemonic("_Hello") label$setMnemonicWidget(entry)
label <- gtkLabelNew() label$setMarkup("Small text")(See complete documentation of available tags in the Pango manual.) The markup passed to
gtkLabelSetMarkup
must be valid; for example,
literal >/& characters must be escaped as <,
>, and &. If you pass text obtained from the user, file,
or a network to gtkLabelSetMarkup
, you'll want to escape it with
gMarkupEscapeText()
or gMarkupPrintfEscaped()
. Markup strings are just a convenient way to set the PangoAttrList
on
a label; gtkLabelSetAttributes
may be a simpler way to set
attributes in some cases. Be careful though; PangoAttrList
tends to
cause internationalization problems, unless you're applying attributes
to the entire string (i.e. unless you set the range of each attribute
to [0, G_MAXINT)). The reason is that specifying the start_index and
end_index for a PangoAttribute
requires knowledge of the exact string
being displayed, so translations will cause problems.gtkLabelSetSelectable
.
Selectable labels allow the user to copy the label contents to
the clipboard. Only labels that contain useful-to-copy information
-- such as error messages -- should be made selectable.gtkLabelSetLineWrap
.
gtkLabelSetJustify
sets how the lines in a label align
with one another. If you want to set how the label as a whole
aligns in its available space, see gtkMiscSetAlignment
.a
with href and title attributes. GTK+ renders links similar to the
way they appear in web browsers, with colored, underlined text. The title
attribute is displayed as a tooltip on the link. An example looks like this:
label$setMarkup("Go to the <a href=\"http://www.gtk.org\" title=\"<i>Our&/i> website\">GTK+ website</a> for more...")It is possible to implement custom handling for links and their tooltips with the
"activate-link"
signal and the gtkLabelGetCurrentUri
function.gtkLabel
is the result of collapsing the constructors of GtkLabel
(gtkLabelNew
, gtkLabelNewWithMnemonic
) and accepts a subset of its arguments matching the required arguments of one of its delegate constructors.activate-current-link(label, user.data)
gSignalEmitByName()
if they need to control activation of URIs programmatically. The default bindings for this signal are all forms of the Enter key.
Since 2.18 label
user.data
activate-link(label, uri, user.data)
gtkShowUri
.
Since 2.18 label
uri
user.data
TRUE
if the link has been activated copy-clipboard(label, user.data)
label
user.data
move-cursor(entry, step, count, extend.selection, user.data)
entry
, this signal causes
the viewport to be moved instead. Applications should not connect to it, but may emit it with
gSignalEmitByName()
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
step
GtkMovementStep
count
step
units to moveextend.selection
TRUE
if the move should extend the selectionuser.data
populate-popup(label, menu, user.data)
menu
. label
menu
user.data
angle
[numeric : Read / Write]attributes
[PangoAttrList
: * : Read / Write]cursor-position
[integer : Read]ellipsize
[PangoEllipsizeMode
: Read / Write]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 gtkWidgetSetSizeRequest
and
gtkLabelSetWidthChars
.
Default value: PANGO_ELLIPSIZE_NONE Since 2.6 justify
[GtkJustification
: Read / Write]label
[character : * : Read / Write]max-width-chars
[integer : Read / Write]"width-chars"
property is set to a positive
value, then the "max-width-chars" property is ignored.
Allowed values: >= -1 Default value: -1 Since 2.6 mnemonic-keyval
[numeric : Read]mnemonic-widget
[GtkWidget
: * : Read / Write]pattern
[character : * : Write]selectable
[logical : Read / Write]selection-bound
[integer : Read]single-line-mode
[logical : Read / Write]track-visited-links
[logical : Read / Write]TRUE
to make the label track which links
have been clicked. It will then apply the ::visited-link-color
color, instead of ::link-color.
Default value: TRUE Since 2.18 use-markup
[logical : Read / Write]use-underline
[logical : Read / Write]width-chars
[integer : Read / Write]"max-width-chars"
property is ignored.
Allowed values: >= -1 Default value: -1 Since 2.6 wrap
[logical : Read / Write]wrap-mode
[PangoWrapMode
: Read / Write]"wrap"
property) this controls
how the line wrapping is done. The default is PANGO_WRAP_WORD
, which
means wrap on word boundaries.
Default value: PANGO_WRAP_WORD Since 2.10