TTkTextEdit

class TTkTextEdit(*, parent: TTkWidget | None = None, visible: bool = True, readOnly: bool = False, multiLine: bool = True, document: TTkTextDocument | None = None, textEditView: TTkTextEditView | None = None, lineNumber: bool = False, lineNumberStarting: int = 0, **kwargs)

Bases: TTkAbstractScrollArea

TTkTextEdit is a container widget which place TTkTextEditView in a scrolling area with on-demand scroll bars.

TTkTextEditView

╔═══════════════════════════════════════════════════════════════════════════════════════╗
║ 0▌"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor ╥   ║
║ <▌incididunt ut labore et dolore magna aliqua.                                    ║   ║
║ 1▌                                                                                ║   ║
║ 2▌Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliqu║   ║
║ <▌ip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate ║   ║
║ <▌velit esse cillum dolore eu fugiat nulla pariatur.                              ║   ║
║ 3▌                                                                                ║   ║
║ 4▌Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deseru║   ║
║ <▌nt mollit anim id est laborum."                                                 ╨   ║
╚═══════════════════════════════════════════════════════════════════════════════════════╝

Demo: textedit.py (tryItOnline)

ttkdesigner Tutorial

Parameters:

• textEditView (TTkTextEditView, optional) – a custom TextEdit View to be used instead of the default one.

• lineNumber (bool, optional) – show the line number on the left side, defaults to False

• lineNumberStarting (int, optional) – set the starting number of the left line number column, defaults to 0

TTkTextEditView’s forwarded init params:

Parameters:

• lineNumber (bool, optional) – Show the line number on the left, defaults to False

• readOnly (bool, optional) – In a read-only text edit the user can only navigate through the text and select text; modifying the text is not possible, defaults to True

• multiLine (bool, optional) – In a multiline text edit the user can split the text in multiple lines, defaults to True

• document (TTkTextDocument, optional) – If required an external Document can be used in this text editor, this option is useful if multiple editors share the same document as in the demo, defaults to a new Document

TTkContainer’s inherited init params:

Parameters:

• layout (TermTk.TTkLayouts) – the layout of this widget, optional, defaults to TTkLayout

• padding (TTkPadding) – the padding (top, bottom, left, right) of the widget, defaults to (0,0,0,0)

• paddingTop (int) – the Top padding, override Top padding if already defined, optional, default=0 if padding is not defined

• paddingBottom (int) – the Bottom padding, override Bottom padding if already defined, optional, default=0 if padding is not defined

• paddingLeft (int) – the Left padding, override Left padding if already defined, optional, default=0 if padding is not defined

• paddingRight (int) – the Right padding, override Right padding if already defined, optional, default=0 if padding is not defined

• forwardStyle (bool) – [Experimental] any change of style will reflect the children, defaults to False

TTkWidget’s inherited init params:

Parameters:

• name (str, optional) – the name of the widget, defaults to “”

• parent (TTkWidget, optional) – the parent widget, defaults to None

• x (int, optional) – the x position, defaults to 0

• y (int, optional) – the y position, defaults to 0

• pos ((int,int), optional) – the [x,y] position (override the previously defined x, y), defaults to (x,y)

• width (int, optional) – the width of the widget, defaults to 0

• height (int, optional) – the height of the widget, defaults to 0

• size ((int,int), optional) – the size [width, height] of the widget (override the previously defined sizes), defaults to (width,height)

• maxWidth (int, optional) – the maxWidth of the widget, defaults to 0x10000

• maxHeight (int, optional) – the maxHeight of the widget, defaults to 0x10000

• maxSize ((int,int), optional) – the max [width,height] of the widget, optional, defaults to (maxWidth,maxHeight)

• minWidth (int, optional) – the minWidth of the widget, defaults to 0

• minHeight (int, optional) – the minHeight of the widget, defaults to 0

• minSize ((int,int), optional) – the minSize [width,height] of the widget, optional, defaults to (minWidth,minHeight)

• toolTip (TTkString, optional) – This property holds the widget’s tooltip, defaults to ‘’

• style (dict, optional) – this field hold the custom style to be used by this widget

• addStyle (dict, optional) – this field is required to override/merge the new style on top of the current one, useful if only few params need to be changed

• visible (bool, optional) – the visibility, optional, defaults to True

• enabled (bool, optional) – the ability to handle input events, optional, defaults to True

TMouseEvents’s inherited init params:

Initialize self. See help(type(self)) for accurate signature.

TDragEvents’s inherited init params:

Initialize self. See help(type(self)) for accurate signature.

Signals

Signals linked to: TTkTextEditView

TTkTextEditView.currentColorChanged	This signal is emitted if the current character color has changed, for example caused by a change of the cursor position.
TTkTextEditView.cursorPositionChanged	This signal is emitted whenever the position of the cursor changed.
TTkTextEditView.redoAvailable	This signal is emitted whenever redo operations become available (available is true) or unavailable (available is false).
TTkTextEditView.textChanged	This signal is emitted whenever the document's content changes; for example, when text is inserted or deleted, or when formatting is applied.
TTkTextEditView.undoAvailable	This signal is emitted whenever undo operations become available (available is true) or unavailable (available is false).

TTkTextEdit signals:

closed	This signal is emitted whenever the widget is closed
currentStyleChanged	This signal is emitted whenever the widget stye change
focusChanged	This signal is emitted whenever the focus status change i.e. with the setFocus() or clearFocus() methods.
sizeChanged	This signal is emitted whenever the widget size change

Slots

Slots linked to: TTkTextEditView

TTkTextEditView.append(text)	Appends a new paragraph with text to the end of the text edit.
TTkTextEditView.copy()	Copies any selected text to the clipboard.
TTkTextEditView.cut()	Copies the selected text to the clipboard and deletes it from the text edit.
TTkTextEditView.ensureCursorVisible()
TTkTextEditView.find(exp)	Search the match word in the document and place the cursor at the beginning of the matched word.
TTkTextEditView.paste()	Pastes the text from the clipboard into the text edit at the current cursor position.
TTkTextEditView.redo()	Redoes the last operation.
TTkTextEditView.setColor(color)	Change the color used by the cursor to input new text or change the color of the selection
TTkTextEditView.setText(text)	Sets the text edit's text.
TTkTextEditView.undo()	Undoes the last operation.

TTkTextEdit slots:

append(text)
copy()
cut()
ensureCursorVisible()
find(exp)
paste()
redo()
setColor(color)
setLineNumber(ln)
setLineNumberStarting(starting)
setText(text)
undo()

Slots Inherited from: TTkContainer

hide()	hide the widget
show()	show the widget

Slots Inherited from: TTkWidget

close()	Close (Destroy/Remove) the widget
hide()	hide the widget
lowerWidget()	Lower the Widget below its relatives
raiseWidget([raiseParent])	Raise the Widget above its relatives
setDisabled([disabled])	This property holds whether the widget is disnabled
setEnabled([enabled])	This property holds whether the widget is enabled
setFocus()
setVisible(visible)	Set the visibility status of this widget
show()	show the widget
update([repaint, updateLayout, updateParent])	Notify the drawing routine that the widget changed and needs to draw its new content.

Members

closed: pyTTkSignal

This signal is emitted whenever the widget is closed

Parameters:

widget (TTkWidget) – the widget closed (=self)

currentStyleChanged: pyTTkSignal

This signal is emitted whenever the widget stye change

Parameters:

style (dict) – the new style applied

focusChanged: pyTTkSignal

This signal is emitted whenever the focus status change i.e. with the setFocus() or clearFocus() methods

Parameters:

status (bool) – the curent focus status

sizeChanged: pyTTkSignal

This signal is emitted whenever the widget size change

Parameters:

• width (int) – the new widget width

• height (int) – the new widget height

Methods

Methods linked to: TTkTextEditView

TTkTextEditView.append(text)	Appends a new paragraph with text to the end of the text edit.
TTkTextEditView.clear()	Deletes all the text in the text edit.
TTkTextEditView.copy()	Copies any selected text to the clipboard.
TTkTextEditView.cut()	Copies the selected text to the clipboard and deletes it from the text edit.
TTkTextEditView.document()	This property holds the underlying document of the text editor.
TTkTextEditView.ensureCursorVisible()
TTkTextEditView.extraSelections()	Returns previously set extra selections.
TTkTextEditView.find(exp)	Search the match word in the document and place the cursor at the beginning of the matched word.
TTkTextEditView.isReadOnly()	This property holds whether the text edit is read-only
TTkTextEditView.isRedoAvailable()	This property holds whether redo is available.
TTkTextEditView.isUndoAvailable()	This property holds whether undo is available.
TTkTextEditView.lineWrapMode()	This property holds the line wrap mode
TTkTextEditView.multiLine()	This property define if the text edit area will use a single line, like in the line-edit or it allows multilines like a normal text edit area.
TTkTextEditView.paste()	Pastes the text from the clipboard into the text edit at the current cursor position.
TTkTextEditView.redo()	Redoes the last operation.
TTkTextEditView.setColor(color)	Change the color used by the cursor to input new text or change the color of the selection
TTkTextEditView.setExtraSelections(...)	This function allows temporarily marking certain regions in the document with a given color, specified as selections.
TTkTextEditView.setLineWrapMode(mode)	Set the wrapping method
TTkTextEditView.setReadOnly(ro)	This property holds whether the text edit is read-only
TTkTextEditView.setText(text)	Sets the text edit's text.
TTkTextEditView.setWordWrapMode(*args, **kwargs)
TTkTextEditView.setWrapWidth(*args, **kwargs)
TTkTextEditView.textCursor()	This property holds the underlying text cursor.
TTkTextEditView.toAnsi()	Returns the text of the text edit as ANSI test string.
TTkTextEditView.toPlainText()	Returns the text of the text edit as plain text string.
TTkTextEditView.toRawText()	Return TTkString representing the document
TTkTextEditView.undo()	Undoes the last operation.
TTkTextEditView.wordWrapMode(*args, **kwargs)
TTkTextEditView.wrapWidth(*args, **kwargs)

TTkTextEdit methods:

append(text: str | TTkString) → None

See also

this method is forwarded to TTkTextEditView.append()

Appends a new paragraph with text to the end of the text edit. The text can be plain text or TTkString.

Parameters:

text (str or TTkString) – the text

clear() → None

See also

this method is forwarded to TTkTextEditView.clear()

Deletes all the text in the text edit.

Note

The undo/redo history is also cleared.

copy() → None

See also

this method is forwarded to TTkTextEditView.copy()

Copies any selected text to the clipboard.

cut() → None

See also

this method is forwarded to TTkTextEditView.cut()

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

If there is no selected text nothing happens.

document() → TTkTextDocument

See also

this method is forwarded to TTkTextEditView.document()

This property holds the underlying document of the text editor.

Return type:

TTkTextDocument

ensureCursorVisible()

See also

this method is forwarded to TTkTextEditView.ensureCursorVisible()

extraSelections() → List[ExtraSelection]

See also

this method is forwarded to TTkTextEditView.extraSelections()

Returns previously set extra selections.

Return type:

List[ExtraSelection]

find(exp: str | TTkString) → bool

See also

this method is forwarded to TTkTextEditView.find()

Search the match word in the document and place the cursor at the beginning of the matched word.

Parameters:

exp (str or TTkString) – The match word

Returns:

True if the operation is successful, False otherwise

Return type:

bool

getLineNumber()

isReadOnly() → bool

See also

this method is forwarded to TTkTextEditView.isReadOnly()

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.

Return type:

bool

isRedoAvailable() → bool

See also

this method is forwarded to TTkTextEditView.isRedoAvailable()

This property holds whether redo is available.

Returns:

the redo available status

Return type:

bool

isUndoAvailable() → bool

See also

this method is forwarded to TTkTextEditView.isUndoAvailable()

This property holds whether undo is available.

Returns:

the undo available status

Return type:

bool

lineNumberStarting()

lineWrapMode() → LineWrapMode

See also

this method is forwarded to TTkTextEditView.lineWrapMode()

This property holds the line wrap mode

The default mode is TTkK.LineWrapMode.WidgetWidth which causes words to be wrapped at the right edge of the text edit. Wrapping occurs at whitespace, keeping whole words intact.

Return type:

TTkK.LineWrapMode

multiLine() → bool

See also

this method is forwarded to TTkTextEditView.multiLine()

This property define if the text edit area will use a single line, like in the line-edit or it allows multilines like a normal text edit area.

Return type:

bool

paste() → None

See also

this method is forwarded to TTkTextEditView.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.

redo() → None

See also

this method is forwarded to TTkTextEditView.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.

ruler() → TTkTextEditRuler

setColor(color: TTkColor) → None

See also

this method is forwarded to TTkTextEditView.setColor()

Change the color used by the cursor to input new text or change the color of the selection

Parameters:

color (TTkColor) – the color to be used

setDocument(document)

setExtraSelections(extraSelections: List[ExtraSelection]) → None

See also

this method is forwarded to TTkTextEditView.setExtraSelections()

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.

Parameters:

extraSelections (List[ExtraSelection]) – the list of extra selections.

setLineNumber(ln)

setLineNumberStarting(starting)

setLineWrapMode(mode: LineWrapMode)

See also

this method is forwarded to TTkTextEditView.setLineWrapMode()

Set the wrapping method

Parameters:

mode (TTkK.LineWrapMode) – the line wrap mode

setReadOnly(ro: bool) → None

See also

this method is forwarded to TTkTextEditView.setReadOnly()

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.

Parameters:

ro (bool) – the readonly status

setText(text: str | TTkString) → None

See also

this method is forwarded to TTkTextEditView.setText()

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

Parameters:

text (str or TTkString) – the text

setWordWrapMode(*args, **kwargs) → None

See also

this method is forwarded to TTkTextEditView.setWordWrapMode()

See also

this method is forwarded to TTkTextWrap.setWordWrapMode()

setWrapWidth(*args, **kwargs) → None

See also

this method is forwarded to TTkTextEditView.setWrapWidth()

See also

this method is forwarded to TTkTextWrap.setWrapWidth()

textCursor() → TTkTextCursor

See also

this method is forwarded to TTkTextEditView.textCursor()

This property holds the underlying text cursor.

Return type:

TTkTextCursor

textEditView()

toAnsi() → str

See also

this method is forwarded to TTkTextEditView.toAnsi()

Returns the text of the text edit as ANSI test string.

This string will insluce the ANSI escape codes for color and text formatting.

Return type:

str

toPlainText() → str

See also

this method is forwarded to TTkTextEditView.toPlainText()

Returns the text of the text edit as plain text string.

Return type:

str

toRawText() → TTkString

See also

this method is forwarded to TTkTextEditView.toRawText()

Return TTkString representing the document

Return type:

TTkString

undo() → None

See also

this method is forwarded to TTkTextEditView.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.

wordWrapMode(*args, **kwargs) → None

See also

this method is forwarded to TTkTextEditView.wordWrapMode()

See also

this method is forwarded to TTkTextWrap.wordWrapMode()

wrapWidth(*args, **kwargs) → None

See also

this method is forwarded to TTkTextEditView.wrapWidth()

See also

this method is forwarded to TTkTextWrap.wrapWidth()

Methods Inherited from: TTkAbstractScrollArea

resizeEvent(w, h)	Convenience function, Event Callback triggered after a successful resize
setHorizontalScrollBarPolicy(policy)
setVerticalScrollBarPolicy(policy)
setViewport(viewport)
update([repaint, updateLayout, updateParent])	Notify the drawing routine that the widget changed and needs to draw its new content.
viewport()

Methods Inherited from: TTkContainer

addWidget(widget)
getPadding()	Retrieve the TTkContainer's paddings sizes as shown in Layout Topology
getWidgetByName(name)	Return the widget from its name.
hide()	hide the widget
layout()	Get the Layout
maximumHeight()
maximumWidth()
minimumHeight()
minimumWidth()
paintChildCanvas()
removeWidget(widget)
rootLayout()	This is a root layout mainly used to place items that are not supposed to be inside the main layout (i.e. the menu elements).
setCurrentStyle(*args, **kwargs)
setLayout(layout)	Set the Layout used by this widget to place all the child widgets.
setPadding(top, bottom, left, right)	Set the TTkContainer's paddings sizes as shown in Layout Topology
show()	show the widget
update([repaint, updateLayout, updateParent])	Notify the drawing routine that the widget changed and needs to draw its new content.

Methods Inherited from: TTkWidget

clearFocus()	Remove the Focus state of this widget
close()	Close (Destroy/Remove) the widget
currentStyle()
disableWidgetCursor([disable])
enableWidgetCursor([enable])
focusInEvent()
focusOutEvent()
focusPolicy()
geometry()
getCanvas()
getPixmap()	Convenience function which return a pixmap representing the current widget status
getWidgetByName(name)	Return the widget from its name.
hasFocus()	This property holds the focus status of this widget
height()
hide()	hide the widget
isEnabled()	This property holds whether the widget is enabled
isEntered()
isVisible()	Retrieve the visibility status of this widget
isVisibleAndParent()
lowerWidget()	Lower the Widget below its relatives
maxDimension(orientation)
maximumHeight()
maximumSize()
maximumWidth()
mergeStyle(style)
minDimension(orientation)
minimumHeight()
minimumSize()
minimumWidth()
mouseEvent(evt)
move(x, y)	Move the widget
moveEvent(x, y)	Convenience function, Event Callback triggered after a successful move
name()
paintChildCanvas()
paintEvent(canvas)	Paint Event callback, this need to be overridden in the widget.
parentWidget()
pasteEvent(txt)	Callback triggered when a paste event is forwarded to this widget.
pos()
raiseWidget([raiseParent])	Raise the Widget above its relatives
resize(width, height)	Resize the widget
resizeEvent(w, h)	Convenience function, Event Callback triggered after a successful resize
setCurrentStyle(*args, **kwargs)
setDefaultSize(arg, width, height)
setDisabled([disabled])	This property holds whether the widget is disnabled
setDropEventProxy(proxy)
setEnabled([enabled])	This property holds whether the widget is enabled
setFocus()
setFocusPolicy(policy)	This property holds the way the widget accepts keyboard focus
setGeometry(x, y, width, height)	Resize and move the widget
setMaximumHeight(maxh)
setMaximumSize(maxw, maxh)
setMaximumWidth(maxw)
setMinimumHeight(minh)
setMinimumSize(minw, minh)
setMinimumWidth(minw)
setName(name)	Set the name of this Instance
setParent(parent)
setStyle([style])
setToolTip(toolTip)
setVisible(visible)	Set the visibility status of this widget
setWidgetCursor([pos, type])
show()	show the widget
size()
style()
toolTip()
update([repaint, updateLayout, updateParent])	Notify the drawing routine that the widget changed and needs to draw its new content.
widgetItem()
width()
x()
y()

Methods Inherited from: TMouseEvents

enterEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse enter events for the widget.
leaveEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse leave events for the widget.
mouseDoubleClickEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse click events for the widget.
mouseDragEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse drag events for the widget.
mouseMoveEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse move events for the widget.
mousePressEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse press events for the widget.
mouseReleaseEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse release events for the widget.
mouseTapEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse click events for the widget.
wheelEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse wheel events for the widget.

Methods Inherited from: TKeyEvents

keyEvent(evt)

This event handler, can be reimplemented in a subclass to receive key events for the widget.

Methods Inherited from: TDragEvents

dragEnterEvent(evt)	This event handler, can be reimplemented in a subclass to receive drag events for the widget.
dragLeaveEvent(evt)	This event handler, can be reimplemented in a subclass to receive drag events for the widget.
dragMoveEvent(evt)	This event handler, can be reimplemented in a subclass to receive drag events for the widget.
dropEvent(evt)	This event handler, can be reimplemented in a subclass to receive drag events for the widget.

TTkTextEdit Classes

class ExtraSelection(cursor: ~TermTk.TTkGui.textcursor.TTkTextCursor, format: ~TermTk.TTkCore.constant.TTkConstant.SelectionFormat = SelectionFormat.NONE, color: ~TermTk.TTkCore.color.TTkColor = <TermTk.TTkCore.color.TTkColor object>)

Bases: object

The ExtraSelection structure provides a way of specifying a character format for a given selection in a document.

Parameters:

• format (TTkK.SelectionFormat) – A format that is used to specify the type of selection, defaults to TTkK.NONE.

• color (TTkColor) – The color used to specify the foreground/background color/mod for the selection.

• cursor (TTkTextCursor) – A cursor that contains a selection in a QTextDocument.

color() → TTkColor

This propery holds the color that is used for the selection.

Return type:

TTkColor

cursor() → TTkTextCursor

This propery holds the fcursor that contains a selection in a QTextDocument.

Return type:

TTkTextCursor

format() → SelectionFormat

This propery holds the format that is used to specify the type of selection.

Return type:

TTkK.SelectionFormat

setColor(color: TTkColor) → None

Set the color.

Parameters:

color (TTkColor) – A color that is used for the selection.

setCursor(cursor: TTkTextCursor) → None

Set the cursor.

Parameters:

cursor (TTkTextCursor) – A cursor that contains a selection in a QTextDocument.

setFormat(format: SelectionFormat) → None

Set the format.

Parameters:

format (TTkK.SelectionFormat) – A format that is used to specify the type of selection.

TTkTextEdit Attributes

classStyle
currentColorChanged
cursorPositionChanged
redoAvailable
textChanged
undoAvailable