creating the app folder to store custom apps

also adding a template for custom apps

Author: seb5g

src/pymodaq_plugins_template/app/__init__.py

@@ -0,0 +1,102 @@
+from qtpy import QtWidgets
+
+from pymodaq.utils import gui_utils as gutils
+
+
+#todo: modify the name of this class to reflect its application and chnage the name in the main
+# method at the end of the script
+class CustomAppTemplate(gutils.CustomApp):
+
+    #todo: if you wish to create custom Parameter and corresponding widgets. These will be
+    # automatically added as children of self.settings. Morevover, the self.settings_tree will
+    # render the widgets in a Qtree. If you wish to see it in your app, add is into a Dock
+    params = []
+
+    def __init__(self, parent: gutils.DockArea):
+        super().__init__(parent)
+
+        self.setup_ui()
+
+    def setup_docks(self):
+        """Mandatory method to be subclassed to setup the docks layout
+
+        Examples
+        --------
+        >>>self.docks['ADock'] = gutils.Dock('ADock name')
+        >>>self.dockarea.addDock(self.docks['ADock'])
+        >>>self.docks['AnotherDock'] = gutils.Dock('AnotherDock name')
+        >>>self.dockarea.addDock(self.docks['AnotherDock'''], 'bottom', self.docks['ADock'])
+
+        See Also
+        --------
+        pyqtgraph.dockarea.Dock
+        """
+        #todo: create docks and add them here to hold your widgets
+        # reminder, the attribute self.settings_tree will  render the widgets in a Qtree.
+        # If you wish to see it in your app, add is into a Dock
+        raise NotImplementedError
+
+    def setup_actions(self):
+        """Method where to create actions to be subclassed. Mandatory
+
+        Examples
+        --------
+        >>> self.add_action('Quit', 'close2', "Quit program")
+        >>> self.add_action('Grab', 'camera', "Grab from camera", checkable=True)
+        >>> self.add_action('Load', 'Open', "Load target file (.h5, .png, .jpg) or data from camera"
+            , checkable=False)
+        >>> self.add_action('Save', 'SaveAs', "Save current data", checkable=False)
+
+        See Also
+        --------
+        ActionManager.add_action
+        """
+        raise NotImplementedError(f'You have to define actions here')
+
+    def connect_things(self):
+        """Connect actions and/or other widgets signal to methods"""
+        raise NotImplementedError
+
+    def setup_menu(self):
+        """Non mandatory method to be subclassed in order to create a menubar
+
+        create menu for actions contained into the self._actions, for instance:
+
+        Examples
+        --------
+        >>>file_menu = self.mainwindow.menuBar().addMenu('File')
+        >>>self.affect_to('load', file_menu)
+        >>>self.affect_to('save', file_menu)
+
+        >>>file_menu.addSeparator()
+        >>>self.affect_to('quit', file_menu)
+
+        See Also
+        --------
+        pymodaq.utils.managers.action_manager.ActionManager
+        """
+        #todo create and populate menu using actions defined above in self.setup_actions
+        pass
+
+
+
+
+
+def main():
+    from pymodaq.utils.gui_utils.utils import mkQApp
+    app = mkQApp('CustomApp')
+
+    mainwindow = QtWidgets.QMainWindow()
+    dockarea = gutils.DockArea()
+    mainwindow.setCentralWidget(dockarea)
+
+    #todo: change the name here to be the same as your app class
+    prog = CustomAppTemplate(dockarea)
+
+    mainwindow.show()
+
+    app.exec()
+
+
+if __name__ == '__main__':
+    main()