TermTk.TTkWidgets.container

TTkContainer

class TTkContainer(*, padding=(0, 0, 0, 0), forwardStyle=False, **kwargs)[source]

TTkContainer Layout sizes:

Terminal area (i.e. XTerm) = TTk
┌─────────────────────────────────────────┐
│                                         │
│    TTkContainer   width                 │
│ (x,y)┌─────────────────────────┐        │
│      │      padt (Top Padding) │        │
│      │    ┌───────────────┐    │ height │
│      │padl│ Layout/child  │padr│        │
│      │    └───────────────┘    │        │
│      │      padb (Bottom Pad.) │        │
│      └─────────────────────────┘        │
└─────────────────────────────────────────┘

Parameters

forwardStyle (bool) – any change of style will reflect the children, defaults to False
padding (int) – the padding (top, bottom, left, right) of the widget, defaults to 0
paddingTop (int) – the Top padding, override Top padding if already defined, optional, default=padding
paddingBottom (int) – the Bottom padding, override Bottom padding if already defined, optional, default=padding
paddingLeft (int) – the Left padding, override Left padding if already defined, optional, default=padding
paddingRight (int) – the Right padding, override Right padding if already defined, optional, default=padding
layout (TermTk.TTkLayouts) – the layout of this widget, optional, defaults to TTkLayout

addWidget(widget)[source]

Warning

Method Deprecated,

use TTkWidget -> layout -> addWidget

i.e.

parentWidget.layout().addWidget(childWidget)

close()

dragEnterEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkDropEvent) – The drop event
Returns: True if the event has been handled
Return type: bool

dragLeaveEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkDropEvent) – The drop event
Returns: True if the event has been handled
Return type: bool

dragMoveEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkDropEvent) – The drop event
Returns: True if the event has been handled
Return type: bool

dropEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkDropEvent) – The drop event
Returns: True if the event has been handled
Return type: bool

enterEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool

getPadding() -> (<class 'int'>, <class 'int'>, <class 'int'>, <class 'int'>)[source]

Retrieve the widget padding sizes

Returns: list[top, bottom, left, right]: the 4 padding sizes

hide()[source]

keyEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkKeyEvent) – The keyboard event
Returns: True if the event has been handled
Return type: bool

keyPressEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkKeyEvent) – The keyboard event
Returns: True if the event has been handled
Return type: bool

keyReleaseEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkKeyEvent) – The keyboard event
Returns: True if the event has been handled
Return type: bool

layout()[source]

Get the layout

Returns: The layout used
Return type: TTkLayout or derived

leaveEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool

lowerWidget()

mouseDoubleClickEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool

mouseDragEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool

mouseEvent(evt)[source]: Caution

Don’t touch this!

mouseMoveEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool

mousePressEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool

mouseReleaseEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool

mouseTapEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool

move(x: int, y: int)

Move the widget

Parameters

x (int) – x position
y (int) – y position

moveEvent(x: int, y: int): Event Callback triggered after a successful move

name() → str

paintChildCanvas()[source]: Caution

Don’t touch this!

paintEvent(canvas: TTkCanvas): Paint Event callback, this need to be overridden in the widget.

raiseWidget(raiseParent=True)

removeWidget(widget)[source]

Warning

Method Deprecated,

use TTkWidget -> layout -> removeWidget

i.e.

parentWidget.layout().removeWidget(childWidget)

resize(w: int, h: int)

Resize the widget

Parameters

w (int) – the new width
h (int) – the new height

resizeEvent(w: int, h: int): Event Callback triggered after a successful resize

setDisabled(disabled=True)

setEnabled(enabled: bool = True)

setFocus()

setGeometry(x: int, y: int, w: int, h: int)

Resize and move the widget

Parameters

x (int) – x position
y (int) – y position
w (int) – the new width
h (int) – the new height

setName(name: str)

setPadding(top: int, bottom: int, left: int, right: int)[source]

Set the padding of the widget

Parameters

top (int) – top padding
bottom (int) – bottom padding
left (int) – left padding
right (int) – right padding

setVisible(visible: bool)

show()[source]

wheelEvent(evt) → bool

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

Note

Reimplement this function to handle this event

Parameters: evt (TTkMouseEvent) – The mouse event
Returns: True if the event has been handled
Return type: bool