TTkTextEdit

class TTkTextEdit(*, parent: TTkWidget = None, visible: bool = True, readOnly: bool = False, multiLine: bool = True, document: TTkTextDocument = None, textEditView: TTkTextEditView = 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 (Try Online)

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

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.focusChanged	This signal is emitted whenever the focus status change i.e. with the setFocus() or clearFocus() methods.
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)
TTkTextEditView.clear()
TTkTextEditView.copy()
TTkTextEditView.cut()
TTkTextEditView.paste()
TTkTextEditView.redo()
TTkTextEditView.setColor(color)
TTkTextEditView.setText(text)
TTkTextEditView.undo()

TTkTextEdit slots:

setLineNumber(ln)
setLineNumberStarting(starting)

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)
TTkTextEditView.clear()
TTkTextEditView.copy()
TTkTextEditView.cut()
TTkTextEditView.document()
TTkTextEditView.isReadOnly()
TTkTextEditView.isRedoAvailable()
TTkTextEditView.isUndoAvailable()
TTkTextEditView.lineWrapMode()
TTkTextEditView.multiLine()	multiline
TTkTextEditView.paste()
TTkTextEditView.redo()
TTkTextEditView.setColor(color)
TTkTextEditView.setLineWrapMode(mode)
TTkTextEditView.setReadOnly(ro)
TTkTextEditView.setText(text)
TTkTextEditView.setWordWrapMode(*args, **kwargs)
TTkTextEditView.setWrapWidth(*args, **kwargs)
TTkTextEditView.textCursor()
TTkTextEditView.toAnsi()
TTkTextEditView.toPlainText()
TTkTextEditView.toRawText()
TTkTextEditView.undo()
TTkTextEditView.wordWrapMode(*args, **kwargs)
TTkTextEditView.wrapWidth(*args, **kwargs)

TTkTextEdit methods:

getLineNumber()

lineNumberStarting()

setDocument(document)

setLineNumber(ln)

setLineNumberStarting(starting)

textEditView()

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()
mouseEvent(evt)
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
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 Attributes

append
classStyle
clear
copy
currentColorChanged
cut
document
isReadOnly
isRedoAvailable
isUndoAvailable
lineWrapMode
multiLine
paste
redo
redoAvailable
setColor
setFocus
setLineWrapMode
setReadOnly
setText
setWordWrapMode
setWrapWidth
textChanged
textCursor
toAnsi
toPlainText
toRawText
undo
undoAvailable
wordWrapMode
wrapWidth