RGtk2 (version 2.8.8)

GtkLabel: GtkLabel

Description

A widget that displays a small to medium amount of text

Methods and Functions

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) 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) 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) gtkLabel(str = NULL, show = TRUE)

Hierarchy

\link{GObject} +----\link{GtkObject} +----\link{GtkWidget} +----\link{GtkMisc} +----GtkLabel +----\link{GtkAccelLabel} +----\link{GtkTipsQuery}

Interfaces

GtkLabel implements AtkImplementorIface.

Detailed Description

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

Mnemonics

Labels may contain mnemonics. Mnemonics are underlined characters in the label, used for keyboard navigation. Mnemonics are created by providing a string with an underscore before the mnemonic character, such as "_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)