Skip to content

Commit 2ef490c

Browse files
UnsignedArduinoUnsignedArduino
committed
Add text on progress bar
1 parent 11eb3ef commit 2ef490c

File tree

4 files changed

+272
-11
lines changed

4 files changed

+272
-11
lines changed

‎Examples/Widgets/Progressbar/Progressbar.py

+3-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
import tkinter as tk
21
from random import randint
32

43
from TkZero.Button import Button
5-
from TkZero.Label import Label
64
from TkZero.MainWindow import MainWindow
75
from TkZero.Progressbar import Progressbar
86

@@ -25,22 +23,19 @@ def get_bytes():
2523
else:
2624
# Just so that we don't go over the limit. In a real situation, you wouldn't need to do this.
2725
bar.value = bar.maximum
28-
label.text = f"{round(bar.value / 1024 / 1024, 2)}/{round(bar.maximum / 1024 / 1024, 2)} MiB downloaded"
26+
bar.text = f"{round(bar.value / 1024 / 1024, 2)}/{round(bar.maximum / 1024 / 1024, 2)} MiB downloaded"
2927

3028

3129
# Create a button to "start" the download
3230
start_btn = Button(root, text="Start download", command=start_download)
3331
start_btn.grid(row=0, column=0)
3432

3533
# Create a progress bar to represent the "download"
36-
bar = Progressbar(root, length=200)
34+
bar = Progressbar(root, length=500)
3735
bar.grid(row=1, column=0)
3836
bar.maximum = randint(1024*1024*128, 1024*1024*1024)
3937

40-
# Create a label to show the exact byte counts
41-
label = Label(root)
42-
label.grid(row=2, column=0, sticky=tk.NW)
43-
label.text = f"File is {round(bar.maximum / 1024 / 1024, 2)} MiB"
38+
bar.text = f"File is {round(bar.maximum / 1024 / 1024, 2)} MiB"
4439

4540
# Start the mainloop like in Tkinter
4641
root.mainloop()

‎Tests/test_Progressbar.py

+14
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,20 @@ def test_max(self):
5454
with self.assertRaises(TypeError):
5555
p.maximum = "5"
5656

57+
def test_text(self):
58+
p = Progressbar(self.root, orientation=OrientModes.Vertical,
59+
mode=ProgressModes.Determinate, length=200)
60+
p.grid(row=0, column=0)
61+
p.value = 0
62+
p.maximum = 100
63+
self.root.update()
64+
self.assertEqual(p.text, "")
65+
p.text = "Foobar"
66+
self.root.update()
67+
self.assertEqual(p.text, "Foobar")
68+
with self.assertRaises(TypeError):
69+
p.text = False
70+
5771
def test_indeterminate(self):
5872
p = Progressbar(self.root, orientation=OrientModes.Horizontal,
5973
mode=ProgressModes.Indeterminate, length=200)

‎TkZero/Progressbar.py

+80-1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ class ProgressModes:
3030
Indeterminate = "indeterminate"
3131

3232

33+
# Used for differentiating between the different styles
34+
_pbar_id = 0
35+
36+
3337
class Progressbar(ttk.Progressbar):
3438
def __init__(
3539
self,
@@ -68,7 +72,58 @@ def __init__(
6872
f"orientation is not a str! "
6973
f"(type passed in: {repr(type(orientation))})"
7074
)
71-
super().__init__(master=parent, orient=orientation, length=length, mode=mode)
75+
self._style = ttk.Style()
76+
global _pbar_id
77+
if mode == OrientModes.Horizontal:
78+
self.style_name = f"LabeledProgressbar{_pbar_id}.Horizontal.TProgressbar"
79+
self._style.layout(
80+
self.style_name,
81+
[
82+
(
83+
"Horizontal.Progressbar.trough",
84+
{
85+
"sticky": "nswe",
86+
"children": [
87+
(
88+
"Horizontal.Progressbar.pbar",
89+
{"side": "left", "sticky": "ns"},
90+
),
91+
(f"{self.style_name}.label", {"sticky": ""}),
92+
],
93+
},
94+
)
95+
],
96+
)
97+
else:
98+
self.style_name = f"LabeledProgressbar{_pbar_id}.Vertical.TProgressbar"
99+
self._style.layout(
100+
self.style_name,
101+
[
102+
(
103+
"Vertical.Progressbar.trough",
104+
{
105+
"sticky": "nswe",
106+
"children": [
107+
(
108+
"Vertical.Progressbar.pbar",
109+
{"side": "left", "sticky": "ns"},
110+
),
111+
(f"{self.style_name}.label", {"sticky": ""}),
112+
],
113+
},
114+
)
115+
],
116+
)
117+
_pbar_id += 1
118+
# https://stackoverflow.com/a/40348163/10291933
119+
self._text = ""
120+
super().__init__(
121+
master=parent,
122+
orient=orientation,
123+
length=length,
124+
mode=mode,
125+
style=self.style_name,
126+
)
72127
self._style_root = "TProgressbar"
73128
self._enabled = True
74129
self._orientation = orientation
@@ -121,6 +176,30 @@ def maximum(self, new_value: Union[int, float]) -> None:
121176
)
122177
self["maximum"] = float(new_value)
123178

179+
@property
180+
def text(self) -> str:
181+
"""
182+
Get the text on this progressbar.
183+
184+
:return: A str.
185+
"""
186+
return self._text
187+
188+
@text.setter
189+
def text(self, new_text: str) -> None:
190+
"""
191+
Set the text on this progressbar.
192+
193+
:param new_text: A str.
194+
:return: None.
195+
"""
196+
if not isinstance(new_text, str):
197+
raise TypeError(
198+
f"new_text is not a str! " f"(type passed in: {repr(type(new_text))})"
199+
)
200+
self._text = new_text
201+
self._style.configure(self.style_name, text=self._text)
202+
124203
@property
125204
def enabled(self) -> bool:
126205
"""

‎docs/Progressbar.html

+175-2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ <h1 class="title">Module <code>TkZero.Progressbar</code></h1>
5959
Indeterminate = &#34;indeterminate&#34;
6060

6161

62+
# Used for differentiating between the different styles
63+
_pbar_id = 0
64+
65+
6266
class Progressbar(ttk.Progressbar):
6367
def __init__(
6468
self,
@@ -97,7 +101,58 @@ <h1 class="title">Module <code>TkZero.Progressbar</code></h1>
97101
f&#34;orientation is not a str! &#34;
98102
f&#34;(type passed in: {repr(type(orientation))})&#34;
99103
)
100-
super().__init__(master=parent, orient=orientation, length=length, mode=mode)
104+
self._style = ttk.Style()
105+
global _pbar_id
106+
if mode == OrientModes.Horizontal:
107+
self.style_name = f&#34;LabeledProgressbar{_pbar_id}.Horizontal.TProgressbar&#34;
108+
self._style.layout(
109+
self.style_name,
110+
[
111+
(
112+
&#34;Horizontal.Progressbar.trough&#34;,
113+
{
114+
&#34;sticky&#34;: &#34;nswe&#34;,
115+
&#34;children&#34;: [
116+
(
117+
&#34;Horizontal.Progressbar.pbar&#34;,
118+
{&#34;side&#34;: &#34;left&#34;, &#34;sticky&#34;: &#34;ns&#34;},
119+
),
120+
(f&#34;{self.style_name}.label&#34;, {&#34;sticky&#34;: &#34;&#34;}),
121+
],
122+
},
123+
)
124+
],
125+
)
126+
else:
127+
self.style_name = f&#34;LabeledProgressbar{_pbar_id}.Vertical.TProgressbar&#34;
128+
self._style.layout(
129+
self.style_name,
130+
[
131+
(
132+
&#34;Vertical.Progressbar.trough&#34;,
133+
{
134+
&#34;sticky&#34;: &#34;nswe&#34;,
135+
&#34;children&#34;: [
136+
(
137+
&#34;Vertical.Progressbar.pbar&#34;,
138+
{&#34;side&#34;: &#34;left&#34;, &#34;sticky&#34;: &#34;ns&#34;},
139+
),
140+
(f&#34;{self.style_name}.label&#34;, {&#34;sticky&#34;: &#34;&#34;}),
141+
],
142+
},
143+
)
144+
],
145+
)
146+
_pbar_id += 1
147+
# https://stackoverflow.com/a/40348163/10291933
148+
self._text = &#34;&#34;
149+
super().__init__(
150+
master=parent,
151+
orient=orientation,
152+
length=length,
153+
mode=mode,
154+
style=self.style_name,
155+
)
101156
self._style_root = &#34;TProgressbar&#34;
102157
self._enabled = True
103158
self._orientation = orientation
@@ -150,6 +205,30 @@ <h1 class="title">Module <code>TkZero.Progressbar</code></h1>
150205
)
151206
self[&#34;maximum&#34;] = float(new_value)
152207

208+
@property
209+
def text(self) -&gt; str:
210+
&#34;&#34;&#34;
211+
Get the text on this progressbar.
212+
213+
:return: A str.
214+
&#34;&#34;&#34;
215+
return self._text
216+
217+
@text.setter
218+
def text(self, new_text: str) -&gt; None:
219+
&#34;&#34;&#34;
220+
Set the text on this progressbar.
221+
222+
:param new_text: A str.
223+
:return: None.
224+
&#34;&#34;&#34;
225+
if not isinstance(new_text, str):
226+
raise TypeError(
227+
f&#34;new_text is not a str! &#34; f&#34;(type passed in: {repr(type(new_text))})&#34;
228+
)
229+
self._text = new_text
230+
self._style.configure(self.style_name, text=self._text)
231+
153232
@property
154233
def enabled(self) -&gt; bool:
155234
&#34;&#34;&#34;
@@ -316,7 +395,58 @@ <h3>Class variables</h3>
316395
f&#34;orientation is not a str! &#34;
317396
f&#34;(type passed in: {repr(type(orientation))})&#34;
318397
)
319-
super().__init__(master=parent, orient=orientation, length=length, mode=mode)
398+
self._style = ttk.Style()
399+
global _pbar_id
400+
if mode == OrientModes.Horizontal:
401+
self.style_name = f&#34;LabeledProgressbar{_pbar_id}.Horizontal.TProgressbar&#34;
402+
self._style.layout(
403+
self.style_name,
404+
[
405+
(
406+
&#34;Horizontal.Progressbar.trough&#34;,
407+
{
408+
&#34;sticky&#34;: &#34;nswe&#34;,
409+
&#34;children&#34;: [
410+
(
411+
&#34;Horizontal.Progressbar.pbar&#34;,
412+
{&#34;side&#34;: &#34;left&#34;, &#34;sticky&#34;: &#34;ns&#34;},
413+
),
414+
(f&#34;{self.style_name}.label&#34;, {&#34;sticky&#34;: &#34;&#34;}),
415+
],
416+
},
417+
)
418+
],
419+
)
420+
else:
421+
self.style_name = f&#34;LabeledProgressbar{_pbar_id}.Vertical.TProgressbar&#34;
422+
self._style.layout(
423+
self.style_name,
424+
[
425+
(
426+
&#34;Vertical.Progressbar.trough&#34;,
427+
{
428+
&#34;sticky&#34;: &#34;nswe&#34;,
429+
&#34;children&#34;: [
430+
(
431+
&#34;Vertical.Progressbar.pbar&#34;,
432+
{&#34;side&#34;: &#34;left&#34;, &#34;sticky&#34;: &#34;ns&#34;},
433+
),
434+
(f&#34;{self.style_name}.label&#34;, {&#34;sticky&#34;: &#34;&#34;}),
435+
],
436+
},
437+
)
438+
],
439+
)
440+
_pbar_id += 1
441+
# https://stackoverflow.com/a/40348163/10291933
442+
self._text = &#34;&#34;
443+
super().__init__(
444+
master=parent,
445+
orient=orientation,
446+
length=length,
447+
mode=mode,
448+
style=self.style_name,
449+
)
320450
self._style_root = &#34;TProgressbar&#34;
321451
self._enabled = True
322452
self._orientation = orientation
@@ -369,6 +499,30 @@ <h3>Class variables</h3>
369499
)
370500
self[&#34;maximum&#34;] = float(new_value)
371501

502+
@property
503+
def text(self) -&gt; str:
504+
&#34;&#34;&#34;
505+
Get the text on this progressbar.
506+
507+
:return: A str.
508+
&#34;&#34;&#34;
509+
return self._text
510+
511+
@text.setter
512+
def text(self, new_text: str) -&gt; None:
513+
&#34;&#34;&#34;
514+
Set the text on this progressbar.
515+
516+
:param new_text: A str.
517+
:return: None.
518+
&#34;&#34;&#34;
519+
if not isinstance(new_text, str):
520+
raise TypeError(
521+
f&#34;new_text is not a str! &#34; f&#34;(type passed in: {repr(type(new_text))})&#34;
522+
)
523+
self._text = new_text
524+
self._style.configure(self.style_name, text=self._text)
525+
372526
@property
373527
def enabled(self) -&gt; bool:
374528
&#34;&#34;&#34;
@@ -448,6 +602,24 @@ <h3>Instance variables</h3>
448602
return self[&#34;maximum&#34;]</code></pre>
449603
</details>
450604
</dd>
605+
<dt id="TkZero.Progressbar.Progressbar.text"><code class="name">var <span class="ident">text</span> : str</code></dt>
606+
<dd>
607+
<div class="desc"><p>Get the text on this progressbar.</p>
608+
<p>:return: A str.</p></div>
609+
<details class="source">
610+
<summary>
611+
<span>Expand source code</span>
612+
</summary>
613+
<pre><code class="python">@property
614+
def text(self) -&gt; str:
615+
&#34;&#34;&#34;
616+
Get the text on this progressbar.
617+
618+
:return: A str.
619+
&#34;&#34;&#34;
620+
return self._text</code></pre>
621+
</details>
622+
</dd>
451623
<dt id="TkZero.Progressbar.Progressbar.value"><code class="name">var <span class="ident">value</span> : float</code></dt>
452624
<dd>
453625
<div class="desc"><p>Get the value on this progress bar.</p>
@@ -503,6 +675,7 @@ <h4><code><a title="TkZero.Progressbar.Progressbar" href="#TkZero.Progressbar.Pr
503675
<ul class="">
504676
<li><code><a title="TkZero.Progressbar.Progressbar.enabled" href="#TkZero.Progressbar.Progressbar.enabled">enabled</a></code></li>
505677
<li><code><a title="TkZero.Progressbar.Progressbar.maximum" href="#TkZero.Progressbar.Progressbar.maximum">maximum</a></code></li>
678+
<li><code><a title="TkZero.Progressbar.Progressbar.text" href="#TkZero.Progressbar.Progressbar.text">text</a></code></li>
506679
<li><code><a title="TkZero.Progressbar.Progressbar.value" href="#TkZero.Progressbar.Progressbar.value">value</a></code></li>
507680
</ul>
508681
</li>

0 commit comments

Comments
 (0)