QTextEdit¶

Inheritance diagram of QTextEdit

Inherited by: QTextBrowser

Synopsis¶

Detailed Description¶

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

Introduction and Concepts¶

PySide.QtGui.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.

PySide.QtGui.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.

PySide.QtGui.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 PySide.QtGui.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 PySide.QtGui.QTextEdit is Qt.IBeamCursor by default. It can be changed through the PySide.QtGui.QAbstractScrollArea.viewport() ‘s cursor property.

Using QTextEdit as a Display Widget¶

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

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

Text itself can be inserted using the PySide.QtGui.QTextCursor class or using the convenience functions PySide.QtGui.QTextEdit.insertHtml() , PySide.QtGui.QTextEdit.insertPlainText() , PySide.QtGui.QTextEdit.append() or PySide.QtGui.QTextEdit.paste() . PySide.QtGui.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 PySide.QtGui.QTextEdit.setLineWrapMode() function is used to specify the kind of line wrap you want, or NoWrap if you don’t want any wrapping. Call PySide.QtGui.QTextEdit.setLineWrapMode() to set a fixed pixel width FixedPixelWidth , or character column (e.g. 80 column) FixedColumnWidth with the pixels or columns specified with PySide.QtGui.QTextEdit.setLineWrapColumnOrWidth() . If you use word wrap to the widget’s width WidgetWidth , you can specify whether to break on whitespace or anywhere with PySide.QtGui.QTextEdit.setWordWrapMode() .

The PySide.QtGui.QTextEdit.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 PySide.QtGui.QTextEdit , as it is for example open useful in a log viewer, then you can use PySide.QtGui.QTextDocument ‘s maximumBlockCount property for that.

Read-only Key Bindings¶

When PySide.QtGui.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 PySide.QtGui.QTextEdit.documentTitle() function will return the text from within HTML <title> tags.

Using QTextEdit as an Editor¶

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

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

Selection of text is handled by the PySide.QtGui.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 PySide.QtGui.QTextEdit.textCursor() method. If you want to set a selection in PySide.QtGui.QTextEdit just create one on a PySide.QtGui.QTextCursor object and then make that cursor the visible cursor using PySide.QtGui.QTextEdit.setTextCursor() . The selection can be copied to the clipboard with PySide.QtGui.QTextEdit.copy() , or cut to the clipboard with PySide.QtGui.QTextEdit.cut() . The entire text can be selected using PySide.QtGui.QTextEdit.selectAll() .

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

PySide.QtGui.QTextEdit holds a PySide.QtGui.QTextDocument object which can be retrieved using the PySide.QtGui.QTextEdit.document() method. You can also set your own document object using PySide.QtGui.QTextEdit.setDocument() . PySide.QtGui.QTextDocument emits a PySide.QtGui.QTextEdit.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¶

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

For example, to allow the user to drag and drop an image onto a PySide.QtGui.QTextEdit , you could the implement these functions in the following way:
def canInsertFromMimeData(source):
    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 PySide.QtCore.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

PySide.QtGui.QTextDocument PySide.QtGui.QTextCursor Application Example Syntax Highlighter Example Rich Text Processing

class PySide.QtGui.QTextEdit([parent=None])¶

class PySide.QtGui.QTextEdit(text[, parent=None])

Parameters:	parent – `PySide.QtGui.QWidget` text – unicode

Constructs an empty PySide.QtGui.QTextEdit with parent parent .

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

PySide.QtGui.QTextEdit.AutoFormattingFlag¶

Constant	Description
QTextEdit.AutoNone	Don’t do any automatic formatting.
QTextEdit.AutoBulletList	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	Apply all automatic formatting. Currently only automatic bullet lists are supported.

PySide.QtGui.QTextEdit.LineWrapMode¶

Constant	Description
QTextEdit.NoWrap
QTextEdit.WidgetWidth
QTextEdit.FixedPixelWidth
QTextEdit.FixedColumnWidth

PySide.QtGui.QTextEdit.acceptRichText()¶

Return type:	`PySide.QtCore.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.

PySide.QtGui.QTextEdit.alignment()¶

Return type:	`PySide.QtCore.Qt.Alignment`

Returns the alignment of the current paragraph.

See also

PySide.QtGui.QTextEdit.setAlignment()

PySide.QtGui.QTextEdit.anchorAt(pos)¶

Parameters:	pos – `PySide.QtCore.QPoint`
Return type:	unicode

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

PySide.QtGui.QTextEdit.append(text)¶

Parameters:	text – unicode

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.

PySide.QtGui.QTextEdit.autoFormatting()¶

Return type:	`PySide.QtGui.QTextEdit.AutoFormatting`

This property holds the enabled set of auto formatting features.

The value can be any combination of the values in the QTextEdit.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.

PySide.QtGui.QTextEdit.canInsertFromMimeData(source)¶

Parameters:	source – `PySide.QtCore.QMimeData`
Return type:	`PySide.QtCore.bool`

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.

PySide.QtGui.QTextEdit.canPaste()¶

Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QTextEdit.clear()¶

Deletes all the text in the text edit.

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

PySide.QtGui.QTextEdit.copy()¶: Copies any selected text to the clipboard.

See also

PySide.QtGui.QTextEdit.copyAvailable()

PySide.QtGui.QTextEdit.copyAvailable(b)¶

Parameters:	b – `PySide.QtCore.bool`

PySide.QtGui.QTextEdit.createMimeDataFromSelection()¶

Return type:	`PySide.QtCore.QMimeData`

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 PySide.QtCore.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 PySide.QtCore.QMimeData object is passed to the caller. The selection can be retrieved by using the PySide.QtGui.QTextEdit.textCursor() function.

PySide.QtGui.QTextEdit.createStandardContextMenu()¶

Return type:	`PySide.QtGui.QMenu`

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 PySide.QtGui.QTextEdit.contextMenuEvent() handler. The popup menu’s ownership is transferred to the caller.

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

PySide.QtGui.QTextEdit.createStandardContextMenu(position)

Parameters:	position – `PySide.QtCore.QPoint`
Return type:	`PySide.QtGui.QMenu`

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 PySide.QtGui.QTextEdit.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.

PySide.QtGui.QTextEdit.currentCharFormat()¶

Return type:	`PySide.QtGui.QTextCharFormat`

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

PySide.QtGui.QTextEdit.currentCharFormatChanged(format)¶

Parameters:	format – `PySide.QtGui.QTextCharFormat`

PySide.QtGui.QTextEdit.currentFont()¶

Return type:	`PySide.QtGui.QFont`

Returns the font of the current format.

PySide.QtGui.QTextEdit.cursorForPosition(pos)¶

Parameters:	pos – `PySide.QtCore.QPoint`
Return type:	`PySide.QtGui.QTextCursor`

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

PySide.QtGui.QTextEdit.cursorPositionChanged()¶

PySide.QtGui.QTextEdit.cursorRect()¶

Return type:	`PySide.QtCore.QRect`

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

PySide.QtGui.QTextEdit.cursorRect(cursor)

Parameters:	cursor – `PySide.QtGui.QTextCursor`
Return type:	`PySide.QtCore.QRect`

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

PySide.QtGui.QTextEdit.cursorWidth()¶

Return type:	`PySide.QtCore.int`

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

PySide.QtGui.QTextEdit.cut()¶

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

If there is no selected text nothing happens.

PySide.QtGui.QTextEdit.document()¶

Return type:	`PySide.QtGui.QTextDocument`

Returns a pointer to the underlying document.

See also

PySide.QtGui.QTextEdit.setDocument()

PySide.QtGui.QTextEdit.documentTitle()¶

Return type:	unicode

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.

PySide.QtGui.QTextEdit.ensureCursorVisible()¶: Ensures that the cursor is visible by scrolling the text edit if necessary.

PySide.QtGui.QTextEdit.extraSelections()¶

Return type:

Returns previously set extra selections.

PySide.QtGui.QTextEdit.find(exp[, options=0])¶

Parameters:	exp – unicode options – `PySide.QtGui.QTextDocument.FindFlags`
Return type:	`PySide.QtCore.bool`

PySide.QtGui.QTextEdit.fontFamily()¶

Return type:	unicode

Returns the font family of the current format.

PySide.QtGui.QTextEdit.fontItalic()¶

Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QTextEdit.fontPointSize()¶

Return type:	`PySide.QtCore.qreal`

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

PySide.QtGui.QTextEdit.fontUnderline()¶

Return type:	`PySide.QtCore.bool`

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

PySide.QtGui.QTextEdit.fontWeight()¶

Return type:	`PySide.QtCore.int`

Returns the font weight of the current format.

PySide.QtGui.QTextEdit.insertFromMimeData(source)¶

Parameters:	source – `PySide.QtCore.QMimeData`

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.

PySide.QtGui.QTextEdit.insertHtml(text)¶

Parameters:	text – unicode

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.

PySide.QtGui.QTextEdit.insertPlainText(text)¶

Parameters:	text – unicode

Convenience slot that inserts text at the current cursor position.

It is equivalent to

edit.textCursor().insertText(text)

PySide.QtGui.QTextEdit.isReadOnly()¶

Return type:	`PySide.QtCore.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.

PySide.QtGui.QTextEdit.isUndoRedoEnabled()¶

Return type:	`PySide.QtCore.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).

PySide.QtGui.QTextEdit.lineWrapColumnOrWidth()¶

Return type:	`PySide.QtCore.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

PySide.QtGui.QTextEdit.lineWrapMode()

PySide.QtGui.QTextEdit.lineWrapMode()¶

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

PySide.QtGui.QTextEdit.loadResource(type, name)¶

Parameters:	type – `PySide.QtCore.int` name – `PySide.QtCore.QUrl`
Return type:	object

Loads the resource specified by the given type and name .

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

See also

QTextDocument.loadResource()

PySide.QtGui.QTextEdit.mergeCurrentCharFormat(modifier)¶

Parameters:	modifier – `PySide.QtGui.QTextCharFormat`

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

PySide.QtGui.QTextEdit.moveCursor(operation[, mode=QTextCursor.MoveAnchor])¶

Parameters:	operation – `PySide.QtGui.QTextCursor.MoveOperation` mode – `PySide.QtGui.QTextCursor.MoveMode`

PySide.QtGui.QTextEdit.overwriteMode()¶

Return type:	`PySide.QtCore.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).

PySide.QtGui.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 PySide.QtGui.QTextEdit can paste and how it is being pasted, reimplement the virtual PySide.QtGui.QTextEdit.canInsertFromMimeData() and PySide.QtGui.QTextEdit.insertFromMimeData() functions.

PySide.QtGui.QTextEdit.print_(printer)¶

Parameters:	printer – `PySide.QtGui.QPrinter`

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

PySide.QtGui.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.

See also

PySide.QtGui.QTextEdit.undo()

PySide.QtGui.QTextEdit.redoAvailable(b)¶

Parameters:	b – `PySide.QtCore.bool`

PySide.QtGui.QTextEdit.scrollToAnchor(name)¶

Parameters:	name – unicode

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.

PySide.QtGui.QTextEdit.selectAll()¶: Selects all text.

See also

PySide.QtGui.QTextEdit.copy() PySide.QtGui.QTextEdit.cut() PySide.QtGui.QTextEdit.textCursor()

PySide.QtGui.QTextEdit.selectionChanged()¶

PySide.QtGui.QTextEdit.setAcceptRichText(accept)¶

Parameters:	accept – `PySide.QtCore.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.

PySide.QtGui.QTextEdit.setAlignment(a)¶

Parameters:	a – `PySide.QtCore.Qt.Alignment`

PySide.QtGui.QTextEdit.setAutoFormatting(features)¶

Parameters:	features – `PySide.QtGui.QTextEdit.AutoFormatting`

This property holds the enabled set of auto formatting features.

The value can be any combination of the values in the QTextEdit.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.

PySide.QtGui.QTextEdit.setCurrentCharFormat(format)¶

Parameters:	format – `PySide.QtGui.QTextCharFormat`

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.

PySide.QtGui.QTextEdit.setCurrentFont(f)¶

Parameters:	f – `PySide.QtGui.QFont`

Sets the font of the current format to f .

PySide.QtGui.QTextEdit.setCursorWidth(width)¶

Parameters:	width – `PySide.QtCore.int`

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

PySide.QtGui.QTextEdit.setDocument(document)¶

Parameters:	document – `PySide.QtGui.QTextDocument`

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

PySide.QtGui.QTextEdit.document()

PySide.QtGui.QTextEdit.setDocumentTitle(title)¶

Parameters:	title – unicode

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.

PySide.QtGui.QTextEdit.setExtraSelections(selections)¶

Parameters:	selections –

PySide.QtGui.QTextEdit.setFontFamily(fontFamily)¶

Parameters:	fontFamily – unicode

Sets the font family of the current format to fontFamily .

PySide.QtGui.QTextEdit.setFontItalic(b)¶

Parameters:	b – `PySide.QtCore.bool`

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

See also

PySide.QtGui.QTextEdit.fontItalic()

PySide.QtGui.QTextEdit.setFontPointSize(s)¶

Parameters:	s – `PySide.QtCore.qreal`

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.

PySide.QtGui.QTextEdit.setFontUnderline(b)¶

Parameters:	b – `PySide.QtCore.bool`

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

PySide.QtGui.QTextEdit.setFontWeight(w)¶

Parameters:	w – `PySide.QtCore.int`

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.

PySide.QtGui.QTextEdit.setHtml(text)¶

Parameters:	text – unicode

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

PySide.QtGui.QTextEdit.toHtml() returns the text of the text edit as html.

PySide.QtGui.QTextEdit.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 PySide.QtCore.QString containing HTML is created and passed to PySide.QtGui.QTextEdit.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 plainText()

PySide.QtGui.QTextEdit.setLineWrapColumnOrWidth(w)¶

Parameters:	w – `PySide.QtCore.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

PySide.QtGui.QTextEdit.lineWrapMode()

PySide.QtGui.QTextEdit.setLineWrapMode(mode)¶

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

PySide.QtGui.QTextEdit.setOverwriteMode(overwrite)¶

Parameters:	overwrite – `PySide.QtCore.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).

PySide.QtGui.QTextEdit.setPlainText(text)¶

Parameters:	text – unicode

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 PySide.QtGui.QTextEdit.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()

PySide.QtGui.QTextEdit.setReadOnly(ro)¶

Parameters:	ro – `PySide.QtCore.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.

PySide.QtGui.QTextEdit.setTabChangesFocus(b)¶

Parameters:	b – `PySide.QtCore.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.

PySide.QtGui.QTextEdit.setTabStopWidth(width)¶

Parameters:	width – `PySide.QtCore.int`

This property holds the tab stop width in pixels.

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

PySide.QtGui.QTextEdit.setText(text)¶

Parameters:	text – unicode

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 PySide.QtGui.QTextEdit.setHtml() or PySide.QtGui.QTextEdit.setPlainText() directly to avoid text edit’s guessing.

See also

text()

PySide.QtGui.QTextEdit.setTextBackgroundColor(c)¶

Parameters:	c – `PySide.QtGui.QColor`

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

PySide.QtGui.QTextEdit.setTextColor(c)¶

Parameters:	c – `PySide.QtGui.QColor`

Sets the text color of the current format to c .

See also

PySide.QtGui.QTextEdit.textColor()

PySide.QtGui.QTextEdit.setTextCursor(cursor)¶

Parameters:	cursor – `PySide.QtGui.QTextCursor`

Sets the visible cursor .

See also

PySide.QtGui.QTextEdit.textCursor()

PySide.QtGui.QTextEdit.setTextInteractionFlags(flags)¶

Parameters:	flags – `PySide.QtCore.Qt.TextInteractionFlags`

Specifies how the widget should interact with user input.

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

PySide.QtGui.QTextEdit.setUndoRedoEnabled(enable)¶

Parameters:	enable – `PySide.QtCore.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).

PySide.QtGui.QTextEdit.setWordWrapMode(policy)¶

Parameters:	policy – `PySide.QtGui.QTextOption.WrapMode`

PySide.QtGui.QTextEdit.tabChangesFocus()¶

Return type:	`PySide.QtCore.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.

PySide.QtGui.QTextEdit.tabStopWidth()¶

Return type:	`PySide.QtCore.int`

This property holds the tab stop width in pixels.

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

PySide.QtGui.QTextEdit.textBackgroundColor()¶

Return type:	`PySide.QtGui.QColor`

Returns the text background color of the current format.

PySide.QtGui.QTextEdit.textChanged()¶

PySide.QtGui.QTextEdit.textColor()¶

Return type:	`PySide.QtGui.QColor`

Returns the text color of the current format.

See also

PySide.QtGui.QTextEdit.setTextColor()

PySide.QtGui.QTextEdit.textCursor()¶

Return type:	`PySide.QtGui.QTextCursor`

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

PySide.QtGui.QTextEdit.textInteractionFlags()¶

Return type:	`PySide.QtCore.Qt.TextInteractionFlags`

Specifies how the widget should interact with user input.

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

PySide.QtGui.QTextEdit.toHtml()¶

Return type:	unicode

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

PySide.QtGui.QTextEdit.toHtml() returns the text of the text edit as html.

PySide.QtGui.QTextEdit.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 PySide.QtCore.QString containing HTML is created and passed to PySide.QtGui.QTextEdit.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 plainText()

PySide.QtGui.QTextEdit.toPlainText()¶

Return type:	unicode

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 PySide.QtGui.QTextEdit.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()

PySide.QtGui.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.

See also

PySide.QtGui.QTextEdit.redo()

PySide.QtGui.QTextEdit.undoAvailable(b)¶

Parameters:	b – `PySide.QtCore.bool`

PySide.QtGui.QTextEdit.wordWrapMode()¶

Return type:	`PySide.QtGui.QTextOption.WrapMode`

PySide.QtGui.QTextEdit.zoomIn([range=1])¶

Parameters:	range – `PySide.QtCore.int`

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

PySide.QtGui.QTextEdit.zoomOut()

PySide.QtGui.QTextEdit.zoomOut([range=1])¶

Parameters:	range – `PySide.QtCore.int`

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

PySide.QtGui.QTextEdit.zoomIn()

Table Of Contents

Previous topic

Next topic

QTextEdit¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶

Introduction and Concepts¶

Using QTextEdit as a Display Widget¶

Read-only Key Bindings¶

Using QTextEdit as an Editor¶

Drag and Drop¶

Editing Key Bindings¶

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.

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

Table Of Contents

Previous topic

Next topic

Quick search

QTextEdit¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶

Introduction and Concepts¶

Using QTextEdit as a Display Widget¶

Read-only Key Bindings¶

Using QTextEdit as an Editor¶

Drag and Drop¶

Editing Key Bindings¶