def launch_suite(suite: TyphosSuite,
initial_size: Optional[QSize] = None) -> QMainWindow:
"""
Creates a main window and execs the application.
Parameters
----------
suite : TyphosSuite
The suite that we'd like to launch.
initial_size : QSize, optional
If provided, the initial size for the full suite window.
This can be useful when creating launcher scripts when
the default window size isn't very good for that
particular suite (e.g. flow layouts)
Returns
-------
window : QMainWindow
The window that we created. This will not be returned until
after the application is done running. This is primarily
useful for unit tests.
"""
window = QMainWindow()
window.setCentralWidget(suite)
window.setWindowTitle(suite.windowTitle())
window.setUnifiedTitleAndToolBarOnMac(True)
if initial_size is not None:
window.resize(initial_size)
window.show()
logger.info("Launching application ...")
get_qapp().exec_()
logger.info("Execution complete!")
return window
def status_bar(qtbot):
"""Set up StatusBarWidget."""
win = QMainWindow()
win.setWindowTitle("Status widgets test")
win.resize(900, 300)
statusbar = win.statusBar()
qtbot.addWidget(win)
return (win, statusbar)
def status_bar(qtbot):
"""Set up StatusBarWidget."""
win = QMainWindow()
win.setWindowTitle("Status widgets test")
win.resize(900, 300)
statusbar = win.statusBar()
qtbot.addWidget(win)
return (win, statusbar)
def test():
from qtpy.QtWidgets import QMainWindow
from spyder.utils.qthelpers import qapplication
app = qapplication(test_time=5)
win = QMainWindow()
win.setWindowTitle("Status widgets test")
win.resize(900, 300)
statusbar = win.statusBar()
status_widgets = []
for status_class in (MemoryStatus, CPUStatus):
status_widget = status_class(win, statusbar)
status_widgets.append(status_widget)
win.show()
app.exec_()
def test():
from qtpy.QtWidgets import QMainWindow
from spyder.utils.qthelpers import qapplication
app = qapplication(test_time=5)
win = QMainWindow()
win.setWindowTitle("Status widgets test")
win.resize(900, 300)
statusbar = win.statusBar()
status_widgets = []
for status_class in (MemoryStatus, CPUStatus):
status_widget = status_class(win, statusbar)
status_widgets.append(status_widget)
win.show()
app.exec_()
def test():
from qtpy.QtWidgets import QMainWindow
from spyderlib.utils.qthelpers import qapplication
app = qapplication(test_time=5)
win = QMainWindow()
win.setWindowTitle("Status widgets test")
win.resize(900, 300)
statusbar = win.statusBar()
swidgets = []
for klass in (ReadWriteStatus, EOLStatus, EncodingStatus,
CursorPositionStatus, MemoryStatus, CPUStatus):
swidget = klass(win, statusbar)
swidgets.append(swidget)
win.show()
app.exec_()
def test():
from qtpy.QtWidgets import QMainWindow
from spyder.utils.qthelpers import qapplication
app = qapplication(test_time=5)
win = QMainWindow()
win.setWindowTitle("Status widgets test")
win.resize(900, 300)
statusbar = win.statusBar()
swidgets = []
for klass in (ReadWriteStatus, EOLStatus, EncodingStatus,
CursorPositionStatus, MemoryStatus, CPUStatus):
swidget = klass(win, statusbar)
swidgets.append(swidget)
win.show()
app.exec_()
def test_widget(widget_class,
size=None,
title=None,
options=True,
timeout=1000):
"""Test widget"""
widget_name = widget_class.__name__
app = QApplication([])
window = widget = widget_class()
if options:
if isinstance(widget, QMainWindow):
widget = window.centralWidget()
widget.setParent(None)
else:
window = QMainWindow()
central_widget = TestCentralWidget(widget_name, parent=window)
central_widget.add_widget(widget)
window.setCentralWidget(central_widget)
widget_of_interest = central_widget.widget_of_interest
else:
widget_of_interest = window
widget_of_interest.setObjectName(widget_name)
if title is None:
from qwt import __version__
title = 'Test "%s" - PythonQwt %s' % (widget_name, __version__)
window.setWindowTitle(title)
if size is not None:
width, height = size
window.resize(width, height)
window.show()
if os.environ.get("TEST_UNATTENDED") is not None:
QTimer.singleShot(timeout, lambda: take_screenshot(widget_of_interest))
app.exec_()
return app
class Window:
"""Application window that contains the menu bar and viewer.
Parameters
----------
qt_viewer : QtViewer
Contained viewer widget.
Attributes
----------
qt_viewer : QtViewer
Contained viewer widget.
"""
with open(os.path.join(resources_dir, 'stylesheet.qss'), 'r') as f:
raw_stylesheet = f.read()
def __init__(self, qt_viewer, *, show=True):
self.qt_viewer = qt_viewer
self._qt_window = QMainWindow()
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
self._qt_center = QWidget(self._qt_window)
self._qt_window.setCentralWidget(self._qt_center)
self._qt_window.setWindowTitle(self.qt_viewer.viewer.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = QStatusBar()
self._qt_window.setStatusBar(self._status_bar)
self._qt_window.closeEvent = self.closeEvent
self.close = self._qt_window.close
self._add_menubar()
self._add_file_menu()
self._add_view_menu()
self._add_window_menu()
self._add_help_menu()
self._status_bar.showMessage('Ready')
self._help = QLabel('')
self._status_bar.addPermanentWidget(self._help)
self._qt_center.layout().addWidget(self.qt_viewer)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
self._update_palette(qt_viewer.viewer.palette)
if self.qt_viewer.console.shell is not None:
self._add_viewer_dock_widget(self.qt_viewer.dockConsole)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerControls)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerList)
self.qt_viewer.viewer.events.status.connect(self._status_changed)
self.qt_viewer.viewer.events.help.connect(self._help_changed)
self.qt_viewer.viewer.events.title.connect(self._title_changed)
self.qt_viewer.viewer.events.palette.connect(
lambda event: self._update_palette(event.palette))
if show:
self.show()
def _add_menubar(self):
self.main_menu = self._qt_window.menuBar()
# Menubar shortcuts are only active when the menubar is visible.
# Therefore, we set a global shortcut not associated with the menubar
# to toggle visibility, *but*, in order to not shadow the menubar
# shortcut, we disable it, and only enable it when the menubar is
# hidden. See this stackoverflow link for details:
# https://stackoverflow.com/questions/50537642/how-to-keep-the-shortcuts-of-a-hidden-widget-in-pyqt5
self._main_menu_shortcut = QShortcut(QKeySequence('Ctrl+M'),
self._qt_window)
self._main_menu_shortcut.activated.connect(
self._toggle_menubar_visible)
self._main_menu_shortcut.setEnabled(False)
def _toggle_menubar_visible(self):
"""Toggle visibility of app menubar.
This function also disables or enables a global keyboard shortcut to
show the menubar, since menubar shortcuts are only available while the
menubar is visible.
"""
if self.main_menu.isVisible():
self.main_menu.setVisible(False)
self._main_menu_shortcut.setEnabled(True)
else:
self.main_menu.setVisible(True)
self._main_menu_shortcut.setEnabled(False)
def _add_file_menu(self):
open_images = QAction('Open image(s)...', self._qt_window)
open_images.setShortcut('Ctrl+O')
open_images.setStatusTip('Open image file(s)')
open_images.triggered.connect(self.qt_viewer._open_images)
open_folder = QAction('Open Folder...', self._qt_window)
open_folder.setShortcut('Ctrl-Shift-O')
open_folder.setStatusTip(
'Open a folder of image file(s) or a zarr file')
open_folder.triggered.connect(self.qt_viewer._open_folder)
self.file_menu = self.main_menu.addMenu('&File')
self.file_menu.addAction(open_images)
self.file_menu.addAction(open_folder)
def _add_view_menu(self):
toggle_visible = QAction('Toggle menubar visibility', self._qt_window)
toggle_visible.setShortcut('Ctrl+M')
toggle_visible.setStatusTip('Hide Menubar')
toggle_visible.triggered.connect(self._toggle_menubar_visible)
self.view_menu = self.main_menu.addMenu('&View')
self.view_menu.addAction(toggle_visible)
def _add_window_menu(self):
exit_action = QAction("Close window", self._qt_window)
exit_action.setShortcut("Ctrl+W")
exit_action.setStatusTip('Close napari window')
exit_action.triggered.connect(self._qt_window.close)
self.window_menu = self.main_menu.addMenu('&Window')
self.window_menu.addAction(exit_action)
def _add_help_menu(self):
self.help_menu = self.main_menu.addMenu('&Help')
about_action = QAction("napari info", self._qt_window)
about_action.setShortcut("Ctrl+/")
about_action.setStatusTip('About napari')
about_action.triggered.connect(
lambda e: QtAbout.showAbout(self.qt_viewer))
self.help_menu.addAction(about_action)
about_keybindings = QAction("keybindings", self._qt_window)
about_keybindings.setShortcut("Ctrl+Alt+/")
about_keybindings.setShortcutContext(Qt.ApplicationShortcut)
about_keybindings.setStatusTip('keybindings')
about_keybindings.triggered.connect(
self.qt_viewer.aboutKeybindings.toggle_visible)
self.help_menu.addAction(about_keybindings)
def add_dock_widget(
self,
widget: QWidget,
*,
name: str = '',
area: str = 'bottom',
allowed_areas=None,
shortcut=None,
):
"""Convenience method to add a QDockWidget to the main window
Parameters
----------
widget : QWidget
`widget` will be added as QDockWidget's main widget.
name : str, optional
Name of dock widget to appear in window menu.
area : str
Side of the main window to which the new dock widget will be added.
Must be in {'left', 'right', 'top', 'bottom'}
allowed_areas : list[str], optional
Areas, relative to main window, that the widget is allowed dock.
Each item in list must be in {'left', 'right', 'top', 'bottom'}
By default, all areas are allowed.
shortcut : str, optional
Keyboard shortcut to appear in dropdown menu.
Returns
-------
dock_widget : QtViewerDockWidget
`dock_widget` that can pass viewer events.
"""
dock_widget = QtViewerDockWidget(
self.qt_viewer,
widget,
name=name,
area=area,
allowed_areas=allowed_areas,
shortcut=shortcut,
)
self._add_viewer_dock_widget(dock_widget)
return dock_widget
def _add_viewer_dock_widget(self, dock_widget: QtViewerDockWidget):
"""Add a QtViewerDockWidget to the main window
Parameters
----------
dock_widget : QtViewerDockWidget
`dock_widget` will be added to the main window.
"""
dock_widget.setParent(self._qt_window)
self._qt_window.addDockWidget(dock_widget.qt_area, dock_widget)
action = dock_widget.toggleViewAction()
action.setStatusTip(dock_widget.name)
action.setText(dock_widget.name)
if dock_widget.shortcut is not None:
action.setShortcut(dock_widget.shortcut)
self.window_menu.addAction(action)
def remove_dock_widget(self, widget):
"""Removes specified dock widget.
Parameters
----------
widget : QWidget | str
If widget == 'all', all docked widgets will be removed.
"""
if widget == 'all':
for dw in self._qt_window.findChildren(QDockWidget):
self._qt_window.removeDockWidget(dw)
else:
self._qt_window.removeDockWidget(widget)
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window."""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
# We want to call Window._qt_window.raise_() in every case *except*
# when instantiating a viewer within a gui_qt() context for the
# _first_ time within the Qt app's lifecycle.
#
# `app_name` will be "napari" iff the application was instantiated in
# gui_qt(). isActiveWindow() will be True if it is the second time a
# _qt_window has been created. See #732
app_name = QApplication.instance().applicationName()
if app_name != 'napari' or self._qt_window.isActiveWindow():
self._qt_window.raise_() # for macOS
self._qt_window.activateWindow() # for Windows
def _update_palette(self, palette):
# set window styles which don't use the primary stylesheet
# FIXME: this is a problem with the stylesheet not using properties
self._status_bar.setStyleSheet(
template(
'QStatusBar { background: {{ background }}; '
'color: {{ text }}; }',
**palette,
))
self._qt_center.setStyleSheet(
template('QWidget { background: {{ background }}; }', **palette))
self._qt_window.setStyleSheet(template(self.raw_stylesheet, **palette))
def _status_changed(self, event):
"""Update status bar.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
"""
self._help.setText(event.text)
def screenshot(self):
"""Take currently displayed viewer and convert to an image array.
Returns
-------
image : array
Numpy array of type ubyte and shape (h, w, 4). Index [0, 0] is the
upper-left corner of the rendered region.
"""
img = self._qt_window.grab().toImage()
return QImg2array(img)
def closeEvent(self, event):
# Forward close event to the console to trigger proper shutdown
self.qt_viewer.console.shutdown()
# if the viewer.QtDims object is playing an axis, we need to terminate the
# AnimationThread before close, otherwise it will cauyse a segFault or Abort trap.
# (calling stop() when no animation is occuring is also not a problem)
self.qt_viewer.dims.stop()
event.accept()
class Window:
"""Application window that contains the menu bar and viewer.
Parameters
----------
qt_viewer : QtViewer
Contained viewer widget.
Attributes
----------
qt_viewer : QtViewer
Contained viewer widget.
"""
def __init__(self, qt_viewer, *, show=True):
self.qt_viewer = qt_viewer
self._qt_window = QMainWindow()
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
self._qt_center = QWidget()
self._qt_window.setCentralWidget(self._qt_center)
self._qt_window.setWindowTitle(self.qt_viewer.viewer.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = self._qt_window.statusBar()
self._qt_window.closeEvent = self.closeEvent
self.close = self._qt_window.close
self._add_menubar()
self._add_file_menu()
self._add_view_menu()
self._add_window_menu()
self._status_bar.showMessage('Ready')
self._help = QLabel('')
self._status_bar.addPermanentWidget(self._help)
self._qt_center.layout().addWidget(self.qt_viewer)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
self._update_palette(qt_viewer.viewer.palette)
self.qt_viewer.viewer.events.status.connect(self._status_changed)
self.qt_viewer.viewer.events.help.connect(self._help_changed)
self.qt_viewer.viewer.events.title.connect(self._title_changed)
self.qt_viewer.viewer.events.palette.connect(
lambda event: self._update_palette(event.palette))
if show:
self.show()
def _add_menubar(self):
self.main_menu = self._qt_window.menuBar()
# Menubar shortcuts are only active when the menubar is visible.
# Therefore, we set a global shortcut not associated with the menubar
# to toggle visibility, *but*, in order to not shadow the menubar
# shortcut, we disable it, and only enable it when the menubar is
# hidden. See this stackoverflow link for details:
# https://stackoverflow.com/questions/50537642/how-to-keep-the-shortcuts-of-a-hidden-widget-in-pyqt5
self._main_menu_shortcut = QShortcut(QKeySequence('Ctrl+M'),
self._qt_window)
self._main_menu_shortcut.activated.connect(
self._toggle_menubar_visible)
self._main_menu_shortcut.setEnabled(False)
def _toggle_menubar_visible(self):
"""Toggle visibility of app menubar.
This function also disables or enables a global keyboard shortcut to
show the menubar, since menubar shortcuts are only available while the
menubar is visible.
"""
if self.main_menu.isVisible():
self.main_menu.setVisible(False)
self._main_menu_shortcut.setEnabled(True)
else:
self.main_menu.setVisible(True)
self._main_menu_shortcut.setEnabled(False)
def _add_file_menu(self):
open_images = QAction('Open', self._qt_window)
open_images.setShortcut('Ctrl+O')
open_images.setStatusTip('Open image file(s)')
open_images.triggered.connect(self.qt_viewer._open_images)
self.file_menu = self.main_menu.addMenu('&File')
self.file_menu.addAction(open_images)
def _add_view_menu(self):
toggle_visible = QAction('Toggle menubar visibility', self._qt_window)
toggle_visible.setShortcut('Ctrl+M')
toggle_visible.setStatusTip('Hide Menubar')
toggle_visible.triggered.connect(self._toggle_menubar_visible)
self.view_menu = self.main_menu.addMenu('&View')
self.view_menu.addAction(toggle_visible)
def _add_window_menu(self):
exit_action = QAction("Close window", self._qt_window)
exit_action.setShortcut("Ctrl+W")
exit_action.setStatusTip('Close napari window')
exit_action.triggered.connect(self._qt_window.close)
self.window_menu = self.main_menu.addMenu('&Window')
self.window_menu.addAction(exit_action)
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window.
"""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
self._qt_window.raise_()
def _update_palette(self, palette):
# set window styles which don't use the primary stylesheet
# FIXME: this is a problem with the stylesheet not using properties
self._status_bar.setStyleSheet(
template(
'QStatusBar { background: {{ background }}; '
'color: {{ text }}; }',
**palette,
))
self._qt_center.setStyleSheet(
template('QWidget { background: {{ background }}; }', **palette))
def _status_changed(self, event):
"""Update status bar.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
"""
self._help.setText(event.text)
def closeEvent(self, event):
# Forward close event to the console to trigger proper shutdown
self.qt_viewer.console.shutdown()
event.accept()
class Window:
"""Application window that contains the menu bar and viewer.
Parameters
----------
qt_viewer : QtViewer
Contained viewer widget.
Attributes
----------
file_menu : qtpy.QtWidgets.QMenu
File menu.
help_menu : qtpy.QtWidgets.QMenu
Help menu.
main_menu : qtpy.QtWidgets.QMainWindow.menuBar
Main menubar.
qt_viewer : QtViewer
Contained viewer widget.
view_menu : qtpy.QtWidgets.QMenu
View menu.
window_menu : qtpy.QtWidgets.QMenu
Window menu.
"""
raw_stylesheet = combine_stylesheets()
def __init__(self, qt_viewer, *, show=True):
self.qt_viewer = qt_viewer
self._qt_window = QMainWindow()
self._qt_window.setAttribute(Qt.WA_DeleteOnClose)
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
self._qt_center = QWidget(self._qt_window)
self._qt_window.setCentralWidget(self._qt_center)
self._qt_window.setWindowTitle(self.qt_viewer.viewer.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = QStatusBar()
self._qt_window.setStatusBar(self._status_bar)
self._add_menubar()
self._add_file_menu()
self._add_view_menu()
self._add_window_menu()
self._add_help_menu()
self._status_bar.showMessage('Ready')
self._help = QLabel('')
self._status_bar.addPermanentWidget(self._help)
self._qt_center.layout().addWidget(self.qt_viewer)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
self._update_palette(qt_viewer.viewer.palette)
if self.qt_viewer.console.shell is not None:
self._add_viewer_dock_widget(self.qt_viewer.dockConsole)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerControls)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerList)
self.qt_viewer.viewer.events.status.connect(self._status_changed)
self.qt_viewer.viewer.events.help.connect(self._help_changed)
self.qt_viewer.viewer.events.title.connect(self._title_changed)
self.qt_viewer.viewer.events.palette.connect(
lambda event: self._update_palette(event.palette))
if show:
self.show()
def _add_menubar(self):
"""Add menubar to napari app."""
self.main_menu = self._qt_window.menuBar()
# Menubar shortcuts are only active when the menubar is visible.
# Therefore, we set a global shortcut not associated with the menubar
# to toggle visibility, *but*, in order to not shadow the menubar
# shortcut, we disable it, and only enable it when the menubar is
# hidden. See this stackoverflow link for details:
# https://stackoverflow.com/questions/50537642/how-to-keep-the-shortcuts-of-a-hidden-widget-in-pyqt5
self._main_menu_shortcut = QShortcut(QKeySequence('Ctrl+M'),
self._qt_window)
self._main_menu_shortcut.activated.connect(
self._toggle_menubar_visible)
self._main_menu_shortcut.setEnabled(False)
def _toggle_menubar_visible(self):
"""Toggle visibility of app menubar.
This function also disables or enables a global keyboard shortcut to
show the menubar, since menubar shortcuts are only available while the
menubar is visible.
"""
if self.main_menu.isVisible():
self.main_menu.setVisible(False)
self._main_menu_shortcut.setEnabled(True)
else:
self.main_menu.setVisible(True)
self._main_menu_shortcut.setEnabled(False)
def _add_file_menu(self):
"""Add 'File' menu to app menubar."""
open_images = QAction('Open image(s)...', self._qt_window)
open_images.setShortcut('Ctrl+O')
open_images.setStatusTip('Open image file(s)')
open_images.triggered.connect(self.qt_viewer._open_images)
open_folder = QAction('Open Folder...', self._qt_window)
open_folder.setShortcut('Ctrl+Shift+O')
open_folder.setStatusTip(
'Open a folder of image file(s) or a zarr file')
open_folder.triggered.connect(self.qt_viewer._open_folder)
screenshot = QAction('Screenshot', self._qt_window)
screenshot.setShortcut('Ctrl+Alt+S')
screenshot.setStatusTip(
'Save screenshot of current display, default .png')
screenshot.triggered.connect(self.qt_viewer._save_screenshot)
self.file_menu = self.main_menu.addMenu('&File')
self.file_menu.addAction(open_images)
self.file_menu.addAction(open_folder)
self.file_menu.addAction(screenshot)
def _add_view_menu(self):
"""Add 'View' menu to app menubar."""
toggle_visible = QAction('Toggle menubar visibility', self._qt_window)
toggle_visible.setShortcut('Ctrl+M')
toggle_visible.setStatusTip('Hide Menubar')
toggle_visible.triggered.connect(self._toggle_menubar_visible)
toggle_theme = QAction('Toggle theme', self._qt_window)
toggle_theme.setShortcut('Ctrl+Shift+T')
toggle_theme.setStatusTip('Toggle theme')
toggle_theme.triggered.connect(self.qt_viewer.viewer._toggle_theme)
self.view_menu = self.main_menu.addMenu('&View')
self.view_menu.addAction(toggle_visible)
self.view_menu.addAction(toggle_theme)
def _add_window_menu(self):
"""Add 'Window' menu to app menubar."""
exit_action = QAction("Close window", self._qt_window)
exit_action.setShortcut("Ctrl+W")
exit_action.setStatusTip('Close napari window')
exit_action.triggered.connect(self._qt_window.close)
self.window_menu = self.main_menu.addMenu('&Window')
self.window_menu.addAction(exit_action)
def _add_help_menu(self):
"""Add 'Help' menu to app menubar."""
self.help_menu = self.main_menu.addMenu('&Help')
about_action = QAction("napari info", self._qt_window)
about_action.setShortcut("Ctrl+/")
about_action.setStatusTip('About napari')
about_action.triggered.connect(
lambda e: QtAbout.showAbout(self.qt_viewer))
self.help_menu.addAction(about_action)
about_keybindings = QAction("keybindings", self._qt_window)
about_keybindings.setShortcut("Ctrl+Alt+/")
about_keybindings.setShortcutContext(Qt.ApplicationShortcut)
about_keybindings.setStatusTip('keybindings')
about_keybindings.triggered.connect(
self.qt_viewer.show_keybindings_dialog)
self.help_menu.addAction(about_keybindings)
def add_dock_widget(
self,
widget: QWidget,
*,
name: str = '',
area: str = 'bottom',
allowed_areas=None,
shortcut=None,
):
"""Convenience method to add a QDockWidget to the main window
Parameters
----------
widget : QWidget
`widget` will be added as QDockWidget's main widget.
name : str, optional
Name of dock widget to appear in window menu.
area : str
Side of the main window to which the new dock widget will be added.
Must be in {'left', 'right', 'top', 'bottom'}
allowed_areas : list[str], optional
Areas, relative to main window, that the widget is allowed dock.
Each item in list must be in {'left', 'right', 'top', 'bottom'}
By default, all areas are allowed.
shortcut : str, optional
Keyboard shortcut to appear in dropdown menu.
Returns
-------
dock_widget : QtViewerDockWidget
`dock_widget` that can pass viewer events.
"""
dock_widget = QtViewerDockWidget(
self.qt_viewer,
widget,
name=name,
area=area,
allowed_areas=allowed_areas,
shortcut=shortcut,
)
self._add_viewer_dock_widget(dock_widget)
return dock_widget
def _add_viewer_dock_widget(self, dock_widget: QtViewerDockWidget):
"""Add a QtViewerDockWidget to the main window
Parameters
----------
dock_widget : QtViewerDockWidget
`dock_widget` will be added to the main window.
"""
dock_widget.setParent(self._qt_window)
self._qt_window.addDockWidget(dock_widget.qt_area, dock_widget)
action = dock_widget.toggleViewAction()
action.setStatusTip(dock_widget.name)
action.setText(dock_widget.name)
if dock_widget.shortcut is not None:
action.setShortcut(dock_widget.shortcut)
self.window_menu.addAction(action)
def remove_dock_widget(self, widget):
"""Removes specified dock widget.
Parameters
----------
widget : QWidget | str
If widget == 'all', all docked widgets will be removed.
"""
if widget == 'all':
for dw in self._qt_window.findChildren(QDockWidget):
self._qt_window.removeDockWidget(dw)
else:
self._qt_window.removeDockWidget(widget)
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window."""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
# We want to call Window._qt_window.raise_() in every case *except*
# when instantiating a viewer within a gui_qt() context for the
# _first_ time within the Qt app's lifecycle.
#
# `app_name` will be "napari" iff the application was instantiated in
# gui_qt(). isActiveWindow() will be True if it is the second time a
# _qt_window has been created. See #732
app_name = QApplication.instance().applicationName()
if app_name != 'napari' or self._qt_window.isActiveWindow():
self._qt_window.raise_() # for macOS
self._qt_window.activateWindow() # for Windows
def _update_palette(self, palette):
"""Update widget color palette.
Parameters
----------
palette : qtpy.QtGui.QPalette
Color palette for each widget state (Active, Disabled, Inactive).
"""
# set window styles which don't use the primary stylesheet
# FIXME: this is a problem with the stylesheet not using properties
self._status_bar.setStyleSheet(
template(
'QStatusBar { background: {{ background }}; '
'color: {{ text }}; }',
**palette,
))
self._qt_center.setStyleSheet(
template('QWidget { background: {{ background }}; }', **palette))
self._qt_window.setStyleSheet(template(self.raw_stylesheet, **palette))
def _status_changed(self, event):
"""Update status bar.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._help.setText(event.text)
def screenshot(self, path=None):
"""Take currently displayed viewer and convert to an image array.
Parameters
----------
path : str
Filename for saving screenshot image.
Returns
-------
image : array
Numpy array of type ubyte and shape (h, w, 4). Index [0, 0] is the
upper-left corner of the rendered region.
"""
img = self._qt_window.grab().toImage()
if path is not None:
imsave(path, QImg2array(img)) # scikit-image imsave method
return QImg2array(img)
def close(self):
"""Close the viewer window and cleanup sub-widgets."""
# on some versions of Darwin, exiting while fullscreen seems to tickle
# some bug deep in NSWindow. This forces the fullscreen keybinding
# test to complete its draw cycle, then pop back out of fullscreen.
if self._qt_window.isFullScreen():
self._qt_window.showNormal()
for i in range(8):
time.sleep(0.1)
QApplication.processEvents()
self.qt_viewer.close()
self._qt_window.close()
del self._qt_window
class Window:
"""Application window that contains the menu bar and viewers.
Parameters
----------
viewer : Viewer
Contained viewer.
Attributes
----------
viewer : Viewer
Contained viewer.
"""
def __init__(self, viewer, show=True):
self._qt_window = QMainWindow()
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
self._qt_center = QWidget()
self._qt_window.setCentralWidget(self._qt_center)
self._qt_window.setWindowTitle(viewer.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = self._qt_window.statusBar()
self._status_bar.showMessage('Ready')
self._help = QLabel('')
self._status_bar.addPermanentWidget(self._help)
self._status_bar.setStyleSheet("""QStatusBar { background: %s;
color: %s}""" % (palette['background'], palette['text']))
self.viewer = viewer
self._qt_center.layout().addWidget(self.viewer._qtviewer)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
self._qt_center.setStyleSheet('QWidget { background: %s;}' %
palette['background'])
self.viewer.events.status.connect(self._status_changed)
self.viewer.events.help.connect(self._help_changed)
self.viewer.events.title.connect(self._title_changed)
if show:
self.show()
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window.
"""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
self._qt_window.raise_()
def _status_changed(self, event):
"""Update status bar.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
"""
self._help.setText(event.text)
class Window:
"""Application window that contains the menu bar and viewer.
Parameters
----------
viewer : napari.components.ViewerModel
Contained viewer widget.
Attributes
----------
file_menu : qtpy.QtWidgets.QMenu
File menu.
help_menu : qtpy.QtWidgets.QMenu
Help menu.
main_menu : qtpy.QtWidgets.QMainWindow.menuBar
Main menubar.
qt_viewer : QtViewer
Contained viewer widget.
view_menu : qtpy.QtWidgets.QMenu
View menu.
window_menu : qtpy.QtWidgets.QMenu
Window menu.
"""
raw_stylesheet = get_stylesheet()
def __init__(self, viewer, *, show: bool = True):
# Check there is a running app
# instance() returns the singleton instance if it exists, or None
app = QApplication.instance()
# if None, raise a RuntimeError with the appropriate message
if app is None:
message = (
"napari requires a Qt event loop to run. To create one, "
"try one of the following: \n"
" - use the `napari.gui_qt()` context manager. See "
"https://github.com/napari/napari/tree/master/examples for"
" usage examples.\n"
" - In IPython or a local Jupyter instance, use the "
"`%gui qt` magic command.\n"
" - Launch IPython with the option `--gui=qt`.\n"
" - (recommended) in your IPython configuration file, add"
" or uncomment the line `c.TerminalIPythonApp.gui = 'qt'`."
" Then, restart IPython."
)
raise RuntimeError(message)
if perf_config:
if perf_config.trace_qt_events:
from .tracing.qt_event_tracing import convert_app_for_tracing
# For tracing Qt events we need a special QApplication. If
# using `gui_qt` we already have the special one, and no
# conversion is done here. However when running inside
# IPython or Jupyter this is where we switch out the
# QApplication.
app = convert_app_for_tracing(app)
# Will patch based on config file.
perf_config.patch_callables()
_napari_app_id = getattr(
viewer,
"_napari_app_id",
'napari.napari.viewer.' + str(__version__),
)
if (
platform.system() == "Windows"
and not getattr(sys, 'frozen', False)
and _napari_app_id
):
import ctypes
ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(
_napari_app_id
)
logopath = os.path.join(
os.path.dirname(__file__), '..', 'resources', 'logo.png'
)
if getattr(viewer, "_napari_global_logo", True):
app = QApplication.instance()
app.setWindowIcon(QIcon(logopath))
# see docstring of `wait_for_workers_to_quit` for caveats on killing
# workers at shutdown.
app.aboutToQuit.connect(wait_for_workers_to_quit)
# Connect the Viewer and create the Main Window
self.qt_viewer = QtViewer(viewer)
self._qt_window = QMainWindow()
self._qt_window.setWindowIcon(QIcon(logopath))
self._qt_window.setAttribute(Qt.WA_DeleteOnClose)
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
# since we initialize canvas before window, we need to manually connect them again.
if self._qt_window.windowHandle() is not None:
self._qt_window.windowHandle().screenChanged.connect(
self.qt_viewer.canvas._backend.screen_changed
)
self._qt_center = QWidget(self._qt_window)
self._qt_window.setCentralWidget(self._qt_center)
self._qt_window.setWindowTitle(self.qt_viewer.viewer.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = QStatusBar()
self._qt_window.setStatusBar(self._status_bar)
self._add_menubar()
self._add_file_menu()
self._add_view_menu()
self._add_window_menu()
if not os.getenv("DISABLE_ALL_PLUGINS"):
self._add_plugins_menu()
self._add_help_menu()
self._status_bar.showMessage('Ready')
self._help = QLabel('')
self._status_bar.addPermanentWidget(self._help)
self._qt_center.layout().addWidget(self.qt_viewer)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
self._update_palette()
self._add_viewer_dock_widget(self.qt_viewer.dockConsole)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerControls)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerList)
self.qt_viewer.viewer.events.status.connect(self._status_changed)
self.qt_viewer.viewer.events.help.connect(self._help_changed)
self.qt_viewer.viewer.events.title.connect(self._title_changed)
self.qt_viewer.viewer.events.palette.connect(self._update_palette)
if perf.USE_PERFMON:
# Add DebugMenu and dockPerformance if using perfmon.
self._debug_menu = DebugMenu(self)
self._add_viewer_dock_widget(self.qt_viewer.dockPerformance)
else:
self._debug_menu = None
if show:
self.show()
def _add_menubar(self):
"""Add menubar to napari app."""
self.main_menu = self._qt_window.menuBar()
# Menubar shortcuts are only active when the menubar is visible.
# Therefore, we set a global shortcut not associated with the menubar
# to toggle visibility, *but*, in order to not shadow the menubar
# shortcut, we disable it, and only enable it when the menubar is
# hidden. See this stackoverflow link for details:
# https://stackoverflow.com/questions/50537642/how-to-keep-the-shortcuts-of-a-hidden-widget-in-pyqt5
self._main_menu_shortcut = QShortcut(
QKeySequence('Ctrl+M'), self._qt_window
)
self._main_menu_shortcut.activated.connect(
self._toggle_menubar_visible
)
self._main_menu_shortcut.setEnabled(False)
def _toggle_menubar_visible(self):
"""Toggle visibility of app menubar.
This function also disables or enables a global keyboard shortcut to
show the menubar, since menubar shortcuts are only available while the
menubar is visible.
"""
if self.main_menu.isVisible():
self.main_menu.setVisible(False)
self._main_menu_shortcut.setEnabled(True)
else:
self.main_menu.setVisible(True)
self._main_menu_shortcut.setEnabled(False)
def _add_file_menu(self):
"""Add 'File' menu to app menubar."""
open_images = QAction('Open File(s)...', self._qt_window)
open_images.setShortcut('Ctrl+O')
open_images.setStatusTip('Open file(s)')
open_images.triggered.connect(self.qt_viewer._open_files_dialog)
open_stack = QAction('Open Files as Stack...', self._qt_window)
open_stack.setShortcut('Ctrl+Alt+O')
open_stack.setStatusTip('Open files')
open_stack.triggered.connect(
self.qt_viewer._open_files_dialog_as_stack_dialog
)
open_folder = QAction('Open Folder...', self._qt_window)
open_folder.setShortcut('Ctrl+Shift+O')
open_folder.setStatusTip('Open a folder')
open_folder.triggered.connect(self.qt_viewer._open_folder_dialog)
save_selected_layers = QAction(
'Save Selected Layer(s)...', self._qt_window
)
save_selected_layers.setShortcut('Ctrl+S')
save_selected_layers.setStatusTip('Save selected layers')
save_selected_layers.triggered.connect(
lambda: self.qt_viewer._save_layers_dialog(selected=True)
)
save_all_layers = QAction('Save All Layers...', self._qt_window)
save_all_layers.setShortcut('Ctrl+Shift+S')
save_all_layers.setStatusTip('Save all layers')
save_all_layers.triggered.connect(
lambda: self.qt_viewer._save_layers_dialog(selected=False)
)
screenshot = QAction('Save Screenshot...', self._qt_window)
screenshot.setShortcut('Alt+S')
screenshot.setStatusTip(
'Save screenshot of current display, default .png'
)
screenshot.triggered.connect(self.qt_viewer._screenshot_dialog)
screenshot_wv = QAction(
'Save Screenshot with Viewer...', self._qt_window
)
screenshot_wv.setShortcut('Alt+Shift+S')
screenshot_wv.setStatusTip(
'Save screenshot of current display with the viewer, default .png'
)
screenshot_wv.triggered.connect(self._screenshot_dialog)
# OS X will rename this to Quit and put it in the app menu.
exitAction = QAction('Exit', self._qt_window)
exitAction.setShortcut('Ctrl+Q')
exitAction.setMenuRole(QAction.QuitRole)
def handle_exit():
# if the event loop was started in gui_qt() then the app will be
# named 'napari'. Since the Qapp was started by us, just close it.
if QApplication.applicationName() == 'napari':
QApplication.closeAllWindows()
QApplication.quit()
# otherwise, something else created the QApp before us (such as
# %gui qt IPython magic). If we quit the app in this case, then
# *later* attempts to instantiate a napari viewer won't work until
# the event loop is restarted with app.exec_(). So rather than
# quit just close all the windows (and clear our app icon).
else:
QApplication.setWindowIcon(QIcon())
self.close()
if perf.USE_PERFMON:
# Write trace file before exit, if we were writing one.
# Is there a better place to make sure this is done on exit?
perf.timers.stop_trace_file()
_stop_monitor()
exitAction.triggered.connect(handle_exit)
self.file_menu = self.main_menu.addMenu('&File')
self.file_menu.addAction(open_images)
self.file_menu.addAction(open_stack)
self.file_menu.addAction(open_folder)
self.file_menu.addSeparator()
self.file_menu.addAction(save_selected_layers)
self.file_menu.addAction(save_all_layers)
self.file_menu.addAction(screenshot)
self.file_menu.addAction(screenshot_wv)
self.file_menu.addSeparator()
self.file_menu.addAction(exitAction)
def _add_view_menu(self):
"""Add 'View' menu to app menubar."""
toggle_visible = QAction('Toggle Menubar Visibility', self._qt_window)
toggle_visible.setShortcut('Ctrl+M')
toggle_visible.setStatusTip('Hide Menubar')
toggle_visible.triggered.connect(self._toggle_menubar_visible)
toggle_theme = QAction('Toggle Theme', self._qt_window)
toggle_theme.setShortcut('Ctrl+Shift+T')
toggle_theme.setStatusTip('Toggle theme')
toggle_theme.triggered.connect(self.qt_viewer.viewer._toggle_theme)
toggle_fullscreen = QAction('Toggle Full Screen', self._qt_window)
toggle_fullscreen.setShortcut('Ctrl+F')
toggle_fullscreen.setStatusTip('Toggle full screen')
toggle_fullscreen.triggered.connect(self._toggle_fullscreen)
toggle_play = QAction('Toggle Play', self._qt_window)
toggle_play.triggered.connect(self._toggle_play)
toggle_play.setShortcut('Ctrl+Alt+P')
toggle_play.setStatusTip('Toggle Play')
self.view_menu = self.main_menu.addMenu('&View')
self.view_menu.addAction(toggle_fullscreen)
self.view_menu.addAction(toggle_visible)
self.view_menu.addAction(toggle_theme)
self.view_menu.addAction(toggle_play)
self.view_menu.addSeparator()
# Add octree actions.
if config.async_octree:
toggle_outline = QAction('Toggle Chunk Outlines', self._qt_window)
toggle_outline.triggered.connect(
self.qt_viewer._toggle_chunk_outlines
)
toggle_outline.setShortcut('Ctrl+Alt+O')
toggle_outline.setStatusTip('Toggle Chunk Outlines')
self.view_menu.addAction(toggle_outline)
# Add axes menu
axes_menu = QMenu('Axes', parent=self._qt_window)
axes_visible_action = QAction(
'Visible',
parent=self._qt_window,
checkable=True,
checked=self.qt_viewer.viewer.axes.visible,
)
axes_visible_action.triggered.connect(self._toggle_axes_visible)
axes_colored_action = QAction(
'Colored',
parent=self._qt_window,
checkable=True,
checked=self.qt_viewer.viewer.axes.colored,
)
axes_colored_action.triggered.connect(self._toggle_axes_colored)
axes_labels_action = QAction(
'Labels',
parent=self._qt_window,
checkable=True,
checked=self.qt_viewer.viewer.axes.labels,
)
axes_labels_action.triggered.connect(self._toggle_axes_labels)
axes_dashed_action = QAction(
'Dashed',
parent=self._qt_window,
checkable=True,
checked=self.qt_viewer.viewer.axes.dashed,
)
axes_dashed_action.triggered.connect(self._toggle_axes_dashed)
axes_arrows_action = QAction(
'Arrows',
parent=self._qt_window,
checkable=True,
checked=self.qt_viewer.viewer.axes.arrows,
)
axes_arrows_action.triggered.connect(self._toggle_axes_arrows)
axes_menu.addAction(axes_visible_action)
axes_menu.addAction(axes_colored_action)
axes_menu.addAction(axes_labels_action)
axes_menu.addAction(axes_dashed_action)
axes_menu.addAction(axes_arrows_action)
self.view_menu.addMenu(axes_menu)
# Add scale bar menu
scale_bar_menu = QMenu('Scale Bar', parent=self._qt_window)
scale_bar_visible_action = QAction(
'Visible',
parent=self._qt_window,
checkable=True,
checked=self.qt_viewer.viewer.scale_bar.visible,
)
scale_bar_visible_action.triggered.connect(
self._toggle_scale_bar_visible
)
scale_bar_colored_action = QAction(
'Colored',
parent=self._qt_window,
checkable=True,
checked=self.qt_viewer.viewer.scale_bar.colored,
)
scale_bar_colored_action.triggered.connect(
self._toggle_scale_bar_colored
)
scale_bar_ticks_action = QAction(
'Ticks',
parent=self._qt_window,
checkable=True,
checked=self.qt_viewer.viewer.scale_bar.ticks,
)
scale_bar_ticks_action.triggered.connect(self._toggle_scale_bar_ticks)
scale_bar_menu.addAction(scale_bar_visible_action)
scale_bar_menu.addAction(scale_bar_colored_action)
scale_bar_menu.addAction(scale_bar_ticks_action)
self.view_menu.addMenu(scale_bar_menu)
self.view_menu.addSeparator()
def _add_window_menu(self):
"""Add 'Window' menu to app menubar."""
exit_action = QAction("Close Window", self._qt_window)
exit_action.setShortcut("Ctrl+W")
exit_action.setStatusTip('Close napari window')
exit_action.triggered.connect(self._qt_window.close)
self.window_menu = self.main_menu.addMenu('&Window')
self.window_menu.addAction(exit_action)
def _add_plugins_menu(self):
"""Add 'Plugins' menu to app menubar."""
self.plugins_menu = self.main_menu.addMenu('&Plugins')
pip_install_action = QAction(
"Install/Uninstall Package(s)...", self._qt_window
)
pip_install_action.triggered.connect(self._show_plugin_install_dialog)
self.plugins_menu.addAction(pip_install_action)
order_plugin_action = QAction("Plugin Call Order...", self._qt_window)
order_plugin_action.setStatusTip('Change call order for plugins')
order_plugin_action.triggered.connect(self._show_plugin_sorter)
self.plugins_menu.addAction(order_plugin_action)
report_plugin_action = QAction("Plugin Errors...", self._qt_window)
report_plugin_action.setStatusTip(
'Review stack traces for plugin exceptions and notify developers'
)
report_plugin_action.triggered.connect(self._show_plugin_err_reporter)
self.plugins_menu.addAction(report_plugin_action)
def _show_plugin_sorter(self):
"""Show dialog that allows users to sort the call order of plugins."""
plugin_sorter = QtPluginSorter(parent=self._qt_window)
if hasattr(self, 'plugin_sorter_widget'):
self.plugin_sorter_widget.show()
else:
self.plugin_sorter_widget = self.add_dock_widget(
plugin_sorter, name='Plugin Sorter', area="right"
)
def _show_plugin_install_dialog(self):
"""Show dialog that allows users to sort the call order of plugins."""
self.plugin_dialog = QtPluginDialog(self._qt_window)
self.plugin_dialog.exec_()
def _show_plugin_err_reporter(self):
"""Show dialog that allows users to review and report plugin errors."""
QtPluginErrReporter(parent=self._qt_window).exec_()
def _add_help_menu(self):
"""Add 'Help' menu to app menubar."""
self.help_menu = self.main_menu.addMenu('&Help')
about_action = QAction("napari Info", self._qt_window)
about_action.setShortcut("Ctrl+/")
about_action.setStatusTip('About napari')
about_action.triggered.connect(
lambda e: QtAbout.showAbout(self.qt_viewer)
)
self.help_menu.addAction(about_action)
about_key_bindings = QAction("Show Key Bindings", self._qt_window)
about_key_bindings.setShortcut("Ctrl+Alt+/")
about_key_bindings.setShortcutContext(Qt.ApplicationShortcut)
about_key_bindings.setStatusTip('key_bindings')
about_key_bindings.triggered.connect(
self.qt_viewer.show_key_bindings_dialog
)
self.help_menu.addAction(about_key_bindings)
def _toggle_scale_bar_visible(self, state):
self.qt_viewer.viewer.scale_bar.visible = state
def _toggle_scale_bar_colored(self, state):
self.qt_viewer.viewer.scale_bar.colored = state
def _toggle_scale_bar_ticks(self, state):
self.qt_viewer.viewer.scale_bar.ticks = state
def _toggle_axes_visible(self, state):
self.qt_viewer.viewer.axes.visible = state
def _toggle_axes_colored(self, state):
self.qt_viewer.viewer.axes.colored = state
def _toggle_axes_labels(self, state):
self.qt_viewer.viewer.axes.labels = state
def _toggle_axes_dashed(self, state):
self.qt_viewer.viewer.axes.dashed = state
def _toggle_axes_arrows(self, state):
self.qt_viewer.viewer.axes.arrows = state
def _toggle_fullscreen(self, event):
"""Toggle fullscreen mode."""
if self._qt_window.isFullScreen():
self._qt_window.showNormal()
else:
self._qt_window.showFullScreen()
def _toggle_play(self, state):
"""Toggle play."""
if self.qt_viewer.dims.is_playing:
self.qt_viewer.dims.stop()
else:
axis = self.qt_viewer.viewer.dims.last_used or 0
self.qt_viewer.dims.play(axis)
def add_dock_widget(
self,
widget: QWidget,
*,
name: str = '',
area: str = 'bottom',
allowed_areas=None,
shortcut=None,
):
"""Convenience method to add a QDockWidget to the main window
Parameters
----------
widget : QWidget
`widget` will be added as QDockWidget's main widget.
name : str, optional
Name of dock widget to appear in window menu.
area : str
Side of the main window to which the new dock widget will be added.
Must be in {'left', 'right', 'top', 'bottom'}
allowed_areas : list[str], optional
Areas, relative to main window, that the widget is allowed dock.
Each item in list must be in {'left', 'right', 'top', 'bottom'}
By default, all areas are allowed.
shortcut : str, optional
Keyboard shortcut to appear in dropdown menu.
Returns
-------
dock_widget : QtViewerDockWidget
`dock_widget` that can pass viewer events.
"""
dock_widget = QtViewerDockWidget(
self.qt_viewer,
widget,
name=name,
area=area,
allowed_areas=allowed_areas,
shortcut=shortcut,
)
self._add_viewer_dock_widget(dock_widget)
return dock_widget
def _add_viewer_dock_widget(self, dock_widget: QtViewerDockWidget):
"""Add a QtViewerDockWidget to the main window
Parameters
----------
dock_widget : QtViewerDockWidget
`dock_widget` will be added to the main window.
"""
dock_widget.setParent(self._qt_window)
self._qt_window.addDockWidget(dock_widget.qt_area, dock_widget)
action = dock_widget.toggleViewAction()
action.setStatusTip(dock_widget.name)
action.setText(dock_widget.name)
if dock_widget.shortcut is not None:
action.setShortcut(dock_widget.shortcut)
self.window_menu.addAction(action)
def remove_dock_widget(self, widget):
"""Removes specified dock widget.
Parameters
----------
widget : QWidget | str
If widget == 'all', all docked widgets will be removed.
"""
if widget == 'all':
for dw in self._qt_window.findChildren(QDockWidget):
self._qt_window.removeDockWidget(dw)
else:
self._qt_window.removeDockWidget(widget)
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window."""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
# Resize axis labels now that window is shown
self.qt_viewer.dims._resize_axis_labels()
# We want to bring the viewer to the front when
# A) it is our own (gui_qt) event loop OR we are running in jupyter
# B) it is not the first time a QMainWindow is being created
# `app_name` will be "napari" iff the application was instantiated in
# gui_qt(). isActiveWindow() will be True if it is the second time a
# _qt_window has been created.
# See #721, #732, #735, #795, #1594
app_name = QApplication.instance().applicationName()
if (
app_name == 'napari' or in_jupyter()
) and self._qt_window.isActiveWindow():
self.activate()
def activate(self):
"""Make the viewer the currently active window."""
self._qt_window.raise_() # for macOS
self._qt_window.activateWindow() # for Windows
def _update_palette(self, event=None):
"""Update widget color palette."""
# set window styles which don't use the primary stylesheet
# FIXME: this is a problem with the stylesheet not using properties
palette = self.qt_viewer.viewer.palette
self._status_bar.setStyleSheet(
template(
'QStatusBar { background: {{ background }}; '
'color: {{ text }}; }',
**palette,
)
)
self._qt_center.setStyleSheet(
template('QWidget { background: {{ background }}; }', **palette)
)
self._qt_window.setStyleSheet(template(self.raw_stylesheet, **palette))
def _status_changed(self, event):
"""Update status bar.
Parameters
----------
event : napari.utils.event.Event
The napari event that triggered this method.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
Parameters
----------
event : napari.utils.event.Event
The napari event that triggered this method.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
Parameters
----------
event : napari.utils.event.Event
The napari event that triggered this method.
"""
self._help.setText(event.text)
def _screenshot_dialog(self):
"""Save screenshot of current display with viewer, default .png"""
dial = ScreenshotDialog(
self.screenshot, self.qt_viewer, self.qt_viewer._last_visited_dir
)
if dial.exec_():
self._last_visited_dir = os.path.dirname(dial.selectedFiles()[0])
def screenshot(self, path=None):
"""Take currently displayed viewer and convert to an image array.
Parameters
----------
path : str
Filename for saving screenshot image.
Returns
-------
image : array
Numpy array of type ubyte and shape (h, w, 4). Index [0, 0] is the
upper-left corner of the rendered region.
"""
img = self._qt_window.grab().toImage()
if path is not None:
imsave(path, QImg2array(img)) # scikit-image imsave method
return QImg2array(img)
def close(self):
"""Close the viewer window and cleanup sub-widgets."""
# Someone is closing us twice? Only try to delete self._qt_window
# if we still have one.
if hasattr(self, '_qt_window'):
self._delete_qt_window()
def _delete_qt_window(self):
"""Delete our self._qt_window."""
# On some versions of Darwin, exiting while fullscreen seems to tickle
# some bug deep in NSWindow. This forces the fullscreen keybinding
# test to complete its draw cycle, then pop back out of fullscreen.
if self._qt_window.isFullScreen():
self._qt_window.showNormal()
for i in range(8):
time.sleep(0.1)
QApplication.processEvents()
self.qt_viewer.close()
self._qt_window.close()
del self._qt_window
class Window:
"""Application window that contains the menu bar and viewer.
Parameters
----------
qt_widget : QtViewer
Contained viewer widget.
Attributes
----------
file_menu : qtpy.QtWidgets.QMenu
File menu.
help_menu : qtpy.QtWidgets.QMenu
Help menu.
main_menu : qtpy.QtWidgets.QMainWindow.menuBar
Main menubar.
qt_widget : QtViewer
Contained viewer widget.
view_menu : qtpy.QtWidgets.QMenu
View menu.
window_menu : qtpy.QtWidgets.QMenu
Window menu.
"""
def __init__(self, qt_widget, *, show):
self.qt_widget = qt_widget
self._qt_window = QMainWindow()
self._qt_window.setAttribute(Qt.WA_DeleteOnClose)
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
self._qt_center = QWidget(self._qt_window)
self._qt_window.setCentralWidget(self._qt_center)
if hasattr(self.qt_widget.model, "title"):
self._qt_window.setWindowTitle(self.qt_widget.model.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = QStatusBar()
self._qt_window.setStatusBar(self._status_bar)
self._status_bar.showMessage("Ready")
self._help = QLabel("")
self._status_bar.addPermanentWidget(self._help)
self._qt_center.layout().addWidget(self.qt_widget)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
# self._add_viewer_dock_widget(self.qt_widget.dockConsole)
# self._add_viewer_dock_widget(self.qt_widget.dockLayerControls)
# self._add_viewer_dock_widget(self.qt_widget.dockLayerList)
# self.qt_widget.viewer.events.status.connect(self._status_changed)
# self.qt_widget.viewer.events.help.connect(self._help_changed)
# self.qt_widget.viewer.events.title.connect(self._title_changed)
# self.qt_widget.viewer.events.palette.connect(self._update_palette)
if show:
self.show()
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window."""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
# We want to call Window._qt_window.raise_() in every case *except*
# when instantiating a viewer within a gui_qt() context for the
# _first_ time within the Qt app's lifecycle.
#
# `app_name` will be ours iff the application was instantiated in
# gui_qt(). isActiveWindow() will be True if it is the second time a
# _qt_window has been created. See #732
app_name = QApplication.instance().applicationName()
if app_name != get_our_app_name() or self._qt_window.isActiveWindow():
self._qt_window.raise_() # for macOS
self._qt_window.activateWindow() # for Windows
def _status_changed(self, event):
"""Update status bar.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._help.setText(event.text)
def _screenshot_dialog(self):
"""Save screenshot of current display with viewer, default .png"""
filename, _ = QFileDialog.getSaveFileName(
parent=self.qt_widget,
caption="Save screenshot with viewer",
directory=self.qt_widget._last_visited_dir, # home dir by default
filter="Image files (*.png *.bmp *.gif *.tif *.tiff)", # first one used by default
# jpg and jpeg not included as they don't support an alpha channel
)
if (filename != "") and (filename is not None):
# double check that an appropriate extension has been added as the
# filter option does not always add an extension on linux and windows
# see https://bugreports.qt.io/browse/QTBUG-27186
image_extensions = (".bmp", ".gif", ".png", ".tif", ".tiff")
if not filename.endswith(image_extensions):
filename = filename + ".png"
self.screenshot(path=filename)
def screenshot(self, path=None):
"""Take currently displayed viewer and convert to an image array.
Parameters
----------
path : str
Filename for saving screenshot image.
Returns
-------
image : array
Numpy array of type ubyte and shape (h, w, 4). Index [0, 0] is the
upper-left corner of the rendered region.
"""
img = self._qt_window.grab().toImage()
if path is not None:
from skimage.io import imsave
from .utils import QImg2array # noqa: E402
imsave(path, QImg2array(img))
return QImg2array(img)
def close(self):
"""Close the viewer window and cleanup sub-widgets."""
# on some versions of Darwin, exiting while fullscreen seems to tickle
# some bug deep in NSWindow. This forces the fullscreen keybinding
# test to complete its draw cycle, then pop back out of fullscreen.
if self._qt_window.isFullScreen():
self._qt_window.showNormal()
for i in range(8):
time.sleep(0.1)
QApplication.processEvents()
self.qt_widget.close()
self._qt_window.close()
wait_for_workers_to_quit()
del self._qt_window
class Window:
"""Application window that contains the menu bar and viewer.
Parameters
----------
qt_viewer : QtViewer
Contained viewer widget.
Attributes
----------
file_menu : qtpy.QtWidgets.QMenu
File menu.
help_menu : qtpy.QtWidgets.QMenu
Help menu.
main_menu : qtpy.QtWidgets.QMainWindow.menuBar
Main menubar.
qt_viewer : QtViewer
Contained viewer widget.
view_menu : qtpy.QtWidgets.QMenu
View menu.
window_menu : qtpy.QtWidgets.QMenu
Window menu.
"""
raw_stylesheet = get_stylesheet()
def __init__(self, qt_viewer: QtViewer, *, show: bool = True):
self.qt_viewer = qt_viewer
self._qt_window = QMainWindow()
self._qt_window.setAttribute(Qt.WA_DeleteOnClose)
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
self._qt_center = QWidget(self._qt_window)
self._qt_window.setCentralWidget(self._qt_center)
self._qt_window.setWindowTitle(self.qt_viewer.viewer.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = QStatusBar()
self._qt_window.setStatusBar(self._status_bar)
self._add_menubar()
self._add_file_menu()
self._add_view_menu()
self._add_window_menu()
self._add_plugins_menu()
self._add_help_menu()
self._status_bar.showMessage('Ready')
self._help = QLabel('')
self._status_bar.addPermanentWidget(self._help)
self._qt_center.layout().addWidget(self.qt_viewer)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
self._update_palette()
self._add_viewer_dock_widget(self.qt_viewer.dockConsole)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerControls)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerList)
self.qt_viewer.viewer.events.status.connect(self._status_changed)
self.qt_viewer.viewer.events.help.connect(self._help_changed)
self.qt_viewer.viewer.events.title.connect(self._title_changed)
self.qt_viewer.viewer.events.palette.connect(self._update_palette)
if perf.USE_PERFMON:
# Add DebugMenu if using perfmon. The DebugMenu is intended to
# contain non-perfmon stuff as well. When it does we will want
# a separate env variable for it.
self._debug_menu = DebugMenu(self)
# The QtPerformance widget only exists if we are using perfmon.
self._add_viewer_dock_widget(self.qt_viewer.dockPerformance)
else:
self._debug_menu = None
if show:
self.show()
def _add_menubar(self):
"""Add menubar to napari app."""
self.main_menu = self._qt_window.menuBar()
# Menubar shortcuts are only active when the menubar is visible.
# Therefore, we set a global shortcut not associated with the menubar
# to toggle visibility, *but*, in order to not shadow the menubar
# shortcut, we disable it, and only enable it when the menubar is
# hidden. See this stackoverflow link for details:
# https://stackoverflow.com/questions/50537642/how-to-keep-the-shortcuts-of-a-hidden-widget-in-pyqt5
self._main_menu_shortcut = QShortcut(QKeySequence('Ctrl+M'),
self._qt_window)
self._main_menu_shortcut.activated.connect(
self._toggle_menubar_visible)
self._main_menu_shortcut.setEnabled(False)
def _toggle_menubar_visible(self):
"""Toggle visibility of app menubar.
This function also disables or enables a global keyboard shortcut to
show the menubar, since menubar shortcuts are only available while the
menubar is visible.
"""
if self.main_menu.isVisible():
self.main_menu.setVisible(False)
self._main_menu_shortcut.setEnabled(True)
else:
self.main_menu.setVisible(True)
self._main_menu_shortcut.setEnabled(False)
def _add_file_menu(self):
"""Add 'File' menu to app menubar."""
open_images = QAction('Open File(s)...', self._qt_window)
open_images.setShortcut('Ctrl+O')
open_images.setStatusTip('Open file(s)')
open_images.triggered.connect(self.qt_viewer._open_files_dialog)
open_stack = QAction('Open Files as Stack...', self._qt_window)
open_stack.setShortcut('Ctrl+Alt+O')
open_stack.setStatusTip('Open files')
open_stack.triggered.connect(
self.qt_viewer._open_files_dialog_as_stack_dialog)
open_folder = QAction('Open Folder...', self._qt_window)
open_folder.setShortcut('Ctrl+Shift+O')
open_folder.setStatusTip('Open a folder')
open_folder.triggered.connect(self.qt_viewer._open_folder_dialog)
save_selected_layers = QAction('Save Selected Layer(s)...',
self._qt_window)
save_selected_layers.setShortcut('Ctrl+S')
save_selected_layers.setStatusTip('Save selected layers')
save_selected_layers.triggered.connect(
lambda: self.qt_viewer._save_layers_dialog(selected=True))
save_all_layers = QAction('Save All Layers...', self._qt_window)
save_all_layers.setShortcut('Ctrl+Shift+S')
save_all_layers.setStatusTip('Save all layers')
save_all_layers.triggered.connect(
lambda: self.qt_viewer._save_layers_dialog(selected=False))
screenshot = QAction('Save Screenshot...', self._qt_window)
screenshot.setShortcut('Alt+S')
screenshot.setStatusTip(
'Save screenshot of current display, default .png')
screenshot.triggered.connect(self.qt_viewer._screenshot_dialog)
screenshot_wv = QAction('Save Screenshot with Viewer...',
self._qt_window)
screenshot_wv.setShortcut('Alt+Shift+S')
screenshot_wv.setStatusTip(
'Save screenshot of current display with the viewer, default .png')
screenshot_wv.triggered.connect(self._screenshot_dialog)
# OS X will rename this to Quit and put it in the app menu.
exitAction = QAction('Exit', self._qt_window)
exitAction.setShortcut('Ctrl+Q')
exitAction.setMenuRole(QAction.QuitRole)
def handle_exit():
# if the event loop was started in gui_qt() then the app will be
# named 'napari'. Since the Qapp was started by us, just close it.
if QApplication.applicationName() == 'napari':
QApplication.closeAllWindows()
QApplication.quit()
# otherwise, something else created the QApp before us (such as
# %gui qt IPython magic). If we quit the app in this case, then
# *later* attempts to instantiate a napari viewer won't work until
# the event loop is restarted with app.exec_(). So rather than
# quit just close all the windows (and clear our app icon).
else:
QApplication.setWindowIcon(QIcon())
self.close()
if perf.USE_PERFMON:
# Write trace file before exit, if we were writing one.
# Is there a better place to make sure this is done on exit?
perf.timers.stop_trace_file()
exitAction.triggered.connect(handle_exit)
self.file_menu = self.main_menu.addMenu('&File')
self.file_menu.addAction(open_images)
self.file_menu.addAction(open_stack)
self.file_menu.addAction(open_folder)
self.file_menu.addSeparator()
self.file_menu.addAction(save_selected_layers)
self.file_menu.addAction(save_all_layers)
self.file_menu.addAction(screenshot)
self.file_menu.addAction(screenshot_wv)
self.file_menu.addSeparator()
self.file_menu.addAction(exitAction)
def _add_view_menu(self):
"""Add 'View' menu to app menubar."""
toggle_visible = QAction('Toggle Menubar Visibility', self._qt_window)
toggle_visible.setShortcut('Ctrl+M')
toggle_visible.setStatusTip('Hide Menubar')
toggle_visible.triggered.connect(self._toggle_menubar_visible)
toggle_theme = QAction('Toggle Theme', self._qt_window)
toggle_theme.setShortcut('Ctrl+Shift+T')
toggle_theme.setStatusTip('Toggle theme')
toggle_theme.triggered.connect(self.qt_viewer.viewer._toggle_theme)
self.view_menu = self.main_menu.addMenu('&View')
self.view_menu.addAction(toggle_visible)
self.view_menu.addAction(toggle_theme)
def _add_window_menu(self):
"""Add 'Window' menu to app menubar."""
exit_action = QAction("Close Window", self._qt_window)
exit_action.setShortcut("Ctrl+W")
exit_action.setStatusTip('Close napari window')
exit_action.triggered.connect(self._qt_window.close)
self.window_menu = self.main_menu.addMenu('&Window')
self.window_menu.addAction(exit_action)
def _add_plugins_menu(self):
"""Add 'Plugins' menu to app menubar."""
self.plugins_menu = self.main_menu.addMenu('&Plugins')
list_plugins_action = QAction("List Installed Plugins...",
self._qt_window)
list_plugins_action.setStatusTip('List installed plugins')
list_plugins_action.triggered.connect(self._show_plugin_list)
self.plugins_menu.addAction(list_plugins_action)
order_plugin_action = QAction("Plugin Call Order...", self._qt_window)
order_plugin_action.setStatusTip('Change call order for plugins')
order_plugin_action.triggered.connect(self._show_plugin_sorter)
self.plugins_menu.addAction(order_plugin_action)
report_plugin_action = QAction("Plugin Errors...", self._qt_window)
report_plugin_action.setStatusTip(
'Review stack traces for plugin exceptions and notify developers')
report_plugin_action.triggered.connect(self._show_plugin_err_reporter)
self.plugins_menu.addAction(report_plugin_action)
def _show_plugin_list(self, plugin_manager=None):
"""Show dialog with a table of installed plugins and metadata."""
QtPluginTable(self._qt_window).exec_()
def _show_plugin_sorter(self):
"""Show dialog that allows users to sort the call order of plugins."""
plugin_sorter = QtPluginSorter(parent=self._qt_window)
dock_widget = self.add_dock_widget(plugin_sorter,
name='Plugin Sorter',
area="right")
plugin_sorter.finished.connect(dock_widget.close)
plugin_sorter.finished.connect(plugin_sorter.deleteLater)
plugin_sorter.finished.connect(dock_widget.deleteLater)
def _show_plugin_err_reporter(self):
"""Show dialog that allows users to review and report plugin errors."""
plugin_sorter = QtPluginErrReporter(parent=self._qt_window)
plugin_sorter.exec_()
def _add_help_menu(self):
"""Add 'Help' menu to app menubar."""
self.help_menu = self.main_menu.addMenu('&Help')
about_action = QAction("napari Info", self._qt_window)
about_action.setShortcut("Ctrl+/")
about_action.setStatusTip('About napari')
about_action.triggered.connect(
lambda e: QtAbout.showAbout(self.qt_viewer))
self.help_menu.addAction(about_action)
about_key_bindings = QAction("Show Key Bindings", self._qt_window)
about_key_bindings.setShortcut("Ctrl+Alt+/")
about_key_bindings.setShortcutContext(Qt.ApplicationShortcut)
about_key_bindings.setStatusTip('key_bindings')
about_key_bindings.triggered.connect(
self.qt_viewer.show_key_bindings_dialog)
self.help_menu.addAction(about_key_bindings)
def add_dock_widget(
self,
widget: QWidget,
*,
name: str = '',
area: str = 'bottom',
allowed_areas=None,
shortcut=None,
):
"""Convenience method to add a QDockWidget to the main window
Parameters
----------
widget : QWidget
`widget` will be added as QDockWidget's main widget.
name : str, optional
Name of dock widget to appear in window menu.
area : str
Side of the main window to which the new dock widget will be added.
Must be in {'left', 'right', 'top', 'bottom'}
allowed_areas : list[str], optional
Areas, relative to main window, that the widget is allowed dock.
Each item in list must be in {'left', 'right', 'top', 'bottom'}
By default, all areas are allowed.
shortcut : str, optional
Keyboard shortcut to appear in dropdown menu.
Returns
-------
dock_widget : QtViewerDockWidget
`dock_widget` that can pass viewer events.
"""
dock_widget = QtViewerDockWidget(
self.qt_viewer,
widget,
name=name,
area=area,
allowed_areas=allowed_areas,
shortcut=shortcut,
)
self._add_viewer_dock_widget(dock_widget)
return dock_widget
def _add_viewer_dock_widget(self, dock_widget: QtViewerDockWidget):
"""Add a QtViewerDockWidget to the main window
Parameters
----------
dock_widget : QtViewerDockWidget
`dock_widget` will be added to the main window.
"""
dock_widget.setParent(self._qt_window)
self._qt_window.addDockWidget(dock_widget.qt_area, dock_widget)
action = dock_widget.toggleViewAction()
action.setStatusTip(dock_widget.name)
action.setText(dock_widget.name)
if dock_widget.shortcut is not None:
action.setShortcut(dock_widget.shortcut)
self.window_menu.addAction(action)
def remove_dock_widget(self, widget):
"""Removes specified dock widget.
Parameters
----------
widget : QWidget | str
If widget == 'all', all docked widgets will be removed.
"""
if widget == 'all':
for dw in self._qt_window.findChildren(QDockWidget):
self._qt_window.removeDockWidget(dw)
else:
self._qt_window.removeDockWidget(widget)
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window."""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
# Resize axis labels now that window is shown
self.qt_viewer.dims._resize_axis_labels()
# We want to call Window._qt_window.raise_() in every case *except*
# when instantiating a viewer within a gui_qt() context for the
# _first_ time within the Qt app's lifecycle.
#
# `app_name` will be "napari" iff the application was instantiated in
# gui_qt(). isActiveWindow() will be True if it is the second time a
# _qt_window has been created. See #732
app_name = QApplication.instance().applicationName()
if app_name != 'napari' or self._qt_window.isActiveWindow():
self._qt_window.raise_() # for macOS
self._qt_window.activateWindow() # for Windows
def _update_palette(self, event=None):
"""Update widget color palette."""
# set window styles which don't use the primary stylesheet
# FIXME: this is a problem with the stylesheet not using properties
palette = self.qt_viewer.viewer.palette
self._status_bar.setStyleSheet(
template(
'QStatusBar { background: {{ background }}; '
'color: {{ text }}; }',
**palette,
))
self._qt_center.setStyleSheet(
template('QWidget { background: {{ background }}; }', **palette))
self._qt_window.setStyleSheet(template(self.raw_stylesheet, **palette))
def _status_changed(self, event):
"""Update status bar.
Parameters
----------
event : napari.utils.event.Event
The napari event that triggered this method.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
Parameters
----------
event : napari.utils.event.Event
The napari event that triggered this method.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
Parameters
----------
event : napari.utils.event.Event
The napari event that triggered this method.
"""
self._help.setText(event.text)
def _screenshot_dialog(self):
"""Save screenshot of current display with viewer, default .png"""
filename, _ = QFileDialog.getSaveFileName(
parent=self.qt_viewer,
caption='Save screenshot with viewer',
directory=self.qt_viewer._last_visited_dir, # home dir by default
filter=
"Image files (*.png *.bmp *.gif *.tif *.tiff)", # first one used by default
# jpg and jpeg not included as they don't support an alpha channel
)
if (filename != '') and (filename is not None):
# double check that an appropriate extension has been added as the
# filter option does not always add an extension on linux and windows
# see https://bugreports.qt.io/browse/QTBUG-27186
image_extensions = ('.bmp', '.gif', '.png', '.tif', '.tiff')
if not filename.endswith(image_extensions):
filename = filename + '.png'
self.screenshot(path=filename)
def screenshot(self, path=None):
"""Take currently displayed viewer and convert to an image array.
Parameters
----------
path : str
Filename for saving screenshot image.
Returns
-------
image : array
Numpy array of type ubyte and shape (h, w, 4). Index [0, 0] is the
upper-left corner of the rendered region.
"""
img = self._qt_window.grab().toImage()
if path is not None:
imsave(path, QImg2array(img)) # scikit-image imsave method
return QImg2array(img)
def close(self):
"""Close the viewer window and cleanup sub-widgets."""
# on some versions of Darwin, exiting while fullscreen seems to tickle
# some bug deep in NSWindow. This forces the fullscreen keybinding
# test to complete its draw cycle, then pop back out of fullscreen.
if self._qt_window.isFullScreen():
self._qt_window.showNormal()
for i in range(8):
time.sleep(0.1)
QApplication.processEvents()
self.qt_viewer.close()
self._qt_window.close()
del self._qt_window
class Window:
"""Application window that contains the menu bar and viewer.
Parameters
----------
qt_viewer : QtViewer
Contained viewer widget.
Attributes
----------
qt_viewer : QtViewer
Contained viewer widget.
"""
with open(os.path.join(resources_dir, 'stylesheet.qss'), 'r') as f:
raw_stylesheet = f.read()
def __init__(self, qt_viewer, *, show=True):
self.qt_viewer = qt_viewer
self._qt_window = QMainWindow()
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
self._qt_center = QWidget(self._qt_window)
self._qt_window.setCentralWidget(self._qt_center)
self._qt_window.setWindowTitle(self.qt_viewer.viewer.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = QStatusBar()
self._qt_window.setStatusBar(self._status_bar)
self._qt_window.closeEvent = self.closeEvent
self.close = self._qt_window.close
self._add_menubar()
self._add_file_menu()
self._add_view_menu()
self._add_window_menu()
self._add_help_menu()
self._status_bar.showMessage('Ready')
self._help = QLabel('')
self._status_bar.addPermanentWidget(self._help)
self._qt_center.layout().addWidget(self.qt_viewer)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
self._update_palette(qt_viewer.viewer.palette)
self.qt_viewer.viewer.events.status.connect(self._status_changed)
self.qt_viewer.viewer.events.help.connect(self._help_changed)
self.qt_viewer.viewer.events.title.connect(self._title_changed)
self.qt_viewer.viewer.events.palette.connect(
lambda event: self._update_palette(event.palette))
if show:
self.show()
def _add_menubar(self):
self.main_menu = self._qt_window.menuBar()
# Menubar shortcuts are only active when the menubar is visible.
# Therefore, we set a global shortcut not associated with the menubar
# to toggle visibility, *but*, in order to not shadow the menubar
# shortcut, we disable it, and only enable it when the menubar is
# hidden. See this stackoverflow link for details:
# https://stackoverflow.com/questions/50537642/how-to-keep-the-shortcuts-of-a-hidden-widget-in-pyqt5
self._main_menu_shortcut = QShortcut(QKeySequence('Ctrl+M'),
self._qt_window)
self._main_menu_shortcut.activated.connect(
self._toggle_menubar_visible)
self._main_menu_shortcut.setEnabled(False)
def _toggle_menubar_visible(self):
"""Toggle visibility of app menubar.
This function also disables or enables a global keyboard shortcut to
show the menubar, since menubar shortcuts are only available while the
menubar is visible.
"""
if self.main_menu.isVisible():
self.main_menu.setVisible(False)
self._main_menu_shortcut.setEnabled(True)
else:
self.main_menu.setVisible(True)
self._main_menu_shortcut.setEnabled(False)
def _add_file_menu(self):
open_images = QAction('Open image(s)...', self._qt_window)
open_images.setShortcut('Ctrl+O')
open_images.setStatusTip('Open image file(s)')
open_images.triggered.connect(self.qt_viewer._open_images)
open_folder = QAction('Open Folder...', self._qt_window)
open_folder.setShortcut('Ctrl-Shift-O')
open_folder.setStatusTip(
'Open a folder of image file(s) or a zarr file')
open_folder.triggered.connect(self.qt_viewer._open_folder)
self.file_menu = self.main_menu.addMenu('&File')
self.file_menu.addAction(open_images)
self.file_menu.addAction(open_folder)
def _add_view_menu(self):
toggle_visible = QAction('Toggle menubar visibility', self._qt_window)
toggle_visible.setShortcut('Ctrl+M')
toggle_visible.setStatusTip('Hide Menubar')
toggle_visible.triggered.connect(self._toggle_menubar_visible)
self.view_menu = self.main_menu.addMenu('&View')
self.view_menu.addAction(toggle_visible)
def _add_window_menu(self):
exit_action = QAction("Close window", self._qt_window)
exit_action.setShortcut("Ctrl+W")
exit_action.setStatusTip('Close napari window')
exit_action.triggered.connect(self._qt_window.close)
self.window_menu = self.main_menu.addMenu('&Window')
self.window_menu.addAction(exit_action)
def _add_help_menu(self):
self.help_menu = self.main_menu.addMenu('&Help')
about_action = QAction("napari info", self._qt_window)
about_action.setStatusTip('About napari')
about_action.triggered.connect(
lambda e: QtAbout.showAbout(self.qt_viewer))
self.help_menu.addAction(about_action)
keybidings_action = QAction("keybindings", self._qt_window)
keybidings_action.setShortcut("Ctrl+/")
keybidings_action.setStatusTip('About keybindings')
keybidings_action.triggered.connect(
lambda e: QtAboutKeybindings.showAbout(self.qt_viewer))
self.help_menu.addAction(keybidings_action)
def add_dock_widget(self,
area: str = 'bottom',
widget: QWidget = None,
allowed_areas=None):
"""Convenience method to add a QDockWidget to the main window
Parameters
----------
area : str
Side of the main window to which the new dock widget will be added.
Must be in {'left', 'right', 'top', 'bottom'}
widget : QWidget, optional
If provided, `widget` will be added as QDockWidget's main widget
allowed_areas : Qt.DockWidgetArea, optional
Areas, relative to main window, that the new dock is allowed to go.
"""
areas = {
'left': Qt.LeftDockWidgetArea,
'right': Qt.RightDockWidgetArea,
'top': Qt.TopDockWidgetArea,
'bottom': Qt.BottomDockWidgetArea,
}
if area not in areas:
raise ValueError(f'side argument must be in {list(areas.keys())}')
dock_widget = QDockWidget(self._qt_window)
dock_widget.setAllowedAreas(allowed_areas or (Qt.LeftDockWidgetArea
| Qt.BottomDockWidgetArea
| Qt.RightDockWidgetArea
| Qt.TopDockWidgetArea))
dock_widget.setMinimumHeight(50)
dock_widget.setMinimumWidth(50)
if isinstance(widget, QWidget):
dock_widget.setWidget(widget)
widget.setParent(dock_widget)
self._qt_window.addDockWidget(areas[area], dock_widget)
return dock_widget
def remove_dock_widget(self, widget):
"""Removes specified dock widget.
Parameters
----------
widget : QWidget | str
If widget == 'all', all docked widgets will be removed.
"""
if widget == 'all':
for dw in self._qt_window.findChildren(QDockWidget):
self._qt_window.removeDockWidget(dw)
else:
self._qt_window.removeDockWidget(widget)
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window.
"""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
def _update_palette(self, palette):
# set window styles which don't use the primary stylesheet
# FIXME: this is a problem with the stylesheet not using properties
self._status_bar.setStyleSheet(
template(
'QStatusBar { background: {{ background }}; '
'color: {{ text }}; }',
**palette,
))
self._qt_center.setStyleSheet(
template('QWidget { background: {{ background }}; }', **palette))
self._qt_window.setStyleSheet(template(self.raw_stylesheet, **palette))
def _status_changed(self, event):
"""Update status bar.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
"""
self._help.setText(event.text)
def closeEvent(self, event):
# Forward close event to the console to trigger proper shutdown
self.qt_viewer.console.shutdown()
# if the viewer.QtDims object is playing an axis, we need to terminate the
# AnimationThread before close, otherwise it will cauyse a segFault or Abort trap.
# (calling stop() when no animation is occuring is also not a problem)
self.qt_viewer.dims.stop()
event.accept()
class Window:
"""Application window that contains the menu bar and viewer.
Parameters
----------
qt_viewer : QtViewer
Contained viewer widget.
Attributes
----------
file_menu : qtpy.QtWidgets.QMenu
File menu.
help_menu : qtpy.QtWidgets.QMenu
Help menu.
main_menu : qtpy.QtWidgets.QMainWindow.menuBar
Main menubar.
qt_viewer : QtViewer
Contained viewer widget.
view_menu : qtpy.QtWidgets.QMenu
View menu.
window_menu : qtpy.QtWidgets.QMenu
Window menu.
"""
raw_stylesheet = get_stylesheet()
def __init__(self, qt_viewer, *, show=True):
self.qt_viewer = qt_viewer
self._qt_window = QMainWindow()
self._qt_window.setAttribute(Qt.WA_DeleteOnClose)
self._qt_window.setUnifiedTitleAndToolBarOnMac(True)
self._qt_center = QWidget(self._qt_window)
self._qt_window.setCentralWidget(self._qt_center)
self._qt_window.setWindowTitle(self.qt_viewer.viewer.title)
self._qt_center.setLayout(QHBoxLayout())
self._status_bar = QStatusBar()
self._qt_window.setStatusBar(self._status_bar)
self._add_menubar()
self._add_file_menu()
self._add_view_menu()
self._add_window_menu()
self._add_plugins_menu()
self._add_help_menu()
self._status_bar.showMessage('Ready')
self._help = QLabel('')
self._status_bar.addPermanentWidget(self._help)
self._qt_center.layout().addWidget(self.qt_viewer)
self._qt_center.layout().setContentsMargins(4, 0, 4, 0)
self._update_palette()
self._add_viewer_dock_widget(self.qt_viewer.dockConsole)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerControls)
self._add_viewer_dock_widget(self.qt_viewer.dockLayerList)
self.qt_viewer.viewer.events.status.connect(self._status_changed)
self.qt_viewer.viewer.events.help.connect(self._help_changed)
self.qt_viewer.viewer.events.title.connect(self._title_changed)
self.qt_viewer.viewer.events.palette.connect(self._update_palette)
if show:
self.show()
def _add_menubar(self):
"""Add menubar to napari app."""
self.main_menu = self._qt_window.menuBar()
# Menubar shortcuts are only active when the menubar is visible.
# Therefore, we set a global shortcut not associated with the menubar
# to toggle visibility, *but*, in order to not shadow the menubar
# shortcut, we disable it, and only enable it when the menubar is
# hidden. See this stackoverflow link for details:
# https://stackoverflow.com/questions/50537642/how-to-keep-the-shortcuts-of-a-hidden-widget-in-pyqt5
self._main_menu_shortcut = QShortcut(QKeySequence('Ctrl+M'),
self._qt_window)
self._main_menu_shortcut.activated.connect(
self._toggle_menubar_visible)
self._main_menu_shortcut.setEnabled(False)
def _toggle_menubar_visible(self):
"""Toggle visibility of app menubar.
This function also disables or enables a global keyboard shortcut to
show the menubar, since menubar shortcuts are only available while the
menubar is visible.
"""
if self.main_menu.isVisible():
self.main_menu.setVisible(False)
self._main_menu_shortcut.setEnabled(True)
else:
self.main_menu.setVisible(True)
self._main_menu_shortcut.setEnabled(False)
def _add_file_menu(self):
"""Add 'File' menu to app menubar."""
open_images = QAction('Open image(s)...', self._qt_window)
open_images.setShortcut('Ctrl+O')
open_images.setStatusTip('Open image file(s)')
open_images.triggered.connect(self.qt_viewer._open_images)
open_stack = QAction('Open image series as stack...', self._qt_window)
open_stack.setShortcut('Ctrl+Alt+O')
open_stack.setStatusTip('Open image files')
open_stack.triggered.connect(self.qt_viewer._open_images_as_stack)
open_folder = QAction('Open Folder...', self._qt_window)
open_folder.setShortcut('Ctrl+Shift+O')
open_folder.setStatusTip(
'Open a folder of image file(s) or a zarr file')
open_folder.triggered.connect(self.qt_viewer._open_folder)
screenshot = QAction('Screenshot', self._qt_window)
screenshot.setShortcut('Ctrl+Alt+S')
screenshot.setStatusTip(
'Save screenshot of current display, default .png')
screenshot.triggered.connect(self.qt_viewer._save_screenshot)
# OS X will rename this to Quit and put it in the app menu.
exitAction = QAction('Exit', self._qt_window)
exitAction.setShortcut('Ctrl+Q')
exitAction.setMenuRole(QAction.QuitRole)
def handle_exit():
# if the event loop was started in gui_qt() then the app will be
# named 'napari'. Since the Qapp was started by us, just close it.
if QApplication.applicationName() == 'napari':
QApplication.closeAllWindows()
QApplication.quit()
# otherwise, something else created the QApp before us (such as
# %gui qt IPython magic). If we quit the app in this case, then
# *later* attemps to instantiate a napari viewer won't work until
# the event loop is restarted with app.exec_(). So rather than
# quit just close all the windows (and clear our app icon).
else:
QApplication.setWindowIcon(QIcon())
self.close()
exitAction.triggered.connect(handle_exit)
self.file_menu = self.main_menu.addMenu('&File')
self.file_menu.addAction(open_images)
self.file_menu.addAction(open_stack)
self.file_menu.addAction(open_folder)
self.file_menu.addAction(screenshot)
self.file_menu.addAction(exitAction)
def _add_view_menu(self):
"""Add 'View' menu to app menubar."""
toggle_visible = QAction('Toggle menubar visibility', self._qt_window)
toggle_visible.setShortcut('Ctrl+M')
toggle_visible.setStatusTip('Hide Menubar')
toggle_visible.triggered.connect(self._toggle_menubar_visible)
toggle_theme = QAction('Toggle theme', self._qt_window)
toggle_theme.setShortcut('Ctrl+Shift+T')
toggle_theme.setStatusTip('Toggle theme')
toggle_theme.triggered.connect(self.qt_viewer.viewer._toggle_theme)
self.view_menu = self.main_menu.addMenu('&View')
self.view_menu.addAction(toggle_visible)
self.view_menu.addAction(toggle_theme)
def _add_window_menu(self):
"""Add 'Window' menu to app menubar."""
exit_action = QAction("Close window", self._qt_window)
exit_action.setShortcut("Ctrl+W")
exit_action.setStatusTip('Close napari window')
exit_action.triggered.connect(self._qt_window.close)
self.window_menu = self.main_menu.addMenu('&Window')
self.window_menu.addAction(exit_action)
def _add_plugins_menu(self):
"""Add 'Plugins' menu to app menubar."""
self.plugins_menu = self.main_menu.addMenu('&Plugins')
list_plugins_action = QAction("List installed plugins...",
self._qt_window)
list_plugins_action.setStatusTip('List installed plugins')
list_plugins_action.triggered.connect(self._show_plugin_list)
self.plugins_menu.addAction(list_plugins_action)
order_plugin_action = QAction("Plugin call order...", self._qt_window)
order_plugin_action.setStatusTip('Change call order for plugins')
order_plugin_action.triggered.connect(self._show_plugin_sorter)
self.plugins_menu.addAction(order_plugin_action)
report_plugin_action = QAction("Plugin errors...", self._qt_window)
report_plugin_action.setStatusTip(
'Review stack traces for plugin exceptions and notify developers')
report_plugin_action.triggered.connect(self._show_plugin_err_reporter)
self.plugins_menu.addAction(report_plugin_action)
def _show_plugin_list(self):
"""Show dialog with a table of installed plugins and metadata."""
from ..plugins import plugin_manager
dialog = QDialog(self._qt_window)
dialog.setMaximumHeight(800)
dialog.setMaximumWidth(1280)
layout = QVBoxLayout()
# maybe someday add a search bar here?
title = QLabel("Installed Plugins")
title.setObjectName("h2")
layout.addWidget(title)
# get metadata for successfully registered plugins
data = [
v for k, v in plugin_manager._plugin_meta.items()
if k in plugin_manager._name2plugin
]
# create a table for it
dialog.table = QtDictTable(
self._qt_window,
data,
headers=[
'plugin',
'package',
'version',
'url',
'author',
'license',
],
min_section_width=60,
)
dialog.table.setObjectName("pluginTable")
dialog.table.horizontalHeader().setObjectName("pluginTableHeader")
dialog.table.verticalHeader().setObjectName("pluginTableHeader")
dialog.table.setGridStyle(Qt.NoPen)
# prevent editing of table
dialog.table.setEditTriggers(QAbstractItemView.NoEditTriggers)
layout.addWidget(dialog.table)
dialog.setLayout(layout)
dialog.setAttribute(Qt.WA_DeleteOnClose)
self._plugin_list = dialog
dialog.exec_()
def _show_plugin_sorter(self):
"""Show dialog that allows users to sort the call order of plugins."""
plugin_sorter = QtPluginSorter(parent=self._qt_window)
dock_widget = self.add_dock_widget(plugin_sorter,
name='Plugin Sorter',
area="right")
plugin_sorter.finished.connect(dock_widget.close)
plugin_sorter.finished.connect(plugin_sorter.deleteLater)
plugin_sorter.finished.connect(dock_widget.deleteLater)
def _show_plugin_err_reporter(self):
"""Show dialog that allows users to review and report plugin errors."""
plugin_sorter = QtPluginErrReporter(parent=self._qt_window)
plugin_sorter.exec_()
def _add_help_menu(self):
"""Add 'Help' menu to app menubar."""
self.help_menu = self.main_menu.addMenu('&Help')
about_action = QAction("napari info", self._qt_window)
about_action.setShortcut("Ctrl+/")
about_action.setStatusTip('About napari')
about_action.triggered.connect(
lambda e: QtAbout.showAbout(self.qt_viewer))
self.help_menu.addAction(about_action)
about_key_bindings = QAction("Show key bindings", self._qt_window)
about_key_bindings.setShortcut("Ctrl+Alt+/")
about_key_bindings.setShortcutContext(Qt.ApplicationShortcut)
about_key_bindings.setStatusTip('key_bindings')
about_key_bindings.triggered.connect(
self.qt_viewer.show_key_bindings_dialog)
self.help_menu.addAction(about_key_bindings)
def add_dock_widget(
self,
widget: QWidget,
*,
name: str = '',
area: str = 'bottom',
allowed_areas=None,
shortcut=None,
):
"""Convenience method to add a QDockWidget to the main window
Parameters
----------
widget : QWidget
`widget` will be added as QDockWidget's main widget.
name : str, optional
Name of dock widget to appear in window menu.
area : str
Side of the main window to which the new dock widget will be added.
Must be in {'left', 'right', 'top', 'bottom'}
allowed_areas : list[str], optional
Areas, relative to main window, that the widget is allowed dock.
Each item in list must be in {'left', 'right', 'top', 'bottom'}
By default, all areas are allowed.
shortcut : str, optional
Keyboard shortcut to appear in dropdown menu.
Returns
-------
dock_widget : QtViewerDockWidget
`dock_widget` that can pass viewer events.
"""
dock_widget = QtViewerDockWidget(
self.qt_viewer,
widget,
name=name,
area=area,
allowed_areas=allowed_areas,
shortcut=shortcut,
)
self._add_viewer_dock_widget(dock_widget)
return dock_widget
def _add_viewer_dock_widget(self, dock_widget: QtViewerDockWidget):
"""Add a QtViewerDockWidget to the main window
Parameters
----------
dock_widget : QtViewerDockWidget
`dock_widget` will be added to the main window.
"""
dock_widget.setParent(self._qt_window)
self._qt_window.addDockWidget(dock_widget.qt_area, dock_widget)
action = dock_widget.toggleViewAction()
action.setStatusTip(dock_widget.name)
action.setText(dock_widget.name)
if dock_widget.shortcut is not None:
action.setShortcut(dock_widget.shortcut)
self.window_menu.addAction(action)
def remove_dock_widget(self, widget):
"""Removes specified dock widget.
Parameters
----------
widget : QWidget | str
If widget == 'all', all docked widgets will be removed.
"""
if widget == 'all':
for dw in self._qt_window.findChildren(QDockWidget):
self._qt_window.removeDockWidget(dw)
else:
self._qt_window.removeDockWidget(widget)
def resize(self, width, height):
"""Resize the window.
Parameters
----------
width : int
Width in logical pixels.
height : int
Height in logical pixels.
"""
self._qt_window.resize(width, height)
def show(self):
"""Resize, show, and bring forward the window."""
self._qt_window.resize(self._qt_window.layout().sizeHint())
self._qt_window.show()
# We want to call Window._qt_window.raise_() in every case *except*
# when instantiating a viewer within a gui_qt() context for the
# _first_ time within the Qt app's lifecycle.
#
# `app_name` will be "napari" iff the application was instantiated in
# gui_qt(). isActiveWindow() will be True if it is the second time a
# _qt_window has been created. See #732
app_name = QApplication.instance().applicationName()
if app_name != 'napari' or self._qt_window.isActiveWindow():
self._qt_window.raise_() # for macOS
self._qt_window.activateWindow() # for Windows
def _update_palette(self, event=None):
"""Update widget color palette."""
# set window styles which don't use the primary stylesheet
# FIXME: this is a problem with the stylesheet not using properties
palette = self.qt_viewer.viewer.palette
self._status_bar.setStyleSheet(
template(
'QStatusBar { background: {{ background }}; '
'color: {{ text }}; }',
**palette,
))
self._qt_center.setStyleSheet(
template('QWidget { background: {{ background }}; }', **palette))
self._qt_window.setStyleSheet(template(self.raw_stylesheet, **palette))
def _status_changed(self, event):
"""Update status bar.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._status_bar.showMessage(event.text)
def _title_changed(self, event):
"""Update window title.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._qt_window.setWindowTitle(event.text)
def _help_changed(self, event):
"""Update help message on status bar.
Parameters
----------
event : qtpy.QtCore.QEvent
Event from the Qt context.
"""
self._help.setText(event.text)
def screenshot(self, path=None):
"""Take currently displayed viewer and convert to an image array.
Parameters
----------
path : str
Filename for saving screenshot image.
Returns
-------
image : array
Numpy array of type ubyte and shape (h, w, 4). Index [0, 0] is the
upper-left corner of the rendered region.
"""
img = self._qt_window.grab().toImage()
if path is not None:
imsave(path, QImg2array(img)) # scikit-image imsave method
return QImg2array(img)
def close(self):
"""Close the viewer window and cleanup sub-widgets."""
# on some versions of Darwin, exiting while fullscreen seems to tickle
# some bug deep in NSWindow. This forces the fullscreen keybinding
# test to complete its draw cycle, then pop back out of fullscreen.
if self._qt_window.isFullScreen():
self._qt_window.showNormal()
for i in range(8):
time.sleep(0.1)
QApplication.processEvents()
self.qt_viewer.close()
self._qt_window.close()
del self._qt_window
central_widget.setWindowTitle(
'Embedding BlastSight\'s container in a PyQt5/PySide2 Application')
layout = QGridLayout(central_widget)
"""
Container inherits from QWidget, so you can insert it as any QWidget.
"""
container = Container(central_widget)
container.setSizePolicy(QSizePolicy.MinimumExpanding,
QSizePolicy.MinimumExpanding)
label_list = []
for i in range(3):
for j in range(3):
if i == j == 1:
continue
label = QLabel(central_widget)
label.setText('Other QWidget at (%d, %d)' % (i, j))
label.setAlignment(Qt.AlignHCenter | Qt.AlignVCenter)
layout.addWidget(label, i, j)
label_list.append(label)
layout.addWidget(container, 1, 1)
window = QMainWindow()
window.setCentralWidget(central_widget)
window.resize(800, 600)
window.show()
app.exec_()