Класс QTextObjectInterface
Класс QTextObjectInterface позволяет рисовать пользовательские объекты текста в QTextDocument. Подробнее...
| Заголовок: | #include <QTextObjectInterface> |
| CMake: | find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
Открытые функции
| virtual | ~QTextObjectInterface() |
| virtual void | drawObject(QPainter *painter, const QRectF &rect, QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0 |
| virtual QSizeF | intrinsicSize(QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0 |
Подробное описание
Объект текста описывает структуру одного или нескольких элементов в документе текста; например, изображения, импортированные из HTML, реализуются с помощью объектов текста. Объект текста знает, как размещать и отрисовывать свои элементы при отрисовке документа.
Qt позволяет вставлять пользовательские объекты текста в документ, регистрируя пользовательский тип объекта в QTextCharFormat. Для этого типа также должен быть реализован QTextObjectInterface и зарегистрирован в QAbstractTextDocumentLayout документа. При обнаружении типа объекта во время отрисовки QTextDocument вызываются функции интерфейса intrinsicSize() и drawObject() интерфейса.
В следующем списке объясняются необходимые шаги для вставки пользовательского объекта текста в документ:
- Выберите objectType. objectType — это целое число со значением, больше или равным QTextFormat::UserObject.
- Создайте объект QTextCharFormat и установите тип объекта на выбранный тип с помощью функции setObjectType().
- Реализуйте класс QTextObjectInterface.
- Вызовите QAbstractTextDocumentLayout::registerHandler() с экземпляром вашего подкласса QTextObjectInterface для регистрации вашего типа объекта.
- Вставьте QChar::ObjectReplacementCharacter с указанным QTextCharFormat выбранного типа объекта в документ. Как упоминалось, функции QTextObjectInterface intrinsicSize() и drawObject() будут вызваны с QTextFormat в качестве параметра всякий раз, когда встречается символ замены.
Класс, реализующий объект текста, должен наследовать как QObject, так и QTextObjectInterface. QObject должен быть первым унаследованным классом. Например:
class SvgTextObject : public QObject, public QTextObjectInterface
{
Q_OBJECT
Q_INTERFACES(QTextObjectInterface) Данные объекта текста обычно хранятся в QTextCharFormat с помощью QTextCharFormat::setProperty() и затем извлекаются с помощью QTextCharFormat::property().
Предупреждение: операции копирования и вставки игнорируют пользовательские объекты текста.
См. также Пример объекта текста, QTextCharFormat и QTextLayout.
Документация по членам функций
[virtual] QTextObjectInterface::~QTextObjectInterface()
Удаляет этот QTextObjectInterface.
[pure virtual] void QTextObjectInterface::drawObject(QPainter *painter, const QRectF &rect, QTextDocument *doc, int posInDocument, const QTextFormat &format)
Отображает этот объект текста с помощью указанного painter.
Размер прямоугольника rect для отрисовки — это размер, ранее рассчитанный функцией intrinsicSize(). Позиция прямоугольника относительна к painter.
Вы также получаете документ (doc) и позицию (posInDocument) format в этом документе.
См. также intrinsicSize().
[pure virtual] QSizeF QTextObjectInterface::intrinsicSize(QTextDocument *doc, int posInDocument, const QTextFormat &format)
Функция intrinsicSize() возвращает размер объекта текста, представленного format в данном документе (doc) в заданной позиции (posInDocument).
Рассчитанный размер будет использоваться для последующих вызовов drawObject() для этого format.
См. также drawObject().
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qtextobjectinterface.html