Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QTextDocument Class Reference

The QTextDocument class holds formatted text that can be viewed and edited using a QTextEdit. More...

    #include <QTextDocument>

Inherits QObject.

- List of all members, including inherited members

### Public Types

- enum FindDirection { FindForward, FindBackward }
- enum FindFlag { FindCaseSensitively, FindWholeWords }
- typedef FindFlags

### Writable Properties

- modified : bool
- undoRedoEnabled : bool

- 1 writable property inherited from QObject

### Public Functions

- QTextDocument ( QObject * parent = 0 )
- QTextDocument ( const QString & text, QObject * parent = 0 )
- ~QTextDocument ()
- QTextBlock begin () const
- QAbstractTextDocumentLayout * documentLayout () const
- QString documentTitle () const
- QTextBlock end () const
- QTextCursor find ( const QString & expr, const QTextCursor & cursor, FindFlags options = 0, FindDirection direction = FindForward ) const
- QTextCursor find ( const QString & expr, int position = 0, FindFlags options = 0, FindDirection direction = FindForward ) const
- QTextBlock findBlock ( int pos ) const
- QString html () const
- bool isEmpty () const
- bool isRedoAvailable () const
- bool isUndoAvailable () const
- QTextObject * object ( int objectIndex ) const
- QTextObject * objectForFormat ( const QTextFormat & f ) const
- QString plainText () const
- QTextFrame * rootFrame () const
- void setDocumentLayout ( QAbstractTextDocumentLayout * layout )
- void setHtml ( const QString & html )
- void setPlainText ( const QString & text )

- 24 public functions inherited from QObject

### Public Slots

- void redo ()
- void setModified ( bool m = true )
- void undo ()

- 1 public slot inherited from QObject

### Signals

- void contentsChanged ()
- void modificationChanged ( bool changed )
- void redoAvailable ( bool b )
- void undoAvailable ( bool b )

- 1 signal inherited from QObject

### Static Public Members

- 4 static public members inherited from QObject

### Protected Functions

- virtual QTextObject * createObject ( const QTextFormat & format )

- 9 protected functions inherited from QObject

## Detailed Description

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.

## Member Type Documentation

### enum QTextDocument::FindDirection

This enum is used to specify the search direction when searching for text with the find() function.

`QTextDocument::FindForward` |
`QTextDocument::FindBackward` |

### enum QTextDocument::FindFlag
typedef QTextDocument::FindFlags

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.

## Property Documentation

### modified : bool

This property holds whether the document has been modified by the user.

Access functions:

- bool isModified () const
- void setModified ( bool m = true )

See also modificationChanged().

### undoRedoEnabled : bool

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:

- bool isUndoRedoEnabled () const
- void setUndoRedoEnabled ( bool enable )

## Member Function Documentation

### QTextDocument::QTextDocument ( QObject * parent = 0 )

Constructs an empty QTextDocument with the given parent.

### QTextDocument::QTextDocument ( const QString & text, QObject * parent = 0 )

Constructs a QTextDocument containing the plain (unformatted) text specified, and with the given parent.

### QTextDocument::~QTextDocument ()

Destroys the document.

### QTextBlock QTextDocument::begin () const

Returns the document's first text block.

### void QTextDocument::contentsChanged () `[signal]`

This signal is emitted whenever the documents content changes, for example, text is inserted or deleted, or formatting is applied.

### QTextObject * QTextDocument::createObject ( const QTextFormat & format ) `[virtual protected]`

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.

### QAbstractTextDocumentLayout * QTextDocument::documentLayout () const

Returns the document layout for this document.

### QString QTextDocument::documentTitle () const

Returns the document's title.

### QTextBlock QTextDocument::end () const

Returns the document's last text block.

### QTextCursor QTextDocument::find ( const QString & expr, const QTextCursor & cursor, FindFlags options = 0, FindDirection direction = FindForward ) const

Finds the next occurrence of the string, expr, in the document. The search starts at the position of the given cursor, and proceeds in the direction specified. The options control the type of search performed.

Returns a cursor with the match selected if expr 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-sensitive, and can match text anywhere in the document.

### QTextCursor QTextDocument::find ( const QString & expr, int position = 0, FindFlags options = 0, FindDirection direction = FindForward ) const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Finds the next occurrence of the string, expr, in the document. The search starts at the given position, and proceeds in the direction specified. The options control the type of search performed.

Returns a cursor with the match selected if expr 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.

### QTextBlock QTextDocument::findBlock ( int pos ) const

Returns the text block that contains the pos-th character.

### QString QTextDocument::html () const

Returns the document in HTML format. The conversion may not be perfect, especially for complex documents, due to the limitations of HTML.

### bool QTextDocument::isEmpty () const

Returns true if the document is empty; otherwise returns false.

### bool QTextDocument::isRedoAvailable () const

Returns true is redo is available; otherwise returns false.

### bool QTextDocument::isUndoAvailable () const

Returns true is undo is available; otherwise returns false.

### void QTextDocument::modificationChanged ( bool changed ) `[signal]`

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.

### QTextObject * QTextDocument::object ( int objectIndex ) const

Returns the text object associated with the given objectIndex.

### QTextObject * QTextDocument::objectForFormat ( const QTextFormat & f ) const

Returns the text object associated with the format f.

### QString QTextDocument::plainText () const

Returns the plain text contained in the document. If you want formatting information use a QTextCursor instead.

See also html().

### void QTextDocument::redo () `[slot]`

Redoes the last editing operation on the document if redo is available.

### void QTextDocument::redoAvailable ( bool b ) `[signal]`

This signal is emitted whenever redo operations become available (b is true) or unavailable (b is false).

### QTextFrame * QTextDocument::rootFrame () const

Returns the document's root frame.

### void QTextDocument::setDocumentLayout ( QAbstractTextDocumentLayout * layout )

Sets the document to use the given layout. The previous layout is deleted.

### void QTextDocument::setHtml ( const QString & html )

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().

### void QTextDocument::setPlainText ( const QString & text )

Replaces the entire contents of the document with the given plain text.

See also setHtml().

### void QTextDocument::undo () `[slot]`

Undoes the last editing operation on the document if undo is available.

### void QTextDocument::undoAvailable ( bool b ) `[signal]`

This signal is emitted whenever undo operations become available (b is true) or unavailable (b is false).