QTextEdit Class Reference

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

  1. #include <QTextEdit>

Inherits: QAbstractScrollArea.

Inherited by: QTextBrowser.

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 HTML files (a subset of HTML 3.2 and 4).

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 QtWebKit, 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 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:

KeypressesAction
UpMoves one line up.
DownMoves one line down.
LeftMoves one character to the left.
RightMoves one character to the right.
PageUpMoves one (viewport) page up.
PageDownMoves one (viewport) page down.
HomeMoves to the beginning of the text.
EndMoves to the end of the text.
Alt+WheelScrolls the page horizontally (the Wheel is the mouse wheel).
Ctrl+WheelZooms the text.
Ctrl+ASelects 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 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.

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.

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:

  1. bool TextEdit::canInsertFromMimeData( const QMimeData *source ) const
  2.  {
  3.     if (source->hasImage())
  4.         return true;
  5.     else
  6.         return QTextEdit::canInsertFromMimeData(source);
  7. }

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

  1. void TextEdit::insertFromMimeData( const QMimeData *source )
  2.  {
  3.     if (source->hasImage())
  4.      {
  5.         QImage image = qvariant_cast<QImage>(source->imageData());
  6.         QTextCursor cursor = this->textCursor();
  7.         QTextDocument *document = this->document();
  8.         document->addResource(QTextDocument::ImageResource, QUrl("image"), image);
  9.         cursor.insertImage("image");
  10.     }
  11. }

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:

KeypressesAction
BackspaceDeletes the character to the left of the cursor.
DeleteDeletes the character to the right of the cursor.
Ctrl+CCopy the selected text to the clipboard.
Ctrl+InsertCopy the selected text to the clipboard.
Ctrl+KDeletes to the end of the line.
Ctrl+VPastes the clipboard text into text edit.
Shift+InsertPastes the clipboard text into text edit.
Ctrl+XDeletes the selected text and copies it to the clipboard.
Shift+DeleteDeletes the selected text and copies it to the clipboard.
Ctrl+ZUndoes the last operation.
Ctrl+YRedoes the last operation.
LeftMoves the cursor one character to the left.
Ctrl+LeftMoves the cursor one word to the left.
RightMoves the cursor one character to the right.
Ctrl+RightMoves the cursor one word to the right.
UpMoves the cursor one line up.
DownMoves the cursor one line down.
PageUpMoves the cursor one page up.
PageDownMoves the cursor one page down.
HomeMoves the cursor to the beginning of the line.
Ctrl+HomeMoves the cursor to the beginning of the text.
EndMoves the cursor to the end of the line.
Ctrl+EndMoves the cursor to the end of the text.
Alt+WheelScrolls 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.

Public Types

Toggle detailsenum QTextEdit::

AutoFormattingFlagAutoFormattingFlag { AutoNone , AutoBulletList , AutoAll 0xffffffff ...} { AutoNone , AutoBulletList , AutoAll 0xffffffff }

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

Look up this member in the source code.

Toggle detailsenum QTextEdit::

LineWrapModeLineWrapMode { NoWrap , WidgetWidth , FixedPixelWidth , FixedColumnWidth 3 ...} { NoWrap , WidgetWidth , FixedPixelWidth , FixedColumnWidth 3 }

ConstantValue
QTextEdit::NoWrap 0
QTextEdit::WidgetWidth 1
QTextEdit::FixedPixelWidth 2
QTextEdit::FixedColumnWidth 3

Look up this member in the source code.

Toggle detailsenum QTextEdit::

CursorActionCursorAction { MoveBackward , MoveForward , MoveWordBackward , MoveWordForward , MoveUp , MoveDown , MoveLineStart , MoveLineEnd , MoveHome , MoveEnd , MovePageUp , MovePageDown , MovePgUp , MovePgDown MovePageDown ...} { MoveBackward , MoveForward , MoveWordBackward , MoveWordForward , MoveUp , MoveDown , MoveLineStart , MoveLineEnd , MoveHome , MoveEnd , MovePageUp , MovePageDown , MovePgUp , MovePgDown MovePageDown }Qt3-support

ConstantValue
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

Look up this member in the source code.

Toggle detailsenum QTextEdit::

KeyboardActionKeyboardAction { ActionBackspace , ActionDelete , ActionReturn , ActionKill , ActionWordBackspace , ActionWordDelete 5 ...} { ActionBackspace , ActionDelete , ActionReturn , ActionKill , ActionWordBackspace , ActionWordDelete 5 }Qt3-support

ConstantValue
QTextEdit::ActionBackspace 0
QTextEdit::ActionDelete 1
QTextEdit::ActionReturn 2
QTextEdit::ActionKill 3
QTextEdit::ActionWordBackspace 4
QTextEdit::ActionWordDelete 5

Look up this member in the source code.

Properties

Toggle detailsacceptRichTextacceptRichText : 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.

Access functions:

Look up this member in the source code.

Toggle detailsautoFormattingautoFormatting : 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:

Look up this member in the source code.

Toggle detailscursorWidthcursorWidth : int

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

Access functions:

Look up this member in the source code.

Toggle detailsdocumentTitledocumentTitle : 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:

Look up this member in the source code.

Toggle detailshtmlhtml : 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.

See also Supported HTML Subset and plainText.

Access functions:

Look up this member in the source code.

Toggle detailslineWrapColumnOrWidthlineWrapColumnOrWidth : 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.

See also lineWrapMode.

Access functions:

Look up this member in the source code.

Toggle detailslineWrapModelineWrapMode : 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.

See also lineWrapColumnOrWidth.

Access functions:

Look up this member in the source code.

Toggle detailsoverwriteModeoverwriteMode : 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).

Access functions:

Look up this member in the source code.

Toggle detailsplainTextplainText : 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.

See also html.

Access functions:

Look up this member in the source code.

Toggle detailsreadOnlyreadOnly : 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:

Look up this member in the source code.

Toggle detailstabChangesFocustabChangesFocus : 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:

Look up this member in the source code.

Toggle detailstabStopWidthtabStopWidth : int

This property holds the tab stop width in pixels

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

Access functions:

Look up this member in the source code.

Toggle detailstextInteractionFlagstextInteractionFlags : 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.

Access functions:

Look up this member in the source code.

Toggle detailsundoRedoEnabledundoRedoEnabled : 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:

Look up this member in the source code.

Toggle detailswordWrapModewordWrapMode : QTextOption::WrapMode

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

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

See also QTextOption::WrapMode.

Access functions:

Look up this member in the source code.

    Public Functions

    Toggle details QTextEdit

    QTextEditQTextEdit ( QWidget *parent=0 ) ( QWidget *parent=0 )

    Constructs an empty QTextEdit with parent parent.

    Look up this member in the source code.

    Toggle details QTextEdit

    QTextEditQTextEdit ( const QString &text , QWidget *parent=0 ...) ( 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.

    Look up this member in the source code.

    Toggle details QTextEdit

    ~QTextEdit~QTextEdit () () [virtual]

    Destructor.

    Look up this member in the source code.

    Toggle details Qt::Alignment QTextEdit

    alignmentalignment () ()const

    Returns the alignment of the current paragraph.

    See also setAlignment().

    Look up this member in the source code.

    Toggle details QString QTextEdit

    anchorAtanchorAt ( const QPoint &pos ) ( const QPoint &pos )const

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

    Look up this member in the source code.

    Toggle details bool QTextEdit

    canInsertFromMimeDatacanInsertFromMimeData ( const QMimeData *source ...) ( 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 and drop operation.

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

    Look up this member in the source code.

    Toggle details bool QTextEdit

    canPastecanPaste () ()const

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    changeEventchangeEvent ( QEvent *e ) ( QEvent *e ) [virtual protected]

    Reimplemented from QWidget::changeEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    contextMenuEventcontextMenuEvent ( QContextMenuEvent *event ) ( QContextMenuEvent *event ) [virtual protected]

    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.

    1. void MyTextEdit::contextMenuEvent(QContextMenuEvent *event)
    2.  {
    3.     QMenu *menu = createStandardContextMenu();
    4.     menu->addAction(tr("My Menu Item"));
    5.     //...
    6.     menu->exec(event->globalPos());
    7.     delete menu;
    8. }

    Look up this member in the source code.

    Toggle details QMimeData * QTextEdit

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

    Look up this member in the source code.

    Toggle details QMenu * QTextEdit

    createStandardContextMenucreateStandardContextMenu () ()

    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.

    Look up this member in the source code.

    Toggle details QMenu * QTextEdit

    createStandardContextMenucreateStandardContextMenu ( const QPoint &position ...) ( 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 of 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.

    Look up this member in the source code.

    Toggle details QTextCharFormat QTextEdit

    currentCharFormatcurrentCharFormat () ()const

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

    See also setCurrentCharFormat().

    Look up this member in the source code.

    Toggle details QFont QTextEdit

    currentFontcurrentFont () ()const

    Returns the font of the current format.

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

    Look up this member in the source code.

    Toggle details QTextCursor QTextEdit

    cursorForPositioncursorForPosition ( const QPoint &pos ) ( const QPoint &pos )const

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

    Look up this member in the source code.

    Toggle details QRect QTextEdit

    cursorRectcursorRect ( const QTextCursor &cursor ) ( const QTextCursor &cursor )const

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

    Look up this member in the source code.

    Toggle details QRect QTextEdit

    cursorRectcursorRect () ()const

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

    Look up this member in the source code.

    Toggle details QTextDocument * QTextEdit

    documentdocument () ()const

    Returns a pointer to the underlying document.

    See also setDocument().

    Look up this member in the source code.

    Toggle details void QTextEdit

    dragEnterEventdragEnterEvent ( QDragEnterEvent *e ) ( QDragEnterEvent *e ) [virtual protected]

    Reimplemented from QWidget::dragEnterEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    dragLeaveEventdragLeaveEvent ( QDragLeaveEvent *e ) ( QDragLeaveEvent *e ) [virtual protected]

    Reimplemented from QWidget::dragLeaveEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    dragMoveEventdragMoveEvent ( QDragMoveEvent *e ) ( QDragMoveEvent *e ) [virtual protected]

    Reimplemented from QWidget::dragMoveEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    dropEventdropEvent ( QDropEvent *e ) ( QDropEvent *e ) [virtual protected]

    Reimplemented from QWidget::dropEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    ensureCursorVisibleensureCursorVisible () ()

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

    Look up this member in the source code.

    Toggle details QList <ExtraSelection > QTextEdit

    extraSelectionsextraSelections () ()const

    Returns previously set extra selections.

    See also setExtraSelections().

    Look up this member in the source code.

    Toggle details bool QTextEdit

    findfind ( const QString &exp , QTextDocument::FindFlags options=0 ...) ( 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.

    Look up this member in the source code.

    Toggle details void QTextEdit

    focusInEventfocusInEvent ( QFocusEvent *e ) ( QFocusEvent *e ) [virtual protected]

    Reimplemented from QWidget::focusInEvent().

    Look up this member in the source code.

    Toggle details bool QTextEdit

    focusNextPrevChildfocusNextPrevChild ( bool next ) ( bool next ) [virtual protected]

    Reimplemented from QWidget::focusNextPrevChild().

    Look up this member in the source code.

    Toggle details void QTextEdit

    focusOutEventfocusOutEvent ( QFocusEvent *e ) ( QFocusEvent *e ) [virtual protected]

    Reimplemented from QWidget::focusOutEvent().

    Look up this member in the source code.

    Toggle details QString QTextEdit

    fontFamilyfontFamily () ()const

    Returns the font family of the current format.

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

    Look up this member in the source code.

    Toggle details bool QTextEdit

    fontItalicfontItalic () ()const

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

    See also setFontItalic().

    Look up this member in the source code.

    Toggle details qreal QTextEdit

    fontPointSizefontPointSize () ()const

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

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

    Look up this member in the source code.

    Toggle details bool QTextEdit

    fontUnderlinefontUnderline () ()const

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

    See also setFontUnderline().

    Look up this member in the source code.

    Toggle details int QTextEdit

    fontWeightfontWeight () ()const

    Returns the font weight of the current format.

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    inputMethodEventinputMethodEvent ( QInputMethodEvent *e ) ( QInputMethodEvent *e ) [virtual protected]

    Reimplemented from QWidget::inputMethodEvent().

    Look up this member in the source code.

    Toggle details QVariant QTextEdit

    inputMethodQueryinputMethodQuery ( Qt::InputMethodQuery property ...) ( Qt::InputMethodQuery property )const [virtual protected]

    Reimplemented from QWidget::inputMethodQuery().

    Look up this member in the source code.

    Toggle details void QTextEdit

    insertFromMimeDatainsertFromMimeData ( const QMimeData *source ) ( 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.

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    keyPressEventkeyPressEvent ( QKeyEvent *e ) ( QKeyEvent *e ) [virtual protected]

    Reimplemented from QWidget::keyPressEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    keyReleaseEventkeyReleaseEvent ( QKeyEvent *e ) ( QKeyEvent *e ) [virtual protected]

    Reimplemented from QWidget::keyReleaseEvent().

    Look up this member in the source code.

    Toggle details QVariant QTextEdit

    loadResourceloadResource ( int type , const QUrl &name ) ( 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().

    Look up this member in the source code.

    Toggle details void QTextEdit

    mergeCurrentCharFormatmergeCurrentCharFormat ( const QTextCharFormat &modifier ...) ( 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().

    Look up this member in the source code.

    Toggle details void QTextEdit

    mouseDoubleClickEventmouseDoubleClickEvent ( QMouseEvent *e ) ( QMouseEvent *e ) [virtual protected]

    Reimplemented from QWidget::mouseDoubleClickEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    mouseMoveEventmouseMoveEvent ( QMouseEvent *e ) ( QMouseEvent *e ) [virtual protected]

    Reimplemented from QWidget::mouseMoveEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    mousePressEventmousePressEvent ( QMouseEvent *e ) ( QMouseEvent *e ) [virtual protected]

    Reimplemented from QWidget::mousePressEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    mouseReleaseEventmouseReleaseEvent ( QMouseEvent *e ) ( QMouseEvent *e ) [virtual protected]

    Reimplemented from QWidget::mouseReleaseEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    moveCursormoveCursor ( QTextCursor::MoveOperation operation , QTextCursor::MoveMode mode=QTextCursor::MoveAnchor ...) ( 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.

    See also QTextCursor::movePosition().

    Look up this member in the source code.

    Toggle details void QTextEdit

    paintEventpaintEvent ( QPaintEvent *event ) ( QPaintEvent *event ) [virtual protected]

    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.

    Look up this member in the source code.

    Toggle details void QTextEdit

    printprint ( QPrinter *printer ) ( QPrinter *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.

    See also QTextDocument::print().

    Look up this member in the source code.

    Toggle details void QTextEdit

    resizeEventresizeEvent ( QResizeEvent *e ) ( QResizeEvent *e ) [virtual protected]

    Reimplemented from QWidget::resizeEvent().

    Look up this member in the source code.

    Toggle details void QTextEdit

    scrollContentsByscrollContentsBy ( int dx , int dy ) ( int dx , int dy ) [virtual protected]

    Look up this member in the source code.

    Toggle details void QTextEdit

    setCurrentCharFormatsetCurrentCharFormat ( const QTextCharFormat &format ...) ( 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().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setDocumentsetDocument ( QTextDocument *document ) ( QTextDocument *document )

    Makes document the new 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.

    The editor does not delete the current document, even if it is a child of the editor.

    See also document().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setExtraSelectionssetExtraSelections ( const QList <ExtraSelection > &selections ...) ( 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.

    See also QTextEdit::ExtraSelection and extraSelections().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setTextCursorsetTextCursor ( const QTextCursor &cursor ) ( const QTextCursor &cursor )

    Sets the visible cursor.

    See also textCursor().

    Look up this member in the source code.

    Toggle details void QTextEdit

    showEventshowEvent ( QShowEvent * ) ( QShowEvent * ) [virtual protected]

    Reimplemented from QWidget::showEvent().

    Look up this member in the source code.

    Toggle details QColor QTextEdit

    textBackgroundColortextBackgroundColor () ()const

    Returns the text background color of the current format.

    See also setTextBackgroundColor().

    Look up this member in the source code.

    Toggle details QColor QTextEdit

    textColortextColor () ()const

    Returns the text color of the current format.

    See also setTextColor().

    Look up this member in the source code.

    Toggle details QTextCursor QTextEdit

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    wheelEventwheelEvent ( QWheelEvent *e ) ( QWheelEvent *e ) [virtual protected]

    Reimplemented from QWidget::wheelEvent().

    Look up this member in the source code.

    Toggle details QTextEdit

    QTextEditQTextEdit ( QWidget *parent , const char *name ) ( QWidget *parent , const char *name ) Qt3-support

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

    Look up this member in the source code.

    Toggle details bool QTextEdit

    boldbold () ()const Qt3-support

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

    See also setBold().

    Look up this member in the source code.

    Toggle details QColor QTextEdit

    colorcolor () ()const Qt3-support

    Use textColor() instead.

    See also setColor().

    Look up this member in the source code.

    Toggle details void QTextEdit

    doKeyboardActiondoKeyboardAction ( KeyboardAction action ) ( KeyboardAction action ) Qt3-support

    Executes keyboard action action.

    Use the QTextCursor class instead.

    See also textCursor().

    Look up this member in the source code.

    Toggle details QString QTextEdit

    familyfamily () ()const Qt3-support

    Use fontFamily() instead.

    See also setFamily().

    Look up this member in the source code.

    Toggle details bool QTextEdit

    findfind ( const QString &exp , bool cs , bool wo ) ( const QString &exp , bool cs , bool wo ) Qt3-support

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

    Look up this member in the source code.

    Toggle details bool QTextEdit

    hasSelectedTexthasSelectedText () ()const Qt3-support

    Use textCursor().hasSelection() instead.

    Look up this member in the source code.

    Toggle details void QTextEdit

    insertinsert ( const QString &text ) ( const QString &text ) Qt3-support

    Use insertPlainText() instead.

    Look up this member in the source code.

    Toggle details bool QTextEdit

    isModifiedisModified () ()const Qt3-support

    Use document()->isModified() instead.

    Look up this member in the source code.

    Toggle details bool QTextEdit

    isRedoAvailableisRedoAvailable () ()const Qt3-support

    Use document()->isRedoAvailable() instead.

    Look up this member in the source code.

    Toggle details bool QTextEdit

    isUndoAvailableisUndoAvailable () ()const Qt3-support

    Use document()->isUndoAvailable() instead.

    Look up this member in the source code.

    Toggle details bool QTextEdit

    italicitalic () ()const Qt3-support

    Use fontItalic() instead.

    See also setItalic().

    Look up this member in the source code.

    Toggle details void QTextEdit

    moveCursormoveCursor ( CursorAction action , QTextCursor::MoveMode mode=QTextCursor::MoveAnchor ...) ( CursorAction action , QTextCursor::MoveMode mode=QTextCursor::MoveAnchor ) Qt3-support

    Use the QTextCursor class instead.

    Look up this member in the source code.

    Toggle details void QTextEdit

    moveCursormoveCursor ( CursorAction action , bool select ) ( CursorAction action , bool select ) Qt3-support

    Use the QTextCursor class instead.

    Look up this member in the source code.

    Toggle details int QTextEdit

    pointSizepointSize () ()const Qt3-support

    Use int(fontPointSize()+0.5) instead.

    See also setPointSize().

    Look up this member in the source code.

    Toggle details void QTextEdit

    redoredo () ()const Qt3-support

    This is an overloaded function.

    Use the non-const overload instead.

    Look up this member in the source code.

    Toggle details QString QTextEdit

    selectedTextselectedText () ()const Qt3-support

    Use textCursor().selectedText() instead.

    Look up this member in the source code.

    Toggle details void QTextEdit

    setBoldsetBold ( bool b ) ( bool b ) Qt3-support

    Use setFontWeight() instead.

    See also bold().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setFamilysetFamily ( const QString &family ) ( const QString &family ) Qt3-support

    Use setFontFamily() instead.

    See also family().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setItalicsetItalic ( bool i ) ( bool i ) Qt3-support

    Use setFontItalic() instead.

    See also italic().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setPointSizesetPointSize ( int size ) ( int size ) Qt3-support

    Use setFontPointSize() instead.

    See also pointSize().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setTextFormatsetTextFormat ( Qt::TextFormat f ) ( Qt::TextFormat f ) Qt3-support

    Sets the text format to format f.

    See also textFormat().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setUnderlinesetUnderline ( bool b ) ( bool b ) Qt3-support

    Use setFontUnderline() instead.

    See also underline().

    Look up this member in the source code.

    Toggle details void QTextEdit

    syncsync () () Qt3-support

    Does nothing.

    Look up this member in the source code.

    Toggle details QString QTextEdit

    texttext () ()const Qt3-support

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

    See also setText().

    Look up this member in the source code.

    Toggle details Qt::TextFormat QTextEdit

    textFormattextFormat () ()const Qt3-support

    Returns the text format.

    See also setTextFormat().

    Look up this member in the source code.

    Toggle details bool QTextEdit

    underlineunderline () ()const Qt3-support

    Use fontUnderline() instead.

    See also setUnderline().

    Look up this member in the source code.

    Toggle details void QTextEdit

    undoundo () ()const Qt3-support

    This is an overloaded function.

    Use the non-const overload instead.

    Look up this member in the source code.

    Signals

    Toggle details void QTextEdit

    copyAvailablecopyAvailable ( bool yes ) ( 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().

    Look up this member in the source code.

    Toggle details void QTextEdit

    currentCharFormatChangedcurrentCharFormatChanged ( const QTextCharFormat &f ...) ( 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().

    Look up this member in the source code.

    Toggle details void QTextEdit

    cursorPositionChangedcursorPositionChanged () () [signal]

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    redoAvailableredoAvailable ( bool available ) ( bool available ) [signal]

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    selectionChangedselectionChanged () () [signal]

    This signal is emitted whenever the selection changes.

    See also copyAvailable().

    Look up this member in the source code.

    Toggle details void QTextEdit

    textChangedtextChanged () () [signal]

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    undoAvailableundoAvailable ( bool available ) ( bool available ) [signal]

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    currentColorChangedcurrentColorChanged ( const QColor &color ) ( const QColor &color ) [signal] Qt3-support

    Use currentCharFormatChanged() instead.

    Look up this member in the source code.

    Toggle details void QTextEdit

    currentFontChangedcurrentFontChanged ( const QFont &font ) ( const QFont &font ) [signal] Qt3-support

    Use currentCharFormatChanged() instead.

    Look up this member in the source code.

    Public Slots

    Toggle details void QTextEdit

    appendappend ( const QString &text ) ( const QString &text ) [slot]

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

    Look up this member in the source code.

    Toggle details void QTextEdit

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    copycopy () () [slot]

    Copies any selected text to the clipboard.

    See also copyAvailable().

    Look up this member in the source code.

    Toggle details void QTextEdit

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    insertHtmlinsertHtml ( const QString &text ) ( 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:

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    insertPlainTextinsertPlainText ( const QString &text ) ( const QString &text ) [slot]

    Convenience slot that inserts text at the current cursor position.

    It is equivalent to

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

    Look up this member in the source code.

    Toggle details void QTextEdit

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

    Look up this member in the source code.

    Toggle details void QTextEdit

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

    See also undo().

    Look up this member in the source code.

    Toggle details void QTextEdit

    scrollToAnchorscrollToAnchor ( const QString &name ) ( 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.

    Look up this member in the source code.

    Toggle details void QTextEdit

    selectAllselectAll () () [slot]

    Selects all text.

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    setAlignmentsetAlignment ( Qt::Alignment a ) ( 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().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setCurrentFontsetCurrentFont ( const QFont &f ) ( const QFont &f ) [slot]

    Sets the font of the current format to f.

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    setFontFamilysetFontFamily ( const QString &fontFamily ) ( const QString &fontFamily ) [slot]

    Sets the font family of the current format to fontFamily.

    See also fontFamily() and setCurrentFont().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setFontItalicsetFontItalic ( bool italic ) ( bool italic ) [slot]

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

    See also fontItalic().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setFontPointSizesetFontPointSize ( qreal s ) ( 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().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setFontUnderlinesetFontUnderline ( bool underline ) ( bool underline ) [slot]

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

    See also fontUnderline().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setFontWeightsetFontWeight ( int weight ) ( 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().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setTextsetText ( const QString &text ) ( 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.

    See also text(), toPlainText(), and toHtml().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setTextBackgroundColorsetTextBackgroundColor ( const QColor &c ) ( const QColor &c ) [slot]

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

    See also textBackgroundColor().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setTextColorsetTextColor ( const QColor &c ) ( const QColor &c ) [slot]

    Sets the text color of the current format to c.

    See also textColor().

    Look up this member in the source code.

    Toggle details void QTextEdit

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

    See also redo().

    Look up this member in the source code.

    Toggle details void QTextEdit

    zoomInzoomIn ( int range=1 ) ( int range=1 ) [slot]

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    zoomOutzoomOut ( int range=1 ) ( int range=1 ) [slot]

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

    Look up this member in the source code.

    Toggle details void QTextEdit

    setColorsetColor ( const QColor &color ) ( const QColor &color ) [slot] Qt3-support

    Use setTextColor() instead.

    See also color().

    Look up this member in the source code.

    Toggle details void QTextEdit

    setModifiedsetModified ( bool m=true ) ( bool m=true ) [slot] Qt3-support

    Use document->setModified() instead.

    See also isModified().

    Look up this member in the source code.

    Notes provided by the Qt Community
    Cool Hack
    • 5

    Votes: 6

    Coverage: Qt library 4.7, 4.8, 5.0

    Picture of Volker Volker

    Ant Farmer
    35 notes

    Nokia Certified Qt Developer

    Hide the cursor entirely

    If you want to entirely hide the cursor, call

    1. textEdit->setCursorWidth(0);

    [Revisions]

    Cool Hack
    • 5

    Votes: 2

    Coverage: Qt library 4.7, 4.8, Qt 5.0

    Picture of Zark Zark

    Lab Rat
    4 notes

    Alternative validation of a maximum permitted text length

    In a form validation we often control the maximum permitted text length that a user can enter. The code below is an alternative, it will change the color to gray to the text that is out of the limit instead of blocking the user input. In some cases this provides the user an easier way of adopting the text lenght. It can be used on other input widgets based on QTextDocument.

    1. class MyHighlighterMaxTextLenght : public QSyntaxHighlighter
    2. {
    3. Q_OBJECT
    4. public:
    5.     MyHighlighterMaxTextLenght(QTextDocument * pParent,const quint32& pMaxLenght)
    6.         :QSyntaxHighlighter(pParent),mMaxLenght(pMaxLenght)
    7.     {
    8.        
    9.     }
    10.     void highlightBlock(const QString& pText)
    11.     {
    12.         QTextCharFormat tQTextCharFormat;
    13.         tQTextCharFormat.setForeground(Qt::gray);
    14.  
    15.         if (pText.length() > mMaxLenght)
    16.         {
    17.             setFormat(mMaxLenght, pText.length()-mMaxLenght , tQTextCharFormat);
    18.         }
    19.     }
    20.     void mSetMaxLenght(const quint32& pMaxLenght)
    21.     {
    22.         mMaxLenght = pMaxLenght;
    23.         rehighlight();
    24.     }
    25. private:
    26.     quint32 mMaxLenght;    
    27. };

    Usage:

    1. MyHighlighterMaxTextLenght *  tHighligh = new MyHighlighterMaxTextLenght(tQTextEdit->document());

    [Revisions]