doocspie.pyqt
This subpackages provides the modules for convenient working with PyQt based GUI applications.
e_log_printer
Initialization module that appropriately sets up the namespace and imports.
- class doocspie.pyqt.e_log_printer.ELogPrinter(application_ui, printers, print_exceptions=True)
E-log printer class for providing e-log print dialogs.
This class offers the methods for providing dialogs for printing to e-logs.
- __init__(application_ui, printers, print_exceptions=True)
Constructor of the e-log printer class.
This constructor initializes the instance with the application’s ui, the printer (e-log) to print to and the optional ‘print_exceptions’ state.
- Parameters:
application_ui (subclass of QMainWindow) – The application’s PyQt ui.
printers (dict) – The e-logs (key) and printers (value).
print_exceptions (bool, optional) – The optional state for handling exceptions with a print dialog.
- show_dialog()
Showing a PyQt print dialog of the particular application for printing to a particular e-log.
- Returns:
None
concurrency
Module with concurrency support for convenient working with PyQt GUI applications.
This module provides the concurrency support for convenient working with PyQt GUI applications.
- class doocspie.pyqt.concurrency.Timer(function)
Timer class for higher level concurrency support for PyQt.
This class provides the higher level concurrency support for Timers in PyQt.
- __init__(function)
Constructor of the timer class.
This constructor initializes the instance with the function to repeatedly carry out.
- Parameters:
function (function) – The function to repeatedly carry out.
- start()
Start the timer with its associated function.
- Returns:
None
- stop()
Stop the timer with its associated function.
- Returns:
None
- is_active()
Return the timer’s activity state.
- Returns:
The state of the timer’s activity.
- Return type:
bool
messages
Module with message dialogs for convenient working with PyQt GUI applications.
This module provides the message dialogs for convenient working with PyQt GUI applications.
- doocspie.pyqt.messages.show_error(message)
Showing a PyQt error dialog with a given message.
- Parameters:
message (str) – The message to show in the PyQt error dialog.
- Returns:
None
- doocspie.pyqt.messages.show_warning(message)
Showing a PyQt warning dialog with a given message.
- Parameters:
message (str) – The message to show in the PyQt warning dialog.
- Returns:
None
- doocspie.pyqt.messages.show_about(application_ui, application_name, application_version)
Showing a PyQt about dialog of a given application with its name and version.
- Parameters:
application_ui (subclass of QMainWindow) – The application’s PyQt ui.
application_name (str) – The application’s name.
application_version (str) – The application’s version number.
- Returns:
None