# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX # All rights reserved. # # This software is provided without warranty under the terms of the BSD # license included in LICENSE.txt and may be redistributed only under # the conditions described in the aforementioned license. The license # is also available online at http://www.enthought.com/licenses/BSD.txt # # Thanks for using Enthought open source! """ A simple progress bar intended to run in the UI thread """ import time from pyface.qt import QtGui, QtCore from traits.api import ( Any, Bool, Callable, Instance, Int, List, Str, provides, Tuple ) from pyface.i_progress_dialog import IProgressDialog, MProgressDialog from .window import Window @provides(IProgressDialog) class ProgressDialog(MProgressDialog, Window): """ A simple progress dialog window which allows itself to be updated """ # FIXME: buttons are not set up correctly yet #: The progress bar widget progress_bar = Instance(QtGui.QProgressBar) #: The window title title = Str() #: The text message to display in the dialog message = Str() #: The minimum value of the progress range min = Int() #: The minimum value of the progress range max = Int() #: The margin around the progress bar margin = Int(5) #: Whether or not the progress dialog can be cancelled can_cancel = Bool(False) # The IProgressDialog interface doesn't declare this, but since this is a # feature of the QT backend ProgressDialog that doesn't appear in WX, we # offer an option to disable it. can_ok = Bool(False) #: Whether or not to show the time taken (not implemented in Qt) show_time = Bool(False) #: Whether or not to show the percent completed show_percent = Bool(False) #: The size of the dialog dialog_size = Instance(QtCore.QRect) #: Label for the 'cancel' button cancel_button_label = Str("Cancel") #: Whether or not the dialog was cancelled by the user _user_cancelled = Bool(False) #: The widget showing the message text _message_control = Instance(QtGui.QLabel) #: The widget showing the time elapsed _elapsed_control = Instance(QtGui.QLabel) #: The widget showing the estimated time to completion _estimated_control = Instance(QtGui.QLabel) #: The widget showing the estimated time remaining _remaining_control = Instance(QtGui.QLabel) # Private interface ---------------------------------------------------# #: A list of connected Qt signals to be removed before destruction. #: First item in the tuple is the Qt signal. The second item is the event #: handler. _connections_to_remove = List(Tuple(Any, Callable)) # ------------------------------------------------------------------------- # IWindow Interface # ------------------------------------------------------------------------- def open(self): """ Opens the window. """ super().open() self._start_time = time.time() def close(self): """ Closes the window. """ self.progress_bar.destroy() self.progress_bar = None super().close() # ------------------------------------------------------------------------- # 'IWidget' interface. # ------------------------------------------------------------------------- def destroy(self): while self._connections_to_remove: signal, handler = self._connections_to_remove.pop() signal.disconnect(handler) super().destroy() # ------------------------------------------------------------------------- # IProgressDialog Interface # ------------------------------------------------------------------------- def update(self, value): """ Update the progress bar to the desired value If the value is >= the maximum and the progress bar is not contained in another panel the parent window will be closed. Parameters ---------- value : The progress value to set. """ if self.progress_bar is None: return None, None if self.max > 0: self.progress_bar.setValue(value) if self.max != self.min: percent = (float(value) - self.min) / (self.max - self.min) else: percent = 1.0 if self.show_time and (percent != 0): current_time = time.time() elapsed = current_time - self._start_time estimated = elapsed / percent remaining = estimated - elapsed self._set_time_label(elapsed, self._elapsed_control) self._set_time_label(estimated, self._estimated_control) self._set_time_label(remaining, self._remaining_control) if value >= self.max or self._user_cancelled: self.close() else: self.progress_bar.setValue(self.progress_bar.value() + value) if self._user_cancelled: self.close() QtGui.QApplication.processEvents() return (not self._user_cancelled, False) # ------------------------------------------------------------------------- # Private Interface # ------------------------------------------------------------------------- def reject(self, event): self._user_cancelled = True self.close() def _set_time_label(self, value, control): hours = value / 3600 minutes = (value % 3600) / 60 seconds = value % 60 label = "%1u:%02u:%02u" % (hours, minutes, seconds) control.setText(label) def _create_buttons(self, dialog, layout): """ Creates the buttons. """ if not (self.can_cancel or self.can_ok): return # Create the button. buttons = QtGui.QDialogButtonBox() if self.can_cancel: buttons.addButton( self.cancel_button_label, QtGui.QDialogButtonBox.ButtonRole.RejectRole ) if self.can_ok: buttons.addButton(QtGui.QDialogButtonBox.StandardButton.Ok) # TODO: hookup the buttons to our methods, this may involve subclassing from QDialog if self.can_cancel: buttons.rejected.connect(dialog.reject) self._connections_to_remove.append( (buttons.rejected, dialog.reject) ) if self.can_ok: buttons.accepted.connect(dialog.accept) self._connections_to_remove.append( (buttons.accepted, dialog.accept) ) layout.addWidget(buttons) def _create_label(self, dialog, layout, text): dummy = QtGui.QLabel(text, dialog) dummy.setAlignment(QtCore.Qt.AlignmentFlag.AlignTop | QtCore.Qt.AlignmentFlag.AlignLeft) label = QtGui.QLabel("unknown", dialog) label.setAlignment( QtCore.Qt.AlignmentFlag.AlignTop | QtCore.Qt.AlignmentFlag.AlignLeft | QtCore.Qt.AlignmentFlag.AlignRight ) sub_layout = QtGui.QHBoxLayout() sub_layout.addWidget(dummy) sub_layout.addWidget(label) layout.addLayout(sub_layout) return label def _create_gauge(self, dialog, layout): self.progress_bar = QtGui.QProgressBar(dialog) self.progress_bar.setRange(self.min, self.max) layout.addWidget(self.progress_bar) if self.show_percent: self.progress_bar.setFormat("%p%") else: self.progress_bar.setFormat("%v") def _create_message(self, dialog, layout): label = QtGui.QLabel(self.message, dialog) label.setAlignment(QtCore.Qt.AlignmentFlag.AlignTop | QtCore.Qt.AlignmentFlag.AlignLeft) layout.addWidget(label) self._message_control = label def _create_percent(self, dialog, parent_sizer): if not self.show_percent: return raise NotImplementedError() def _create_timer(self, dialog, layout): if not self.show_time: return self._elapsed_control = self._create_label( dialog, layout, "Elapsed time : " ) self._estimated_control = self._create_label( dialog, layout, "Estimated time : " ) self._remaining_control = self._create_label( dialog, layout, "Remaining time : " ) def _create_control(self, parent): return QtGui.QDialog(parent) def create(self, parent=None): super().create(parent=parent) self._create_contents(self.control) def _create_contents(self, parent): dialog = parent layout = QtGui.QVBoxLayout(dialog) layout.setContentsMargins( self.margin, self.margin, self.margin, self.margin ) # The 'guts' of the dialog. self._create_message(dialog, layout) self._create_gauge(dialog, layout) self._create_timer(dialog, layout) self._create_buttons(dialog, layout) dialog.setWindowTitle(self.title) parent.setLayout(layout) # ------------------------------------------------------------------------- # Trait change handlers # ------------------------------------------------------------------------- def _max_changed(self, new): if self.progress_bar is not None: self.progress_bar.setMaximum(new) def _min_changed(self, new): if self.progress_bar is not None: self.progress_bar.setMinimum(new) def _message_changed(self, new): if self._message_control is not None: self._message_control.setText(new)