|  | Home · All Classes · Main Classes · Grouped Classes · Modules · Functions |

# QTextEdit Class Reference
[QtGui module]

The QTextEdit class provides a widget that is used to edit and display both plain and rich text. More...

     #include <QTextEdit>

Inherits QAbstractScrollArea.

Inherited by QTextBrowser.

- List of all members, including inherited members
- Qt 3 support members

### Public Types

- class ExtraSelection
- flags AutoFormatting
- enum AutoFormattingFlag { AutoNone, AutoBulletList, AutoAll }
- enum CursorAction { MoveBackward, MoveForward, MoveWordBackward, MoveWordForward, ..., MovePageDown }
- enum LineWrapMode { NoWrap, WidgetWidth, FixedPixelWidth, FixedColumnWidth }

### Properties

acceptRichText : bool autoFormatting : AutoFormatting cursorWidth : int documentTitle : QString html : QString lineWrapColumnOrWidth : int lineWrapMode : LineWrapMode | overwriteMode : bool readOnly : bool tabChangesFocus : bool tabStopWidth : int textInteractionFlags : Qt::TextInteractionFlags undoRedoEnabled : bool wordWrapMode : QTextOption::WrapMode

- 2 properties inherited from QAbstractScrollArea
- 6 properties inherited from QFrame
- 55 properties inherited from QWidget
- 1 property inherited from QObject

### Public Functions

- QTextEdit ( QWidget * parent = 0 )
- QTextEdit ( const QString & text, QWidget * parent = 0 )
- virtual ~QTextEdit ()
- bool acceptRichText () const
- Qt::Alignment alignment () const
- QString anchorAt ( const QPoint & pos ) const
- AutoFormatting autoFormatting () const
- bool canPaste () const
- QMenu * createStandardContextMenu ()
- QTextCharFormat currentCharFormat () const
- QFont currentFont () const
- QTextCursor cursorForPosition ( const QPoint & pos ) const
- QRect cursorRect ( const QTextCursor & cursor ) const
- QRect cursorRect () const
- int cursorWidth () const
- QTextDocument * document () const
- QString documentTitle () const
- void ensureCursorVisible ()
- QList<ExtraSelection> extraSelections () const
- bool find ( const QString & exp, QTextDocument::FindFlags options = 0 )
- QString fontFamily () const
- bool fontItalic () const
- qreal fontPointSize () const
- bool fontUnderline () const
- int fontWeight () const
- bool isReadOnly () const
- bool isUndoRedoEnabled () const
- int lineWrapColumnOrWidth () const
- LineWrapMode lineWrapMode () const
- virtual QVariant loadResource ( int type, const QUrl & name )
- void mergeCurrentCharFormat ( const QTextCharFormat & modifier )
- void moveCursor ( QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor )
- bool overwriteMode () const
- void setAcceptRichText ( bool accept )
- void setAutoFormatting ( AutoFormatting features )
- void setCurrentCharFormat ( const QTextCharFormat & format )
- void setCursorWidth ( int width )
- void setDocument ( QTextDocument * document )
- void setDocumentTitle ( const QString & title )
- void setExtraSelections ( const QList<ExtraSelection> & selections )
- void setLineWrapColumnOrWidth ( int w )
- void setLineWrapMode ( LineWrapMode mode )
- void setOverwriteMode ( bool overwrite )
- void setReadOnly ( bool ro )
- void setTabChangesFocus ( bool b )
- void setTabStopWidth ( int width )
- void setTextCursor ( const QTextCursor & cursor )
- void setTextInteractionFlags ( Qt::TextInteractionFlags flags )
- void setUndoRedoEnabled ( bool enable )
- void setWordWrapMode ( QTextOption::WrapMode policy )
- bool tabChangesFocus () const
- int tabStopWidth () const
- QColor textColor () const
- QTextCursor textCursor () const
- Qt::TextInteractionFlags textInteractionFlags () const
- QString toHtml () const
- QString toPlainText () const
- QTextOption::WrapMode wordWrapMode () const

- 15 public functions inherited from QAbstractScrollArea
- 13 public functions inherited from QFrame
- 195 public functions inherited from QWidget
- 29 public functions inherited from QObject
- 12 public functions inherited from QPaintDevice

### Public Slots

- void append ( const QString & text )
- void clear ()
- void copy ()
- void cut ()
- void insertHtml ( const QString & text )
- void insertPlainText ( const QString & text )
- void paste ()
- void redo ()
- void scrollToAnchor ( const QString & name )
- void selectAll ()
- void setAlignment ( Qt::Alignment a )
- void setCurrentFont ( const QFont & f )
- void setFontFamily ( const QString & fontFamily )
- void setFontItalic ( bool italic )
- void setFontPointSize ( qreal s )
- void setFontUnderline ( bool underline )
- void setFontWeight ( int weight )
- void setHtml ( const QString & text )
- void setPlainText ( const QString & text )
- void setText ( const QString & text )
- void setTextColor ( const QColor & c )
- void undo ()
- void zoomIn ( int range = 1 )
- void zoomOut ( int range = 1 )

- 19 public slots inherited from QWidget
- 1 public slot inherited from QObject

### Signals

- void copyAvailable ( bool yes )
- void currentCharFormatChanged ( const QTextCharFormat & f )
- void cursorPositionChanged ()
- void redoAvailable ( bool available )
- void selectionChanged ()
- void textChanged ()
- void undoAvailable ( bool available )

- 1 signal inherited from QWidget
- 1 signal inherited from QObject

### Protected Functions

- virtual bool canInsertFromMimeData ( const QMimeData * source ) const
- virtual void contextMenuEvent ( QContextMenuEvent * e )
- virtual QMimeData * createMimeDataFromSelection () const
- virtual void insertFromMimeData ( const QMimeData * source )

- 16 protected functions inherited from QAbstractScrollArea
- 38 protected functions inherited from QWidget
- 7 protected functions inherited from QObject
- 1 protected function inherited from QPaintDevice

### Additional Inherited Members

- 4 static public members inherited from QWidget
- 5 static public members inherited from QObject
- 1 protected slot inherited from QAbstractScrollArea
- 1 protected slot inherited from QWidget

## Detailed Description

The QTextEdit class provides a widget that is used to edit and display both plain and rich text.

- Introduction and Concepts
- Using QTextEdit as a Display Widget

- Read-only Key Bindings

- Using QTextEdit as an Editor

- Editing Key Bindings

### Introduction and Concepts

QTextEdit is an advanced WYSIWYG viewer/editor supporting rich text formatting using HTML-style tags. It is optimized to handle large documents and to respond quickly to user input.

QTextEdit works on paragraphs and characters. A paragraph is a formatted string which is word-wrapped to fit into the width of the widget. By default when reading plain text, one newline signifies a paragraph. A document consists of zero or more paragraphs. The words in the paragraph are aligned in accordance with the paragraph's alignment. Paragraphs are separated by hard line breaks. Each character within a paragraph has its own attributes, for example, font and color.

QTextEdit can display images, lists and tables. If the text is too large to view within the text edit's viewport, scrollbars will appear. The text edit can load both plain text and HTML files (a subset of HTML 3.2 and 4).

If you just need to display a small piece of rich text use QLabel.

Note that we do not intend to add a full-featured web browser widget to Qt (because that would easily double Qt's size and only a few applications would benefit from it). The rich text support in Qt is designed to provide a fast, portable and efficient way to add reasonable online help facilities to applications, and to provide a basis for rich text editors.

### Using QTextEdit as a Display Widget

QTextEdit can display a large HTML subset, including tables and images.

The text is set or replaced using setHtml() which deletes any existing text and replaces it with the text passed in the setHtml() call. If you call setHtml() with legacy HTML, and then call toHtml(), the text that is returned may have different markup, but will render the same. The entire text can be deleted with clear().

Text itself can be inserted using the QTextCursor class or using the convenience functions insertHtml(), insertPlainText(), append() or paste(). QTextCursor is also able to insert complex objects like tables or lists into the document, and it deals with creating selections and applying changes to selected text.

By default the text edit wraps words at whitespace to fit within the text edit widget. The setLineWrapMode() function is used to specify the kind of line wrap you want, or NoWrap if you don't want any wrapping. Call setLineWrapMode() to set a fixed pixel width FixedPixelWidth, or character column (e.g. 80 column) FixedColumnWidth with the pixels or columns specified with setLineWrapColumnOrWidth(). If you use word wrap to the widget's width WidgetWidth, you can specify whether to break on whitespace or anywhere with setWordWrapMode().

The find() function can be used to find and select a given string within the text.

If you want to limit the total number of paragraphs in a QTextEdit, as it is for example open useful in a log viewer, then you can use QTextDocument's maximumBlockCount property for that.

#### Read-only Key Bindings

When QTextEdit is used read-only the key bindings are limited to navigation, and text may only be selected with the mouse:

Keypresses | Action
--- | ---
Qt::UpArrow | Moves one line up.
Qt::DownArrow | Moves one line down.
Qt::LeftArrow | Moves one character to the left.
Qt::RightArrow | Moves one character to the right.
PageUp | Moves one (viewport) page up.
PageDown | Moves one (viewport) page down.
Home | Moves to the beginning of the text.
End | Moves to the end of the text.
Alt+Wheel | Scrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+Wheel | Zooms the text.
Ctrl+A | Selects all text.

The text edit may be able to provide some meta-information. For example, the documentTitle() function will return the text from within HTML `<title>` tags.

### Using QTextEdit as an Editor

All the information about using QTextEdit as a display widget also applies here.

The current char format's attributes are set with setFontItalic(), setFontWeight(), setFontUnderline(), setFontFamily(), setFontPointSize(), setTextColor() and setCurrentFont(). The current paragraph's alignment is set with setAlignment().

Selection of text is handled by the QTextCursor class, which provides functionality for creating selections, retrieving the text contents or deleting selections. You can retrieve the object that corresponds with the user-visible cursor using the textCursor() method. If you want to set a selection in QTextEdit just create one on a QTextCursor object and then make that cursor the visible cursor using setCursor(). The selection can be copied to the clipboard with copy(), or cut to the clipboard with cut(). The entire text can be selected using selectAll().

When the cursor is moved and the underlying formatting attributes change, the currentCharFormatChanged() signal is emitted to reflect the new attributes at the new cursor position.

QTextEdit holds a QTextDocument object which can be retrieved using the document() method. You can also set your own document object using setDocument(). QTextDocument emits a textChanged() signal if the text changes and it also provides a isModified() function which will return true if the text has been modified since it was either loaded or since the last call to setModified with false as argument. In addition it provides methods for undo and redo.

#### Editing Key Bindings

The list of key bindings which are implemented for editing:

Keypresses | Action
--- | ---
Backspace | Deletes the character to the left of the cursor.
Delete | Deletes the character to the right of the cursor.
Ctrl+C | Copy the selected text to the clipboard.
Ctrl+Insert | Copy the selected text to the clipboard.
Ctrl+K | Deletes to the end of the line.
Ctrl+V | Pastes the clipboard text into text edit.
Shift+Insert | Pastes the clipboard text into text edit.
Ctrl+X | Deletes the selected text and copies it to the clipboard.
Shift+Delete | Deletes the selected text and copies it to the clipboard.
Ctrl+Z | Undoes the last operation.
Ctrl+Y | Redoes the last operation.
LeftArrow | Moves the cursor one character to the left.
Ctrl+LeftArrow | Moves the cursor one word to the left.
RightArrow | Moves the cursor one character to the right.
Ctrl+RightArrow | Moves the cursor one word to the right.
UpArrow | Moves the cursor one line up.
Ctrl+UpArrow | Moves the cursor one word up.
DownArrow | Moves the cursor one line down.
Ctrl+Down Arrow | Moves the cursor one word down.
PageUp | Moves the cursor one page up.
PageDown | Moves the cursor one page down.
Home | Moves the cursor to the beginning of the line.
Ctrl+Home | Moves the cursor to the beginning of the text.
End | Moves the cursor to the end of the line.
Ctrl+End | Moves the cursor to the end of the text.
Alt+Wheel | Scrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+Wheel | Zooms the text.

To select (mark) text hold down the Shift key whilst pressing one of the movement keystrokes, for example, Shift+Right Arrow will select the character to the right, and Shift+Ctrl+Right Arrow will select the word to the right, etc.

See also QTextDocument, QTextCursor, Application Example, and Syntax Highlighter Example.

## Member Type Documentation

### enum QTextEdit::AutoFormattingFlag
flags QTextEdit::AutoFormatting

Constant | Value | Description
--- | --- | ---
`QTextEdit::AutoNone` | `0` | Don't do any automatic formatting.
`QTextEdit::AutoBulletList` | `0x00000001` | Automatically create bullet lists (e.g. when the user enters an asterisk ('*') in the left most column, or presses Enter in an existing list item.
`QTextEdit::AutoAll` | `0xffffffff` | Apply all automatic formatting. Currently only automatic bullet lists are supported.

The AutoFormatting type is a typedef for QFlags<AutoFormattingFlag>. It stores an OR combination of AutoFormattingFlag values.

### enum QTextEdit::CursorAction

Constant | Value
--- | ---
`QTextEdit::MoveBackward` | `0`
`QTextEdit::MoveForward` | `1`
`QTextEdit::MoveWordBackward` | `2`
`QTextEdit::MoveWordForward` | `3`
`QTextEdit::MoveUp` | `4`
`QTextEdit::MoveDown` | `5`
`QTextEdit::MoveLineStart` | `6`
`QTextEdit::MoveLineEnd` | `7`
`QTextEdit::MoveHome` | `8`
`QTextEdit::MoveEnd` | `9`
`QTextEdit::MovePageUp` | `10`
`QTextEdit::MovePageDown` | `11`

### enum QTextEdit::LineWrapMode

Constant | Value
--- | ---
`QTextEdit::NoWrap` | `0`
`QTextEdit::WidgetWidth` | `1`
`QTextEdit::FixedPixelWidth` | `2`
`QTextEdit::FixedColumnWidth` | `3`

## Property Documentation

### acceptRichText : bool

This property holds whether the text edit accepts rich text insertions by the user.

When this propery is set to false text edit will accept only plain text input from the user. For example through clipboard or drag and drop.

This property's default is true.

This property was introduced in Qt 4.1.

Access functions:

- bool acceptRichText () const
- void setAcceptRichText ( bool accept )

### autoFormatting : AutoFormatting

This property holds the enabled set of auto formatting features.

The value can be any combination of the values in the AutoFormattingFlag enum. The default is AutoNone. Choose AutoAll to enable all automatic formatting.

Currently, the only automatic formatting feature provided is AutoBulletList; future versions of Qt may offer more.

Access functions:

- AutoFormatting autoFormatting () const
- void setAutoFormatting ( AutoFormatting features )

### cursorWidth : int

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

This property was introduced in Qt 4.2.

Access functions:

- int cursorWidth () const
- void setCursorWidth ( int width )

### documentTitle : QString

This property holds the title of the document parsed from the text.

Access functions:

- QString documentTitle () const
- void setDocumentTitle ( const QString & title )

### html : QString

This property provides an HTML interface to the text of the text edit.

toHtml() returns the text of the text edit as html.

setHtml() changes the text of the text edit. Any previous text is removed. The input text is interpreted as rich text in html format.

Note that the undo/redo history is cleared by calling setHtml().

Access functions:

- QString toHtml () const
- void setHtml ( const QString & text )

See also Supported HTML Subset.

### lineWrapColumnOrWidth : int

This property holds the position (in pixels or columns depending on the wrap mode) where text will be wrapped.

If the wrap mode is FixedPixelWidth, the value is the number of pixels from the left edge of the text edit at which text should be wrapped. If the wrap mode is FixedColumnWidth, the value is the column number (in character columns) from the left edge of the text edit at which text should be wrapped.

Access functions:

- int lineWrapColumnOrWidth () const
- void setLineWrapColumnOrWidth ( int w )

See also lineWrapMode.

### lineWrapMode : LineWrapMode

This property holds the line wrap mode.

The default mode is WidgetWidth which causes words to be wrapped at the right edge of the text edit. Wrapping occurs at whitespace, keeping whole words intact. If you want wrapping to occur within words use setWrapPolicy(). If you set a wrap mode of FixedPixelWidth or FixedColumnWidth you should also call setWrapColumnOrWidth() with the width you want.

Access functions:

- LineWrapMode lineWrapMode () const
- void setLineWrapMode ( LineWrapMode mode )

See also lineWrapColumnOrWidth.

### overwriteMode : bool

This property was introduced in Qt 4.1.

Access functions:

- bool overwriteMode () const
- void setOverwriteMode ( bool overwrite )

### readOnly : bool

This property holds whether the text edit is read-only.

In a read-only text edit the user can only navigate through the text and select text; modifying the text is not possible.

This property's default is false.

Access functions:

- bool isReadOnly () const
- void setReadOnly ( bool ro )

### tabChangesFocus : bool

This property holds whether Tab changes focus or is accepted as input.

In some occasions text edits should not allow the user to input tabulators or change indentation using the Tab key, as this breaks the focus chain. The default is false.

Access functions:

- bool tabChangesFocus () const
- void setTabChangesFocus ( bool b )

### tabStopWidth : int

This property holds the tab stop width in pixels.

This property was introduced in Qt 4.1.

Access functions:

- int tabStopWidth () const
- void setTabStopWidth ( int width )

### textInteractionFlags : Qt::TextInteractionFlags

Specifies how the label should interact with user input if it displays text.

If the flags contain either Qt::LinksAccessibleByKeyboard or Qt::TextSelectableByKeyboard then the focus policy is also automatically set to Qt::ClickFocus.

The default value depends on whether the QTextEdit is read-only or editable, and whether it is a QTextBrowser or not.

This property was introduced in Qt 4.2.

Access functions:

- Qt::TextInteractionFlags textInteractionFlags () const
- void setTextInteractionFlags ( Qt::TextInteractionFlags flags )

### undoRedoEnabled : bool

This property holds whether undo and redo are enabled.

Users are only able to undo or redo actions if this property is true, and if there is an action that can be undone (or redone).

Access functions:

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

### wordWrapMode : QTextOption::WrapMode

This property holds the mode QTextEdit will use when wrapping text by words.

Access functions:

- QTextOption::WrapMode wordWrapMode () const
- void setWordWrapMode ( QTextOption::WrapMode policy )

See also QTextOption::WrapMode.

## Member Function Documentation

### QTextEdit::QTextEdit ( QWidget * parent = 0 )

Constructs an empty QTextEdit with parent parent.

### QTextEdit::QTextEdit ( const QString & text, QWidget * parent = 0 )

Constructs a QTextEdit with parent parent. The text edit will display the text text. The text is interpreted as html.

### QTextEdit::~QTextEdit () `[virtual]`

Destructor.

### Qt::Alignment QTextEdit::alignment () const

Returns the alignment of the current paragraph.

See also setAlignment().

### QString QTextEdit::anchorAt ( const QPoint & pos ) const

Returns the reference of the anchor at position pos, or an empty string if no anchor exists at that point.

### void QTextEdit::append ( const QString & text ) `[slot]`

Appends a new paragraph with text to the end of the text edit.

### bool QTextEdit::canInsertFromMimeData ( const QMimeData * source ) const `[virtual protected]`

This function returns true if the contents of the MIME data object, specified by source, can be decoded and inserted into the document. It is called for example when during a drag operation the mouse enters this widget and it is necessary to determine whether it is possible to accept the drag.

### bool QTextEdit::canPaste () const

Returns whether text can be pasted from the clipboard into the textedit.

This function was introduced in Qt 4.2.

### void QTextEdit::clear () `[slot]`

Deletes all the text in the text edit.

Note that the undo/redo history is cleared by this function.

See also cut(), setPlainText(), and setHtml().

### void QTextEdit::contextMenuEvent ( QContextMenuEvent * e ) `[virtual protected]`

Shows the standard context menu created with createStandardContextMenu().

If you do not want the text edit to have a context menu, you can set its contextMenuPolicy to Qt::NoContextMenu. If you want to customize the context menu, reimplement this function. If you want to extend the standard context menu, reimplement this function, call createStandardContextMenu() and extend the menu returned.

Information about the event is passed in e.

     void TextEdit::contextMenuEvent(QContextMenuEvent * e) {
             QMenu *menu = createStandardContextMenu();
             menu->addAction(My Menu Item");
             //...
             menu->exec(e->globalPos());
             delete menu;
     }

Reimplemented from QWidget.

### void QTextEdit::copy () `[slot]`

Copies any selected text to the clipboard.

See also copyAvailable().

### void QTextEdit::copyAvailable ( bool yes ) `[signal]`

This signal is emitted when text is selected or de-selected in the text edit.

When text is selected this signal will be emitted with yes set to true. If no text has been selected or if the selected text is de-selected this signal is emitted with yes set to false.

If yes is true then copy() can be used to copy the selection to the clipboard. If yes is false then copy() does nothing.

See also selectionChanged().

### QMimeData * QTextEdit::createMimeDataFromSelection () const `[virtual protected]`

This function returns a new MIME data object to represent the contents of the text edit's current selection. It is called when the selection needs to be encapsulated into a new QMimeData object; for example, when a drag and drop operation is started, or when data is copyied to the clipboard.

If you reimplement this function, note that the ownership of the returned QMimeData object is passed to the caller. The selection can be retrieved by using the textCursor() function.

### QMenu * QTextEdit::createStandardContextMenu ()

This function creates the standard context menu which is shown when the user clicks on the line edit with the right mouse button. It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

### QTextCharFormat QTextEdit::currentCharFormat () const

Returns the char format that is used when inserting new text.

See also setCurrentCharFormat().

### void QTextEdit::currentCharFormatChanged ( const QTextCharFormat & f ) `[signal]`

This signal is emitted if the current character format has changed, for example caused by a change of the cursor position.

The new format is f.

See also setCurrentCharFormat().

### QFont QTextEdit::currentFont () const

Returns the font of the current format.

See also setCurrentFont(), setFontFamily(), and setFontPointSize().

### QTextCursor QTextEdit::cursorForPosition ( const QPoint & pos ) const

returns a QTextCursor at position pos (in viewport coordinates).

### void QTextEdit::cursorPositionChanged () `[signal]`

This signal is emitted whenever the position of the cursor changed.

### QRect QTextEdit::cursorRect ( const QTextCursor & cursor ) const

returns a rectangle (in viewport coordinates) that includes the cursor.

### QRect QTextEdit::cursorRect () const

This is an overloaded member function, provided for convenience.

returns a rectangle (in viewport coordinates) that includes the cursor of the text edit.

### void QTextEdit::cut () `[slot]`

Copies the selected text to the clipboard and deletes it from the text edit.

If there is no selected text nothing happens.

See also copy() and paste().

### QTextDocument * QTextEdit::document () const

Returns a pointer to the underlying document.

See also setDocument().

### void QTextEdit::ensureCursorVisible ()

Ensures that the cursor is visible by scrolling the text edit if necessary.

### QList<ExtraSelection> QTextEdit::extraSelections () const

Returns previously set extra selections.

This function was introduced in Qt 4.2.

See also setExtraSelections().

### bool QTextEdit::find ( const QString & exp, QTextDocument::FindFlags options = 0 )

Finds the next occurrence of the string, exp, using the given options. Returns true if exp was found and changes the cursor to select the match; otherwise returns false.

### QString QTextEdit::fontFamily () const

Returns the font family of the current format.

See also setFontFamily(), setCurrentFont(), and setFontPointSize().

### bool QTextEdit::fontItalic () const

Returns true if the font of the current format is italic; otherwise returns false.

See also setFontItalic().

### qreal QTextEdit::fontPointSize () const

Returns the point size of the font of the current format.

See also setFontFamily(), setCurrentFont(), and setFontPointSize().

### bool QTextEdit::fontUnderline () const

Returns true if the font of the current format is underlined; otherwise returns false.

See also setFontUnderline().

### int QTextEdit::fontWeight () const

Returns the font weight of the current format.

See also setFontWeight(), setCurrentFont(), setFontPointSize(), and QFont::Weight.

### void QTextEdit::insertFromMimeData ( const QMimeData * source ) `[virtual protected]`

This function inserts the contents of the MIME data object, specified by source, into the text edit at the current cursor position. It is called whenever text is inserted as the result of a clipboard paste operation, or when the text edit accepts data from a drag and drop operation.

### void QTextEdit::insertHtml ( const QString & text ) `[slot]`

Convenience slot that inserts text which is assumed to be of html formatting at the current cursor position.

It is equivalent to:

     edit->textCursor().insertHtml(fragment);

### void QTextEdit::insertPlainText ( const QString & text ) `[slot]`

Convenience slot that inserts text at the current cursor position.

It is equivalent to

     edit->textCursor().insertText(text);

### QVariant QTextEdit::loadResource ( int type, const QUrl & name ) `[virtual]`

Loads the resource specified by the given type and name.

This function is an extension of QTextDocument::loadResource().

See also QTextDocument::loadResource().

### void QTextEdit::mergeCurrentCharFormat ( const QTextCharFormat & modifier )

Merges the properties specified in modifier into the current character format by calling QTextCursor::mergeCharFormat on the editor's cursor. If the editor has a selection then the properties of modifier are directly applied to the selection.

See also QTextCursor::mergeCharFormat().

### void QTextEdit::moveCursor ( QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor )

Moves the cursor by performing the given operation.

If mode is QTextCursor::KeepAnchor, the cursor selects the text it moves over. This is the same effect that the user achieves when they hold down the Shift key and move the cursor with the cursor keys.

This function was introduced in Qt 4.2.

See also QTextCursor::movePosition().

### void QTextEdit::paste () `[slot]`

Pastes the text from the clipboard into the text edit at the current cursor position.

If there is no text in the clipboard nothing happens.

To change the behavior of this function, i.e. to modify what QTextEdit can paste and how it is being pasted, reimplement the virtual canInsertFromMimeData() and insertFromMimeData() functions.

See also cut() and copy().

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

Redoes the last operation.

If there is no operation to redo, i.e. there is no redo step in the undo/redo history, nothing happens.

This function was introduced in Qt 4.2.

See also undo().

### void QTextEdit::redoAvailable ( bool available ) `[signal]`

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

### void QTextEdit::scrollToAnchor ( const QString & name ) `[slot]`

Scrolls the text edit so that the anchor with the given name is visible; does nothing if the name is empty, or is already visible, or isn't found.

### void QTextEdit::selectAll () `[slot]`

Selects all text.

See also copy(), cut(), and textCursor().

### void QTextEdit::selectionChanged () `[signal]`

This signal is emitted whenever the selection changes.

See also copyAvailable().

### void QTextEdit::setAlignment ( Qt::Alignment a ) `[slot]`

Sets the alignment of the current paragraph to a. Valid alignments are Qt::AlignLeft, Qt::AlignRight, Qt::AlignJustify and Qt::AlignCenter (which centers horizontally).

See also alignment().

### void QTextEdit::setCurrentCharFormat ( const QTextCharFormat & format )

Sets the char format that is be used when inserting new text to format by calling QTextCursor::setCharFormat() on the editor's cursor. If the editor has a selection then the char format is directly applied to the selection.

See also currentCharFormat().

### void QTextEdit::setCurrentFont ( const QFont & f ) `[slot]`

Sets the font of the current format to f.

See also currentFont(), setFontPointSize(), and setFontFamily().

### void QTextEdit::setDocument ( QTextDocument * document )

Makes document the new document of the text editor.

The parent QObject of the provided document remains the owner of the object. If the current document is a child of the text editor, then it is deleted.

See also document().

### void QTextEdit::setExtraSelections ( const QList<ExtraSelection> & selections )

This function allows temporarily marking certain regions in the document with a given color, specified as selections. This can be useful for example in a programming editor to mark a whole line of text with a given background color to indicate the existence of a breakpoint.

This function was introduced in Qt 4.2.

See also QTextEdit::ExtraSelection and extraSelections().

### void QTextEdit::setFontFamily ( const QString & fontFamily ) `[slot]`

Sets the font family of the current format to fontFamily.

See also fontFamily() and setCurrentFont().

### void QTextEdit::setFontItalic ( bool italic ) `[slot]`

If italic is true, sets the current format to italic; otherwise sets the current format to non-italic.

See also fontItalic().

### void QTextEdit::setFontPointSize ( qreal s ) `[slot]`

Sets the point size of the current format to s.

Note that if s is zero or negative, the behavior of this function is not defined.

See also fontPointSize(), setCurrentFont(), and setFontFamily().

### void QTextEdit::setFontUnderline ( bool underline ) `[slot]`

If underline is true, sets the current format to underline; otherwise sets the current format to non-underline.

See also fontUnderline().

### void QTextEdit::setFontWeight ( int weight ) `[slot]`

Sets the font weight of the current format to the given weight, where the value used is in the range defined by the QFont::Weight enum.

See also fontWeight(), setCurrentFont(), and setFontFamily().

### void QTextEdit::setPlainText ( const QString & text ) `[slot]`

Changes the text of the text edit to the string text. Any previous text is removed.

text is interpreted as plain text.

Note that the undo/redo history is cleared by this function.

See also toPlainText().

### void QTextEdit::setText ( const QString & text ) `[slot]`

Sets the text edit's text. The text can be plain text or HTML and the text edit will try to guess the right format.

Use setHtml() or setPlainText() directly to avoid text edit's guessing.

This function was introduced in Qt 4.2.

See also text().

### void QTextEdit::setTextColor ( const QColor & c ) `[slot]`

Sets the text color of the current format to c.

See also textColor().

### void QTextEdit::setTextCursor ( const QTextCursor & cursor )

Sets the visible cursor.

See also textCursor().

### void QTextEdit::textChanged () `[signal]`

This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.

### QColor QTextEdit::textColor () const

Returns the text color of the current format.

See also setTextColor().

### QTextCursor QTextEdit::textCursor () const

Returns a copy of the QTextCursor that represents the currently visible cursor. Note that changes on the returned cursor do not affect QTextEdit's cursor; use setTextCursor() to update the visible cursor.

See also setTextCursor().

### QString QTextEdit::toPlainText () const

Returns the text of the text edit as plain text.

See also QTextEdit::setPlainText().

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

Undoes the last operation.

If there is no operation to undo, i.e. there is no undo step in the undo/redo history, nothing happens.

This function was introduced in Qt 4.2.

See also redo().

### void QTextEdit::undoAvailable ( bool available ) `[signal]`

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

### void QTextEdit::zoomIn ( int range = 1 ) `[slot]`

Zooms in on the text by by making the base font size range points larger and recalculating all font sizes to be the new size. This does not change the size of any images.

See also zoomOut().

### void QTextEdit::zoomOut ( int range = 1 ) `[slot]`

Zooms out on the text by making the base font size range points smaller and recalculating all font sizes to be the new size. This does not change the size of any images.

See also zoomIn().

## Member Type Documentation

### enum QTextEdit::KeyboardAction

Constant | Value
--- | ---
`QTextEdit::ActionBackspace` | `0`
`QTextEdit::ActionDelete` | `1`
`QTextEdit::ActionReturn` | `2`
`QTextEdit::ActionKill` | `3`
`QTextEdit::ActionWordBackspace` | `4`
`QTextEdit::ActionWordDelete` | `5`

## Member Function Documentation

### QTextEdit::QTextEdit ( QWidget * parent, const char * name )

Use one of the constructors that doesn't take the name argument and then use setObjectName() instead.

### bool QTextEdit::bold () const

Use fontWeight() >= QFont::Bold instead.

See also setBold().

### QColor QTextEdit::color () const

Use textColor() instead.

See also setColor().

### void QTextEdit::currentColorChanged ( const QColor & color ) `[signal]`

Use currentCharFormatChanged() instead.

### void QTextEdit::currentFontChanged ( const QFont & font ) `[signal]`

Use currentCharFormatChanged() instead.

### void QTextEdit::doKeyboardAction ( KeyboardAction action )

Executes keyboard action action.

Use the QTextCursor class instead.

See also textCursor().

### QString QTextEdit::family () const

Use fontFamily() instead.

See also setFamily().

### bool QTextEdit::find ( const QString & exp, bool cs, bool wo )

This is an overloaded member function, provided for convenience.

Use the find() overload that takes a QTextDocument::FindFlags argument.

### bool QTextEdit::hasSelectedText () const

Use textCursor().hasSelection() instead.

### void QTextEdit::insert ( const QString & text )

Use insertPlainText() instead.

### bool QTextEdit::isModified () const

Use document()->isModified() instead.

### bool QTextEdit::isRedoAvailable () const

Use document()->isRedoAvailable() instead.

### bool QTextEdit::isUndoAvailable () const

Use document()->isUndoAvailable() instead.

### bool QTextEdit::italic () const

Use fontItalic() instead.

See also setItalic().

### void QTextEdit::moveCursor ( CursorAction action, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor )

This is an overloaded member function, provided for convenience.

Use the QTextCursor class instead.

### void QTextEdit::moveCursor ( CursorAction action, bool select )

This is an overloaded member function, provided for convenience.

Use the QTextCursor class instead.

### int QTextEdit::pointSize () const

Use int(fontPointSize()+0.5) instead.

See also setPointSize().

### void QTextEdit::redo () const

This is an overloaded member function, provided for convenience.

Use the non-const overload instead.

### QString QTextEdit::selectedText () const

Use textCursor().selectedText() instead.

### void QTextEdit::setBold ( bool b )

Use setFontWeight() instead.

See also bold().

### void QTextEdit::setColor ( const QColor & color ) `[slot]`

Use setTextColor() instead.

See also color().

### void QTextEdit::setFamily ( const QString & family )

Use setFontFamily() instead.

See also family().

### void QTextEdit::setItalic ( bool i )

Use setFontItalic() instead.

See also italic().

### void QTextEdit::setModified ( bool m = true ) `[slot]`

Use document->setModified() instead.

See also isModified().

### void QTextEdit::setPointSize ( int size )

Use setFontPointSize() instead.

See also pointSize().

### void QTextEdit::setTextFormat ( Qt::TextFormat f )

Sets the text format to format f.

See also textFormat().

### void QTextEdit::setUnderline ( bool b )

Use setFontUnderline() instead.

See also underline().

### void QTextEdit::sync ()

Does nothing.

### QString QTextEdit::text () const

Returns all the text in the text edit as plain text.

See also setText().

### Qt::TextFormat QTextEdit::textFormat () const

Returns the text format.

See also setTextFormat().

### bool QTextEdit::underline () const

Use fontUnderline() instead.

See also setUnderline().

### void QTextEdit::undo () const

This is an overloaded member function, provided for convenience.

Use the non-const overload instead.