| Home · All Classes · Modules |
The QTextEdit class provides a widget that is used to edit and display both plain and rich text. More...
Inherits QAbstractScrollArea.
Inherited by QTextBrowser.
The QTextEdit class provides a widget that is used to edit and display both plain and rich text.
QTextEdit is an advanced WYSIWYG viewer/editor supporting rich text formatting using HTML-style tags. It is optimized to handle large documents and to respond quickly to user input.
QTextEdit works on paragraphs and characters. A paragraph is a formatted string which is word-wrapped to fit into the width of the widget. By default when reading plain text, one newline signifies a paragraph. A document consists of zero or more paragraphs. The words in the paragraph are aligned in accordance with the paragraph's alignment. Paragraphs are separated by hard line breaks. Each character within a paragraph has its own attributes, for example, font and color.
QTextEdit can display images, lists and tables. If the text is too large to view within the text edit's viewport, scrollbars will appear. The text edit can load both plain text and HTML files (a subset of HTML 3.2 and 4).
If you just need to display a small piece of rich text use QLabel.
Note that we do not intend to add a full-featured web browser widget to Qt (because that would easily double Qt's size and only a few applications would benefit from it). The rich text support in Qt is designed to provide a fast, portable and efficient way to add reasonable online help facilities to applications, and to provide a basis for rich text editors.
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 text(), 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.
When QTextEdit is used read-only the key bindings are limited to navigation, and text may only be selected with the mouse:
| Keypresses | Action |
|---|---|
| Qt.UpArrow | Moves one line up. |
| Qt.DownArrow | Moves one line down. |
| Qt.LeftArrow | Moves one character to the left. |
| Qt.RightArrow | Moves one character to the right. |
| PageUp | Moves one (viewport) page up. |
| PageDown | Moves one (viewport) page down. |
| Home | Moves to the beginning of the text. |
| End | Moves to the end of the text. |
| Alt+Wheel | Scrolls the page horizontally (the Wheel is the mouse wheel). |
| Ctrl+Wheel | Zooms the text. |
| Ctrl+A | Selects all text. |
The text edit may be able to provide some meta-information. For example, the documentTitle() function will return the text from within HTML <title> tags.
All the information about using QTextEdit as a display widget also applies here.
The current char format's attributes are set with setFontItalic(), setFontWeight(), setFontUnderline(), setFontFamily(), setFontPointSize(), setTextColor() and setCurrentFont(). The current paragraph's alignment is set with setAlignment().
Selection of text is handled by the QTextCursor class, which provides functionality for creating selections, retrieving the text contents or deleting selections. You can retrieve the object that corresponds with the user-visible cursor using the textCursor() method. If you want to set a selection in QTextEdit just create one on a QTextCursor object and then make that cursor the visible cursor using setCursor(). The selection can be copied to the clipboard with copy(), or cut to the clipboard with cut(). The entire text can be selected using selectAll().
When the cursor is moved and the underlying formatting attributes change, the currentCharFormatChanged() signal is emitted to reflect the new attributes at the new cursor position.
QTextEdit holds a QTextDocument object which can be retrieved using the document() method. You can also set your own document object using setDocument(). QTextDocument emits a textChanged() signal if the text changes and it also provides a isModified() function which will return true if the text has been modified since it was either loaded or since the last call to setModified with false as argument. In addition it provides methods for undo and redo.
The list of key bindings which are implemented for editing:
| Keypresses | Action |
|---|---|
| Backspace | Deletes the character to the left of the cursor. |
| Delete | Deletes the character to the right of the cursor. |
| Ctrl+C | Copy the selected text to the clipboard. |
| Ctrl+Insert | Copy the selected text to the clipboard. |
| Ctrl+K | Deletes to the end of the line. |
| Ctrl+V | Pastes the clipboard text into text edit. |
| Shift+Insert | Pastes the clipboard text into text edit. |
| Ctrl+X | Deletes the selected text and copies it to the clipboard. |
| Shift+Delete | Deletes the selected text and copies it to the clipboard. |
| Ctrl+Z | Undoes the last operation. |
| Ctrl+Y | Redoes the last operation. |
| LeftArrow | Moves the cursor one character to the left. |
| Ctrl+LeftArrow | Moves the cursor one word to the left. |
| RightArrow | Moves the cursor one character to the right. |
| Ctrl+RightArrow | Moves the cursor one word to the right. |
| UpArrow | Moves the cursor one line up. |
| Ctrl+UpArrow | Moves the cursor one word up. |
| DownArrow | Moves the cursor one line down. |
| Ctrl+Down Arrow | Moves the cursor one word down. |
| PageUp | Moves the cursor one page up. |
| PageDown | Moves the cursor one page down. |
| Home | Moves the cursor to the beginning of the line. |
| Ctrl+Home | Moves the cursor to the beginning of the text. |
| End | Moves the cursor to the end of the line. |
| Ctrl+End | Moves the cursor to the end of the text. |
| Alt+Wheel | Scrolls the page horizontally (the Wheel is the mouse wheel). |
| Ctrl+Wheel | Zooms the text. |
To select (mark) text hold down the Shift key whilst pressing one of the movement keystrokes, for example, Shift+Right Arrow will select the character to the right, and Shift+Ctrl+Right Arrow will select the word to the right, etc.
See also QTextDocument, QTextCursor, document(), textCursor(), setDocument(), and setTextCursor().
| 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.
| Constant | Value |
|---|---|
| QTextEdit.MoveBackward | 0 |
| QTextEdit.MoveForward | 1 |
| QTextEdit.MoveWordBackward | 2 |
| QTextEdit.MoveWordForward | 3 |
| QTextEdit.MoveUp | 4 |
| QTextEdit.MoveDown | 5 |
| QTextEdit.MoveLineStart | 6 |
| QTextEdit.MoveLineEnd | 7 |
| QTextEdit.MoveHome | 8 |
| QTextEdit.MoveEnd | 9 |
| QTextEdit.MovePageUp | 10 |
| QTextEdit.MovePageDown | 11 |
| Constant | Value |
|---|---|
| QTextEdit.NoWrap | 0 |
| QTextEdit.WidgetWidth | 1 |
| QTextEdit.FixedPixelWidth | 2 |
| QTextEdit.FixedColumnWidth | 3 |
The parent argument, if not None, causes self to be owned by Qt instead of PyQt.
Constructs an empty QTextEdit with parent parent.
The parent argument, if not None, causes self to be owned by Qt instead of PyQt.
Constructs a QTextEdit with parent parent. The text edit will display the text text. The text is interpreted as html.
Returns the alignment of the current paragraph.
See also setAlignment().
Returns the reference of the anchor at position pos, or an empty string if no anchor exists at that point.
Appends a new paragraph with text to the end of the text edit.
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.
This method is also a Qt slot with the C++ signature void 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().
Shows the standard context menu created with createStandardContextMenu().
If you do not want the text edit to have a context menu, you can set its contextMenuPolicy to Qt.NoContextMenu. If you want to customize the context menu, reimplement this function. If you want to extend the standard context menu, reimplement this function, call createStandardContextMenu() and extend the menu returned.
Information about the event is passed in e.
void TextEdit.contextMenuEvent(QContextMenuEvent * e) {
QMenu *menu = createStandardContextMenu();
menu->addAction(My Menu Item");
//...
menu->exec(e->globalPos());
delete menu;
}
Reimplemented from QWidget.
This method is also a Qt slot with the C++ signature void copy().
Copies any selected text to the clipboard.
See also copyAvailable().
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.
This function creates the standard context menu which is shown when the user clicks on the line edit with the right mouse button. It is called from the default contextMenuEvent() handler. The popup menu's ownership is transferred to the caller.
Returns the char format that is used when inserting new text.
See also setCurrentCharFormat().
Returns the font of the current format.
See also setCurrentFont(), setFontFamily(), and setFontPointSize().
returns a QTextCursor at position pos (in viewport coordinates).
returns a rectangle (in viewport coordinates) that includes the cursor.
This is an overloaded member function, provided for convenience.
returns a rectangle (in viewport coordinates) that includes the cursor of the text edit.
This method is also a Qt slot with the C++ signature void cut().
Copies the selected text to the clipboard and deletes it from the text edit.
If there is no selected text nothing happens.
Returns a pointer to the underlying document.
See also setDocument().
Ensures that the cursor is visible by scrolling the text edit if necessary.
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.
Returns the font family of the current format.
See also setFontFamily(), setCurrentFont(), and setFontPointSize().
Returns true if the font of the current format is italic; otherwise returns false.
See also setFontItalic().
Returns the point size of the font of the current format.
See also setFontFamily(), setCurrentFont(), and setFontPointSize().
Returns true if the font of the current format is underlined; otherwise returns false.
See also setFontUnderline().
Returns the font weight of the current format.
See also setFontWeight(), setCurrentFont(), setFontPointSize(), and QFont.Weight.
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.
This method is also a Qt slot with the C++ signature void insertHtml(const QString&).
Convenience slot that inserts text which is assumed to be of html formatting at the current cursor position.
It is equivalent to:
QTextDocumentFragment fragment = QTextDocumentFragment.fromHtml(text);
edit->textCursor().insertFragment(fragment);
This method is also a Qt slot with the C++ signature void insertPlainText(const QString&).
Convenience slot that inserts text at the current cursor position.
It is equivalent to
edit->textCursor().insertText(text);
Loads the resource specified by the given type and name.
This function is an extension of QTextDocument.loadResource().
See also QTextDocument.loadResource().
If the editor has a selection then the properties of modifier are applied to the selection. Without a selection the properties are applied to the word under the cursor. In addition they are always merged into the current char format.
See also QTextCursor.mergeCharFormat().
This method is also a Qt slot with the C++ signature void 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.
This method is also a Qt slot with the C++ signature void scrollToAnchor(const QString&).
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.
This method is also a Qt slot with the C++ signature void selectAll().
Selects all text.
See also copy(), cut(), and textCursor().
This method is also a Qt slot with the C++ signature void setAlignment(Qt::Alignment).
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().
Sets the char format that is be used when inserting new text to format .
See also currentCharFormat().
This method is also a Qt slot with the C++ signature void setCurrentFont(const QFont&).
Sets the font of the current format to f.
See also currentFont(), setFontPointSize(), and setFontFamily().
Makes document the new document of the text editor.
The parent QObject of the provided document remains the owner of the object. If the current document is a child of the text editor, then it is deleted.
See also document().
This method is also a Qt slot with the C++ signature void setFontFamily(const QString&).
Sets the font family of the current format to fontFamily.
See also fontFamily() and setCurrentFont().
This method is also a Qt slot with the C++ signature void setFontItalic(bool).
If italic is true, sets the current format to italic; otherwise sets the current format to non-italic.
See also fontItalic().
This method is also a Qt slot with the C++ signature void setFontPointSize(double).
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().
This method is also a Qt slot with the C++ signature void setFontUnderline(bool).
If underline is true, sets the current format to underline; otherwise sets the current format to non-underline.
See also fontUnderline().
This method is also a Qt slot with the C++ signature void setFontWeight(int).
Sets the font weight of the current format to w.
See also fontWeight(), setCurrentFont(), setFontFamily(), and QFont.Weight.
This method is also a Qt slot with the C++ signature void setHtml(const QString&).
This method is also a Qt slot with the C++ signature void setPlainText(const QString&).
Changes the text of the text edit to the string text. Any previous text is removed.
text is interpreted as plain text.
Note that the undo/redo history is cleared by this function.
See also toPlainText().
This method is also a Qt slot with the C++ signature void setTextColor(const QColor&).
Sets the text color of the current format to c.
See also textColor().
Sets the visible cursor.
See also textCursor().
Returns the text color of the current format.
See also setTextColor().
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().
Returns the text of the text edit as plain text.
See also QTextEdit.setPlainText().
This method is also a Qt slot with the C++ signature void zoomIn(int = 1).
Zooms in on the text by by making the base font size range points larger and recalculating all font sizes to be the new size. This does not change the size of any images.
See also zoomOut().
This method is also a Qt slot with the C++ signature void zoomOut(int = 1).
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().
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().
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().
This signal is emitted whenever the position of the cursor changed.
This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).
This signal is emitted whenever the selection changes.
See also copyAvailable().
This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.
This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).
| PyQt 4.0.1 for X11 | Copyright © Riverbank Computing Ltd and Trolltech AS 2006 | Qt 4.1.4 |