Тип QML Text

Определяет способ добавления форматированного текста в сцену Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Свойства

• baseUrl : url
• bottomPadding : real
• clip : bool
• color : цвет
• contentHeight : real
• contentWidth : real
• effectiveHorizontalAlignment : перечисление
• elide : перечисление
• font.bold : bool
• font.capitalization : перечисление
• font.family : строка
• font.hintingPreference : перечисление
• font.italic : bool
• font.letterSpacing : real
• font.pixelSize : int
• font.pointSize : real
• font.strikeout : bool
• font.styleName : строка
• font.underline : bool
• font.weight : перечисление
• font.wordSpacing : real
• fontInfo.bold : bool
• fontInfo.family : строка
• fontInfo.italic : bool
• fontInfo.pixelSize : строка
• fontInfo.pointSize : real
• fontInfo.styleName : строка
• fontInfo.weight : int
• fontSizeMode : перечисление
• horizontalAlignment : перечисление
• hoveredLink : строка
• leftPadding : real
• lineCount : int
• lineHeight : real
• lineHeightMode : перечисление
• linkColor : цвет
• maximumLineCount : int
• minimumPixelSize : int
• minimumPointSize : int
• padding : real
• renderType : перечисление
• rightPadding : real
• style : перечисление
• styleColor : цвет
• text : строка
• textFormat : перечисление
• topPadding : real
• truncated : bool
• verticalAlignment : перечисление
• wrapMode : перечисление

Сигналы

• lineLaidOut(объект line)
• linkActivated(строка link)
• linkHovered(строка link)

Методы

• forceLayout()
• linkAt(real x, real y)

Подробное описание

Элементы Text могут отображать как обычный, так и форматированный текст. Например, красный текст с определенным шрифтом и размером можно определить так:

Text {
    text: "Hello World!"
    font.family: "Helvetica"
    font.pointSize: 24
    color: "red"
}

Форматированный текст определяется с помощью разметки в стиле HTML:

Text {
    text: "<b>Hello</b> <i>World!</i>"
}

Если высота и ширина не заданы явно, Text попытается определить необходимое пространство и установить его соответствующим образом. Если свойство wrapMode не установлено, оно всегда отдаёт предпочтение ширине высоте (весь текст будет размещён на одной строке).

Свойство elide можно альтернативно использовать для подгонки одной строки обычного текста под заданную ширину.

Обратите внимание, что поддерживаемый подмножество HTML ограничено. Кроме того, если текст содержит теги HTML img, загружающие удалённые изображения, текст перезагружается.

Text предоставляет только для чтения текст. Для редактируемого текста см. TextEdit.

См. также Пример шрифтов.

Документация по свойствам

baseUrl : url

Это свойство задаёт базовый URL, который используется для разрешения относительных URL внутри текста.

URL разрешаются таким образом, чтобы они находились в той же директории, что и целевой базовый URL, что означает, что любая часть пути после последнего '/' будет проигнорирована.

Значение по умолчанию — URL файла QML, который создаёт элемент Text.

bottomPadding : real

Эти свойства хранят отступы вокруг содержимого. Это пространство зарезервировано дополнительно к contentWidth и contentHeight.

Это свойство QML было введено в Qt 5.6.

clip : bool

Это свойство указывает, обрезается ли текст.

Обратите внимание, что если текст не помещается в прямоугольник ограничительной области, он будет резко обрублен.

Если вы хотите отображать потенциально длинный текст в ограниченном пространстве, вам, вероятно, следует использовать elide вместо этого.

color : color

Цвет текста.

Пример зеленого текста, определенного с помощью шестнадцатеричной записи:

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

Пример стального синего текста, определенного с помощью имени цвета SVG:

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

contentHeight : real

Возвращает высоту текста, включая высоту, превышающую высоту, которая покрывается из-за того, что текста больше, чем помещается в заданную высоту.

contentWidth : real

Возвращает ширину текста, включая ширину, превышающую ширину, которая покрывается из-за недостаточного перевода, если WrapMode установлен.

effectiveHorizontalAlignment : enumeration

Устанавливает горизонтальное и вертикальное выравнивание текста в пределах ширины и высоты элементов Text. По умолчанию текст вертикально выравнивается по верхнему краю. Горизонтальное выравнивание следует естественному выравниванию текста, например, текст, который читается слева направо, будет выровнен по левому краю.

Допустимые значения для horizontalAlignment — это Text.AlignLeft, Text.AlignRight, Text.AlignHCenter и Text.AlignJustify. Допустимые значения для verticalAlignment — это Text.AlignTop, Text.AlignBottom и Text.AlignVCenter.

Обратите внимание, что для однострочного текста размер текста соответствует площади текста. В этом общем случае все выравнивания эквивалентны. Если вам нужно, чтобы текст, например, был центрирован в своём родителе, вам необходимо либо изменить Item::anchors, либо установить horizontalAlignment в Text.AlignHCenter и привязать ширину к ширине родителя.

При использовании присоединённого свойства LayoutMirroring::enabled для отражения макетов приложения, горизонтальное выравнивание текста также будет отражено. Однако свойство horizontalAlignment останется неизменным. Для запроса эффективного горизонтального выравнивания Text используйте только для чтения свойство effectiveHorizontalAlignment.

elide : перечисление

Установите это свойство для обрезки частей текста, которые не помещаются в ширину элемента Text. Текст будет обрезаться только если явно установлена ширина.

Это свойство нельзя использовать с форматированным текстом.

Обрезка может быть:

• Text.ElideNone — по умолчанию
• Text.ElideLeft
• Text.ElideMiddle
• Text.ElideRight

Если это свойство установлено в Text.ElideRight, его можно использовать с wrapped текстом. Текст будет обрезаться только если maximumLineCount, или height установлено. Если оба maximumLineCount и height установлены, maximumLineCount будет применено, если только строки не помещаются в разрешённую высоту.

Если текст представляет собой строку с несколькими длинами, а режим не Text.ElideNone, будет использована первая строка, которая подходит, в противном случае будет обрезана последняя.

Строки с несколькими длинами упорядочены по убыванию длины, разделённые символом Unicode «String Terminator» U009C (запишите это в QML с помощью "\u009C" или "\x9C").

font.bold : bool

Устанавливает, является ли вес шрифта полужирным.

font.capitalization : перечисление

Устанавливает регистр для текста.

• Font.MixedCase — это обычный вариант рендеринга текста, где изменения регистра не применяются.
• Font.AllUppercase — это изменяет текст, чтобы он отображался прописными буквами.
• Font.AllLowercase — это изменяет текст, чтобы он отображался строчными буквами.
• Font.SmallCaps — это изменяет текст, чтобы он отображался строчными заглавными буквами.
• Font.Capitalize — это изменяет текст, чтобы отобразить первую букву каждого слова как прописную.

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

font.family : строка

Устанавливает имя семейства шрифта.

Имя семейства нечувствительно к регистру и может необязательно содержать имя типографии, например, "Helvetica [Cronyx]". Если семейство доступно от более чем одной типографии, и типография не указана, выбирается произвольная типография. Если семейство недоступно, семейство будет установлено с помощью алгоритма сопоставления шрифтов.

font.hintingPreference : перечисление

Устанавливает предпочтительное кернинг шрифта. Это подсказка для системы рендеринга текста использовать определённый уровень кернинга, и поддержка её варьируется в разных платформах. Более подробные сведения см. в таблице в документации для QFont::HintingPreference.

Примечание: Это свойство действует только при использовании типа рендеринга Text.NativeRendering.

Font.PreferDefaultHinting — использовать уровень кернинга по умолчанию для целевой платформы.

Font.PreferNoHinting — если возможно, отображать текст без кернинга контуров глифов. Вывод текста будет типографически точным, используя те же метрики, что и, например, при печати.

Font.PreferVerticalHinting — если возможно, отображать текст без горизонтального кернинга, но выравнивать глифы к пиксельной сетке в вертикальном направлении. Текст будет отображаться чётче на дисплеях, где плотность слишком низка для точного отображения глифов. Но поскольку горизонтальные метрики глифов не кернированы, макет текста будет масштабироваться до устройств с большей плотностью (таких как принтеры), не затрагивая такие детали, как перенос строк.

Font.PreferFullHinting — если возможно, отображать текст с кернингом в горизонтальном и вертикальном направлениях. Текст будет изменён для оптимизации читаемости на целевом устройстве, но поскольку метрики будут зависеть от целевого размера текста, позиции глифов, переносы строк и другие типографические детали не будут масштабироваться, что означает, что макет текста может выглядеть по-разному на устройствах с различной плотностью пикселей.

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

Это свойство QML было введено в Qt 5.8.

font.italic : bool

Устанавливает, имеет ли шрифт курсивный стиль.

font.letterSpacing : вещественное

Устанавливает интерлиньяж шрифта.

Интерлиньяж изменяет стандартное расстояние между отдельными буквами в шрифте. Положительное значение увеличивает интерлиньяж на соответствующее количество пикселей; отрицательное значение уменьшает расстояние.

font.pixelSize : целое

Устанавливает размер шрифта в пикселях.

Использование этой функции делает шрифт зависимым от устройства. Используйте pointSize для установки размера шрифта независимо от устройства.

font.pointSize : вещественное

Устанавливает размер шрифта в пунктах. Размер в пунктах должен быть больше нуля.

font.strikeout : bool

Устанавливает, имеет ли шрифт стиль перечёркивания.

font.styleName : строка

Устанавливает имя стиля шрифта.

Имя стиля нечувствительно к регистру. Если оно задано, шрифт будет сопоставляться по имени стиля вместо свойств шрифта font.weight, font.bold и font.italic.

Это свойство QML было введено в Qt 5.6.

font.underline : bool

Устанавливает, подчёркивается ли текст.

font.weight : перечисление

Устанавливает вес шрифта.

Вес может быть одним из следующих:

• Font.Thin
• Font.Light
• Font.ExtraLight
• Font.Normal — по умолчанию
• Font.Medium
• Font.DemiBold
• Font.Bold
• Font.ExtraBold
• Font.Black

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

font.wordSpacing : вещественное

Устанавливает интерлиньяж слов шрифта.

Интерлиньяж слов изменяет стандартное расстояние между отдельными словами. Положительное значение увеличивает расстояние между словами на соответствующее количество пикселей, в то время как отрицательное значение уменьшает расстояние между словами.

fontInfo.bold : bool

Состояние полужирности информации о шрифте, разрешённой для текущего шрифта и fontSizeMode. Это true, если вес разрешённого шрифта полужирный или выше.

Это свойство QML было введено в Qt 5.9.

fontInfo.family : строка

Имя семейства шрифта, разрешённого для текущего шрифта и fontSizeMode.

Это свойство QML было введено в Qt 5.9.

fontInfo.italic : bool

Состояние наклона информации о шрифте, разрешённой для текущего шрифта и fontSizeMode.

Это свойство QML было введено в Qt 5.9.

fontInfo.pixelSize : строка

Размер в пикселях шрифта, разрешённого для текущего шрифта и fontSizeMode.

Это свойство QML было введено в Qt 5.9.

fontInfo.pointSize : вещественное

Значение pointSize информации о шрифте, разрешённой для текущего шрифта и fontSizeMode.

Это свойство QML было введено в Qt 5.9.

fontInfo.styleName : строка

Имя стиля шрифта, разрешённого для текущего шрифта и fontSizeMode.

Это свойство QML было введено в Qt 5.9.

fontInfo.weight : целое

Вес шрифта, разрешённый для текущего шрифта и fontSizeMode.

Это свойство QML было введено в Qt 5.9.

fontSizeMode : перечисление

Это свойство определяет, как определяется размер шрифта отображаемого текста. Возможные значения:

• Text.FixedSize (по умолчанию) — используется размер, заданный font.pixelSize или font.pointSize.
• Text.HorizontalFit — используется наибольший размер до указанного, который помещается в ширину элемента без переноса строк.
• Text.VerticalFit — используется наибольший размер до указанного, который помещается в высоту элемента.
• Text.Fit — используется наибольший размер до указанного, который помещается в ширину и высоту элемента.

Размер шрифта для подгоняемого текста ограничен снизу свойством minimumPointSize или minimumPixelSize, а сверху — свойством font.pointSize или font.pixelSize.

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

Если текст не помещается в рамки элемента с минимальным размером шрифта, он будет усечён в соответствии со свойством elide.

horizontalAlignment : перечисление

Устанавливает горизонтальное и вертикальное выравнивание текста внутри ширины и высоты элемента Text. По умолчанию текст выравнивается по вертикали сверху. Горизонтальное выравнивание соответствует естественному направлению чтения текста, например, текст, читающийся слева направо, будет выровнен по левому краю.

Допустимые значения для horizontalAlignment — Text.AlignLeft, Text.AlignRight, Text.AlignHCenter и Text.AlignJustify. Допустимые значения для verticalAlignment — Text.AlignTop, Text.AlignBottom и Text.AlignVCenter.

Обратите внимание, что для одной строки текста размер текста — это область текста. В этом общем случае все выравнивания эквивалентны. Если вы хотите, чтобы текст, например, был центрирован в своём родителе, вам нужно либо изменить Item::anchors, либо установить horizontalAlignment на Text.AlignHCenter и связать ширину с шириной родителя.

При использовании присоединённого свойства LayoutMirroring::enabled для зеркального отображения макета приложения, горизонтальное выравнивание текста также будет зеркальным. Однако свойство horizontalAlignment останется без изменений. Для запроса эффективного горизонтального выравнивания текста используйте только для чтения свойство effectiveHorizontalAlignment.

hoveredLink : строка

Это свойство содержит строку ссылки, когда пользователь наводит указатель мыши на ссылку, встроенную в текст. Ссылка должна быть в формате форматированного текста или HTML, и строка hoveredLink предоставляет доступ к конкретной ссылке.

Это свойство QML было добавлено в Qt 5.2.

См. также linkHovered и linkAt().

leftPadding : вещественное число

Эти свойства содержат отступы вокруг содержимого. Это пространство резервируется в дополнение к contentWidth и contentHeight.

Это свойство QML было добавлено в Qt 5.6.

lineCount : целое число

Возвращает количество видимых строк в элементе текста.

Это свойство не поддерживается для форматированного текста.

См. также maximumLineCount.

lineHeight : вещественное число

Устанавливает высоту строки для текста. Значение может быть в пикселях или множителем, в зависимости от lineHeightMode.

Значение по умолчанию — множитель 1,0. Высота строки должна быть положительной.

lineHeightMode : перечисление

Это свойство определяет, как задаётся высота строки. Возможные значения:

• Text.ProportionalHeight (по умолчанию) — устанавливает интервал пропорционально строке (как множитель). Например, значение 2 задаёт двойной интервал.
• Text.FixedHeight — устанавливает высоту строки фиксированным значением (в пикселях).

linkColor : цвет

Цвет ссылок в тексте.

Это свойство работает с форматированным текстом StyledText textFormat, но не с RichText. Цвет ссылок в RichText можно указать, включив теги стилей CSS в текст.

maximumLineCount : целое число

Установите это свойство, чтобы ограничить количество отображаемых строк в элементе текста. Если elide установлено в Text.ElideRight, текст будет усечён соответствующим образом. По умолчанию это значение максимального целого числа.

Это свойство не поддерживается для форматированного текста.

См. также lineCount и elide.

minimumPixelSize : целое число

Это свойство задаёт минимальный размер шрифта текста в пикселях, масштабируемый свойством fontSizeMode.

Если fontSizeMode равен Text.FixedSize или font.pixelSize равен -1, это свойство игнорируется.

minimumPointSize : целое число

Это свойство задаёт минимальный размер шрифта текста в пунктах, масштабируемый свойством fontSizeMode.

Если fontSizeMode равен Text.FixedSize или font.pointSize равен -1, это свойство игнорируется.

padding : вещественное число

Эти свойства содержат отступы вокруг содержимого. Это пространство резервируется в дополнение к contentWidth и contentHeight.

Это свойство QML было добавлено в Qt 5.6.

renderType : перечисление

Переопределяет тип рендеринга по умолчанию для этого компонента.

Поддерживаемые типы рендеринга:

• Text.QtRendering — по умолчанию
• Text.NativeRendering

Выберите Text.NativeRendering, если вы предпочитаете, чтобы текст выглядел нативно на целевой платформе и не требуются расширенные функции, такие как преобразование текста. Использование таких функций в сочетании с типом рендеринга NativeRendering приведёт к некачественным и иногда пикселизированным результатам.

rightPadding : вещественное число

Эти свойства содержат отступы вокруг содержимого. Это пространство резервируется в дополнение к contentWidth и contentHeight.

Это свойство QML было добавлено в Qt 5.6.

style : перечисление

Установите дополнительный стиль текста.

Поддерживаемые стили текста:

• Text.Normal — по умолчанию
• Text.Outline
• Text.Raised
• Text.Sunken

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" }
}

styleColor : цвет

Определяет вторичный цвет, используемый стилями текста.

styleColor используется в качестве цвета контура для контурного текста и как цвет тени для поднятого или опущенного текста. Если не установлен никакой стиль, он вообще не используется.

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

См. также style.

text : строка

Текст для отображения. Текст поддерживает как обычный, так и форматированный текст.

Элемент попытается автоматически определить, следует ли рассматривать текст как форматированный текст. Это определение выполняется с помощью Qt::mightBeRichText().

textFormat : перечисление

Способ отображения свойства text.

Поддерживаемые форматы текста:

• Text.AutoText (по умолчанию)
• Text.PlainText
• Text.StyledText
• Text.RichText

Если формат текста — Text.AutoText элемент Text автоматически определит, следует ли рассматривать текст как форматированный текст. Это определение выполняется с помощью Qt::mightBeRichText(), который использует быстрый и поэтому простой эвристический метод. Он в основном проверяет, есть ли что-то, что выглядит как тег, перед первой переносом строки. Хотя результат может быть корректным в общих случаях, никакой гарантии нет.

Text.StyledText — это оптимизированный формат, поддерживающий некоторые базовые теги форматирования текста в стиле 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
&gt; &lt; &amp;

Text.StyledText парсер жёсткий, требующий правильного вложенных тегов.

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.RichText поддерживает более широкий подмножество HTML 4, как описано на странице Поддерживаемое подмножество HTML. Вместо этого следует отдавать предпочтение Text.PlainText или Text.StyledText, так как они обеспечивают лучшую производительность.

topPadding : вещественное число

Эти свойства содержат отступы вокруг содержимого. Это пространство резервируется в дополнение к contentWidth и contentHeight.

Это свойство QML было добавлено в Qt 5.6.

truncated : логическое значение

Возвращает true, если текст был усечён из-за maximumLineCount или elide.

Это свойство не поддерживается для форматированного текста.

См. также maximumLineCount и elide.

verticalAlignment : перечисление

Устанавливает горизонтальное и вертикальное выравнивание текста внутри ширины и высоты элемента Text. По умолчанию текст выравнивается по вертикали сверху. Горизонтальное выравнивание соответствует естественному направлению чтения текста, например, текст, читающийся слева направо, будет выровнен по левому краю.

Допустимые значения для horizontalAlignment — Text.AlignLeft, Text.AlignRight, Text.AlignHCenter и Text.AlignJustify. Допустимые значения для verticalAlignment — Text.AlignTop, Text.AlignBottom и Text.AlignVCenter.

Обратите внимание, что для одной строки текста размер текста — это площадь текста. В этом общем случае все выравнивания эквивалентны. Если вы хотите, чтобы текст, например, был центрирован в своем родительском элементе, то вам необходимо либо изменить Item::anchors, либо установить horizontalAlignment в Text.AlignHCenter и привязать ширину к ширине родительского элемента.

При использовании присоединенного свойства LayoutMirroring::enabled для зеркального отображения макета приложения, горизонтальное выравнивание текста также будет зеркальным. Однако свойство horizontalAlignment останется неизменным. Для запроса эффективного горизонтального выравнивания Text используйте только для чтения свойство effectiveHorizontalAlignment.

wrapMode : перечисление

Установите это свойство для перевода текста к ширине элемента Text. Текст будет переноситься только в том случае, если явным образом установлена ширина. wrapMode может быть одним из:

• Text.NoWrap (по умолчанию) — перенос не будет выполнен. Если текст содержит недостаточно символов новой строки, то contentWidth превысит заданную ширину.
• Text.WordWrap — перенос выполняется только по границам слов. Если слово слишком длинное, contentWidth превысит заданную ширину.
• Text.WrapAnywhere — перенос выполняется в любой точке строки, даже если он происходит посреди слова.
• Text.Wrap — если возможно, перенос происходит по границам слов; в противном случае он произойдет в соответствующей точке строки, даже посреди слова.

Документация сигналов

lineLaidOut(объект line)

Этот сигнал излучается для каждой строки текста, которая размещается во время процесса компоновки. Указанный объект line предоставляет подробную информацию о строке, которая в данный момент размещается.

Это дает возможность позиционировать и изменять размер строки по мере ее размещения. Например, это можно использовать для создания столбцов или размещения текста вокруг объектов.

Свойства указанного объекта line:

• number (только для чтения)
• x
• y
• width
• height

Например, это сдвинет первые 5 строк элемента Text на 100 пикселей вправо:

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

Соответствующий обработчик — onLineLaidOut.

linkActivated(строка link)

Этот сигнал излучается, когда пользователь нажимает на ссылку, встроенную в текст. Ссылка должна быть в формате форматированного или HTML-текста, и строка link предоставляет доступ к конкретной ссылке.

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

Пример кода отобразит текст «См. сайт Qt Project».

Нажатие на выделенную ссылку выведет http://qt-project.org link activated в консоль.

Соответствующий обработчик — onLinkActivated.

linkHovered(строка link)

Этот сигнал излучается, когда пользователь наводит курсор на ссылку, встроенную в текст. Ссылка должна быть в формате форматированного или HTML-текста, и строка link предоставляет доступ к конкретной ссылке.

Соответствующий обработчик — onLinkHovered.

Этот QML-сигнал был введен в Qt 5.2.

См. также hoveredLink и linkAt().

Документация по методам

forceLayout()

Вызывает повторную компоновку отображаемого текста.

Этот QML-метод был введен в Qt 5.9.

linkAt(вещественное x, вещественное y)

Возвращает строку ссылки в точке x, y в координатах содержимого или пустую строку, если в этой точке нет ссылки.

Этот QML-метод был введен в Qt 5.3.

См. также hoveredLink.