12. Spinner¶
The Gtk.Spinner
displays an icon-size spinning animation.
It is often used as an alternative to a GtkProgressBar
for displaying indefinite activity, instead of actual progress.
To start the animation, use Gtk.Spinner.start()
,
to stop it use Gtk.Spinner.stop()
.
12.1. Example¶
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 | import gi gi.require_version("Gtk", "3.0") from gi.repository import Gtk class SpinnerAnimation(Gtk.Window): def __init__(self): super().__init__(title="Spinner") self.set_border_width(3) self.connect("destroy", Gtk.main_quit) self.button = Gtk.ToggleButton(label="Start Spinning") self.button.connect("toggled", self.on_button_toggled) self.button.set_active(False) self.spinner = Gtk.Spinner() self.grid = Gtk.Grid() self.grid.add(self.button) self.grid.attach_next_to( self.spinner, self.button, Gtk.PositionType.BOTTOM, 1, 2 ) self.grid.set_row_homogeneous(True) self.add(self.grid) self.show_all() def on_button_toggled(self, button): if button.get_active(): self.spinner.start() self.button.set_label("Stop Spinning") else: self.spinner.stop() self.button.set_label("Start Spinning") myspinner = SpinnerAnimation() Gtk.main() |
12.2. Extended example¶
An extended example that uses a timeout function to start and stop
the spinning animation.
The on_timeout()
function is called at regular intervals
until it returns False
, at which point the timeout is automatically
destroyed and the function will not be called again.
12.2.1. Example¶
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 | import gi gi.require_version("Gtk", "3.0") from gi.repository import Gtk, GLib class SpinnerWindow(Gtk.Window): def __init__(self, *args, **kwargs): super().__init__(title="Spinner Demo") self.set_border_width(10) mainBox = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, spacing=6) self.add(mainBox) self.spinner = Gtk.Spinner() mainBox.pack_start(self.spinner, True, True, 0) self.label = Gtk.Label() mainBox.pack_start(self.label, True, True, 0) self.entry = Gtk.Entry() self.entry.set_text("10") mainBox.pack_start(self.entry, True, True, 0) self.buttonStart = Gtk.Button(label="Start timer") self.buttonStart.connect("clicked", self.on_buttonStart_clicked) mainBox.pack_start(self.buttonStart, True, True, 0) self.buttonStop = Gtk.Button(label="Stop timer") self.buttonStop.set_sensitive(False) self.buttonStop.connect("clicked", self.on_buttonStop_clicked) mainBox.pack_start(self.buttonStop, True, True, 0) self.timeout_id = None self.connect("destroy", self.on_SpinnerWindow_destroy) def on_buttonStart_clicked(self, widget, *args): """ Handles "clicked" event of buttonStart. """ self.start_timer() def on_buttonStop_clicked(self, widget, *args): """ Handles "clicked" event of buttonStop. """ self.stop_timer("Stopped from button") def on_SpinnerWindow_destroy(self, widget, *args): """ Handles destroy event of main window. """ # ensure the timeout function is stopped if self.timeout_id: GLib.source_remove(self.timeout_id) self.timeout_id = None Gtk.main_quit() def on_timeout(self, *args, **kwargs): """ A timeout function. Return True to stop it. This is not a precise timer since next timeout is recalculated based on the current time.""" self.counter -= 1 if self.counter <= 0: self.stop_timer("Reached time out") return False self.label.set_label("Remaining: " + str(int(self.counter / 4))) return True def start_timer(self): """ Start the timer. """ self.buttonStart.set_sensitive(False) self.buttonStop.set_sensitive(True) # time out will check every 250 milliseconds (1/4 of a second) self.counter = 4 * int(self.entry.get_text()) self.label.set_label("Remaining: " + str(int(self.counter / 4))) self.spinner.start() self.timeout_id = GLib.timeout_add(250, self.on_timeout, None) def stop_timer(self, alabeltext): """ Stop the timer. """ if self.timeout_id: GLib.source_remove(self.timeout_id) self.timeout_id = None self.spinner.stop() self.buttonStart.set_sensitive(True) self.buttonStop.set_sensitive(False) self.label.set_label(alabeltext) win = SpinnerWindow() win.show_all() Gtk.main() |