TTkTerminalView🌶️

class TTkTerminalView(**kwargs)[source]🌶️

Bases: TTkAbstractScrollView, _TTkTerminal_CSI_DEC

TTkTerminalView is a terminal emulator fot TermTk

Warning

This is an Alpha feature, it is not optimized and the API definition may change in the future

TermShot from: tests/t.pty/test.pty.006.terminal.07.py

╔════════════════════════════════════════════════════════════════════════════════════╗
║ Terminello n.1                                                            [_][^][x]║
╟────────────────────────────────────────────────────────────────────────────────────╢
║ $ neofetch                                                                        ▲║
║`.-::---..                     PierCecco@FrankenstOne                              ┊║
║      .:++++ooooosssoo:.       ---------------------------                         ┊║
║    .+o++::.      `.:oos+.     OS: LMDE 6 (faye) x86_64                            ┊║
║   :oo:.`             -+oo:    Host: Lemur Pro lemp11                              ┊║
║ `+o/`    .::::::-.    .++-`   Kernel: 6.1.0-26-amd64                              ▓║
║`/s/    .yyyyyyyyyyo:   +o-`   Uptime: 27 days, 2 hours, 33 mins                   ▓║
║`so     .ss       ohyo` :s-:   Packages: 2787 (dpkg), 38 (flatpak)                 ▓║
║`s/     .ss  h  m  myy/ /s``   Shell: bash 5.2.15                                  ▓║
║`s:     `oo  s  m  Myy+-o:`    Resolution: 1920x1080, 3440x1440                    ▓║
║`oo      :+sdoohyoydyso/.      DE: Cinnamon 6.2.9                                  ▓║
║ :o.      .:////////++:        WM: Mutter (Muffin)                                 ▓║
║ `/++        -:::::-           WM Theme: Mint-Y-Dark-Orange (Mint-Y)               ▓║
║  `++-                         Theme: Mint-L-Dark [GTK2/3]                         ▓║
║   `/+-                        Icons: Mint-X-Orange [GTK2/3]                       ▓║
║     .+/.                      Terminal: tmux                                      ▓║
║       .:+-.                   CPU: 12th Gen Intel i7-1255U (12) @ 4.700GHz        ▓║
║          `--.``               GPU: Intel Alder Lake-UP3 GT2 [Iris Xe Graphics]    ▓║
║                               Memory: 32111MiB / 39956MiB                         ▓║
║                                                                                   ▓║
║23 PierCecco FrankenstOne < 12:24 > (1052) ~/github/Varie/pyTermTk                 ▓║
║ $                                                                                 ▼║
╚════════════════════════════════════════════════════════════════════════════════════╝

Quickstart:

import TermTk as ttk

root = ttk.TTk(mouseTrack=True)

win = ttk.TTkWindow(parent=root, title="Terminal", size=(80+2,24+4), layout=ttk.TTkGridLayout())

term = ttk.TTkTerminal(parent=win)

th = ttk.TTkTerminalHelper(term=term)
th.runShell()

root.mainloop()

More examples are available here.

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 🌶️

`bell`	This signal is emitted when the bell is received.
`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
`termData`	This signal is emitted when data event fires.
`termResized`	This signal is emitted when the terminal is resized.
`terminalClosed`	This signal is emitted when the terminl is closed.
`textSelected`	This signal is emitted when a text is selected.
`titleChanged`	This signal is emitted when the terminal title change through OSC "ESC ]0;"
`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 🌶️

Slots Inherited from: TTkAbstractScrollView

viewMoveTo(x, y)

This method is used to set the vertical and horizontal offsets of the TTkAbstractScrollViewInterface

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`()	Focus the widget
`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🌶️

bell: pyTTkSignal🌶️: This signal is emitted when the bell is received.

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

termData: pyTTkSignal🌶️

This signal is emitted when data event fires.

This happens for example when the user types or pastes into the terminal. The event value is whatever ‘str’ results, in a typical setup, this should be passed on to the backing pty.

This signal is used in TTkTerminalHelper through TTkTerminalHelper.attachTTkTerminal() to frward all the terminal events to the pty interface.

Parameters:: data (str) – the event data

termResized: pyTTkSignal🌶️

This signal is emitted when the terminal is resized.

Parameters:: size ((int,int)) – the new size [width, height] of the terminal

terminalClosed: pyTTkSignal🌶️: This signal is emitted when the terminl is closed.

textSelected: pyTTkSignal🌶️

This signal is emitted when a text is selected.

Parameters:: text (ttkString) – the selected text

titleChanged: pyTTkSignal🌶️

This signal is emitted when the terminal title change through OSC “ESC ]0;”

Parameters:: title (str) – the new title

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 heighht

Methods🌶️

termSize() → tuple[int, int][source]🌶️

This property holds the size of the terminal

Returns:: a tuple of 2 integers (width, height)
Return type:: tuple

termWrite(data: str) → None[source]🌶️

Write data to the terminal.

Params data:: the data to write

viewFullAreaSize() -> (<class 'int'>, <class 'int'>)[source]🌶️

This method returns the full widget area size of the TTkAbstractScrollViewInterface implementation.

This is required to TTkAbstractScrollArea implementation to handle the on-demand scroll bars.

Note

Reimplement this function to handle this event

Returns:: the full area size as a tuple of 2 int elements (width,height)
Return type:: tuple[int,int]

Methods Inherited from: TTkAbstractScrollView

`getViewOffsets`()	Retrieve the vertical and horizontal offsets of the `TTkAbstractScrollViewInterface`
`resizeEvent`(w, h)	Convenience function, Event Callback triggered after a successful resize
`update`([repaint, updateLayout, updateParent])	Notify the drawing routine that the widget changed and needs to draw its new content.
`viewDisplayedSize`()	This method returns the displayed size of the `TTkAbstractScrollViewInterface` implementation.
`viewMoveTo`(x, y)	This method is used to set the vertical and horizontal offsets of the `TTkAbstractScrollViewInterface`
`wheelEvent`(evt)	This event handler, can be reimplemented in a subclass to receive mouse wheel events for the widget.

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