Memory-managed wrapper type.

Type class for types which can be safely cast to Label, for instance with toLabel.

Cast to Label, for types for which this is known to be safe. For general casts, use castTo.

Gets the label's attribute list.

This is the [structpango.AttrList] that was set on the label using labelSetAttributes, if any. This function does not reflect attributes that come from the label's markup (see labelSetMarkup). If you want to get the effective attributes for the label, use pango_layout_get_attributes (gtk_label_get_layout (self)).

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 Label::activateLink handler or for use in a Widget::queryTooltip handler.

Returns the ellipsizing position of the label.

See labelSetEllipsize.

Gets the extra menu model of label.

See labelSetExtraMenu.

Returns the justification of the label.

See labelSetJustify.

Fetches the text from a label.

The returned text includes any embedded underlines indicating mnemonics and Pango markup. (See labelGetText).

Gets the PangoLayout used to display the label.

The layout is useful to e.g. convert text positions to pixel positions, in combination with labelGetLayoutOffsets. The returned layout is owned by the label so need not be freed by the caller. The label is free to recreate its layout at any time, so it should be considered read-only.

Obtains the coordinates where the label will draw its PangoLayout.

The coordinates are useful to convert mouse events into coordinates inside the Layout, e.g. to take some action if some part of the label is clicked. Remember when using the Layout functions you need to convert to and from pixels using PANGO_PIXELS() or [constpango.SCALE].

Gets the number of lines to which an ellipsized, wrapping label should be limited.

See labelSetLines.

Retrieves the desired maximum width of label, in characters.

See labelSetWidthChars.

Return the mnemonic accelerator.

If the label has been set so that it has a mnemonic key this function returns the keyval used for the mnemonic accelerator. If there is no mnemonic set up it returns GDK_KEY_VoidSymbol.

Retrieves the target of the mnemonic (keyboard shortcut) of this label.

See labelSetMnemonicWidget.

Returns line wrap mode used by the label.

See labelSetNaturalWrapMode.

Since: 4.6

Returns whether the label is selectable.

Gets the selected range of characters in the label.

Returns whether the label is in single line mode.

Gets the tabs for self.

The returned array will be Nothing if “standard” (8-space) tabs are used. Free the return value with tabArrayFree.

Since: 4.8

Fetches the text from a label.

The returned text is as it appears on screen. This does not include any embedded underlines indicating mnemonics or Pango markup. (See labelGetLabel)

Returns whether the label’s text is interpreted as Pango markup.

See labelSetUseMarkup.

Returns whether an embedded underlines in the label indicate mnemonics.

See labelSetUseUnderline.

Retrieves the desired width of label, in characters.

See labelSetWidthChars.

Returns whether lines in the label are automatically wrapped.

See labelSetWrap.

Returns line wrap mode used by the label.

See labelSetWrapMode.

Gets the xalign of the label.

See the Label:xalign property.

Gets the yalign of the label.

See the Label:yalign property.

Creates a new label with the given text inside it.

You can pass Nothing to get an empty label widget.

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

If labelSetMnemonicWidget 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.

Selects a range of characters in the label, if the label is selectable.

See labelSetSelectable. If the label is not selectable, this function has no effect. If startOffset or endOffset are -1, then the end of the label will be substituted.

Apply attributes 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 Label:useUnderline or Label:useMarkup 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.

Sets the mode used to ellipsize the text.

The text will be ellipsized if there is not enough space to render the entire string.

Sets a menu model to add when constructing the context menu for label.

Sets the alignment of the lines in the text of the label relative to each other.

JustificationLeft is the default value when the widget is first created with labelNew. If you instead want to set the alignment of the label as a whole, use widgetSetHalign instead. labelSetJustify has no effect on labels containing only a single line.

Sets the text of the label.

The label is interpreted as including embedded underlines and/or Pango markup depending on the values of the Label:useUnderline and Label:useMarkup properties.

Sets the number of lines to which an ellipsized, wrapping label should be limited.

This has no effect if the label is not wrapping or ellipsized. Set this to -1 if you don’t want to limit the number of lines.

Sets the labels text and attributes from markup.

The string must be marked up with Pango markup (see parseMarkup).

If the str is external data, you may need to escape it with markupEscapeText or g_markup_printf_escaped():

c code

GtkWidget *self = gtk_label_new (NULL);
const char *str = "...";
const char *format = "<span style=\"italic\">\%s</span>";
char *markup;

markup = g_markup_printf_escaped (format, str);
gtk_label_set_markup (GTK_LABEL (self), markup);
g_free (markup);

This function will set the Label:useMarkup property to True as a side effect.

If you set the label contents using the Label:label property you should also ensure that you set the Label:useMarkup property accordingly.

See also: labelSetText

Sets the labels text, attributes and mnemonic from markup.

Parses str which is marked up with Pango markup (see parseMarkup), 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 labelSetMnemonicWidget.

Sets the desired maximum width in characters of label to nChars.

Associate the label with its mnemonic target.

If the label has been set so that it has a mnemonic key (using i.e. labelSetMarkupWithMnemonic, labelSetTextWithMnemonic, labelNewWithMnemonic or the [propertygtk.Label: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 Button or a Notebook tab) it is automatically associated with the correct widget, but sometimes (i.e. when the target is a Entry next to the label) you need to set it explicitly using this function.

The target widget will be accelerated by emitting the Widget::mnemonicActivate 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.

Select the line wrapping for the natural size request.

This only affects the natural size requested, for the actual wrapping used, see the Label:wrapMode property.

Since: 4.6

Makes text in the label selectable.

Selectable labels allow the user to select text from the label, for copy-and-paste.

Sets whether the label is in single line mode.

Sets the default tab stops for paragraphs in self.

Since: 4.8

Sets the text within the GtkLabel widget.

It overwrites any text that was there before.

This function will clear any previously set mnemonic accelerators, and set the Label:useUnderline property to False as a side effect.

This function will set the Label:useMarkup property to False as a side effect.

See also: labelSetMarkup

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

Sets whether the text of the label contains markup.

See labelSetMarkup.

Sets whether underlines in the text indicate mnemonics.

Sets the desired width in characters of label to nChars.

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

Controls how line wrapping is done.

This only affects the label if line wrapping is on. (See labelSetWrap) The default is WrapModeWord which means wrap on word boundaries.

For sizing behavior, also consider the Label:naturalWrapMode property.

Sets the xalign of the label.

See the Label:xalign property.

Sets the yalign of the label.

See the Label:yalign property.

Set the value of the “attributes” property to Nothing. When overloading is enabled, this is equivalent to

clear #attributes

Construct a GValueConstruct with valid value for the “attributes” property. This is rarely needed directly, but it is used by new.

Get the value of the “attributes” property. When overloading is enabled, this is equivalent to

get label #attributes

Set the value of the “attributes” property. When overloading is enabled, this is equivalent to

set label [ #attributes := value ]

Construct a GValueConstruct with valid value for the “ellipsize” property. This is rarely needed directly, but it is used by new.

Get the value of the “ellipsize” property. When overloading is enabled, this is equivalent to

get label #ellipsize

Set the value of the “ellipsize” property. When overloading is enabled, this is equivalent to

set label [ #ellipsize := value ]

Set the value of the “extra-menu” property to Nothing. When overloading is enabled, this is equivalent to

clear #extraMenu

Construct a GValueConstruct with valid value for the “extra-menu” property. This is rarely needed directly, but it is used by new.

Get the value of the “extra-menu” property. When overloading is enabled, this is equivalent to

get label #extraMenu

Set the value of the “extra-menu” property. When overloading is enabled, this is equivalent to

set label [ #extraMenu := value ]

Construct a GValueConstruct with valid value for the “justify” property. This is rarely needed directly, but it is used by new.

Get the value of the “justify” property. When overloading is enabled, this is equivalent to

get label #justify

Set the value of the “justify” property. When overloading is enabled, this is equivalent to

set label [ #justify := value ]

Construct a GValueConstruct with valid value for the “label” property. This is rarely needed directly, but it is used by new.

Get the value of the “label” property. When overloading is enabled, this is equivalent to

get label #label

Set the value of the “label” property. When overloading is enabled, this is equivalent to

set label [ #label := value ]

Construct a GValueConstruct with valid value for the “lines” property. This is rarely needed directly, but it is used by new.

Get the value of the “lines” property. When overloading is enabled, this is equivalent to

get label #lines

Set the value of the “lines” property. When overloading is enabled, this is equivalent to

set label [ #lines := value ]

Construct a GValueConstruct with valid value for the “max-width-chars” property. This is rarely needed directly, but it is used by new.

Get the value of the “max-width-chars” property. When overloading is enabled, this is equivalent to

get label #maxWidthChars

Set the value of the “max-width-chars” property. When overloading is enabled, this is equivalent to

set label [ #maxWidthChars := value ]

Get the value of the “mnemonic-keyval” property. When overloading is enabled, this is equivalent to

get label #mnemonicKeyval

Set the value of the “mnemonic-widget” property to Nothing. When overloading is enabled, this is equivalent to

clear #mnemonicWidget

Construct a GValueConstruct with valid value for the “mnemonic-widget” property. This is rarely needed directly, but it is used by new.

Get the value of the “mnemonic-widget” property. When overloading is enabled, this is equivalent to

get label #mnemonicWidget

Set the value of the “mnemonic-widget” property. When overloading is enabled, this is equivalent to

set label [ #mnemonicWidget := value ]

Construct a GValueConstruct with valid value for the “natural-wrap-mode” property. This is rarely needed directly, but it is used by new.

Get the value of the “natural-wrap-mode” property. When overloading is enabled, this is equivalent to

get label #naturalWrapMode

Set the value of the “natural-wrap-mode” property. When overloading is enabled, this is equivalent to

set label [ #naturalWrapMode := value ]

Construct a GValueConstruct with valid value for the “selectable” property. This is rarely needed directly, but it is used by new.

Get the value of the “selectable” property. When overloading is enabled, this is equivalent to

get label #selectable

Set the value of the “selectable” property. When overloading is enabled, this is equivalent to

set label [ #selectable := value ]

Construct a GValueConstruct with valid value for the “single-line-mode” property. This is rarely needed directly, but it is used by new.

Get the value of the “single-line-mode” property. When overloading is enabled, this is equivalent to

get label #singleLineMode

Set the value of the “single-line-mode” property. When overloading is enabled, this is equivalent to

set label [ #singleLineMode := value ]

Set the value of the “tabs” property to Nothing. When overloading is enabled, this is equivalent to

clear #tabs

Construct a GValueConstruct with valid value for the “tabs” property. This is rarely needed directly, but it is used by new.

Get the value of the “tabs” property. When overloading is enabled, this is equivalent to

get label #tabs

Set the value of the “tabs” property. When overloading is enabled, this is equivalent to

set label [ #tabs := value ]

Construct a GValueConstruct with valid value for the “use-markup” property. This is rarely needed directly, but it is used by new.

Get the value of the “use-markup” property. When overloading is enabled, this is equivalent to

get label #useMarkup

Set the value of the “use-markup” property. When overloading is enabled, this is equivalent to

set label [ #useMarkup := value ]

Construct a GValueConstruct with valid value for the “use-underline” property. This is rarely needed directly, but it is used by new.

Get the value of the “use-underline” property. When overloading is enabled, this is equivalent to

get label #useUnderline

Set the value of the “use-underline” property. When overloading is enabled, this is equivalent to

set label [ #useUnderline := value ]

Construct a GValueConstruct with valid value for the “width-chars” property. This is rarely needed directly, but it is used by new.

Get the value of the “width-chars” property. When overloading is enabled, this is equivalent to

get label #widthChars

Set the value of the “width-chars” property. When overloading is enabled, this is equivalent to

set label [ #widthChars := value ]

Construct a GValueConstruct with valid value for the “wrap” property. This is rarely needed directly, but it is used by new.

Get the value of the “wrap” property. When overloading is enabled, this is equivalent to

get label #wrap

Set the value of the “wrap” property. When overloading is enabled, this is equivalent to

set label [ #wrap := value ]

Construct a GValueConstruct with valid value for the “wrap-mode” property. This is rarely needed directly, but it is used by new.

Get the value of the “wrap-mode” property. When overloading is enabled, this is equivalent to

get label #wrapMode

Set the value of the “wrap-mode” property. When overloading is enabled, this is equivalent to

set label [ #wrapMode := value ]

Construct a GValueConstruct with valid value for the “xalign” property. This is rarely needed directly, but it is used by new.

Get the value of the “xalign” property. When overloading is enabled, this is equivalent to

get label #xalign

Set the value of the “xalign” property. When overloading is enabled, this is equivalent to

set label [ #xalign := value ]

Construct a GValueConstruct with valid value for the “yalign” property. This is rarely needed directly, but it is used by new.

Get the value of the “yalign” property. When overloading is enabled, this is equivalent to

get label #yalign

Set the value of the “yalign” property. When overloading is enabled, this is equivalent to

set label [ #yalign := value ]

Gets emitted when the user activates a link in the label.

The activateCurrentLink is a keybinding signal.

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 <kbd>Enter</kbd> key.

Connect a signal handler for the activateCurrentLink signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after label #activateCurrentLink callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the activateCurrentLink signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on label #activateCurrentLink callback

Gets emitted to activate a URI.

Applications may connect to it to override the default behaviour, which is to call fileLauncherLaunch.

Connect a signal handler for the activateLink signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after label #activateLink callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the activateLink signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on label #activateLink callback

Gets emitted to copy the selection to the clipboard.

The copyClipboard signal is a keybinding signal.

The default binding for this signal is <kbd>Ctrl</kbd>+<kbd>c</kbd>.

Connect a signal handler for the copyClipboard signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after label #copyClipboard callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the copyClipboard signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on label #copyClipboard callback

Gets emitted when the user initiates a cursor movement.

The moveCursor signal is a keybinding signal. 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 modifier does not. There are too many key combinations to list them all here.

• <kbd>←</kbd>, <kbd>→</kbd>, <kbd>↑</kbd>, <kbd>↓</kbd> move by individual characters/lines
• <kbd>Ctrl</kbd>+<kbd>←</kbd>, etc. move by words/paragraphs
• <kbd>Home</kbd> and <kbd>End</kbd> move to the ends of the buffer

Connect a signal handler for the moveCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after label #moveCursor callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the moveCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on label #moveCursor callback