Gjsify LogoGjsify Logo

Hierarchy

Index

Properties

accessibleRole?: AccessibleRole

The accessible role of the given GtkAccessible implementation.

The accessible role cannot be changed once set.

attributes?: Pango.AttrList

A list of style attributes to apply to the text of the label.

canFocus?: boolean

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

canTarget?: boolean

Whether the widget can receive pointer events.

cssClasses?: string[]

A list of css classes applied to this widget.

cssName?: string

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

cursor?: Gdk.Cursor

The cursor used by widget.

ellipsize?: EllipsizeMode

The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.

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 [propertyGtk.NotebookPage:tab-expand] child property is set to %TRUE. Other ways to set a label's width are [methodGtk.Widget.set_size_request] and [methodGtk.Label.set_width_chars].

extraMenu?: MenuModel

A menu model whose contents will be appended to the context menu.

focusOnClick?: boolean

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

focusable?: boolean

Whether this widget itself will accept the input focus.

halign?: Gtk.Align

How to distribute horizontal space if widget gets extra space.

hasTooltip?: boolean

Enables or disables the emission of the ::query-tooltip signal on widget.

A value of %TRUE indicates that widget can have a tooltip, in this case the widget will be queried using [signalGtk.Widget::query-tooltip] to determine whether it will provide a tooltip or not.

heightRequest?: number

Override for height request of the widget.

If this is -1, the natural request will be used.

hexpand?: boolean

Whether to expand horizontally.

hexpandSet?: boolean

Whether to use the hexpand property.

justify?: Gtk.Justification

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 [propertyGtk.Label:xalign] for that.

label?: string

The contents of the label.

If the string contains Pango markup (see [funcPango.parse_markup]), you will have to set the [propertyGtk.Label:use-markup] property to %TRUE in order for the label to display the markup attributes. See also [methodGtk.Label.set_markup] for a convenience function that sets both this property and the [propertyGtk.Label:use-markup] property at the same time.

If the string contains underlines acting as mnemonics, you will have to set the [propertyGtk.Label:use-underline] property to %TRUE in order for the label to display them.

layoutManager?: Gtk.LayoutManager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

lines?: number

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

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

marginBottom?: number

Margin on bottom side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

marginEnd?: number

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

marginStart?: number

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

marginTop?: number

Margin on top side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from [methodGtk.Widget.set_size_request] for example.

maxWidthChars?: number

The desired maximum width of the label, in characters.

If this property is set to -1, the width will be calculated automatically.

See the section on text layout for details of how [propertyGtk.Label:width-chars] and [propertyGtk.Label:max-width-chars] determine the width of ellipsized and wrapped labels.

mnemonicWidget?: Gtk.Widget

The widget to be activated when the labels mnemonic key is pressed.

name?: string

The name of the widget.

naturalWrapMode?: NaturalWrapMode

Select the line wrapping for the natural size request.

This only affects the natural size requested. For the actual wrapping used, see the [propertyGtk.Label:wrap-mode] property.

The default is %GTK_NATURAL_WRAP_INHERIT, which inherits the behavior of the [propertyGtk.Label:wrap-mode] property.

opacity?: number

The requested opacity of the widget.

overflow?: Overflow

How content outside the widget's content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

receivesDefault?: boolean

Whether the widget will receive the default action when it is focused.

selectable?: boolean

Whether the label text can be selected with the mouse.

sensitive?: boolean

Whether the widget responds to input.

singleLineMode?: boolean

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.

tooltipMarkup?: string

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see [methodGtk.Tooltip.set_markup].

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: [propertyGtk.Widget:has-tooltip] will automatically be set to %TRUE and there will be taken care of [signalGtk.Widget::query-tooltip] in the default signal handler.

Note that if both [propertyGtk.Widget:tooltip-text] and [propertyGtk.Widget:tooltip-markup] are set, the last one wins.

tooltipText?: string

Sets the text of tooltip to be the given string.

Also see [methodGtk.Tooltip.set_text].

This is a convenience property which will take care of getting the tooltip shown if the given string is not %NULL: [propertyGtk.Widget:has-tooltip] will automatically be set to %TRUE and there will be taken care of [signalGtk.Widget::query-tooltip] in the default signal handler.

Note that if both [propertyGtk.Widget:tooltip-text] and [propertyGtk.Widget:tooltip-markup] are set, the last one wins.

useMarkup?: boolean

%TRUE if the text of the label includes Pango markup.

See [funcPango.parse_markup].

useUnderline?: boolean

%TRUE if the text of the label indicates a mnemonic with _.

valign?: Gtk.Align

How to distribute vertical space if widget gets extra space.

vexpand?: boolean

Whether to expand vertically.

vexpandSet?: boolean

Whether to use the vexpand property.

visible?: boolean

Whether the widget is visible.

widthChars?: number

The desired width of the label, in characters.

If this property is set to -1, the width will be calculated automatically.

See the section on text layout for details of how [propertyGtk.Label:width-chars] and [propertyGtk.Label:max-width-chars] determine the width of ellipsized and wrapped labels.

widthRequest?: number

Override for width request of the widget.

If this is -1, the natural request will be used.

wrap?: boolean

%TRUE if the label text will wrap if it gets too wide.

wrapMode?: Pango.WrapMode

Controls how the line wrapping is done.

This only affects the formatting if line wrapping is on (see the [propertyGtk.Label:wrap] property). The default is %PANGO_WRAP_WORD, which means wrap on word boundaries.

For sizing behavior, also consider the [propertyGtk.Label:natural-wrap-mode] property.

xalign?: number

The horizontal alignment of the label text inside its size allocation.

Compare this to [propertyGtk.Widget:halign], which determines how the labels size allocation is positioned in the space available for the label.

yalign?: number

The vertical alignment of the label text inside its size allocation.

Compare this to [propertyGtk.Widget:valign], which determines how the labels size allocation is positioned in the space available for the label.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method