|
|
              
TextThe Text item allows you to add formatted text to a scene. More... Inherits Item Properties
Signals
Detailed DescriptionText items can display both plain and rich text. For example, red text with a specific font and size can be defined like this: Text { text: "Hello World!" font.family: "Helvetica" font.pointSize: 24 color: "red" } Rich text is defined using HTML-style markup: Text { text: "<b>Hello</b> <i>World!</i>" } [Missing image declarative-text.png] If height and width are not explicitly set, Text will attempt to determine how much room is needed and set it accordingly. Unless wrapMode is set, it will always prefer width to height (all text will be placed on a single line). The elide property can alternatively be used to fit a single line of plain text to a set width. Note that the Supported HTML Subset is limited. Also, if the text contains HTML img tags that load remote images, the text is reloaded. Text provides read-only text. For editable text, see TextEdit. See also Fonts example. Property DocumentationThis property specifies a base URL which 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.
By default is the url of the Text element. 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. Returns the height of the text, including height past the height which 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 which 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 } Sets the family name of the font. The family name is case insensitive and may optionally include a foundry name, e.g. "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. Sets whether the font has an italic style. 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. Sets whether the font has a strikeout style. Sets whether the text is underlined. Sets the font's weight. The weight can be one of:
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. 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. 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. 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. 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. 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. This property holds whether the text is smoothly scaled or transformed. Smooth filtering gives better visual quality, but is slower. If the item is displayed at its natural size, this property has no visual or performance effect. Note: Generally scaling artifacts are only visible if the item is stationary on the screen. A common pattern when animating an item is to disable smooth filtering at the beginning of the animation and reenable it at the conclusion. 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" } } [Missing image declarative-textstyle.png] 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(). The way the text property should be displayed. Supported text formats are:
If the text format is Text.AutoText the text element will automatically determine whether the text should be treated as styled text. This determination is made using Qt::mightBeRichText() which uses a fast and therefore simple heuristic. It mainly checks whether there is something that looks like a tag before the first line break. Although the result may be correct for common cases, there is no guarantee. Text.StyledText is an optimized format supporting some basic text styling markup, in the style of html 3.2: <b></b> - bold <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 > < & Text.StyledText parser is strict, requiring tags to be correctly nested.
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:
Signal DocumentationThis handler is called for every line during the layout process. 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 a line are:
For example, this will move the first 5 lines of a text element by 100 pixels to the right: onLineLaidOut: {
if (line.number < 5) {
line.x = line.x + 100
line.width = line.width - 100
}
}
This handler is called 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: "The main website is at <a href=\"http://qt.nokia.com\">Nokia Qt DF</a>." onLinkActivated: console.log(link + " link activated") } The example code will display the text "The main website is at Nokia Qt DF." Clicking on the highlighted link will output http://qt.nokia.com link activated to the console. |
