TermTk.TTkWidgets.menubar

TTkMenuBarButton

class TTkMenuBarButton(*, text=Ellipsis, data=None, checkable=False, checked=False, **kwargs)[source]
addMenu(text: TTkString, data: Optional[object] = None, checkable: bool = False, checked: bool = False)
close()
data()

Returns the user data as set in the constructor or setData.

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

hide()
isCheckable()

This property holds whether the button is checkable

Returns

bool

isChecked()

This property holds whether the button is checked

Only checkable buttons can be checked. By default, the button is unchecked.

Returns

bool

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

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)

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
paintEvent(canvas)[source]

Paint Event callback, this need to be overridden in the widget.

raiseWidget(raiseParent=True)
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

setCheckable(ch)[source]

Enable/Disable the checkable property

Parameters

ch (bool) – Checkable

setChecked(ch)

Set the checked status

Parameters

ch (bool) – Checked

setData(data)

Sets the Menu Button’s internal data to the given userData.

Parameters

data – the user data

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)
setText(text)

This property holds the text shown

Parameters

text (TTkString) –

setVisible(visible: bool)
show()
text()

This property holds the text shown

Returns

TTkString

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

TTkMenuBarLayout

class TTkMenuBarLayout(*args, **kwargs)[source]
addItem(item, row=None, col=None, rowspan=1, colspan=1, direction=3)

Add the item to this TTkGridLayout

Parameters

  • item (TTkLayoutItem) – the item to be added

  • row (int) – the row of the grid, optional, defaults to None

  • col (int) – the col of the grid, optional, defaults to None

  • rowspan (int) – the rows used by the item, optional, defaults to 1

  • colspan (int) – the cols used by the item, optional, defaults to 1

  • direction (Direction) – The direction the new item will be added if row/col are not specified, defaults to defaults to HORIZONTAL

addItems(items, row=None, col=None, rowspan=1, colspan=1, direction=3)

Add the items to this TTkGridLayout

Parameters

  • items (list of TTkLayoutItem) – the items to be added

  • row (int) – the row of the grid, optional, defaults to None

  • col (int) – the col of the grid, optional, defaults to None

  • rowspan (int) – the rows used by the item, optional, defaults to 1

  • colspan (int) – the cols used by the item, optional, defaults to 1

  • direction (Direction) – The direction the new items will be added if row/col are not specified, defaults to defaults to HORIZONTAL

addMenu(text: TTkString, data: Optional[object] = None, checkable: bool = False, checked: bool = False, alignment=1)[source]
addWidget(widget, row=None, col=None, rowspan=1, colspan=1, direction=3)

Add the widget to this TTkGridLayout, this function uses addItem()

Parameters

  • widget (TTkWidget) – the widget to be added

  • row (int) – the row of the grid, optional, defaults to None

  • col (int) – the col of the grid, optional, defaults to None

  • rowspan (int) – the rows used by the widget, optional, defaults to 1

  • colspan (int) – the cols used by the widget, optional, defaults to 1

  • direction (Direction) – The direction the new item will be added if row/col are not specified, defaults to defaults to HORIZONTAL

addWidgets(widgets, row=None, col=None, rowspan=1, colspan=1, direction=3)

Add the widgets to this TTkGridLayout, this function uses addItem()

Parameters

  • widgets (list of TTkWidget) – the widgets to be added

  • row (int) – the row of the grid, optional, defaults to None

  • col (int) – the col of the grid, optional, defaults to None

  • rowspan (int) – the rows used by the widget, optional, defaults to 1

  • colspan (int) – the cols used by the widget, optional, defaults to 1

  • direction (Direction) – The direction the new items will be added if row/col are not specified, defaults to defaults to HORIZONTAL

insertWidget(index, widget)
insertWidgets(index, widgets)
layer()
lowerWidget(widget)
maximumHeight() → int

process the widgets and get the min size

maximumWidth() → int

process the widgets and get the min size

minimumHeight() → int

process the widgets and get the min size

minimumWidth() → int

process the widgets and get the min size

parent()
raiseWidget(widget)
removeItem(item)
removeItems(items)
removeWidget(widget)

Remove a widget from this Layout

Parameters

widget (TTkWidgets) – the widget to be removed

removeWidgets(widgets)

Remove a list of widget from this Layout

Parameters

widgets (list of TTkWidgets) – the widget to be removed

setGeometry(x, y, w, h)
setLayer(layer)
setOffset(x, y)
setParent(parent)