Класс QTextOption
Класс QTextOption предоставляет описание общих свойств форматированного текста. Подробнее...
| Заголовок: | #include <QTextOption> |
| CMake: | find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
Примечание: Все функции в этом классе являются перевходозащищёнными.
Типы публичного доступа
| Структура | Tab |
| Перечисление | Flag { IncludeTrailingSpaces, ShowTabsAndSpaces, ShowLineAndParagraphSeparators, ShowDocumentTerminator, AddSpaceForLineAndParagraphSeparators, SuppressColors } |
| Флаги | Flags |
| Перечисление | TabType { LeftTab, RightTab, CenterTab, DelimiterTab } |
| Перечисление | WrapMode { NoWrap, WordWrap, ManualWrap, WrapAnywhere, WrapAtWordBoundaryOrAnywhere } |
Функции публичного доступа
| QTextOption(const QTextOption &other) | |
| QTextOption(Qt::Alignment alignment) | |
| QTextOption() | |
| QTextOption & | operator=(const QTextOption &other) |
| ~QTextOption() | |
| Qt::Alignment | alignment() const |
| QTextOption::Flags | flags() const |
| void | setAlignment(Qt::Alignment alignment) |
| void | setFlags(QTextOption::Flags flags) |
| void | setTabArray(const QList<qreal> &tabStops) |
| void | setTabStopDistance(qreal tabStopDistance) |
| void | setTabs(const QList<QTextOption::Tab> &tabStops) |
| void | setTextDirection(Qt::LayoutDirection direction) |
| void | setUseDesignMetrics(bool enable) |
| void | setWrapMode(QTextOption::WrapMode mode) |
| QList<qreal> | tabArray() const |
| qreal | tabStopDistance() const |
| QList<QTextOption::Tab> | tabs() const |
| Qt::LayoutDirection | textDirection() const |
| bool | useDesignMetrics() const |
| QTextOption::WrapMode | wrapMode() const |
Подробное описание
QTextOption используется для объединения общих свойств форматированного текста в одном объекте. Он содержит информацию о выравнивании текста, направлении текста, обёртывании слов и других стандартных свойствах, связанных с рендерингом и размещением текста.
См. также QTextEdit, QTextDocument и QTextCursor.
Документация по типам членов
Перечисление QTextOption::Flag Флаги QTextOption::Flags
| Константа | Значение | Описание |
|---|---|---|
QTextOption::IncludeTrailingSpaces |
0x80000000 |
При установке этого параметра QTextLine::naturalTextWidth() и naturalTextRect() вернут значение, включающее ширину завершающих пробелов в тексте; в противном случае эта ширина исключается. |
QTextOption::ShowTabsAndSpaces |
0x1 |
Визуализирует пробелы с помощью маленьких точек, а табуляции — с помощью маленьких стрелок. Неразрывные пробелы отображаются иначе, чем разрывные пробелы. |
QTextOption::ShowLineAndParagraphSeparators |
0x2 |
Визуализирует разделители строк и абзацев соответствующими символами. |
QTextOption::ShowDocumentTerminator |
0x10 |
Визуализирует конец документа знаком раздела. Этот элемент перечисления был добавлен в Qt 5.7. |
QTextOption::AddSpaceForLineAndParagraphSeparators |
0x4 |
При определении позиций разбиения строк учитывается добавленное пространство для отображения разделительного символа. |
QTextOption::SuppressColors |
0x8 |
Подавляет все изменения цвета в форматах символов (кроме основного выделения). |
Тип Flags — это псевдоним для QFlags<Flag>. Он хранит логическое ИЛИ сочетание значений Flag.
Перечисление QTextOption::TabType
Это перечисление содержит различные типы табуляции
| Константа | Значение | Описание |
|---|---|---|
QTextOption::LeftTab |
0 |
Левая табуляция |
QTextOption::RightTab |
1 |
Правая табуляция |
QTextOption::CenterTab |
2 |
Центрированная табуляция |
QTextOption::DelimiterTab |
3 |
Табуляция, останавливающаяся на определённом символе-разделителе |
Перечисление QTextOption::WrapMode
Это перечисление описывает, как текст обёртывается в документе.
| Константа | Значение | Описание |
|---|---|---|
QTextOption::NoWrap |
0 |
Текст вообще не обёртывается. |
QTextOption::WordWrap |
1 |
Текст обёртывается по границам слов. |
QTextOption::ManualWrap |
2 |
То же, что QTextOption::NoWrap |
QTextOption::WrapAnywhere |
3 |
Текст может быть обёрнут в любой точке строки, даже если он находится посреди слова. |
QTextOption::WrapAtWordBoundaryOrAnywhere |
4 |
Если возможно, обёртывание происходит по границам слов; в противном случае оно произойдёт в соответствующей точке строки, даже посреди слова. |
Документация по функциям-членам
QTextOption::QTextOption(const QTextOption &other)
Создаёт копию текстового параметра other.
QTextOption::QTextOption(Qt::Alignment alignment)
Создаёт текстовый параметр с заданным alignment для текста. Свойство обёртывания слов установлено в QTextOption::WordWrap. Флаг использования метрик дизайна установлен в false.
QTextOption::QTextOption()
Создает текстовый параметр с параметрами по умолчанию для текста. Свойство выравнивания текста установлено в Qt::AlignLeft. Свойство перевода слов установлено в QTextOption::WordWrap. Флаг использования метрик дизайна установлен в false.
QTextOption &QTextOption::operator=(const QTextOption &other)
Возвращает true если текстовый параметр такой же, как и параметр текста other; в противном случае возвращает false.
QTextOption::~QTextOption()
Удаляет текстовый параметр.
Qt::Alignment QTextOption::alignment() const
Возвращает выравнивание текста, определённое параметром.
См. также setAlignment().
QTextOption::Flags QTextOption::flags() const
Возвращает флаги, связанные с параметром.
См. также setFlags().
void QTextOption::setAlignment(Qt::Alignment alignment)
Устанавливает выравнивание текста параметра на заданное значение alignment.
См. также alignment().
void QTextOption::setFlags(QTextOption::Flags flags)
Устанавливает флаги, связанные с параметром, на заданные значения flags.
См. также flags().
void QTextOption::setTabArray(const QList<qreal> &tabStops)
Устанавливает позиции табуляции для форматирования текста на заданные значения tabStops.
См. также tabArray(), setTabStopDistance(), и setTabs().
[since 5.10] void QTextOption::setTabStopDistance(qreal tabStopDistance)
Устанавливает расстояние по умолчанию в единицах устройства между позициями табуляции на значение, заданное tabStopDistance.
Эта функция была добавлена в Qt 5.10.
См. также tabStopDistance(), setTabArray(), setTabs(), и tabs().
void QTextOption::setTabs(const QList<QTextOption::Tab> &tabStops)
Устанавливает позиции табуляции для форматирования текста на заданные значения tabStops.
См. также tabs() и tabStopDistance().
void QTextOption::setTextDirection(Qt::LayoutDirection direction)
Устанавливает направление форматирования текста, определённое параметром, на заданное значение direction.
См. также textDirection().
void QTextOption::setUseDesignMetrics(bool enable)
Если enable равно true, то форматирование будет использовать метрики дизайна; в противном случае будут использоваться метрики устройства (по умолчанию).
См. также useDesignMetrics().
void QTextOption::setWrapMode(QTextOption::WrapMode mode)
Устанавливает режим перевода слов параметра на заданное значение mode.
См. также wrapMode().
QList<qreal> QTextOption::tabArray() const
Возвращает список позиций табуляции, определённых для форматирования текста.
См. также setTabArray() и tabStopDistance().
[since 5.10] qreal QTextOption::tabStopDistance() const
Возвращает расстояние в единицах устройства между позициями табуляции.
Эта функция была добавлена в Qt 5.10.
См. также setTabStopDistance(), tabArray(), setTabs(), и tabs().
QList<QTextOption::Tab> QTextOption::tabs() const
Возвращает список позиций табуляции, определённых для форматирования текста.
См. также tabStopDistance(), setTabs(), и setTabStopDistance().
Qt::LayoutDirection QTextOption::textDirection() const
Возвращает направление форматирования текста, определённое параметром.
См. также setTextDirection().
bool QTextOption::useDesignMetrics() const
Возвращает true если форматирование использует метрики дизайна, а не устройства; в противном случае возвращает false.
См. также setUseDesignMetrics().
QTextOption::WrapMode QTextOption::wrapMode() const
Возвращает режим перевода слов, определённый параметром.
См. также setWrapMode().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qtextoption.html