8.5.8.9. pymodaq_gui.utils.shared_ui module

class pymodaq_gui.utils.shared_ui.MenuToolbarNames(*values)

Bases: StrEnum

FILE = 'file'

HELP = 'help'

RUNTIME = 'runtime'

SETTINGS = 'settings'

TOOLBARS = 'toolbars'

TOOLS = 'tools'

VIEW = 'view'

class pymodaq_gui.utils.shared_ui.PymodaqUpdateTableWidget

Bases: QTableWidget

A class to represent PyMoDAQ and its subpackages available updates as a table.

Methods

setHorizontalHeaderLabels(self, labels)
sizeHint()

append_row

append_row(package, current_version, available_version)

setHorizontalHeaderLabels(self, labels: Iterable[str | None])

sizeHint()

class pymodaq_gui.utils.shared_ui.SharedUI(widget, show=True, title=None)

Bases: CustomApp

This class is a UI wrapper that incorporates all base functionalities one want in a main PyMoDAQ app including default menu and toolbar with settings, log, help… shortcuts

Methods

affect_application(app)	Affect the given application to this SharedUI and add the App QMenus to the QMainWindow menubar reordering/merging them if necessary
connect_things()
quit_fun()	Quit the current instance of DashBoard and close on cascade move and detector modules.
setup_actions()
setup_docks_and_widgets()
setup_menus_and_toolbars([menubar])	Create the menubar object and toolbars:

check_update
hide
restart_fun
show
show_about
show_config
show_help
show_log

affect_application(app)

Affect the given application to this SharedUI and add the App QMenus to the QMainWindow menubar reordering/merging them if necessary

check_update(show=True)

connect_things()

hide()

quit_fun()

Quit the current instance of DashBoard and close on cascade move and detector modules.

See also

quit_fun

restart_fun(ask=False)

setup_actions()

setup_docks_and_widgets()

setup_menus_and_toolbars(menubar=None)

Create the menubar object and toolbars:

show(show=True)

show_about()

show_config(config)

show_help()

show_log()

pymodaq_gui.utils.shared_ui.main()