Qt 5.6 | Qt Widgets | C++ Classes | QTextEdit

Qt 5.6.2 Reference Documentation

# QTextEdit Class

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

Header: | #include <QTextEdit>
qmake: | QT += widgets
Inherits: | QAbstractScrollArea
Inherited By: | QTextBrowser

- List of all members, including inherited members

## Public Types

class | ExtraSelection
flags | AutoFormatting
enum | AutoFormattingFlag { AutoNone, AutoBulletList, AutoAll }
enum | LineWrapMode { NoWrap, WidgetWidth, FixedPixelWidth, FixedColumnWidth }

## Properties

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

- 3 properties inherited from QAbstractScrollArea
- 6 properties inherited from QFrame
- 58 properties inherited from QWidget

## Public Functions

| QTextEdit(QWidget *parent = Q_NULLPTR)
| QTextEdit(const QString &text, QWidget *parent = Q_NULLPTR)
virtual | ~QTextEdit()
bool | acceptRichText() const
Qt::Alignment | alignment() const
QString | anchorAt(const QPoint &pos) const
AutoFormatting | autoFormatting() const
bool | canPaste() const
QMenu * | createStandardContextMenu()
QMenu * | createStandardContextMenu(const QPoint &position)
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 = QTextDocument::FindFlags())
bool | find(const QRegExp &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())
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
QString | placeholderText() const
void | print(QPagedPaintDevice *printer) 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 | setPlaceholderText(const QString &placeholderText)
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 | textBackgroundColor() const
QColor | textColor() const
QTextCursor | textCursor() const
Qt::TextInteractionFlags | textInteractionFlags() const
QString | toHtml() const
QString | toPlainText() const
QTextOption::WrapMode | wordWrapMode() const

## Reimplemented Public Functions

virtual QVariant | inputMethodQuery(Qt::InputMethodQuery property) const

- 20 public functions inherited from QAbstractScrollArea
- 14 public functions inherited from QFrame
- 211 public functions inherited from QWidget

## 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 | setTextBackgroundColor(const QColor &c)
void | setTextColor(const QColor &c)
void | undo()
void | zoomIn(int range = 1)
void | zoomOut(int range = 1)

- 19 public slots inherited from QWidget

## Signals

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

- 3 signals inherited from QWidget

## Protected Functions

virtual bool | canInsertFromMimeData(const QMimeData *source) const
virtual QMimeData * | createMimeDataFromSelection() const
virtual void | insertFromMimeData(const QMimeData *source)

## Reimplemented Protected Functions

virtual void | changeEvent(QEvent *e)
virtual void | contextMenuEvent(QContextMenuEvent *event)
virtual void | dragEnterEvent(QDragEnterEvent *e)
virtual void | dragLeaveEvent(QDragLeaveEvent *e)
virtual void | dragMoveEvent(QDragMoveEvent *e)
virtual void | dropEvent(QDropEvent *e)
virtual void | focusInEvent(QFocusEvent *e)
virtual bool | focusNextPrevChild(bool next)
virtual void | focusOutEvent(QFocusEvent *e)
virtual void | inputMethodEvent(QInputMethodEvent *e)
virtual void | keyPressEvent(QKeyEvent *e)
virtual void | keyReleaseEvent(QKeyEvent *e)
virtual void | mouseDoubleClickEvent(QMouseEvent *e)
virtual void | mouseMoveEvent(QMouseEvent *e)
virtual void | mousePressEvent(QMouseEvent *e)
virtual void | mouseReleaseEvent(QMouseEvent *e)
virtual void | paintEvent(QPaintEvent *event)
virtual void | resizeEvent(QResizeEvent *e)
virtual void | scrollContentsBy(int dx, int dy)
virtual void | showEvent(QShowEvent *)
virtual void | wheelEvent(QWheelEvent *e)

- 20 protected functions inherited from QAbstractScrollArea
- 4 protected functions inherited from QFrame
- 35 protected functions inherited from QWidget

### Additional Inherited Members

- 5 static public members inherited from QWidget
- 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

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, scroll bars will appear. The text edit can load both plain text and rich text files. Rich text is described using a subset of HTML 4 markup, refer to the Supported HTML Subset page for more information.

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

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. If you find the HTML support insufficient for your needs you may consider the use of Qt WebKit, which provides a full-featured web browser widget.

The shape of the mouse cursor on a QTextEdit is Qt::IBeamCursor by default. It can be changed through the viewport()'s cursor property.

### 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 for example it is often 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
--- | ---
Up | Moves one line up.
Down | Moves one line down.
Left | Moves one character to the left.
Right | 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.

Note: Zooming into HTML documents only works if the font-size is not set to a fixed size.

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

The textChanged() signal is emitted whenever the text changes (as a result of setText() or through the editor itself).

QTextEdit holds a QTextDocument object which can be retrieved using the document() method. You can also set your own document object using setDocument().

QTextDocument provides an 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.

#### Drag and Drop

QTextEdit also supports custom drag and drop behavior. By default, QTextEdit will insert plain text, HTML and rich text when the user drops data of these MIME types onto a document. Reimplement canInsertFromMimeData() and insertFromMimeData() to add support for additional MIME types.

For example, to allow the user to drag and drop an image onto a QTextEdit, you could the implement these functions in the following way:

      bool TextEdit::canInsertFromMimeData( const QMimeData *source ) const
      {
          if (source->hasImage())
              return true;
          else
              return QTextEdit::canInsertFromMimeData(source);
      }

We add support for image MIME types by returning true. For all other MIME types, we use the default implementation.

      void TextEdit::insertFromMimeData( const QMimeData *source )
      {
          if (source->hasImage())
          {
              QImage image = qvariant_cast<QImage>(source->imageData());
              QTextCursor cursor = this->textCursor();
              QTextDocument *document = this->document();
              document->addResource(QTextDocument::ImageResource, QUrl("image"), image);
              cursor.insertImage("image");
          }
      }

We unpack the image from the QVariant held by the MIME source and insert it into the document as a resource.

#### 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.
Left | Moves the cursor one character to the left.
Ctrl+Left | Moves the cursor one word to the left.
Right | Moves the cursor one character to the right.
Ctrl+Right | Moves the cursor one word to the right.
Up | Moves the cursor one line up.
Down | Moves the cursor one line 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).

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

See also QTextDocument, QTextCursor, Application Example, Syntax Highlighter Example, and Rich Text Processing.

## 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::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)

### document : QTextDocument *

This property holds the underlying document of the text editor.

Note: The editor does not take ownership of the document unless it is the document's parent object. The parent object of the provided document remains the owner of the object. If the previously assigned document is a child of the editor then it will be deleted.

Access functions:

QTextDocument * | document() const
void | setDocument(QTextDocument *document)

### documentTitle : QString

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

By default, for a newly-created, empty document, this property contains an empty string.

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 and the undo/redo history is cleared. The input text is interpreted as rich text in html format.

Note: It is the responsibility of the caller to make sure that the text is correctly decoded when a QString containing HTML is created and passed to setHtml().

By default, for a newly-created, empty document, this property contains text to describe an HTML 4.0 document with no body text.

Access functions:

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

Notifier signal:

void | textChanged()

See also Supported HTML Subset and plainText.

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

By default, this property contains a value of 0.

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 setWordWrapMode(). If you set a wrap mode of FixedPixelWidth or FixedColumnWidth you should also call setLineWrapColumnOrWidth() with the width you want.

Access functions:

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

See also lineWrapColumnOrWidth.

### overwriteMode : bool

This property holds whether text entered by the user will overwrite existing text.

As with many text editors, the text editor widget can be configured to insert or overwrite existing text with new text entered by the user.

If this property is `true`, existing text is overwritten, character-for-character by new text; otherwise, text is inserted at the cursor position, displacing existing text.

By default, this property is `false` (new text does not overwrite existing text).

This property was introduced in Qt 4.1.

Access functions:

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

### placeholderText : QString

This property holds the editor placeholder text.

Setting this property makes the editor display a grayed-out placeholder text as long as the document() is empty.

By default, this property contains an empty string.

This property was introduced in Qt 5.2.

Access functions:

QString | placeholderText() const
void | setPlaceholderText(const QString &placeholderText)

See also document().

### plainText : QString

This property gets and sets the text editor's contents as plain text. Previous contents are removed and undo/redo history is reset when the property is set.

If the text edit has another content type, it will not be replaced by plain text if you call toPlainText(). The only exception to this is the non-break space, nbsp;, that will be converted into standard space.

By default, for an editor with no contents, this property contains an empty string.

This property was introduced in Qt 4.3.

Access functions:

QString | toPlainText() const
void | setPlainText(const QString &text)

See also html.

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

By default, this property contains a value of 80 pixels.

This property was introduced in Qt 4.1.

Access functions:

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

### textInteractionFlags : Qt::TextInteractionFlags

Specifies how the widget should interact with user input.

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.

By default, this property is set to QTextOption::WrapAtWordBoundaryOrAnywhere.

Access functions:

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

See also QTextOption::WrapMode.

## Member Function Documentation

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

Constructs an empty QTextEdit with parent parent.

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

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

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

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.

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

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

Note: The new paragraph appended will have the same character format and block format as the current paragraph, determined by the position of the cursor.

See also currentCharFormat() and QTextCursor::blockFormat().

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

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 and drop operation.

Reimplement this function to enable drag and drop support for additional MIME types.

### bool QTextEdit::canPaste() const

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

This function was introduced in Qt 4.2.

### `[virtual protected]` void QTextEdit::changeEvent(QEvent *e)

Reimplemented from QWidget::changeEvent().

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

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

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

Reimplemented from QWidget::contextMenuEvent().

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 the event object.

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

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

Copies any selected text to the clipboard.

See also copyAvailable().

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

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

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

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 copied 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 text edit with the right mouse button. It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.

We recommend that you use the createStandardContextMenu(QPoint) version instead which will enable the actions that are sensitive to where the user clicked.

### QMenu *QTextEdit::createStandardContextMenu(const QPoint &position)

This function creates the standard context menu which is shown when the user clicks on the text edit with the right mouse button. It is called from the default contextMenuEvent() handler and it takes the position in document coordinates where the mouse click was. This can enable actions that are sensitive to the position where the user clicked. The popup menu's ownership is transferred to the caller.

This function was introduced in Qt 4.4.

### QTextCharFormat QTextEdit::currentCharFormat() const

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

See also setCurrentCharFormat().

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

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

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

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

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

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

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

### `[virtual protected]` void QTextEdit::dragEnterEvent(QDragEnterEvent *e)

Reimplemented from QWidget::dragEnterEvent().

### `[virtual protected]` void QTextEdit::dragLeaveEvent(QDragLeaveEvent *e)

Reimplemented from QWidget::dragLeaveEvent().

### `[virtual protected]` void QTextEdit::dragMoveEvent(QDragMoveEvent *e)

Reimplemented from QWidget::dragMoveEvent().

### `[virtual protected]` void QTextEdit::dropEvent(QDropEvent *e)

Reimplemented from QWidget::dropEvent().

### 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 = QTextDocument::FindFlags())

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

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

This is an overloaded function.

Finds the next occurrence, matching the regular expression, exp, using the given options. The QTextDocument::FindCaseSensitively option is ignored for this overload, use QRegExp::caseSensitivity instead.

Returns `true` if a match was found and changes the cursor to select the match; otherwise returns `false`.

This function was introduced in Qt 5.3.

### `[virtual protected]` void QTextEdit::focusInEvent(QFocusEvent *e)

Reimplemented from QWidget::focusInEvent().

### `[virtual protected]` bool QTextEdit::focusNextPrevChild(bool next)

Reimplemented from QWidget::focusNextPrevChild().

### `[virtual protected]` void QTextEdit::focusOutEvent(QFocusEvent *e)

Reimplemented from QWidget::focusOutEvent().

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

### `[virtual protected]` void QTextEdit::inputMethodEvent(QInputMethodEvent *e)

Reimplemented from QWidget::inputMethodEvent().

### `[virtual]` QVariant QTextEdit::inputMethodQuery(Qt::InputMethodQuery property) const

Reimplemented from QWidget::inputMethodQuery().

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

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.

Reimplement this function to enable drag and drop support for additional MIME types.

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

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);

Note: When using this function with a style sheet, the style sheet will only apply to the current block in the document. In order to apply a style sheet throughout a document, use QTextDocument::setDefaultStyleSheet() instead.

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

Convenience slot that inserts text at the current cursor position.

It is equivalent to

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

### `[virtual protected]` void QTextEdit::keyPressEvent(QKeyEvent *e)

Reimplemented from QWidget::keyPressEvent().

### `[virtual protected]` void QTextEdit::keyReleaseEvent(QKeyEvent *e)

Reimplemented from QWidget::keyReleaseEvent().

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

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

### `[virtual protected]` void QTextEdit::mouseDoubleClickEvent(QMouseEvent *e)

Reimplemented from QWidget::mouseDoubleClickEvent().

### `[virtual protected]` void QTextEdit::mouseMoveEvent(QMouseEvent *e)

Reimplemented from QWidget::mouseMoveEvent().

### `[virtual protected]` void QTextEdit::mousePressEvent(QMouseEvent *e)

Reimplemented from QWidget::mousePressEvent().

### `[virtual protected]` void QTextEdit::mouseReleaseEvent(QMouseEvent *e)

Reimplemented from QWidget::mouseReleaseEvent().

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

### `[virtual protected]` void QTextEdit::paintEvent(QPaintEvent *event)

Reimplemented from QWidget::paintEvent().

This event handler can be reimplemented in a subclass to receive paint events passed in event. It is usually unnecessary to reimplement this function in a subclass of QTextEdit.

Warning: The underlying text document must not be modified from within a reimplementation of this function.

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

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::print(QPagedPaintDevice *printer) const

Convenience function to print the text edit's document to the given printer. This is equivalent to calling the print method on the document directly except that this function also supports QPrinter::Selection as print range.

This function was introduced in Qt 4.3.

See also QTextDocument::print().

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

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

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

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

### `[virtual protected]` void QTextEdit::resizeEvent(QResizeEvent *e)

Reimplemented from QWidget::resizeEvent().

### `[virtual protected]` void QTextEdit::scrollContentsBy(int dx, int dy)

Reimplemented from QAbstractScrollArea::scrollContentsBy().

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

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.

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

Selects all text.

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

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

This signal is emitted whenever the selection changes.

See also copyAvailable().

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

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

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

Sets the font of the current format to f.

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

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

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

Sets the font family of the current format to fontFamily.

See also fontFamily() and setCurrentFont().

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

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

See also fontItalic().

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

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

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

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

See also fontUnderline().

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

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

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

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.

Note: Setter function for property plainText.

See also toPlainText().

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

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 toPlainText() and toHtml().

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

Sets the text background color of the current format to c.

This function was introduced in Qt 4.4.

See also textBackgroundColor().

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

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

### `[virtual protected]` void QTextEdit::showEvent(QShowEvent *)

Reimplemented from QWidget::showEvent().

### QColor QTextEdit::textBackgroundColor() const

Returns the text background color of the current format.

This function was introduced in Qt 4.4.

See also setTextBackgroundColor().

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

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

Note: Notifier signal for property html.

### 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

QString QTextEdit::toPlainText() const

Returns the text of the text edit as plain text.

Note: Getter function for property plainText.

See also QTextEdit::setPlainText().

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

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

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

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

### `[virtual protected]` void QTextEdit::wheelEvent(QWheelEvent *e)

Reimplemented from QWidget::wheelEvent().

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

Zooms in on the text 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().

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

This is an overloaded function.

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