Класс QTextObjectInterface
Класс QTextObjectInterface позволяет рисовать пользовательские текстовые объекты в QTextDocument. Подробнее...
| Заголовок: | #include <QTextObjectInterface> |
| CMake: | find_package(Qt6 COMPONENTS Gui REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
Открытые функции
| виртуальный | ~QTextObjectInterface() |
| виртуальный void | drawObject(QPainter *painter, const QRectF &rect, QTextDocument *doc, int posInDocument, const QTextFormat &format) = 0 |
| виртуальный 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.1/qtextobjectinterface.html