TTkCheckbox

class TTkCheckbox(*, text: TTkString = '', checked: bool = False, checkStatus: CheckState = None, tristate: bool = False, **kwargs)

Bases: TTkWidget

Checked

[X]CheckBox

Unchecked

[ ]CheckBox

Partially Checked

[/]CheckBox

Demo:

formwidgets.py

Parameters:

• text (str, optional) – the text shown on the checkbox, defaults to “”

• checked (bool, optional) – Checked status, defaults to “False”

• checkStatus (TTkK.CheckState , optional) – If defined, override the option defined in the ‘checked’ field otherwise defaults to TTkK.CheckState.Checked or TTkK.CheckState.Unchecked based on the checked status

• tristate (bool, optional) – Tristate status, if enabled the checkbox is able to assume the TTkK.CheckState.PartiallyChecked status, 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

Style

classStyle = {
            'default':     {'color': TTkColor.RST,
                            'borderColor':TTkColor.RST,
                            'cbContentColor': TTkColor.fg("#dddd88")+TTkColor.bg("#000044")},
            'disabled':    {'color': TTkColor.fg('#888888'),
                            'borderColor':TTkColor.fg('#888888'),
                            'cbContentColor': TTkColor.fg('#888888')},
            'focus':       {'color': TTkColor.fg("#dddd88")+TTkColor.bg("#000044")+TTkColor.BOLD,
                            'borderColor': TTkColor.fg("#ffff00") + TTkColor.BOLD,
                            'cbContentColor': TTkColor.fg("#dddd88")+TTkColor.bg("#000044")+TTkColor.BOLD},
        }

Signals

clicked	This signal is emitted when the button is activated
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
stateChanged	This signal is emitted whenever the checkbox's state changes, i.e., whenever the user checks or unchecks it.
toggled	This signal is emitted whenever the button state changes if checkeable, i.e., whenever the user checks or unchecks it.

Slots

setCheckState(state)	Sets the checkbox's check state.
setChecked(state)	Set the check status

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

clicked: pyTTkSignal

This signal is emitted when the button is activated

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

stateChanged: pyTTkSignal

This signal is emitted whenever the checkbox’s state changes, i.e., whenever the user checks or unchecks it.

Parameters:

state (TTkK.CheckState) – state of the checkbox

toggled: pyTTkSignal

This signal is emitted whenever the button state changes if checkeable, i.e., whenever the user checks or unchecks it.

Parameters:

checked (bool) – True if checked otherwise False

Methods

checkState() → CheckState

Retrieve the state of the checkbox

Returns:

TTkConstant.CheckState : the checkbox status

isChecked() → bool

This property holds whether the checkbox is checked

Returns:

bool - True if Checked or PartiallyChecked

isTristate() → bool

This property holds whether the checkbox is a tri-state checkbox

Returns:

bool

setCheckState(state: CheckState) → None

Sets the checkbox’s check state.

Parameters:

state (TTkConstant.CheckState) – state of the checkbox

setChecked(state: bool) → None

Set the check status

Parameters:

state (bool)

setText(text: TTkString) → None

This property holds the text shown on the checkhox

Parameters:

text (TTkString)

setTristate(tristate: bool)

Enable/Disable the tristate property

Parameters:

tristate (bool)

text() → TTkString

This property holds the text shown on the checkhox

Returns:

TTkString

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)
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(width, height)	Convenience function, Event Callback triggered after a successful resize
setCurrentStyle(style)
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.

TTkCheckbox Attributes

classStyle