org.gnu.gtk
public class Label extends Misc
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 constructor or setText method, with the hadMnemonic parameter true.
Mnemonics automatically activate any activatable widget the label is inside, such as a Button; if the label is not inside the mnemonic's target widget, you have to tell the label about the target using setMnemonicWidget.
To make it easy to format text in a label (changing colors, fonts, etc.), label text can be provided in a simple markup format. Here's how to create a label with a small font:
label = new Label(""); label.setMarkup("<small>Small text</small>");(See complete documentation of available tags in the Pango manual.)
The markup passed to setMarkup 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 setMarkup, you'll want to escape it with g_markup_escape_text().
Markup strings are just a convenient way to set the PangoAttrList on a label; setAttributes 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 . The reason is that specifying the startIndex and endIndex for a PangoAttribute requires knowledge of the exact string being displayed, so translations will cause problems.
Labels can be made selectable with setSelectable. 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.
A label can contain any number of paragraphs, but will have performance problems if it contains more than a small number. Paragraphs are separated by newlines or other paragraph separators understood by Pango.
Labels can automatically wrap text if you call setLineWrap.
setJustify 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 gtk.Misc.setAlignment.
Constructor Summary | |
---|---|
Label(String caption)
Creates a new label widget displaying the given caption. | |
Label(String caption, boolean hasMnemonic)
Creates a new label widget displaying the given caption.
| |
Label(Handle handle)
Construct a label using a handle to a native resource. |
Method Summary | |
---|---|
double | getAngle()
Gets the angle of rotation for the label.
|
AttrList | getAttributes()
Gets the attribute list that was set on the label using setAttributes, if
any. |
EllipsizeMode | getEllipsize()
Returns the ellipsizing position.
|
Justification | getJustification()
Returns the justification of the label.
|
static Label | getLabel(Handle handle)
Construct a label using a handle to a native resource. |
String | getLabel()
Fetches the text from a label widget including any embedded underlines
indicating mnemonics and Pango markup.
|
boolean | getLineWrap()
Returns whether lines in the label are automatically wrapped.
|
int | getMaxWidthChars()
Retrieves the desired maximum width of label, in characters.
|
Widget | getMnemonicWidget()
Retrieves the target of the mnemonic (keyboard shortcut) of this label
|
boolean | getSelectable()
Gets the value set by setSelectable.
|
boolean | getSelected()
Returns true if any part of the label is selected |
int | getSelectionEnd()
Returns the index of the end of the selected test. |
int | getSelectionStart()
Returns the index of the start of the selected text. |
boolean | getSingleLineMode()
Returns whether the label is in single line mode.
|
String | getText()
Returns the text which is being displayed on this label.
|
static Type | getType()
Retrieve the runtime type used by the GLib library. |
boolean | getUseMarkup()
Returns whether the label's text is interpreted as marked up with the
Pango text markup language.
|
boolean | getUseMnemonic()
Returns whether an embedded underline in the label indicates a mnemonic.
|
int | getWidthChars()
Retrieves the desired width of label, in characters.
|
void | select(int startOffset, int endOffset)
Selects a range of characters in the label, if the label is selectable.
|
void | setAngle(double angle)
Sets the angle of rotation for the label. |
void | setAttributes(AttrList attributes)
Sets a PangoAttrList; the attributes in the list are applied to the label
text. |
void | setEllipsize(EllipsizeMode mode)
Sets the mode used to ellipsize (add an ellipsis: "...") the text if
there is not enough space to render the entire string.
|
void | setJustification(Justification justification)
Sets the alignment of the lines in the text of the label relative to each
other. |
void | setLabel(String label)
Sets the text of the label.
|
void | setLineWrap(boolean wrap)
Toggles line wrapping within the Label widget. |
void | setMarkup(String markup)
Parses markup which is marked up with the Pango text
markup language, setting the label's text and attribute list based on the
parse results. |
void | setMarkup(String markup, boolean hasMnemonic)
Parses markup which is marked up with the Pango text
markup language, setting the label's text and attribute list based on the
parse results.
|
void | setMaxWidthChars(int chars)
Sets the desired maximum width in characters to chars.
|
void | setMnemonicWidget(Widget widget)
If the label has been set so that it has an mnemonic key, the label can
be associated with a widget that is the target of the mnemonic. |
void | setSelectable(boolean setting)
Selectable labels allow the user to select text from the label, for
copy-and-paste.
|
void | setSingleLineMode(boolean singleLineMode)
Sets whether the label is in single line mode.
|
void | setText(String caption)
Changes the text to be displayed in the label widget.
|
void | setUnderlinePattern(String pattern)
The pattern of underlines you want under the existing text within the
Label widget. |
void | setUseMarkup(boolean setting)
Sets whether the text of the label contains markup in Pango's text markup
language.
|
void | setUseMnemonic(boolean setting)
If true, an underline in the text indicates the next character should be
used for the mnemonic accelerator key.
|
void | setWidthChars(int chars)
Sets the desired width in characters of label to chars.
|
Parameters: caption The default text to be displayed on the label
Parameters: caption The default text to be displayed on the label hasMnemonic If true, the caption is interpreted to have mnemonic characters. See the description for this class for more details.
Returns: the angle of rotation for the label
Since: 2.6
See Also: Label
Returns: the Pango Attributes list
Since: 2.6
Returns: the justification of the label
See Also: setJustification
Returns: The entry text of the label.
Returns: True if lines are automatically wrapped
Returns: the maximum width of the label in characters.
Since: 2.6
See Also: Label
Returns: Target Widget
Returns: TRUE if the user can copy text from the label.
Returns: true when the label is in single line mode.
Since: 2.6
Returns: the text which is being displayed.
Returns: TRUE if the label's text will be parsed for markup.
See Also: Label
Returns: Whether an embedded underline in the label indicates the mnemonic accelerator keys.
See Also: Label
Returns: the width of the label in characters.
Since: 2.6
See Also: Label
Parameters: startOffset The start offset in characters endOffset The end offset in characters
See Also: Label
Parameters: angle the angle that the baseline of the label makes with the horizontal, in degrees, measured counterclockwise
Since: 2.6
Parameters: attributes Pange attrlist attributes to use
See Also: AttrList
Since: 2.6
Parameters: label The new text to set for the label
Parameters: wrap New line wrap setting.
markup
which is marked up with the Pango text
markup language, setting the label's text and attribute list based on the
parse results. The markup should not contain mnemonic characters if this
method is used.
Parameters: markup String containing pango markup
markup
which is marked up with the Pango text
markup language, setting the label's text and attribute list based on the
parse results.
Parameters: markup String containing pango markup hasMnemonic If true, the markup string will be interpreted to contain mnemonic characters, for use as keyboard accelerators
Parameters: chars the new desired maximum width, in characters.
Since: 2.6
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.
Parameters: widget The target widget
Parameters: setting TRUE to allow selecting text in the label
Parameters: singleLineMode true if the label should be in single line mode
Since: 2.6
Parameters: caption the new text to be displayed.
Parameters: pattern The pattern as described above.
Parameters: setting TRUE if the label's text should be parsed for markup.
See Also: Label
Parameters: setting TRUE if underlines in the text indicate mnemonics
Parameters: chars the new desired width, in characters.
Since: 2.6