QAbstractTextDocumentLayout Class

Dokumentation der Mitgliedsfunktionen

[explicit] QAbstractTextDocumentLayout::QAbstractTextDocumentLayout(QTextDocument *document)

Erzeugt ein neues Textdokument-Layout für das angegebene document.

QString QAbstractTextDocumentLayout::anchorAt(const QPointF &position) const

Gibt die Referenz des Ankers an der angegebenen position zurück, oder eine leere Zeichenkette, wenn an diesem Punkt kein Anker existiert.

[pure virtual] QRectF QAbstractTextDocumentLayout::blockBoundingRect(const QTextBlock &block) const

Gibt das Begrenzungsrechteck von block zurück.

QTextBlock QAbstractTextDocumentLayout::blockWithMarkerAt(const QPointF &pos) const

Gibt den Block (wahrscheinlich ein Listenelement) zurück, dessen marker an der angegebenen Position pos gefunden wird.

QTextDocument *QAbstractTextDocumentLayout::document() const

Gibt das Textdokument zurück, für das dieses Layout verwendet wird.

[pure virtual protected] void QAbstractTextDocumentLayout::documentChanged(int position, int charsRemoved, int charsAdded)

Diese Funktion wird immer dann aufgerufen, wenn sich der Inhalt des Dokuments ändert. Eine Änderung liegt vor, wenn Text eingefügt, entfernt oder eine Kombination aus beidem wird. Die Änderung wird durch position, charsRemoved und charsAdded angegeben, die der Anfangsposition der Änderung, der Anzahl der aus dem Dokument entfernten Zeichen und der Anzahl der hinzugefügten Zeichen entsprechen.

Wenn Sie beispielsweise den Text "Hallo" in ein leeres Dokument einfügen, wäre charsRemoved gleich 0 und charsAdded gleich 5 (die Länge der Zeichenfolge).

Das Ersetzen von Text ist eine Kombination aus Entfernen und Einfügen. Wenn der Text "Hallo" beispielsweise durch "Hi" ersetzt wird, wäre charsRemoved gleich 5 und charsAdded gleich 2.

Für Unterklassen von QAbstractTextDocumentLayout ist dies die zentrale Funktion, bei der ein großer Teil der Arbeit für das Layout und die Positionierung der Dokumentinhalte erledigt wird.

In einer Unterklasse, die nur Textblöcke anordnet, müsste eine Implementierung dieser Funktion zum Beispiel Folgendes tun:

• Ermitteln der Liste der geänderten QTextBlock(s) anhand der übergebenen Parameter.
• Für jedes QTextBlock Objekt muss das entsprechende QTextLayout Objekt verarbeitet werden. Sie können auf das Layout von QTextBlock mit der Funktion QTextBlock::layout() zugreifen. Bei dieser Verarbeitung sollte die Seitengröße des Dokuments berücksichtigt werden.
• Wenn sich die Gesamtzahl der Seiten geändert hat, sollte das Signal pageCountChanged() ausgegeben werden.
• Wenn sich die Gesamtgröße geändert hat, sollte das Signal documentSizeChanged() ausgegeben werden.
• Das Signal update() sollte ausgegeben werden, um einen Neuanstrich der Bereiche im Layout zu planen, die einen Neuanstrich benötigen.

Siehe auch QTextLayout.

[pure virtual] QSizeF QAbstractTextDocumentLayout::documentSize() const

Gibt die Gesamtgröße des Dokumentenlayouts zurück.

Diese Information kann von Anzeige-Widgets verwendet werden, um ihre Bildlaufleisten korrekt zu aktualisieren.

Siehe auch documentSizeChanged() und QTextDocument::pageSize.

[signal] void QAbstractTextDocumentLayout::documentSizeChanged(const QSizeF &newSize)

Dieses Signal wird ausgegeben, wenn sich die Größe des Dokumentenlayouts auf newSize ändert.

Unterklassen von QAbstractTextDocumentLayout sollten dieses Signal ausgeben, wenn sich die gesamte Layoutgröße des Dokuments ändert. Dieses Signal ist nützlich für Widgets, die Textdokumente anzeigen, da es ihnen ermöglicht, ihre Bildlaufleisten korrekt zu aktualisieren.

Siehe auch documentSize().

[pure virtual] void QAbstractTextDocumentLayout::draw(QPainter *painter, const QAbstractTextDocumentLayout::PaintContext &context)

Zeichnet das Layout mit dem angegebenen painter unter Verwendung des angegebenen context.

[virtual protected] void QAbstractTextDocumentLayout::drawInlineObject(QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format)

Diese Funktion wird aufgerufen, um das Inline-Objekt object mit dem angegebenen painter innerhalb des durch rect angegebenen Rechtecks mit dem angegebenen Text format zu zeichnen.

posInDocument gibt die Position des Objekts innerhalb des Dokuments an.

Die Standard-Implementierung ruft drawObject() bei den Objekt-Handlern auf. Diese Funktion wird nur innerhalb von Qt aufgerufen. Unterklassen können diese Funktion reimplementieren, um das Zeichnen von Inline-Objekten anzupassen.

Siehe auch draw().

[protected] QTextCharFormat QAbstractTextDocumentLayout::format(int position)

Gibt das Zeichenformat zurück, das für die angegebene position gilt.

QTextFormat QAbstractTextDocumentLayout::formatAt(const QPointF &pos) const

Gibt das Textformat an der angegebenen Position pos zurück.

[pure virtual] QRectF QAbstractTextDocumentLayout::frameBoundingRect(QTextFrame *frame) const

Gibt das Begrenzungsrechteck von frame zurück.

QTextObjectInterface *QAbstractTextDocumentLayout::handlerForObject(int objectType) const

Gibt einen Handler für Objekte der angegebenen objectType zurück.

[pure virtual] int QAbstractTextDocumentLayout::hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy) const

Gibt die Cursorposition für die angegebene point mit dem angegebenen accuracy zurück. Gibt -1 zurück, wenn keine gültige Cursorposition gefunden wurde.

QString QAbstractTextDocumentLayout::imageAt(const QPointF &pos) const

Gibt die Quelle des Bildes an der angegebenen Position pos zurück, oder eine leere Zeichenkette, wenn an dieser Stelle kein Bild existiert.

[pure virtual] int QAbstractTextDocumentLayout::pageCount() const

Gibt die Anzahl der im Layout enthaltenen Seiten zurück.

Siehe auch pageCountChanged().

[signal] void QAbstractTextDocumentLayout::pageCountChanged(int newPages)

Dieses Signal wird ausgegeben, wenn sich die Anzahl der Seiten im Layout ändert; newPages ist die aktualisierte Seitenzahl.

Unterklassen von QAbstractTextDocumentLayout sollten dieses Signal ausgeben, wenn sich die Anzahl der Seiten im Layout geändert hat. Änderungen der Seitenzahl werden durch Änderungen des Layouts oder des Dokumentinhalts selbst verursacht.

Siehe auch pageCount().

QPaintDevice *QAbstractTextDocumentLayout::paintDevice() const

Gibt das Malgerät zurück, mit dem das Layout des Dokuments gerendert wurde.

Siehe auch setPaintDevice().

[virtual protected] void QAbstractTextDocumentLayout::positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format)

Legt das Inline-Objekt item mit dem angegebenen Text format aus.

posInDocument gibt die Position des Objekts innerhalb des Dokuments an.

Die Standardimplementierung tut nichts. Diese Funktion wird nur innerhalb von Qt aufgerufen. Unterklassen können diese Funktion reimplementieren, um die Position von Inline-Objekten anzupassen.

Siehe auch drawInlineObject().

void QAbstractTextDocumentLayout::registerHandler(int objectType, QObject *component)

Registriert das angegebene component als Handler für Objekte des angegebenen objectType.

Das Textdokument-Layout übernimmt nicht das Eigentum an component.

[virtual protected] void QAbstractTextDocumentLayout::resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format)

Legt die Größe des Inline-Objekts item entsprechend dem Text format fest.

posInDocument gibt die Position des Objekts innerhalb des Dokuments an.

Die Standardimplementierung passt die Größe von item an die Größe an, die von der Funktion intrinsicSize() des Object Handlers zurückgegeben wird. Diese Funktion wird nur innerhalb von Qt aufgerufen. Unterklassen können diese Funktion reimplementieren, um die Größenänderung von Inline-Objekten anzupassen.

void QAbstractTextDocumentLayout::setPaintDevice(QPaintDevice *device)

Setzt das Malgerät, das für die Darstellung des Dokumentlayouts verwendet wird, auf die angegebene device.

Siehe auch paintDevice().

void QAbstractTextDocumentLayout::unregisterHandler(int objectType, QObject *component = nullptr)

Hebt die Registrierung des angegebenen component als Handler für Elemente des angegebenen objectType auf, oder eines beliebigen Handlers, wenn component nicht angegeben ist.

[signal] void QAbstractTextDocumentLayout::update(const QRectF &rect = QRectF(0., 0., 1000000000., 1000000000.))

Dieses Signal wird ausgesendet, wenn das Rechteck rect aktualisiert wurde.

Unterklassen von QAbstractTextDocumentLayout sollten dieses Signal ausgeben, wenn sich das Layout des Inhalts ändert, um es neu zu malen.

[signal] void QAbstractTextDocumentLayout::updateBlock(const QTextBlock &block)

Dieses Signal wird ausgesendet, wenn die angegebene block aktualisiert wurde.

Unterklassen von QAbstractTextDocumentLayout sollten dieses Signal ausgeben, wenn sich das Layout von block geändert hat, um es neu zu malen.