Text QML Type

Sets the horizontal and vertical alignment of the text within the Text items width and height. By default, the text is vertically aligned to the top. Horizontal alignment follows the natural alignment of the text, for example text that is read from left to right will be aligned to the left.

The valid values for horizontalAlignment are Text.AlignLeft, Text.AlignRight, Text.AlignHCenter and Text.AlignJustify. The valid values for verticalAlignment are Text.AlignTop, Text.AlignBottom and Text.AlignVCenter.

Note that for a single line of text, the size of the text is the area of the text. In this common case, all alignments are equivalent. If you want the text to be, say, centered in its parent, then you will need to either modify the Item::anchors, or set horizontalAlignment to Text.AlignHCenter and bind the width to that of the parent.

When using the attached property LayoutMirroring::enabled to mirror application layouts, the horizontal alignment of text will also be mirrored. However, the property horizontalAlignment will remain unchanged. To query the effective horizontal alignment of Text, use the read-only property effectiveHorizontalAlignment.

These properties hold the padding around the content. This space is reserved in addition to the contentWidth and contentHeight.

The distance, in pixels, from the baseline origin of the first character of the text item, to the baseline origin of the first character in a text item occurring directly after this one in a text flow.

Note that the advance can be negative if the text flows from right to left.

Used to decide if the Text should use antialiasing or not. Only Text with renderType of Text.NativeRendering can disable antialiasing.

The default is true.

This property specifies a base URL that is used to resolve relative URLs within the text.

Urls are resolved to be within the same directory as the target of the base URL meaning any portion of the path after the last '/' will be ignored.

The default value is the url of the QML file instantiating the Text item.

This property holds whether the text is clipped.

Note that if the text does not fit in the bounding rectangle, it will be abruptly chopped.

If you want to display potentially long text in a limited space, you probably want to use elide instead.

The text color.

An example of green text defined using hexadecimal notation:

 Text {
     color: "#00FF00"
     text: "green text"
 }

An example of steel blue text defined using an SVG color name:

 Text {
     color: "steelblue"
     text: "blue text"
 }

Returns the height of the text, including height past the height that is covered due to there being more text than fits in the set height.

Returns the width of the text, including width past the width that is covered due to insufficient wrapping if WrapMode is set.

Set this property to elide parts of the text fit to the Text item's width. The text will only elide if an explicit width has been set.

This property cannot be used with rich text.

Eliding can be:

If this property is set to Text.ElideRight, it can be used with wrapped text. The text will only elide if maximumLineCount, or height has been set. If both maximumLineCount and height are set, maximumLineCount will apply unless the lines do not fit in the height allowed.

If the text is a multi-length string, and the mode is not Text.ElideNone, the first string that fits will be used, otherwise the last will be elided.

Multi-length strings are ordered from longest to shortest, separated by the Unicode "String Terminator" character U009C (write this in QML with "\u009C" or "\x9C").

Sets whether the font weight is bold.

Sets the capitalization for the text.

 Text { text: "Hello"; font.capitalization: Font.AllLowercase }

If the selected font does not contain a certain character, Qt automatically chooses a similar-looking fallback font that contains the character. By default this is done on a character-by-character basis.

This means that in certain uncommon cases, many different fonts may be used to represent one string of text even if it's in the same script. Setting contextFontMerging to true will try finding the fallback font that matches the largest subset of the input string instead. This will be more expensive for strings where missing glyphs occur, but may give more consistent results. By default, contextFontMerging is false.

This property was introduced in Qt 6.8.

See also QFont::StyleStrategy.

Sets the family name of the font.

The family name is case insensitive and may optionally include a foundry name, for example "Helvetica [Cronyx]". If the family is available from more than one foundry and the foundry isn't specified, an arbitrary foundry is chosen. If the family isn't available a family will be set using the font matching algorithm.

Applies integer values to specific OpenType features when shaping the text based on the contents in features. This provides advanced access to the font shaping process, and can be used to support font features that are otherwise not covered in the API.

The font features are represented by a map from four-letter tags to integer values. This integer value passed along with the tag in most cases represents a boolean value: A zero value means the feature is disabled, and a non-zero value means it is enabled. For certain font features, however, it may have other interpretations. For example, when applied to the salt feature, the value is an index that specifies the stylistic alternative to use.

For example, the frac font feature will convert diagonal fractions separated with a slash (such as 1/2) with a different representation. Typically this will involve baking the full fraction into a single character width (such as ½).

If a font supports the frac feature, then it can be enabled in the shaper as in the following code:

 Text {
     text: "One divided by two is 1/2"
     font.family: "MyFractionFont"
     font.features: { "frac": 1 }
 }

Multiple features can be assigned values in the same mapping. For instance, if you would like to also disable kerning for the font, you can explicitly disable this as follows:

 Text {
     text: "One divided by two is 1/2"
     font.family: "MyFractionFont"
     font.features: { "frac": 1, "kern": 0 }
 }

You can also collect the font properties in an object:

 Text {
     text: "One divided by two is 1/2"
     font: {
         family: "MyFractionFont"
         features: { "frac": 1, "kern": 0 }
     }
 }

This property was introduced in Qt 6.6.

See also QFont::setFeature().

Sets the preferred hinting on the text. This is a hint to the underlying text rendering system to use a certain level of hinting, and has varying support across platforms. See the table in the documentation for QFont::HintingPreference for more details.

 Text { text: "Hello"; renderType: Text.NativeRendering; font.hintingPreference: Font.PreferVerticalHinting }

Sets whether the font has an italic style.

Enables or disables the kerning OpenType feature when shaping the text. Disabling this may improve performance when creating or changing the text, at the expense of some cosmetic features. The default value is true.

 Text { text: "OATS FLAVOUR WAY"; font.kerning: false }

Sets the letter spacing for the font.

Letter spacing changes the default spacing between individual letters in the font. A positive value increases the letter spacing by the corresponding pixels; a negative value decreases the spacing.

Sets the font size in pixels.

Using this function makes the font device dependent. Use pointSize to set the size of the font in a device independent manner.

Sets the font size in points. The point size must be greater than zero.

Sometimes, a font will apply complex rules to a set of characters in order to display them correctly. In some writing systems, such as Brahmic scripts, this is required in order for the text to be legible, but in for example Latin script, it is merely a cosmetic feature. Setting the preferShaping property to false will disable all such features when they are not required, which will improve performance in most cases.

The default value is true.

 Text { text: "Some text"; font.preferShaping: false }

competing sets of the vertical line metrics that provide the ascent, descent and leading of the font. These are often referred to as the win (Windows) metrics and the typo (typographical) metrics. While the specification recommends using the typo metrics for line spacing, many applications prefer the win metrics unless the USE_TYPO_METRICS flag is set in the fsSelection field of the font. For backwards-compatibility reasons, this is also the case for Qt applications. This is not an issue for fonts that set the USE_TYPO_METRICS flag to indicate that the typo metrics are valid, nor for fonts where the win metrics and typo metrics match up. However, for certain fonts the win metrics may be larger than the preferable line spacing and the USE_TYPO_METRICS flag may be unset by mistake. For such fonts, setting font.preferTypoLineMetrics may give superior results.

By default, preferTypoLineMetrics is false.

This property was introduced in Qt 6.8.

See also QFont::StyleStrategy.

Sets whether the font has a strikeout style.

Sets the style name of the font.

The style name is case insensitive. If set, the font will be matched against style name instead of the font properties font.weight, font.bold and font.italic.

Sets whether the text is underlined.

Applies floating point values to variable axes in variable fonts.

Variable fonts provide a way to store multiple variations (with different weights, widths or styles) in the same font file. The variations are given as floating point values for a pre-defined set of parameters, called "variable axes". Specific instances are typically given names by the font designer, and, in Qt, these can be selected using setStyleName() just like traditional sub-families.

In some cases, it is also useful to provide arbitrary values for the different axes. For instance, if a font has a Regular and Bold sub-family, you may want a weight in-between these. You could then manually request this by supplying a custom value for the "wght" axis in the font.

 Text {
     text: "Foobar"
     font.family: "MyVariableFont"
     font.variableAxes: { "wght": (Font.Normal + Font.Bold) / 2.0 }
 }

If the "wght" axis is supported by the font and the given value is within its defined range, a font corresponding to the weight 550.0 will be provided.

There are a few standard axes than many fonts provide, such as "wght" (weight), "wdth" (width), "ital" (italic) and "opsz" (optical size). They each have indivdual ranges defined in the font itself. For instance, "wght" may span from 100 to 900 (QFont::Thin to QFont::Black) whereas "ital" can span from 0 to 1 (from not italic to fully italic).

A font may also choose to define custom axes; the only limitation is that the name has to meet the requirements for a QFont::Tag (sequence of four latin-1 characters.)

By default, no variable axes are set.

This property was introduced in Qt 6.7.

See also QFont::setVariableAxis().

The requested weight of the font. The weight requested must be an integer between 1 and 1000, or one of the predefined values:

 Text { text: "Hello"; font.weight: Font.DemiBold }

Sets the word spacing for the font.

Word spacing changes the default spacing between individual words. A positive value increases the word spacing by a corresponding amount of pixels, while a negative value decreases the inter-word spacing accordingly.

The bold state of the font info that has been resolved for the current font and fontSizeMode. This is true if the weight of the resolved font is bold or higher.

The family name of the font that has been resolved for the current font and fontSizeMode.

The italic state of the font info that has been resolved for the current font and fontSizeMode.

The pixel size of the font info that has been resolved for the current font and fontSizeMode.

The pointSize of the font info that has been resolved for the current font and fontSizeMode.

The style name of the font info that has been resolved for the current font and fontSizeMode.

The weight of the font info that has been resolved for the current font and fontSizeMode.

This property specifies how the font size of the displayed text is determined. The possible values are:

The font size of fitted text has a minimum bound specified by the minimumPointSize or minimumPixelSize property and maximum bound specified by either the font.pointSize or font.pixelSize properties.

 Text { text: "Hello"; fontSizeMode: Text.Fit; minimumPixelSize: 10; font.pixelSize: 72 }

If the text does not fit within the item bounds with the minimum font size the text will be elided as per the elide property.

If the textFormat property is set to Text.RichText, this will have no effect at all as the property will be ignored completely. If textFormat is set to Text.StyledText, then the property will be respected provided there is no font size tags inside the text. If there are font size tags, the property will still respect those. This can cause it to not fully comply with the fontSizeMode setting.

This property contains the link string when the user hovers a link embedded in the text. The link must be in rich text or HTML format and the hoveredLink string provides access to the particular link.

See also linkHovered and linkAt().

Returns the number of lines visible in the text item.

This property is not supported for rich text.

See also maximumLineCount.

Sets the line height for the text. The value can be in pixels or a multiplier depending on lineHeightMode.

The default value is a multiplier of 1.0. The line height must be a positive value.

This property determines how the line height is specified. The possible values are:

The color of links in the text.

This property works with the StyledText textFormat, but not with RichText. Link color in RichText can be specified by including CSS style tags in the text.

Set this property to limit the number of lines that the text item will show. If elide is set to Text.ElideRight, the text will be elided appropriately. By default, this is the value of the largest possible integer.

This property is not supported for rich text.

See also lineCount and elide.

This property specifies the minimum font pixel size of text scaled by the fontSizeMode property.

If the fontSizeMode is Text.FixedSize or the font.pixelSize is -1 this property is ignored.

This property specifies the minimum font point size of text scaled by the fontSizeMode property.

If the fontSizeMode is Text.FixedSize or the font.pointSize is -1 this property is ignored.

Override the default rendering type for this component.

Supported render types are:

Select Text.NativeRendering if you prefer text to look native on the target platform and do not require advanced features such as transformation of the text. Using such features in combination with the NativeRendering render type will lend poor and sometimes pixelated results.

Both Text.QtRendering and Text.CurveRendering are hardware-accelerated techniques. QtRendering is the faster of the two, but uses more memory and will exhibit rendering artifacts at large sizes. CurveRendering should be considered as an alternative in cases where QtRendering does not give good visual results or where reducing graphics memory consumption is a priority.

The default rendering type is determined by QQuickWindow::textRenderType().

Override the default rendering type quality for this component. This is a low-level customization which can be ignored in most cases. It currently only has an effect when renderType is Text.QtRendering.

The rasterization algorithm used by Text.QtRendering may give artifacts at large text sizes, such as sharp corners looking rounder than they should. If this is an issue for specific text items, increase the renderTypeQuality to improve rendering quality, at the expense of memory consumption.

The renderTypeQuality may be any integer over 0, or one of the following predefined values

This property was introduced in Qt 6.0.

Set an additional text style.

Supported text styles are:

 Row {
     Text { font.pointSize: 24; text: "Normal" }
     Text { font.pointSize: 24; text: "Raised"; style: Text.Raised; styleColor: "#AAAAAA" }
     Text { font.pointSize: 24; text: "Outline";style: Text.Outline; styleColor: "red" }
     Text { font.pointSize: 24; text: "Sunken"; style: Text.Sunken; styleColor: "#AAAAAA" }
 }

Defines the secondary color used by text styles.

styleColor is used as the outline color for outlined text, and as the shadow color for raised or sunken text. If no style has been set, it is not used at all.

 Text { font.pointSize: 18; text: "hello"; style: Text.Raised; styleColor: "gray" }

See also style.

The text to display. Text supports both plain and rich text strings.

The item will try to automatically determine whether the text should be treated as styled text. This determination is made using Qt::mightBeRichText(). However, detection of Markdown is not automatic.

See also textFormat.

The way the text property should be displayed.

Supported text formats are:

If the text format is Text.AutoText, the Text item will automatically determine whether the text should be treated as styled text. This determination is made using Qt::mightBeRichText(), which can detect the presence of an HTML tag on the first line of text, but cannot distinguish Markdown from plain text.

Text.StyledText is an optimized format supporting some basic text styling markup, in the style of HTML 3.2:

 <b></b> - bold
 <del></del> - strike out (removed content)
 <s></s> - strike out (no longer accurate or no longer relevant content)
 <strong></strong> - bold
 <i></i> - italic
 <br> - new line
 <p> - paragraph
 <u> - underlined text
 <font color="color_name" size="1-7"></font>
 <h1> to <h6> - headers
 <a href=""> - anchor
 <img src="" align="top,middle,bottom" width="" height=""> - inline images
 <ol type="">, <ul type=""> and <li> - ordered and unordered lists
 <pre></pre> - preformatted
 All entities

Text.StyledText parser is strict, requiring tags to be correctly nested.

 Column {
     Text {
         font.pointSize: 24
         text: "<b>Hello</b> <i>World!</i>"
     }
     Text {
         font.pointSize: 24
         textFormat: Text.RichText
         text: "<b>Hello</b> <i>World!</i>"
     }
     Text {
         font.pointSize: 24
         textFormat: Text.PlainText
         text: "<b>Hello</b> <i>World!</i>"
     }
     Text {
         font.pointSize: 24
         textFormat: Text.MarkdownText
         text: "**Hello** *World!*"
     }
 }

Text.RichText supports a larger subset of HTML 4, as described on the Supported HTML Subset page. You should prefer using Text.PlainText, Text.StyledText or Text.MarkdownText instead, as they offer better performance.

• code blocks use the default monospace font but without a surrounding highlight box
• block quotes are indented, but there is no vertical line alongside the quote

Returns true if the text has been truncated due to maximumLineCount or elide.

This property is not supported for rich text.

See also maximumLineCount and elide.

Set this property to wrap the text to the Text item's width. The text will only wrap if an explicit width has been set. wrapMode can be one of:

This signal is emitted for each line of text that is laid out during the layout process in plain text or styled text mode. It is not emitted in rich text mode. The specified line object provides more details about the line that is currently being laid out.

This gives the opportunity to position and resize a line as it is being laid out. It can for example be used to create columns or lay out text around objects.

The properties of the specified line object are:

For example, this will move the first 5 lines of a Text item by 100 pixels to the right:

 onLineLaidOut: (line)=> {
     if (line.number < 5) {
         line.x = line.x + 100
         line.width = line.width - 100
     }
 }

The following example will allow you to position an item at the end of the last line:

 onLineLaidOut: (line)=> {
     if (line.isLast) {
         lastLineMarker.x = line.x + line.implicitWidth
         lastLineMarker.y = line.y + (line.height - lastLineMarker.height) / 2
     }
 }

This signal is emitted when the user clicks on a link embedded in the text. The link must be in rich text or HTML format and the link string provides access to the particular link.

     Text {
             textFormat: Text.RichText
             text: "See the <a href=\"http://qt-project.org\">Qt Project website</a>."
             onLinkActivated: (link)=> console.log(link + " link activated")
     }

The example code will display the text "See the Qt Project website."

Clicking on the highlighted link will output http://qt-project.org link activated to the console.

This signal is emitted when the user hovers a link embedded in the text. The link must be in rich text or HTML format and the link string provides access to the particular link.

See also hoveredLink and linkAt().

Triggers a re-layout of the displayed text.

Returns the link string at point x, y in content coordinates, or an empty string if no link exists at that point.

See also hoveredLink.