Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions | ![]() |
The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit. More...
#include <QTextDocument>
Inherits QObject.
The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit.
A text document can be thought of as a list of strings and their associated formats. A format can contain "references" to objects, such as a QTextList, a QTextFrame, or a QTextTable, and these are available using object().
A QTextDocument can be edited programmatically using a QTextCursor.
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 is available using documentTitle().
You can retrieve the contents of the document using plainText() or html(). If you want the text with format information, or wish to edit the text, use a QTextCursor The text can be searched using the find() functions. If you want to iterate over the contents of the document you can use begin(), end(), or findBlock() to retrieve a QTextBlock that you can query and iterate from.
Undo/redo can be controlled using setUndoRedoEnabled(). undo() and redo() slots are provided, along with contentsChanged(), undoAvailable() and redoAvailable() signals.
This enum describes the options available to QTextDocument's find function. The options can be OR-red together from the following list:
QTextDocument::FindCaseSensitively | By default find works case insensitive. Specifying this option changes the behaviour to a case sensitive find operation. |
QTextDocument::FindWholeWords | Makes find match only complete words. |
The FindFlags typedef can store a combination of FindFlag values.
This property holds whether the document has been modified by the user.
Access functions:
See also modificationChanged().
This property holds 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.
Access functions:
Constructs an empty QTextDocument with the given parent.
Constructs a QTextDocument containing the plain (unformatted) text specified, and with the given parent.
Destroys the document.
Returns the document's first text block.
This signal is emitted whenever the documents content changes, for example, text is inserted or deleted, or formatting is applied.
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.
Returns the document layout for this document.
Returns the document's title.
Returns the document's last text block.
Finds the next occurrence of the string, expr, starting at position from, using the given options. Returns a cursor with the match selected if expr was found; otherwise returns a null cursor.
If the from cursor has a selection the search begins after the selection; otherwise from the position of the cursor.
By default the search is case-sensitive, and can match anywhere.
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Finds the next occurrence of the string, expr, starting at position from, using the given options. Returns a cursor with the match selected if expr was found; otherwise returns a null cursor.
If from is 0 (the default) the search begins from the beginning of the document; otherwise from the specified position.
Returns the text block that contains the pos-th character.
Returns the document in HTML format. The conversion may not be perfect, especially for complex documents, due to the limitations of HTML.
Returns true if the document is empty; otherwise returns false.
Returns true is redo is available; otherwise returns false.
Returns true is undo is available; otherwise returns false.
This signal is emitted whenever the content of the document changes in a way that affects the modification state. If changed is true if 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.
Returns the text object associated with the given objectIndex.
Returns the text object associated with the format f.
Returns the plain text contained in the document. If you want formatting information use a QTextCursor instead.
See also html().
Redoes the last editing operation on the document if redo is available.
This signal is emitted whenever redo operations become available (b is true) or unavailable (b is false).
Sets the document to use the given layout. The previous layout is deleted.
Replaces the entire contents of the document with the given HTML-formatted text in the html string.
The HTML formatting is respected as much as possible, i.e. "<b>bold</b> text" will have the text "bold text" with the first word having a character format with a bold font weight.
See also setPlainText().
Replaces the entire contents of the document with the given plain text.
See also setHtml().
Undoes the last editing operation on the document if undo is available.
This signal is emitted whenever undo operations become available (b is true) or unavailable (b is false).
Copyright © 2004 Trolltech. | Trademarks | Qt 4.0.0-tp1 |