added the possibility to change the centralWidget

Author: Chilipp

psyplot_gui/common.py

@@ -7,7 +7,7 @@
 import os.path as osp
 from psyplot_gui.compat.qtcompat import (
     QDockWidget, QRegExpValidator, QtCore, QErrorMessage, QDesktopWidget,
-    QToolButton, QInputDialog, QIcon)
+    QToolButton, QInputDialog, QIcon, QAction)
 import logging
 
 if six.PY2:
@@ -39,6 +39,8 @@ class DockMixin(object):
     :attr:`title` attribute!
     """
 
+    _set_central_action = _view_action = None
+
     #: The position of the plugin
     dock_position = None
 
@@ -83,7 +85,9 @@ def to_dock(self, main, title=None, position=None, docktype='pane', *args,
             self.dock = self.dock_cls(title, main)
             self.dock.setWidget(self)
             main.dockwidgets.append(self.dock)
-        main.addDockWidget(position, self.dock, docktype, *args, **kwargs)
+            self.create_central_widget_action(main)
+            self.create_view_action(main, docktype)
+        main.addDockWidget(position, self.dock, *args, **kwargs)
         config_page = self.config_page
         if config_page is not None:
             main.config_pages.append(config_page)
@@ -108,6 +112,27 @@ def show_status_message(self, msg):
         except AttributeError:
             pass
 
+    def create_central_widget_action(self, main):
+        """Setup the action to make this plugin the central widget"""
+        if self._set_central_action is None:
+            menu = main.central_widgets_menu
+            group = main.central_widgets_actions
+            self._set_central_action = action = QAction(self.title)
+            action.setCheckable(True)
+            action.triggered.connect(partial(main.set_central_widget, self))
+            menu.addAction(action)
+            group.addAction(action)
+        return self._set_central_action
+
+    def create_view_action(self, main, docktype='pane'):
+        if self._view_action is None:
+            self._view_action = action = self.dock.toggleViewAction()
+            if docktype == 'pane':
+                main.panes_menu.addAction(action)
+            elif docktype == 'df':
+                main.dataframe_menu.addAction(action)
+        return self._view_action
+
 
 class LoadFromConsoleButton(QToolButton):
     """A toolbutton to load an object from the console"""

psyplot_gui/compat/qtcompat.py

@@ -26,7 +26,7 @@
         QIntValidator, QErrorMessage, QInputDialog, QTabWidget,
         QDoubleValidator, QGraphicsScene, QGraphicsRectItem, QGraphicsView,
         QKeySequence, QStyleOptionViewItem, QDialog, QDialogButtonBox,
-        QStackedWidget, QScrollArea, QTableView, QHeaderView)
+        QStackedWidget, QScrollArea, QTableView, QHeaderView, QActionGroup)
     from PyQt4 import QtCore
     from PyQt4.QtCore import Qt
     from PyQt4.QtWebKit import QWebView as QWebEngineView
@@ -77,7 +77,7 @@ def setCurrentText(self, s):
         QGridLayout, QErrorMessage, QInputDialog, QTabWidget,
         QGraphicsScene, QGraphicsRectItem, QGraphicsView, QStyleOptionViewItem,
         QDialog, QDialogButtonBox, QStackedWidget, QScrollArea,
-        QTableView, QHeaderView)
+        QTableView, QHeaderView, QActionGroup)
     from PyQt5.QtGui import (
         QIcon, QKeyEvent, QStandardItem, QStandardItemModel, QTextCursor,
         QValidator, QRegExpValidator, QIntValidator, QDoubleValidator,

psyplot_gui/console.py

@@ -24,6 +24,7 @@
 import psyplot
 import psyplot_gui
 from psyplot_gui import rcParams
+from psyplot_gui.common import DockMixin
 import psyplot.project as psy
 from psyplot.docstring import dedents
 
@@ -61,11 +62,15 @@ def keyPressEvent(self, event):
         QTextEdit.keyPressEvent(self, event)
 
 
-class ConsoleWidget(QtInProcessRichJupyterWidget):
+class ConsoleWidget(QtInProcessRichJupyterWidget, DockMixin):
     """A console widget to access an inprocess shell"""
 
     custom_control = IPythonControl
 
+    dock_position = Qt.RightDockWidgetArea
+
+    title = 'Console'
+
     rc = rcParams.find_and_replace(
         'console.', pattern_base='console\.')
 

psyplot_gui/main.py

@@ -31,7 +31,7 @@
 from psyplot_gui.compat.qtcompat import (
     QMainWindow, QApplication, Qt, QMenu, QAction, QDesktopWidget, QLabel,
     QFileDialog, QKeySequence, QtCore, with_qt5, QMessageBox, QIcon,
-    QInputDialog)
+    QInputDialog, QActionGroup)
 from psyplot_gui.content_widget import (
     ProjectContentWidget, DatasetTree, FiguresTree)
 from psyplot_gui.plot_creator import PlotCreator
@@ -108,6 +108,10 @@ class MainWindow(QMainWindow):
     #: The current keyboard shortcuts
     current_shortcuts = []
 
+    #: The key for the central widget for the main window in the
+    #: :attr:`plugins` dictionary
+    central_widget_key = 'console'
+
     @property
     def logger(self):
         """The logger of this instance"""
@@ -368,6 +372,7 @@ def __init__(self, show=True):
 
         # load plugin widgets
         self.plugins = plugins = OrderedDict([
+            ('console', self.console),
             ('project_content', self.project_content),
             ('ds_tree', self.ds_tree),
             ('figures_tree', self.figures_tree),
@@ -381,11 +386,13 @@ def __init__(self, show=True):
         self.add_mp_to_menu()
         psy.Project.oncpchange.connect(self.eventually_add_mp_to_menu)
         self.windows_menu.addSeparator()
+
         self.window_layouts_menu = QMenu('Window layouts', self)
         self.restore_layout_action = QAction('Restore default layout', self)
         self.restore_layout_action.triggered.connect(self.setup_default_layout)
         self.window_layouts_menu.addAction(self.restore_layout_action)
         self.windows_menu.addMenu(self.window_layouts_menu)
+
         self.panes_menu = QMenu('Panes', self)
         self.windows_menu.addMenu(self.panes_menu)
 
@@ -396,6 +403,11 @@ def __init__(self, show=True):
         self.dataframe_menu.addSeparator()
         self.windows_menu.addMenu(self.dataframe_menu)
 
+        self.central_widgets_menu = menu = QMenu('Central widget', self)
+        self.windows_menu.addMenu(menu)
+        self.central_widgets_actions = group = QActionGroup(self)
+        group.setExclusive(True)
+
         # ---------------------------------------------------------------------
         # -------------------------- connections ------------------------------
         # ---------------------------------------------------------------------
@@ -461,15 +473,19 @@ def __init__(self, show=True):
 
         # save the default widths after they have been shown
         for w in self.plugins.values():
-            self.default_widths[w] = w.dock.size().width()
+            if w.dock is not None:
+                self.default_widths[w] = w.dock.size().width()
 
         # hide plugin widgets that should be hidden at startup. Although this
         # has been executed by :meth:`setup_default_layout`, we have to execute
         # it again after the call of showMaximized
-        for w in self.plugins.values():
-            w.to_dock(self)
-            if w.hidden:
-                w.hide_plugin()
+        for name, w in self.plugins.items():
+            if name != self.central_widget_key:
+                w.to_dock(self)
+                if w.hidden:
+                    w.hide_plugin()
+            else:
+                w.create_central_widget_action(self).setChecked(True)
 
         self._is_open = True
 
@@ -514,17 +530,19 @@ def setup_default_layout(self):
 
         modify_widths = bool(self.default_widths)
         for w in map(self.plugins.__getitem__, self.default_plugins):
-            w.show_plugin()
+            if w.dock is not None:
+                w.show_plugin()
 
-            if modify_widths and with_qt5:
-                self.resizeDocks([w.dock], [self.default_widths[w]],
-                                 Qt.Horizontal)
+                if modify_widths and with_qt5:
+                    self.resizeDocks([w.dock], [self.default_widths[w]],
+                                     Qt.Horizontal)
 
         # hide plugin widgets that should be hidden at startup
-        for w in self.plugins.values():
-            w.to_dock(self)
-            if w.hidden:
-                w.hide_plugin()
+        for name, w in self.plugins.items():
+            if name != self.central_widget_key:
+                w.to_dock(self)
+                if w.hidden:
+                    w.hide_plugin()
 
         action2shortcut = defaultdict(list)
         for s, a in self.default_shortcuts:
@@ -533,6 +551,34 @@ def setup_default_layout(self):
         for a, s in action2shortcut.items():
             self.register_shortcut(a, s)
 
+    def set_central_widget(self, name):
+        """Set the central widget
+
+        Parameters
+        ----------
+        name: str or QWidget
+            The key or the plugin widget in the :attr:`plugins` dictionary"""
+        current = self.centralWidget()
+        if isinstance(name, six.string_types):
+            new = self.plugins[name]
+        else:
+            new = name
+            name = next(key for key, val in self.plugins.items() if val is new)
+        if new is not current:
+            self.removeDockWidget(new.dock)
+            new.dock.close()
+            self.panes_menu.removeAction(new._view_action)
+            self.dataframe_menu.removeAction(new._view_action)
+            new.dock = new._view_action = None
+            self.central_widget_key = name
+            current.to_dock(self)
+            self.setCentralWidget(new)
+            new._set_central_action.setChecked(True)
+            current.show_plugin()
+            current.to_dock(self)
+            if current.hidden:
+                current.hide_plugin()
+
     def _save_project(self, p, new_fname=False, *args, **kwargs):
         if new_fname or 'project_file' not in p.attrs:
             fname = QFileDialog.getSaveFileName(
@@ -734,16 +780,6 @@ def eventually_add_mp_to_menu(self, p):
         if p.num not in self.project_actions:
             self.add_mp_to_menu()
 
-    def addDockWidget(self, area, dockwidget, docktype=None, *args, **kwargs):
-        """Reimplemented to add widgets to the windows menu"""
-        ret = super(MainWindow, self).addDockWidget(area, dockwidget, *args,
-                                                    **kwargs)
-        if docktype == 'pane':
-            self.panes_menu.addAction(dockwidget.toggleViewAction())
-        elif docktype == 'df':
-            self.dataframe_menu.addAction(dockwidget.toggleViewAction())
-        return ret
-
     def start_open_files_server(self):
         """This method listens to the open_files_port and opens the plot
         creator for new files

tests/test_main.py

@@ -25,6 +25,13 @@ def test_plugin(self):
         w.show_plugin()
         self.assertTrue(a.isChecked())
 
+    def test_central_widget(self):
+        """Test changing the central widget"""
+        self.window.set_central_widget('help_explorer')
+        self.assertIs(self.window.centralWidget(), self.window.help_explorer)
+        self.window.set_central_widget(self.window.figures_tree)
+        self.assertIs(self.window.centralWidget(), self.window.figures_tree)
+
 
 if __name__ == "__main__":
     unittest.main()