QtBase
v6.3.1
|
The QTextDocument class holds formatted text. More...
#include <qtextdocument.h>
Public Types | |
enum | MetaInformation { DocumentTitle , DocumentUrl , CssMedia } |
enum | FindFlag { FindBackward = 0x00001 , FindCaseSensitively = 0x00002 , FindWholeWords = 0x00004 } |
enum | ResourceType { UnknownResource = 0 , HtmlResource = 1 , ImageResource = 2 , StyleSheetResource = 3 , MarkdownResource = 4 , UserResource = 100 } |
enum | Stacks { UndoStack = 0x01 , RedoStack = 0x02 , UndoAndRedoStacks = UndoStack | RedoStack } |
using | ResourceProvider = std::function< QVariant(const QUrl &)> |
Public Slots | |
void | undo () |
void | redo () |
void | appendUndoItem (QAbstractUndoItem *) |
void | setModified (bool m=true) |
Public Slots inherited from QObject | |
void | deleteLater () |
Signals | |
void | contentsChange (int from, int charsRemoved, int charsAdded) |
void | contentsChanged () |
void | undoAvailable (bool) |
void | redoAvailable (bool) |
void | undoCommandAdded () |
void | modificationChanged (bool m) |
void | cursorPositionChanged (const QTextCursor &cursor) |
void | blockCountChanged (int newBlockCount) |
void | baseUrlChanged (const QUrl &url) |
void | documentLayoutChanged () |
Signals inherited from QObject | |
void | destroyed (QObject *=nullptr) |
void | objectNameChanged (const QString &objectName, QPrivateSignal) |
Protected Member Functions | |
virtual QTextObject * | createObject (const QTextFormat &f) |
virtual Q_INVOKABLE QVariant | loadResource (int type, const QUrl &name) |
QTextDocument (QTextDocumentPrivate &dd, QObject *parent) | |
Protected Member Functions inherited from QObject | |
QObject * | sender () const |
int | senderSignalIndex () const |
int | receivers (const char *signal) const |
bool | isSignalConnected (const QMetaMethod &signal) const |
virtual void | timerEvent (QTimerEvent *event) |
virtual void | childEvent (QChildEvent *event) |
virtual void | customEvent (QEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
Properties | |
bool | undoRedoEnabled |
whether undo/redo are enabled for this document More... | |
bool | modified |
whether the document has been modified by the user More... | |
QSizeF | pageSize |
the page size that should be used for laying out the document More... | |
QFont | defaultFont |
the default font used to display the document's text More... | |
bool | useDesignMetrics |
whether the document uses design metrics of fonts to improve the accuracy of text layout More... | |
QSizeF | size |
the actual size of the document. This is equivalent to documentLayout()->documentSize(); More... | |
qreal | textWidth |
int | blockCount |
the number of text blocks in the document. More... | |
qreal | indentWidth |
QString | defaultStyleSheet |
int | maximumBlockCount |
Specifies the limit for blocks in the document. More... | |
qreal | documentMargin |
QUrl | baseUrl |
the base URL used to resolve relative resource URLs within the document. More... | |
Properties inherited from QObject | |
QString | objectName |
the name of this object More... | |
Friends | |
class | QTextObjectPrivate |
Additional Inherited Members | |
Protected Attributes inherited from QObject | |
QScopedPointer< QObjectData > | d_ptr |
Related Functions inherited from QObject | |
template< class T > T | qobject_cast (const QObject *object) |
template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
QObjectList | |
The QTextDocument class holds formatted text.
\reentrant \inmodule QtGui
QTextDocument is a container for structured rich text documents, providing support for styled text and various types of document elements, such as lists, tables, frames, and images. They can be created for use in a QTextEdit, or used independently.
Each document element is described by an associated format object. Each format object is treated as a unique object by QTextDocuments, and can be passed to objectForFormat() to obtain the document element that it is applied to.
A QTextDocument can be edited programmatically using a QTextCursor, and its contents can be examined by traversing the document structure. The entire document structure is stored as a hierarchy of document elements beneath the root frame, found with the rootFrame() function. Alternatively, if you just want to iterate over the textual contents of the document you can use begin(), end(), and findBlock() to retrieve text blocks that you can examine and iterate over.
The layout of a document is determined by the documentLayout(); you can create your own QAbstractTextDocumentLayout subclass and set it using setDocumentLayout() if you want to use your own layout logic. The document's title and other meta-information can be obtained by calling the metaInformation() function. For documents that are exposed to users through the QTextEdit class, the document title is also available via the QTextEdit::documentTitle() function.
The toPlainText() and toHtml() convenience functions allow you to retrieve the contents of the document as plain text and HTML. The document's text can be searched using the find() functions.
Undo/redo of operations performed on the document can be controlled using the setUndoRedoEnabled() function. The undo/redo system can be controlled by an editor widget through the undo() and redo() slots; the document also provides contentsChanged(), undoAvailable(), and redoAvailable() signals that inform connected editor widgets about the state of the undo/redo system. The following are the undo/redo operations of a QTextDocument:
\list
Definition at line 92 of file qtextdocument.h.
Definition at line 242 of file qtextdocument.h.
This enum describes the options available to QTextDocument's find function. The options can be OR-ed together from the following list:
\value FindBackward Search backwards instead of forwards. \value FindCaseSensitively By default find works case insensitive. Specifying this option changes the behaviour to a case sensitive find operation. \value FindWholeWords Makes find match only complete words.
Enumerator | |
---|---|
FindBackward | |
FindCaseSensitively | |
FindWholeWords |
Definition at line 174 of file qtextdocument.h.
This enum describes the different types of meta information that can be added to a document.
\value DocumentTitle The title of the document. \value DocumentUrl The url of the document. The loadResource() function uses this url as the base when loading relative resources. \value CssMedia This value is used to select the corresponding '@media' rule, if any, from a specified CSS stylesheet when setHtml() is called. This enum value has been introduced in Qt 6.3.
Enumerator | |
---|---|
DocumentTitle | |
DocumentUrl | |
CssMedia |
Definition at line 137 of file qtextdocument.h.
This enum describes the types of resources that can be loaded by QTextDocument's loadResource() function or by QTextBrowser::setSource().
\value UnknownResource No resource is loaded, or the resource type is not known. \value HtmlResource The resource contains HTML. \value ImageResource The resource contains image data. Currently supported data types are QMetaType::QPixmap and QMetaType::QImage. If the corresponding variant is of type QMetaType::QByteArray then Qt attempts to load the image using QImage::loadFromData. QMetaType::QIcon is currently not supported. The icon needs to be converted to one of the supported types first, for example using QIcon::pixmap. \value StyleSheetResource The resource contains CSS. \value MarkdownResource The resource contains Markdown. \value UserResource The first available value for user defined resource types.
Enumerator | |
---|---|
UnknownResource | |
HtmlResource | |
ImageResource | |
StyleSheetResource | |
MarkdownResource | |
UserResource |
Definition at line 228 of file qtextdocument.h.
\value UndoStack The undo stack. \value RedoStack The redo stack. \value UndoAndRedoStacks Both the undo and redo stacks.
Enumerator | |
---|---|
UndoStack | |
RedoStack | |
UndoAndRedoStacks |
Definition at line 285 of file qtextdocument.h.
Constructs an empty QTextDocument with the given parent.
Definition at line 292 of file qtextdocument.cpp.
Constructs a QTextDocument containing the plain (unformatted) text specified, and with the given parent.
Definition at line 303 of file qtextdocument.cpp.
QTextDocument::~QTextDocument | ( | ) |
Destroys the document.
Definition at line 324 of file qtextdocument.cpp.
|
protected |
Definition at line 314 of file qtextdocument.cpp.
Adds the resource resource to the resource cache, using type and name as identifiers. type should be a value from QTextDocument::ResourceType.
For example, you can add an image as a resource in order to reference it from within the document:
The image can be inserted into the document using the QTextCursor API:
Alternatively, you can insert images using the HTML img
tag:
Definition at line 2141 of file qtextdocument.cpp.
void QTextDocument::adjustSize | ( | ) |
Adjusts the document to a reasonable size.
Definition at line 815 of file qtextdocument.cpp.
QList< QTextFormat > QTextDocument::allFormats | ( | ) | const |
MarkdownDialectCommonMark
for a more basic parse.The Markdown formatting is respected as much as possible; for example, "*bold* text" will produce text where the first word has a font weight that gives it an emphasized appearance.
Parsing of HTML included in the markdown string is handled in the same way as in \l setHtml; however, Markdown formatting inside HTML blocks is not supported.
Some features of the parser can be enabled or disabled via the features argument:
\value MarkdownNoHTML Any HTML tags in the Markdown text will be discarded \value MarkdownDialectCommonMark The parser supports only the features standardized by CommonMark \value MarkdownDialectGitHub The parser supports the GitHub dialect
The default is MarkdownDialectGitHub
.
The undo/redo history is reset when this function is called.
Returns a list of text formats for all the formats used in the document.
Definition at line 3541 of file qtextdocument.cpp.
|
slot |
Definition at line 478 of file qtextdocument.cpp.
int QTextDocument::availableRedoSteps | ( | ) | const |
Returns the number of available redo steps.
Definition at line 1076 of file qtextdocument.cpp.
int QTextDocument::availableUndoSteps | ( | ) | const |
Returns the number of available undo steps.
Definition at line 1064 of file qtextdocument.cpp.
qreal QTextDocument::baselineOffset | ( | ) | const |
Returns the the baseline offset in % used in the document layout.
Definition at line 1833 of file qtextdocument.cpp.
QUrl QTextDocument::baseUrl | ( | ) | const |
Definition at line 580 of file qtextdocument.cpp.
QTextBlock QTextDocument::begin | ( | ) | const |
Returns the document's first text block.
Definition at line 1651 of file qtextdocument.cpp.
int QTextDocument::blockCount | ( | ) | const |
Definition at line 870 of file qtextdocument.cpp.
|
signal |
This signal is emitted when the total number of text blocks in the document changes. The value passed in newBlockCount is the new total.
QChar QTextDocument::characterAt | ( | int | pos | ) | const |
Returns the character at position pos, or a null character if the position is out of range.
Definition at line 915 of file qtextdocument.cpp.
int QTextDocument::characterCount | ( | ) | const |
Returns the number of characters of this document.
Definition at line 901 of file qtextdocument.cpp.
|
virtual |
Clears the document.
Definition at line 383 of file qtextdocument.cpp.
void QTextDocument::clearUndoRedoStacks | ( | Stacks | stacksToClear = UndoAndRedoStacks | ) |
This method clears any commands on the undo stack, the redo stack, or both (the default). If commands are cleared, the appropriate signals are emitted, QTextDocument::undoAvailable() or QTextDocument::redoAvailable().
Definition at line 447 of file qtextdocument.cpp.
QTextDocument * QTextDocument::clone | ( | QObject * | parent = nullptr | ) | const |
Creates a new QTextDocument that is a copy of this text document. parent is the parent of the returned text document.
Definition at line 333 of file qtextdocument.cpp.
|
signal |
This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.
Information is provided about the position of the character in the document where the change occurred, the number of characters removed (charsRemoved), and the number of characters added (charsAdded).
The signal is emitted before the document's layout manager is notified about the change. This hook allows you to implement syntax highlighting for the document.
|
signal |
This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.
|
protectedvirtual |
Creates and returns a new document object (a QTextObject), based on the given format.
QTextObjects will always get created through this method, so you must reimplement it if you use custom text objects inside your document.
Definition at line 1561 of file qtextdocument.cpp.
|
signal |
This signal is emitted whenever the position of a cursor changed due to an editing operation. The cursor that changed is passed in cursor. If the document is used with the QTextEdit class and you need a signal when the cursor is moved with the arrow keys you can use the \l{QTextEdit::}{cursorPositionChanged()} signal in QTextEdit.
Qt::CursorMoveStyle QTextDocument::defaultCursorMoveStyle | ( | ) | const |
The default cursor movement style is used by all QTextCursor objects created from the document. The default is Qt::LogicalMoveStyle.
Definition at line 603 of file qtextdocument.cpp.
QFont QTextDocument::defaultFont | ( | ) | const |
Returns the default font to be used in the document layout.
Definition at line 1745 of file qtextdocument.cpp.
|
static |
Returns the default resource provider.
Definition at line 2203 of file qtextdocument.cpp.
QString QTextDocument::defaultStyleSheet | ( | ) | const |
Definition at line 953 of file qtextdocument.cpp.
QTextOption QTextDocument::defaultTextOption | ( | ) | const |
the default text option will be set on all \l{QTextLayout}s in the document.
When \l{QTextBlock}s are created, the defaultTextOption is set on their QTextLayout. This allows setting global properties for the document such as the default word wrap mode.
The default text option is used on all QTextLayout objects in the document. This allows setting global properties for the document such as the default word wrap mode.
Definition at line 545 of file qtextdocument.cpp.
QAbstractTextDocumentLayout * QTextDocument::documentLayout | ( | ) | const |
Returns the document layout for this document.
Definition at line 1114 of file qtextdocument.cpp.
|
signal |
This signal is emitted when a new document layout is set.
qreal QTextDocument::documentMargin | ( | ) | const |
Definition at line 746 of file qtextdocument.cpp.
Draws the content of the document with painter p, clipped to rect. If rect is a null rectangle (default) then the document is painted unclipped.
Definition at line 677 of file qtextdocument.cpp.
QTextBlock QTextDocument::end | ( | ) | const |
This function returns a block to test for the end of the document while iterating over it.
The block returned is invalid and represents the block after the last block in the document. You can use lastBlock() to retrieve the last valid block of the document.
Definition at line 1669 of file qtextdocument.cpp.
QTextCursor QTextDocument::find | ( | const QString & | subString, |
const QTextCursor & | cursor, | ||
FindFlags | options = FindFlags() |
||
) | const |
Finds the next occurrence of the string, subString, in the document. The search starts at the position of the given cursor, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed.
Returns a cursor with the match selected if subString was found; otherwise returns a null cursor.
If the given cursor has a selection, the search begins after the selection; otherwise it begins at the cursor's position.
By default the search is case insensitive, and can match text anywhere in the document.
Definition at line 1411 of file qtextdocument.cpp.
QTextCursor QTextDocument::find | ( | const QString & | subString, |
int | position = 0 , |
||
FindFlags | options = FindFlags() |
||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Finds the next occurrence of the string, subString, in the document. The search starts at the given position, and proceeds forwards through the document unless specified otherwise in the search options. The options control the type of search performed.
Returns a cursor with the match selected if subString was found; otherwise returns a null cursor.
If the position is 0 (the default) the search begins from the beginning of the document; otherwise it begins at the specified position.
Definition at line 1355 of file qtextdocument.cpp.
QTextBlock QTextDocument::findBlock | ( | int | pos | ) | const |
Returns the text block that contains the {pos}-th character.
Definition at line 1616 of file qtextdocument.cpp.
QTextBlock QTextDocument::findBlockByLineNumber | ( | int | lineNumber | ) | const |
Definition at line 1640 of file qtextdocument.cpp.
QTextBlock QTextDocument::findBlockByNumber | ( | int | blockNumber | ) | const |
Definition at line 1628 of file qtextdocument.cpp.
QTextBlock QTextDocument::firstBlock | ( | ) | const |
Definition at line 1679 of file qtextdocument.cpp.
QTextFrame * QTextDocument::frameAt | ( | int | pos | ) | const |
Definition at line 1579 of file qtextdocument.cpp.
qreal QTextDocument::idealWidth | ( | ) | const |
Returns the ideal width of the text document. The ideal width is the actually used width of the document without optional alignments taken into account. It is always <= size().width().
Definition at line 733 of file qtextdocument.cpp.
qreal QTextDocument::indentWidth | ( | ) | const |
Definition at line 778 of file qtextdocument.cpp.
bool QTextDocument::isEmpty | ( | ) | const |
Returns true
if the document is empty; otherwise returns false
.
Definition at line 372 of file qtextdocument.cpp.
bool QTextDocument::isModified | ( | ) | const |
bool QTextDocument::isRedoAvailable | ( | ) | const |
Returns true
if redo is available; otherwise returns false
.
Definition at line 1052 of file qtextdocument.cpp.
bool QTextDocument::isUndoAvailable | ( | ) | const |
Returns true
if undo is available; otherwise returns false
.
Definition at line 1041 of file qtextdocument.cpp.
bool QTextDocument::isUndoRedoEnabled | ( | ) | const |
QTextBlock QTextDocument::lastBlock | ( | ) | const |
Definition at line 1689 of file qtextdocument.cpp.
int QTextDocument::lineCount | ( | ) | const |
Returns the number of lines of this document (if the layout supports this). Otherwise, this is identical to the number of blocks.
Definition at line 885 of file qtextdocument.cpp.
Loads data of the specified type from the resource with the given name.
This function is called by the rich text engine to request data that isn't directly stored by QTextDocument, but still associated with it. For example, images are referenced indirectly by the name attribute of a QTextImageFormat object.
When called by Qt, type is one of the values of QTextDocument::ResourceType.
If the QTextDocument is a child object of a QObject that has an invokable loadResource method such as QTextEdit, QTextBrowser or a QTextDocument itself then the default implementation tries to retrieve the data from the parent.
Reimplemented in TestDocument, BaseDocument, and TestDocument.
Definition at line 2227 of file qtextdocument.cpp.
void QTextDocument::markContentsDirty | ( | int | position, |
int | length | ||
) |
Marks the contents specified by the given position and length as "dirty", informing the document that it needs to be laid out again.
Definition at line 627 of file qtextdocument.cpp.
int QTextDocument::maximumBlockCount | ( | ) | const |
Definition at line 524 of file qtextdocument.cpp.
QString QTextDocument::metaInformation | ( | MetaInformation | info | ) | const |
Returns meta information about the document of the type specified by info.
Definition at line 1131 of file qtextdocument.cpp.
|
signal |
This signal is emitted whenever the content of the document changes in a way that affects the modification state. If changed is true, the document has been modified; otherwise it is false.
For example, calling setModified(false) on a document and then inserting text causes the signal to get emitted. If you undo that operation, causing the document to return to its original unmodified state, the signal will get emitted again.
QTextObject * QTextDocument::object | ( | int | objectIndex | ) | const |
Returns the text object associated with the given objectIndex.
Definition at line 1597 of file qtextdocument.cpp.
QTextObject * QTextDocument::objectForFormat | ( | const QTextFormat & | f | ) | const |
Returns the text object associated with the format f.
Definition at line 1606 of file qtextdocument.cpp.
int QTextDocument::pageCount | ( | ) | const |
returns the number of pages in this document.
Definition at line 1726 of file qtextdocument.cpp.
QSizeF QTextDocument::pageSize | ( | ) | const |
Definition at line 1717 of file qtextdocument.cpp.
void QTextDocument::print | ( | QPagedPaintDevice * | printer | ) | const |
Prints the document to the given printer. The QPagedPaintDevice must be set up before being used with this function.
This is only a convenience method to print the whole document to the printer.
If the document is already paginated through a specified height in the pageSize() property it is printed as-is.
If the document is not paginated, like for example a document used in a QTextEdit, then a temporary copy of the document is created and the copy is broken into multiple pages according to the size of the paint device's paperRect(). By default a 2 cm margin is set around the document contents. In addition the current page number is printed at the bottom of each page.
Definition at line 1925 of file qtextdocument.cpp.
|
slot |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Redoes the last editing operation on the document if \l{QTextDocument::isRedoAvailable()}{redo is available}.
Definition at line 467 of file qtextdocument.cpp.
void QTextDocument::redo | ( | QTextCursor * | cursor | ) |
The provided cursor is positioned at the end of the location where the edition operation was redone.
Definition at line 419 of file qtextdocument.cpp.
|
signal |
This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).
Returns data of the specified type from the resource with the given name.
This function is called by the rich text engine to request data that isn't directly stored by QTextDocument, but still associated with it. For example, images are referenced indirectly by the name attribute of a QTextImageFormat object.
Resources are cached internally in the document. If a resource can not be found in the cache, loadResource is called to try to load the resource. loadResource should then use addResource to add the resource to the cache.
If loadResource does not load the resource, then the resourceProvider and lastly the defaultResourceProvider will be called, if set. Note that the result from the provider will not be added automatically to the cache.
Definition at line 2103 of file qtextdocument.cpp.
QTextDocument::ResourceProvider QTextDocument::resourceProvider | ( | ) | const |
Returns the resource provider for this text document.
Definition at line 2155 of file qtextdocument.cpp.
int QTextDocument::revision | ( | ) | const |
Returns the document's revision (if undo is enabled).
The revision is guaranteed to increase when a document that is not modified is edited.
Definition at line 1091 of file qtextdocument.cpp.
QTextFrame * QTextDocument::rootFrame | ( | ) | const |
Returns the document's root frame.
Definition at line 1588 of file qtextdocument.cpp.
Sets the base line as a% of font height to use in the document layout to baseline. The default value is 0. A positive value moves up the text, by the corresponding %; a negative value moves it down.
Definition at line 1819 of file qtextdocument.cpp.
Definition at line 586 of file qtextdocument.cpp.
void QTextDocument::setDefaultCursorMoveStyle | ( | Qt::CursorMoveStyle | style | ) |
Sets the default cursor movement style to the given style.
Definition at line 614 of file qtextdocument.cpp.
Sets the default font to use in the document layout.
Definition at line 1734 of file qtextdocument.cpp.
|
static |
Sets the default resource provider to provider.
The default provider will be used by all QTextDocuments that don't have an explicit provider set.
Definition at line 2191 of file qtextdocument.cpp.
void QTextDocument::setDefaultTextOption | ( | const QTextOption & | option | ) |
Sets the default text option to option.
Definition at line 556 of file qtextdocument.cpp.
void QTextDocument::setDocumentLayout | ( | QAbstractTextDocumentLayout * | layout | ) |
Sets the document to use the given layout. The previous layout is deleted.
Definition at line 1105 of file qtextdocument.cpp.
Definition at line 752 of file qtextdocument.cpp.
Replaces the entire contents of the document with the given HTML-formatted text in the html string. The undo/redo history is reset when this function is called.
The HTML formatting is respected as much as possible; for example, "<b>bold</b> text" will produce text where the first word has a font weight that gives it a bold appearance: "\b{bold} text".
To select a css media rule other than the default "screen" rule, use setMetaInformation() with 'CssMedia' as "info" parameter.
Definition at line 1263 of file qtextdocument.cpp.
Sets the width used for text list and text block indenting.
The indent properties of QTextListFormat and QTextBlockFormat specify multiples of this value. The default indent width is 40 .
Definition at line 795 of file qtextdocument.cpp.
void QTextDocument::setMaximumBlockCount | ( | int | maximum | ) |
void QTextDocument::setMetaInformation | ( | MetaInformation | info, |
const QString & | string | ||
) |
Sets the document's meta information of the type specified by info to the given string.
Definition at line 1151 of file qtextdocument.cpp.
Replaces the entire contents of the document with the given plain text. The undo/redo history is reset when this function is called.
Definition at line 1230 of file qtextdocument.cpp.
void QTextDocument::setResourceProvider | ( | const ResourceProvider & | provider | ) |
Type alias for std::function<QVariant(const QUrl&)>.
Sets the provider of resources for the text document to provider.
Definition at line 2175 of file qtextdocument.cpp.
Sets the default subscript's base line as a % of font height to use in the document layout to baseline. The default value is 16.67% (1/6 of height).
Definition at line 1789 of file qtextdocument.cpp.
Sets the default superscript's base line as a % of font height to use in the document layout to baseline. The default value is 50% (1/2 of height).
Definition at line 1760 of file qtextdocument.cpp.
Definition at line 710 of file qtextdocument.cpp.
void QTextDocument::setUndoRedoEnabled | ( | bool | enable | ) |
void QTextDocument::setUseDesignMetrics | ( | bool | b | ) |
QSizeF QTextDocument::size | ( | ) | const |
qreal QTextDocument::subScriptBaseline | ( | ) | const |
Returns the superscript's base line as a % of font height used in the document layout.
Definition at line 1803 of file qtextdocument.cpp.
qreal QTextDocument::superScriptBaseline | ( | ) | const |
Returns the superscript's base line as a % of font height used in the document layout.
Definition at line 1774 of file qtextdocument.cpp.
qreal QTextDocument::textWidth | ( | ) | const |
Definition at line 719 of file qtextdocument.cpp.
QString QTextDocument::toHtml | ( | ) | const |
Returns a string containing an HTML representation of the document.
The content of the document specifies its encoding to be UTF-8. If you later on convert the returned html string into a byte array for transmission over a network or when saving to disk you should use QString::toUtf8() to convert the string to a QByteArray.
Definition at line 3476 of file qtextdocument.cpp.
QString QTextDocument::toPlainText | ( | ) | const |
Returns the plain text contained in the document. If you want formatting information use a QTextCursor instead.
This function returns the same as toRawText(), but will replace some unicode characters with ASCII alternatives. In particular, no-break space (U+00A0) is replaced by a regular space (U+0020), and both paragraph (U+2029) and line (U+2028) separators are replaced by line feed (U+000A). If you need the precise contents of the document, use toRawText() instead.
Definition at line 1198 of file qtextdocument.cpp.
QString QTextDocument::toRawText | ( | ) | const |
Returns the raw text contained in the document without any formatting information. If you want formatting information use a QTextCursor instead.
Definition at line 1175 of file qtextdocument.cpp.
|
slot |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 457 of file qtextdocument.cpp.
void QTextDocument::undo | ( | QTextCursor * | cursor | ) |
Undoes the last editing operation on the document if undo is available. The provided cursor is positioned at the end of the location where the edition operation was undone.
See the \l {Overview of Qt's Undo Framework}{Qt Undo Framework} documentation for details.
Definition at line 402 of file qtextdocument.cpp.
|
signal |
This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).
See the \l {Overview of Qt's Undo Framework}{Qt Undo Framework} documentation for details.
|
signal |
This signal is emitted every time a new level of undo is added to the QTextDocument.
bool QTextDocument::useDesignMetrics | ( | ) | const |
Definition at line 665 of file qtextdocument.cpp.
|
friend |
Definition at line 330 of file qtextdocument.h.
|
readwrite |
the base URL used to resolve relative resource URLs within the document.
Resource URLs are resolved to be within the same directory as the target of the base URL meaning any portion of the path after the last '/' will be ignored.
\table \header
Definition at line 83 of file qtextdocument.h.
|
read |
the number of text blocks in the document.
The value of this property is undefined in documents with tables or frames.
By default, if defined, this property contains a value of 1.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
the default font used to display the document's text
Definition at line 83 of file qtextdocument.h.
|
readwrite |
The default style sheet is applied to all newly HTML formatted text that is inserted into the document, for example using setHtml() or QTextCursor::insertHtml().
The style sheet needs to be compliant to CSS 2.1 syntax.
{Note:} Changing the default style sheet does not have any effect to the existing content of the document.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
The margin around the document. The default is 4.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
Returns the width used for text list and text block indenting.
The indent properties of QTextListFormat and QTextBlockFormat specify multiples of this value. The default indent width is 40.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
Specifies the limit for blocks in the document.
Specifies the maximum number of blocks the document may have. If there are more blocks in the document that specified with this property blocks are removed from the beginning of the document.
A negative or zero value specifies that the document may contain an unlimited amount of blocks.
The default value is 0.
Note that setting this property will apply the limit immediately to the document contents.
Setting this property also disables the undo redo history.
This property is undefined in documents with tables or frames.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
whether the document has been modified by the user
By default, this property is false
.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
the page size that should be used for laying out the document
The units are determined by the underlying paint device. The size is measured in logical pixels when painting to the screen, and in points (1/72 inch) when painting to a printer.
By default, for a newly-created, empty document, this property contains an undefined size.
Definition at line 83 of file qtextdocument.h.
|
read |
the actual size of the document. This is equivalent to documentLayout()->documentSize();
The size of the document can be changed either by setting a text width or setting an entire page size.
Note that the width is always >= pageSize().width().
By default, for a newly-created, empty document, this property contains a configuration-dependent size.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
The text width specifies the preferred width for text in the document. If the text (or content in general) is wider than the specified with it is broken into multiple lines and grows vertically. If the text cannot be broken into multiple lines to fit into the specified text width it will be larger and the size() and the idealWidth() property will reflect that.
If the text width is set to -1 then the text will not be broken into multiple lines unless it is enforced through an explicit line break or a new paragraph.
The default value is -1.
Setting the text width will also set the page height to -1, causing the document to grow or shrink vertically in a continuous way. If you want the document layout to break the text into multiple pages then you have to set the pageSize property instead.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
whether undo/redo are enabled for this document
This defaults to true. If disabled, the undo stack is cleared and no items will be added to it.
Definition at line 83 of file qtextdocument.h.
|
readwrite |
whether the document uses design metrics of fonts to improve the accuracy of text layout
If this property is set to true, the layout will use design metrics. Otherwise, the metrics of the paint device as set on QAbstractTextDocumentLayout::setPaintDevice() will be used.
Using design metrics makes a layout have a width that is no longer dependent on hinting and pixel-rounding. This means that WYSIWYG text layout becomes possible because the width scales much more linearly based on paintdevice metrics than it would otherwise.
By default, this property is false
.
Definition at line 83 of file qtextdocument.h.