Skip to main content

Type Alias: GtkInscriptionProps

GtkInscriptionProps = WidgetProps & object

Defined in: generated/jsx.ts:5565

Props for the GtkInscription widget.

Type Declaration

NameTypeDescriptionDefined in
attributes?Pango.AttrList | nullA list of style attributes to apply to the text of the inscription.generated/jsx.ts:5567
markup?stringUtility property that sets both the Inscription.text and Inscription.attributes properties, mainly intended for use in GtkBuilder ui files to ease translation support and bindings. This function uses Pangoparse_markup to parse the markup into text and attributes. The markup must be valid. If you cannot ensure that, consider using Pangoparse_markup and setting the two properties yourself.generated/jsx.ts:5577
minChars?numberThe number of characters that should fit into the inscription at minimum. This influences the requested width, not the width actually given to the widget, which might turn out to be larger. Note that this is an approximate character width, so some characters might be wider and some might be thinner, so do not expect the number of characters to exactly match. If you set this property to 0, the inscription will not request any width at all and its width will be determined entirely by its surroundings.generated/jsx.ts:5591
minLines?numberThe number of lines that should fit into the inscription at minimum. This influences the requested height, not the height actually given to the widget, which might turn out to be larger. Note that this is an approximate line height, so if the text uses things like fancy Unicode or attribute that influence the height, the text might not fit. If you set this property to 0, the inscription will not request any height at all and its height will be determined entirely by its surroundings.generated/jsx.ts:5604
natChars?numberThe number of characters that should ideally fit into the inscription. This influences the requested width, not the width actually given to the widget. The widget might turn out larger as well as smaller. If this property is set to a value smaller than Inscription.min-chars, that value will be used. In particular, for the default value of 0, this will always be the case.generated/jsx.ts:5615
natLines?numberThe number of lines that should ideally fit into the inscription. This influences the requested height, not the height actually given to the widget. The widget might turn out larger as well as smaller. If this property is set to a value smaller than Inscription.min-lines, that value will be used. In particular, for the default value of 0, this will always be the case.generated/jsx.ts:5626
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:5656
ref?Ref<Gtk.Inscription>-generated/jsx.ts:5673
text?string | nullThe displayed text.generated/jsx.ts:5628
textOverflow?Gtk.InscriptionOverflowThe overflow method to use for the text.generated/jsx.ts:5630
wrapMode?Pango.WrapModeControls how the line wrapping is done. Note that unlike GtkLabel, the default here is %PANGO_WRAP_WORD_CHAR.generated/jsx.ts:5636
xalign?numberThe horizontal alignment of the text inside the allocated size. Compare this to Widget.halign, which determines how the inscription's size allocation is positioned in the available space.generated/jsx.ts:5643
yalign?numberThe vertical alignment of the text inside the allocated size. Compare this to Widget.valign, which determines how the inscription's size allocation is positioned in the available space.generated/jsx.ts:5650