QPlainTextDocumentLayout Class

The QPlainTextDocumentLayout class implements a plain text layout for QTextDocument. More...

Header:	#include <QPlainTextDocumentLayout>
qmake:	QT += widgets
Since:	Qt 4.4
Inherits:	QAbstractTextDocumentLayout

• List of all members, including inherited members
• Obsolete members

Properties

• cursorWidth : int

• 1 property inherited from QObject

Public Functions

	QPlainTextDocumentLayout(QTextDocument *document)
virtual	~QPlainTextDocumentLayout()
int	cursorWidth() const
void	ensureBlockLayout(const QTextBlock &block) const
void	requestUpdate()
void	setCursorWidth(int width)

Reimplemented Public Functions

virtual QRectF	blockBoundingRect(const QTextBlock &block) const override
virtual QSizeF	documentSize() const override
virtual void	draw(QPainter *, const QAbstractTextDocumentLayout::PaintContext &) override
virtual QRectF	frameBoundingRect(QTextFrame *) const override
virtual int	hitTest(const QPointF &, Qt::HitTestAccuracy) const override
virtual int	pageCount() const override

• 15 public functions inherited from QAbstractTextDocumentLayout
• 31 public functions inherited from QObject

Static Public Members

const QMetaObject

staticMetaObject

• 9 static public members inherited from QObject

Reimplemented Protected Functions

virtual void

documentChanged(int from, int charsRemoved, int charsAdded) override

• 5 protected functions inherited from QAbstractTextDocumentLayout
• 9 protected functions inherited from QObject

Additional Inherited Members

• 1 public slot inherited from QObject
• 4 signals inherited from QAbstractTextDocumentLayout
• 2 signals inherited from QObject
• 5 protected functions inherited from QAbstractTextDocumentLayout
• 9 protected functions inherited from QObject

Detailed Description

The QPlainTextDocumentLayout class implements a plain text layout for QTextDocument.

A QPlainTextDocumentLayout is required for text documents that can be display or edited in a QPlainTextEdit. See QTextDocument::setDocumentLayout().

QPlainTextDocumentLayout uses the QAbstractTextDocumentLayout API that QTextDocument requires, but redefines it partially in order to support plain text better. For instances, it does not operate on vertical pixels, but on paragraphs (called blocks) instead. The height of a document is identical to the number of paragraphs it contains. The layout also doesn't support tables or nested frames, or any sort of advanced text layout that goes beyond a list of paragraphs with syntax highlighting.

Member Function Documentation

QPlainTextDocumentLayout::QPlainTextDocumentLayout(QTextDocument *document)

Constructs a plain text document layout for the text document.

[virtual] QPlainTextDocumentLayout::~QPlainTextDocumentLayout()

Destructs a plain text document layout.

[override virtual] QRectF QPlainTextDocumentLayout::blockBoundingRect(const QTextBlock &block) const

Reimplemented from QAbstractTextDocumentLayout::blockBoundingRect().

[override virtual protected] void QPlainTextDocumentLayout::documentChanged(int from, int charsRemoved, int charsAdded)

Reimplemented from QAbstractTextDocumentLayout::documentChanged().

[override virtual] QSizeF QPlainTextDocumentLayout::documentSize() const

Reimplemented from QAbstractTextDocumentLayout::documentSize().

[override virtual] void QPlainTextDocumentLayout::draw(QPainter *, const QAbstractTextDocumentLayout::PaintContext &)

Reimplemented from QAbstractTextDocumentLayout::draw().

void QPlainTextDocumentLayout::ensureBlockLayout(const QTextBlock &block) const

Ensures that block has a valid layout

[override virtual] QRectF QPlainTextDocumentLayout::frameBoundingRect(QTextFrame *) const

Reimplemented from QAbstractTextDocumentLayout::frameBoundingRect().

[override virtual] int QPlainTextDocumentLayout::hitTest(const QPointF &, Qt::HitTestAccuracy) const

Reimplemented from QAbstractTextDocumentLayout::hitTest().

[override virtual] int QPlainTextDocumentLayout::pageCount() const

Reimplemented from QAbstractTextDocumentLayout::pageCount().

void QPlainTextDocumentLayout::requestUpdate()

Requests a complete update on all views.