1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
from tkinter import Checkbutton, IntVar
from . import utilities as utils
from .base import TextWidget
class CheckBox(TextWidget):
def __init__(
self,
master,
text="",
command=None,
grid=None,
align=None,
args=None,
visible=True,
enabled=None,
width=None,
height=None):
"""
Creates a CheckBox
:param Container master:
The Container (App, Box, etc) the CheckBox will belong too.
:param string selected:
The text required for the checkbox. Defaults to "".
:param Callable command:
The callback function to call when the CheckBox changes.
:param List grid:
Grid co-ordinates for the widget, required if the master layout
is 'grid', defaults to `None`.
:param string align:
How to align the widget within the grid, defaults to None.
:param callback args:
A list of arguments to pass to the widgets `command`, defaults to
`None`.
:param bool visible:
If the widget should be visible, defaults to `True`.
:param bool enabled:
If the widget should be enabled, defaults to `None`. If `None`
the value is inherited from the master.
:param int width:
The starting width of the widget. Defaults to `None` and will auto
size.
:param int height:
The starting height of the widget. Defaults to `None` and will auto
size.
"""
self._text = str(text)
self._value = IntVar()
tk = Checkbutton(master.tk, text=text, variable=self._value)
super().__init__(master, tk, grid, align, visible, enabled, width, height)
# Set the command callback
self.tk.config(command=self._command_callback)
self.update_command(command, args)
# PROPERTIES
# ----------------------------------
# Whether the box is checked or not
@property
def value(self):
"""
Sets or returns the value of the CheckBox.
"""
return (self._value.get())
# Set whether the box is checked or not
@value.setter
def value(self, value):
try:
value = int(value)
if value in [0, 1]:
self._value.set(value)
except ValueError:
utils.error_format("You can only set the value of " + self.description + " to either 0 (not checked) or 1 (checked)")
# The text associated with this box
@property
def text(self):
"""
Sets or returns the text of the CheckBox.
"""
return (self._text)
# Set whether the box is checked or not
@text.setter
def text(self, text):
self._text = str(text)
self.tk.config(text=self._text)
@property
def description(self):
"""
Returns the description for the widget.
"""
return "[CheckBox] object with text '{}'".format(self.text)
# METHODS
# -------------------------------------------
def toggle(self):
"""
Toggles the value of the CheckBox.
"""
self.tk.toggle()
def update_command(self, command, args=None):
"""
Updates the callback command which is called when the Combo
changes.
Setting to `None` stops the callback.
:param Callable command:
The callback function to call.
:param args list:
A list of argument values to pass to the callback. Defaults to
`None`.
"""
if command is None:
self._command = lambda: None
else:
if args is None:
self._command = command
else:
self._command = utils.with_args(command, *args)
def _command_callback(self):
self._command()
|
