PlainTextDocumentLayout Class

class Utils::PlainTextDocumentLayout

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

Header: #include <PlainTextDocumentLayout>

List of all members, including inherited members

Properties

cursorWidth : int

Public Functions

	PlainTextDocumentLayout(QTextDocument *document)
	~PlainTextDocumentLayout()
int	cursorWidth() const
QSizeF	documentSize() const
int	hitTest(const QPointF &, Qt::HitTestAccuracy) const
int	pageCount() const
void	requestUpdate()
void	setCursorWidth(int width)

Protected Functions

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

Detailed Description

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

PlainTextDocumentLayout 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.

Property Documentation

cursorWidth : int

This property specifies the width of the cursor in pixels. The default value is 1.

Access functions:

int	cursorWidth() const
void	setCursorWidth(int width)

Member Function Documentation

PlainTextDocumentLayout::PlainTextDocumentLayout(QTextDocument **document*)

Constructs a plain text document layout for the text document.

`[noexcept]` PlainTextDocumentLayout::~PlainTextDocumentLayout()

Destructs a plain text document layout.

`[protected]` void PlainTextDocumentLayout::documentChanged(int from, int charsRemoved, int charsAdded)

This function overloads QAbstractTextDocumentLayout::documentChanged().

QSizeF PlainTextDocumentLayout::documentSize() const

This function overloads QAbstractTextDocumentLayout::documentSize().

int PlainTextDocumentLayout::hitTest(const QPointF &, Qt::HitTestAccuracy) const

This function overloads QAbstractTextDocumentLayout::hitTest().

int PlainTextDocumentLayout::pageCount() const

This function overloads QAbstractTextDocumentLayout::pageCount().

void PlainTextDocumentLayout::requestUpdate()

Requests a complete update on all views.

Copyright © The Qt Company Ltd. and other contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.