TTkTextEditView

class TTkTextEditView(*, readOnly: bool = False, multiLine: bool = True, document: TTkTextDocument | None = None, follow: bool = False, **kwargs)

Bases: TTkAbstractScrollView

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:

• 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 False

• 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

• follow (bool, optional) – If True, the text edit will automatically scroll to the bottom when new text is added, defaults to False

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.

Style

classStyle = {
            'default':     {'color':         TTkColor.fg("#dddddd")+TTkColor.bg("#222222"),
                            'selectedColor': TTkColor.fg("#ffffff")+TTkColor.bg("#008844"),
                            'lineColor':     TTkColor.fg("#444444"),
                            'wrapLineColor': TTkColor.fg("#888888")+TTkColor.bg("#333333")},
            'disabled':    {'color': TTkColor.fg('#888888'),
                            'selectedColor': TTkColor.bg("#888888"),
                            'lineColor':     TTkColor.fg("#888888"),
                            'wrapLineColor': TTkColor.fg('#888888')},
            'focus':       {'selectedColor': TTkColor.fg("#ffffff")+TTkColor.bg("#008888")},
        }

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
viewChanged	This signal is emitted whenever there is a change in the view content topology (size,pos)
viewMovedTo	This signal is emitted when the view content move to a new position (x,y),
viewSizeChanged	This signal is emitted when the view content size changed

Slots

append(text)	Appends a new paragraph with text to the end of the text edit.
copy()	Copies any selected text to the clipboard.
cut()	Copies the selected text to the clipboard and deletes it from the text edit.
ensureCursorVisible()
find(exp)	Search for text in the document and place the cursor at the beginning of the first match.
paste()	Pastes the text from the clipboard into the text edit at the current cursor position.
redo()	Redoes the last operation.
scrollTo(position)	Scrolls the view to the specified edge(s) of the text document.
setColor(color)	Change the color used by the cursor to input new text or change the color of the selection
setFollow(follow)	Enable or disable the follow-bottom mode.
setText(text)	Sets the text edit's text.
undo()	Undoes the last operation.

Slots Inherited from: TTkAbstractScrollView

viewMoveTo(x, y)

Move the view to the specified offset position

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 disabled
setEnabled([enabled])	This property holds whether the widget is enabled
setFocus()	Focus the widget
setVisible(visible)	Set the visibility status of this widget
show()	show the widget
update([repaint, updateLayout, updateParent])	Update the widget and emit viewChanged signal if layout is updated

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

viewChanged: pyTTkSignal

This signal is emitted whenever there is a change in the view content topology (size,pos)

Note

This signal must be implemented in any implementation of TTkAbstractScrollView to notify that the view content boudaries changed

viewMovedTo: pyTTkSignal

This signal is emitted when the view content move to a new position (x,y),

Parameters:

• x (int) – the new horizontal offset

• y (int) – the new vertical offset

viewSizeChanged: pyTTkSignal

This signal is emitted when the view content size changed

Parameters:

• width (int) – the new width

• height (int) – the new height

Methods

append(text: str | TTkString) → None

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

Deletes all the text in the text edit.

Note

The undo/redo history is also cleared.

copy() → None

Copies any selected text to the clipboard.

cut() → None

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

If there is no selected text nothing happens.

document() → TTkTextDocument

This property holds the underlying document of the text editor.

Return type:

TTkTextDocument

ensureCursorVisible()

extraSelections() → List[ExtraSelection]

Returns previously set extra selections.

Return type:

List[ExtraSelection]

find(exp: str | TTkString) → bool

Search for text in the document and place the cursor at the beginning of the first match.

Parameters:

exp (str or TTkString) – the expression to find

Returns:

True if the operation is successful, False otherwise

Return type:

bool

follow() → bool

This property holds whether the view follows the last line whenever the document changes.

Return type:

bool

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

Return type:

bool

isRedoAvailable() → bool

This property holds whether redo is available.

Returns:

the redo available status

Return type:

bool

isUndoAvailable() → bool

This property holds whether undo is available.

Returns:

the undo available status

Return type:

bool

lineWrapMode() → LineWrapMode

This property holds the line wrap mode

The default mode is TTkK.LineWrapMode.NoWrap.

Return type:

TTkK.LineWrapMode

multiLine() → bool

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

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

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.

scrollTo(position: TextEditEdge) → None

Scrolls the view to the specified edge(s) of the text document.

This method allows scrolling to the top, bottom, left, or right edge of the document. Multiple edges can be specified by combining them with the bitwise OR operator.

Parameters:

position (TTkK.TextEditEdge) – the edge(s) to scroll to

setColor(color: TTkColor) → None

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: TTkTextDocument) → None

Set the underlying document of the text editor.

Parameters:

document (TTkTextDocument) – the text document

setExtraSelections(extraSelections: List[ExtraSelection]) → None

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.

setFollow(follow: bool) → None

Enable or disable the follow-bottom mode.

When enabled, the view automatically scrolls to the last visible row every time the underlying document changes.

Parameters:

follow (bool) – True to keep following the bottom row, False otherwise

setLineWrapMode(mode: LineWrapMode, wrapEngine: WrapEngine = WrapEngine.FullWrap) → None

Set the wrapping method

Parameters:

• mode (TTkK.LineWrapMode) – the line wrap mode

• wrapEngine (TTkK.WrapEngine) – the wrap engine used when wrapping is enabled

setReadOnly(ro: bool) → None

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

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

setWrapWidth(*args, **kwargs) → None

See also

this method is forwarded to TTkTextWrap.setWrapWidth()

textCursor() → TTkTextCursor

This property holds the underlying text cursor.

Return type:

TTkTextCursor

toAnsi() → str

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

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

Return type:

str

toPlainText() → str

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

Return type:

str

toRawText() → TTkString

Return TTkString representing the document

Return type:

TTkString

undo() → None

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) → WrapMode

See also

this method is forwarded to TTkTextWrap.wordWrapMode()

wrapWidth(*args, **kwargs) → int

See also

this method is forwarded to TTkTextWrap.wrapWidth()

Methods Inherited from: TTkAbstractScrollView

getViewOffsets()	Retrieve the vertical and horizontal offsets of the TTkAbstractScrollViewInterface
resizeEvent(w, h)	Handle resize events
setPadding(top, bottom, left, right)	Set the padding and emit viewChanged signal
update([repaint, updateLayout, updateParent])	Update the widget and emit viewChanged signal if layout is updated
viewDisplayedSize()	Return the displayed size of this view
viewFullAreaSize()	Return the full area size including padding
viewMoveTo(x, y)	Move the view to the specified offset position
wheelEvent(evt)	Handle mouse wheel events for scrolling

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
keyEvent(evt)	This event handler, can be reimplemented in a subclass to receive key events for the widget.
layout()	Get the Layout
maximumHeight()	Retrieve the maximum height
maximumWidth()	Retrieve the maximum width
minimumHeight()	Retrieve the minimum height
minimumWidth()	Retrieve the minimum width
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)	Set the currently active style
setLayout(layout)	Set the Layout used by this widget to place all the child widgets.
setPadding(top, bottom, left, right)	Set the padding and emit viewChanged signal
show()	show the widget
update([repaint, updateLayout, updateParent])	Update the widget and emit viewChanged signal if layout is updated

Methods Inherited from: TTkWidget

clearFocus()	Remove the Focus state of this widget
close()	Close (Destroy/Remove) the widget
currentStyle()	Retrieve the currently active style
disableWidgetCursor([disable])	Disable or enable the widget cursor
enableWidgetCursor([enable])	Enable or disable the widget cursor
focusInEvent()	Callback triggered when the widget receives focus
focusOutEvent()	Callback triggered when the widget loses focus
focusPolicy()	Retrieve the focus policy of this widget
geometry()	Retrieve the widget geometry
getCanvas()	Retrieve the widget canvas
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()	Retrieve the widget height
hide()	hide the widget
isEnabled()	This property holds whether the widget is enabled
isEntered()	Check if the mouse cursor is currently over this widget
isVisible()	Retrieve the visibility status of this widget
isVisibleAndParent()	Check if the widget and all its parents are visible
lowerWidget()	Lower the Widget below its relatives
maxDimension(orientation)	Retrieve the maximum dimension for the given orientation
maximumHeight()	Retrieve the maximum height
maximumSize()	Retrieve the maximum size
maximumWidth()	Retrieve the maximum width
mergeStyle(style)	Merge additional style properties with the existing style
minDimension(orientation)	Retrieve the minimum dimension for the given orientation
minimumHeight()	Retrieve the minimum height
minimumSize()	Retrieve the minimum size
minimumWidth()	Retrieve the minimum width
mouseEvent(evt)	Handle mouse events for this widget and its children
move(x, y)	Move the widget
moveEvent(x, y)	Convenience function, Event Callback triggered after a successful move
name()	Retrieve the name of this widget
paintChildCanvas()
paintEvent(canvas)	Paint Event callback, this need to be overridden in the widget.
parentWidget()	Retrieve the parent widget
pasteEvent(txt)	Callback triggered when a paste event is forwarded to this widget.
pos()	Retrieve the widget position
raiseWidget([raiseParent])	Raise the Widget above its relatives
resize(width, height)	Resize the widget
resizeEvent(w, h)	Handle resize events
setCurrentStyle(*args, **kwargs)	Set the currently active style
setDefaultSize(arg, width, height)	Set default size if not already specified in arguments
setDisabled([disabled])	This property holds whether the widget is disabled
setDropEventProxy(proxy)
setEnabled([enabled])	This property holds whether the widget is enabled
setFocus()	Focus the widget
setFocusPolicy(policy)	This property holds the way the widget accepts keyboard focus
setGeometry(x, y, width, height)	Resize and move the widget
setMaximumHeight(maxh)	Set the maximum height of the widget
setMaximumSize(maxw, maxh)	Set the maximum size of the widget
setMaximumWidth(maxw)	Set the maximum width of the widget
setMinimumHeight(minh)	Set the minimum height of the widget
setMinimumSize(minw, minh)	Set the minimum size of the widget
setMinimumWidth(minw)	Set the minimum width of the widget
setName(name)	Set the name of this Instance
setParent(parent)	Set the parent widget
setStyle([style])	Set the style for the widget
setToolTip(toolTip)	Set the widget tooltip
setVisible(visible)	Set the visibility status of this widget
setWidgetCursor([pos, type])	Set the widget cursor position and type
show()	show the widget
size()	Retrieve the widget size
style()	Retrieve a copy of the widget style dictionary
toolTip()	Retrieve the widget tooltip
update([repaint, updateLayout, updateParent])	Update the widget and emit viewChanged signal if layout is updated
widgetItem()	Retrieve the widget item (layout item wrapper)
width()	Retrieve the widget width
x()	Retrieve the horizontal position
y()	Retrieve the vertical position

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)	Handle mouse wheel events for scrolling

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.

TTkTextEditView 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 TTkTextDocument.

color() → TTkColor

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

Return type:

TTkColor

cursor() → TTkTextCursor

This property holds the cursor that contains a selection in a TTkTextDocument.

Return type:

TTkTextCursor

format() → SelectionFormat

This property 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.

TTkTextEditView Attributes

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