Mercurial Repositories > Pyramid Project / changeset
changeset
Replaced pixmap icons by vector icons.
Thu, 09 Apr 2020 18:16:19 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Thu, 09 Apr 2020 18:16:19 +0200
- changeset 133
- 8f183975895d
- parent 132
- c0d53fb9a0e0
- child 134
- bde5497fb5fc
Replaced pixmap icons by vector icons.
--- a/ChangeLog Wed Jan 01 11:58:58 2020 +0100 +++ b/ChangeLog Thu Apr 09 18:16:19 2020 +0200 @@ -1,5 +1,8 @@ ChangeLog --------- +Version 2.5.0: +- replaced pixmap icons by vector icons + Version 2.4.3: - bug fixes - changes to support changed eric6 menu structure as of eric6 19.06
--- a/PKGLIST Wed Jan 01 11:58:58 2020 +0100 +++ b/PKGLIST Thu Apr 09 18:16:19 2020 +0200 @@ -35,5 +35,7 @@ ProjectPyramid/i18n/pyramid_en.qm ProjectPyramid/i18n/pyramid_es.qm ProjectPyramid/i18n/pyramid_ru.qm -ProjectPyramid/icons/pyramid.png -ProjectPyramid/icons/pyramid64.png +ProjectPyramid/icons/pyramid-dark.svg +ProjectPyramid/icons/pyramid-light.svg +ProjectPyramid/icons/pyramid64-dark.svg +ProjectPyramid/icons/pyramid64-light.svg
--- a/PluginProjectPyramid.py Wed Jan 01 11:58:58 2020 +0100 +++ b/PluginProjectPyramid.py Thu Apr 09 18:16:19 2020 +0200 @@ -28,7 +28,7 @@ author = "Detlev Offenbach <detlev@die-offenbachs.de>" autoactivate = True deactivateable = True -version = "2.4.3" +version = "2.5.0" className = "ProjectPyramidPlugin" packageName = "ProjectPyramid" shortDescription = "Project support for Pyramid projects." @@ -63,10 +63,23 @@ @return dictionary containing the relevant data """ + try: + usesDarkPalette = e5App().usesDarkPalette() + except AttributeError: + from PyQt5.QtGui import QPalette + palette = e5App().palette() + lightness = palette.color(QPalette.Window).lightness() + usesDarkPalette = lightness <= 128 + if usesDarkPalette: + iconSuffix = "dark" + else: + iconSuffix = "light" + return { "pyramidPage": [ QCoreApplication.translate("ProjectPyramidPlugin", "Pyramid"), - os.path.join("ProjectPyramid", "icons", "pyramid.png"), + os.path.join("ProjectPyramid", "icons", + "pyramid-{0}".format(iconSuffix)), createPyramidPage, None, None], }
--- a/PluginPyramid.e4p Wed Jan 01 11:58:58 2020 +0100 +++ b/PluginPyramid.e4p Thu Apr 09 18:16:19 2020 +0200 @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE Project SYSTEM "Project-5.1.dtd"> <!-- eric project file for project PluginPyramid --> -<!-- Copyright (C) 2018 Detlev Offenbach, detlev@die-offenbachs.de --> +<!-- Copyright (C) 2020 Detlev Offenbach, detlev@die-offenbachs.de --> <Project version="5.1"> <Language>en_US</Language> <Hash>16b809c49f4985b2bd6959b37c5612f6b30e89b4</Hash> @@ -68,8 +68,10 @@ <Other>ProjectPyramid/APIs/WebOb-1.2.bas</Other> <Other>ProjectPyramid/Documentation/LICENSE.GPL3</Other> <Other>ProjectPyramid/Documentation/source</Other> - <Other>ProjectPyramid/icons/pyramid.png</Other> - <Other>ProjectPyramid/icons/pyramid64.png</Other> + <Other>ProjectPyramid/icons/pyramid-dark.svg</Other> + <Other>ProjectPyramid/icons/pyramid-light.svg</Other> + <Other>ProjectPyramid/icons/pyramid64-dark.svg</Other> + <Other>ProjectPyramid/icons/pyramid64-light.svg</Other> </Others> <MainScript>PluginProjectPyramid.py</MainScript> <Vcs>
--- a/ProjectPyramid/ConfigurationPage/PyramidPage.py Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/ConfigurationPage/PyramidPage.py Thu Apr 09 18:16:19 2020 +0200 @@ -56,10 +56,10 @@ consoleList.append("xterm -e") self.consoleCommandCombo.addItems(consoleList) - self.virtualEnvPy3Button.setIcon(UI.PixmapCache.getIcon("open.png")) - self.virtualEnvPy2Button.setIcon(UI.PixmapCache.getIcon("open.png")) - self.translationsButton.setIcon(UI.PixmapCache.getIcon("open.png")) - self.urlResetButton.setIcon(UI.PixmapCache.getIcon("editUndo.png")) + self.virtualEnvPy3Button.setIcon(UI.PixmapCache.getIcon("open")) + self.virtualEnvPy2Button.setIcon(UI.PixmapCache.getIcon("open")) + self.translationsButton.setIcon(UI.PixmapCache.getIcon("open")) + self.urlResetButton.setIcon(UI.PixmapCache.getIcon("editUndo")) self.virtualEnvPy2Completer = E5DirCompleter(self.virtualEnvPy2Edit) self.virtualEnvPy3Completer = E5DirCompleter(self.virtualEnvPy3Edit)
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.PluginProjectPyramid.html Thu Apr 09 18:16:19 2020 +0200 @@ -18,328 +18,430 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Pyramid.PluginProjectPyramid</h1> + <p> Module implementing the Pyramid project plugin. </p> <h3>Global Attributes</h3> + <table> <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>needsRestart</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>pyramidPluginObject</td></tr><tr><td>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#ProjectPyramidPlugin">ProjectPyramidPlugin</a></td> <td>Class implementing the Pyramid project plugin.</td> </tr> </table> <h3>Functions</h3> + <table> + <tr> <td><a href="#apiFiles">apiFiles</a></td> <td>Module function to return the API files made available by this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#createPyramidPage">createPyramidPage</a></td> <td>Module function to create the Pyramid configuration page.</td> -</tr><tr> +</tr> +<tr> <td><a href="#getConfigData">getConfigData</a></td> <td>Module function returning data as required by the configuration dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#prepareUninstall">prepareUninstall</a></td> <td>Module function to prepare for an uninstallation.</td> </tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="ProjectPyramidPlugin" ID="ProjectPyramidPlugin"></a> <h2>ProjectPyramidPlugin</h2> + <p> Class implementing the Pyramid project plugin. </p> <h3>Derived from</h3> QObject <h3>Class Attributes</h3> + <table> <tr><td>PreferencesKey</td></tr><tr><td>lexerAssociations</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#ProjectPyramidPlugin.__init__">ProjectPyramidPlugin</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.__initialize">__initialize</a></td> <td>Private slot to (re)initialize the plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.__loadTranslator">__loadTranslator</a></td> <td>Private method to load the translation file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.__projectClosed">__projectClosed</a></td> <td>Private slot to handle the projectClosed signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.__projectOpened">__projectOpened</a></td> <td>Private slot to handle the projectOpened signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.__reregisterProjectType">__reregisterProjectType</a></td> <td>Private method to re-register the project type.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.activate">activate</a></td> <td>Public method to activate this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.binaryTranslationsCallback">binaryTranslationsCallback</a></td> <td>Public method to determine the filename of a compiled translation file given the translation source file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.deactivate">deactivate</a></td> <td>Public method to deactivate this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.fileTypesCallback">fileTypesCallback</a></td> <td>Public method get the filetype associations of the Pyramid project type.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.getDefaultPreference">getDefaultPreference</a></td> <td>Public method to get the default value for a setting.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.getMenu">getMenu</a></td> <td>Public method to get a reference to the requested menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.getMenuNames">getMenuNames</a></td> <td>Public method to get the names of all menus.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.getPreferences">getPreferences</a></td> <td>Public method to retrieve the various settings.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.lexerAssociationCallback">lexerAssociationCallback</a></td> <td>Public method to get the lexer association of the Pyramid project type for a file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectPyramidPlugin.setPreferences">setPreferences</a></td> <td>Public method to store the various settings.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="ProjectPyramidPlugin.__init__" ID="ProjectPyramidPlugin.__init__"></a> <h4>ProjectPyramidPlugin (Constructor)</h4> <b>ProjectPyramidPlugin</b>(<i>ui</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>ui</i></dt> <dd> reference to the user interface object (UI.UserInterface) </dd> -</dl><a NAME="ProjectPyramidPlugin.__initialize" ID="ProjectPyramidPlugin.__initialize"></a> +</dl> +<a NAME="ProjectPyramidPlugin.__initialize" ID="ProjectPyramidPlugin.__initialize"></a> <h4>ProjectPyramidPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) + <p> Private slot to (re)initialize the plugin. -</p><a NAME="ProjectPyramidPlugin.__loadTranslator" ID="ProjectPyramidPlugin.__loadTranslator"></a> +</p> +<a NAME="ProjectPyramidPlugin.__loadTranslator" ID="ProjectPyramidPlugin.__loadTranslator"></a> <h4>ProjectPyramidPlugin.__loadTranslator</h4> <b>__loadTranslator</b>(<i></i>) + <p> Private method to load the translation file. -</p><a NAME="ProjectPyramidPlugin.__projectClosed" ID="ProjectPyramidPlugin.__projectClosed"></a> +</p> +<a NAME="ProjectPyramidPlugin.__projectClosed" ID="ProjectPyramidPlugin.__projectClosed"></a> <h4>ProjectPyramidPlugin.__projectClosed</h4> <b>__projectClosed</b>(<i></i>) + <p> Private slot to handle the projectClosed signal. -</p><a NAME="ProjectPyramidPlugin.__projectOpened" ID="ProjectPyramidPlugin.__projectOpened"></a> +</p> +<a NAME="ProjectPyramidPlugin.__projectOpened" ID="ProjectPyramidPlugin.__projectOpened"></a> <h4>ProjectPyramidPlugin.__projectOpened</h4> <b>__projectOpened</b>(<i></i>) + <p> Private slot to handle the projectOpened signal. -</p><a NAME="ProjectPyramidPlugin.__reregisterProjectType" ID="ProjectPyramidPlugin.__reregisterProjectType"></a> +</p> +<a NAME="ProjectPyramidPlugin.__reregisterProjectType" ID="ProjectPyramidPlugin.__reregisterProjectType"></a> <h4>ProjectPyramidPlugin.__reregisterProjectType</h4> <b>__reregisterProjectType</b>(<i></i>) + <p> Private method to re-register the project type. -</p><a NAME="ProjectPyramidPlugin.activate" ID="ProjectPyramidPlugin.activate"></a> +</p> +<a NAME="ProjectPyramidPlugin.activate" ID="ProjectPyramidPlugin.activate"></a> <h4>ProjectPyramidPlugin.activate</h4> <b>activate</b>(<i></i>) + <p> Public method to activate this plugin. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of None and activation status (boolean) </dd> -</dl><a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a> +</dl> +<a NAME="ProjectPyramidPlugin.binaryTranslationsCallback" ID="ProjectPyramidPlugin.binaryTranslationsCallback"></a> <h4>ProjectPyramidPlugin.binaryTranslationsCallback</h4> <b>binaryTranslationsCallback</b>(<i>filename</i>) + <p> Public method to determine the filename of a compiled translation file given the translation source file. -</p><dl> +</p> +<dl> + <dt><i>filename</i></dt> <dd> name of the translation source file (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> name of the binary translation file (string) </dd> -</dl><a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a> +</dl> +<a NAME="ProjectPyramidPlugin.deactivate" ID="ProjectPyramidPlugin.deactivate"></a> <h4>ProjectPyramidPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) + <p> Public method to deactivate this plugin. -</p><a NAME="ProjectPyramidPlugin.fileTypesCallback" ID="ProjectPyramidPlugin.fileTypesCallback"></a> +</p> +<a NAME="ProjectPyramidPlugin.fileTypesCallback" ID="ProjectPyramidPlugin.fileTypesCallback"></a> <h4>ProjectPyramidPlugin.fileTypesCallback</h4> <b>fileTypesCallback</b>(<i></i>) + <p> Public method get the filetype associations of the Pyramid project type. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> dictionary with file type associations </dd> -</dl><a NAME="ProjectPyramidPlugin.getDefaultPreference" ID="ProjectPyramidPlugin.getDefaultPreference"></a> +</dl> +<a NAME="ProjectPyramidPlugin.getDefaultPreference" ID="ProjectPyramidPlugin.getDefaultPreference"></a> <h4>ProjectPyramidPlugin.getDefaultPreference</h4> <b>getDefaultPreference</b>(<i>key</i>) + <p> Public method to get the default value for a setting. -</p><dl> +</p> +<dl> + <dt><i>key</i></dt> <dd> the key of the value to get </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> the requested setting </dd> -</dl><a NAME="ProjectPyramidPlugin.getMenu" ID="ProjectPyramidPlugin.getMenu"></a> +</dl> +<a NAME="ProjectPyramidPlugin.getMenu" ID="ProjectPyramidPlugin.getMenu"></a> <h4>ProjectPyramidPlugin.getMenu</h4> <b>getMenu</b>(<i>name</i>) + <p> Public method to get a reference to the requested menu. -</p><dl> +</p> +<dl> + <dt><i>name</i></dt> <dd> name of the menu (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the menu (QMenu) or None, if no menu with the given name exists </dd> -</dl><a NAME="ProjectPyramidPlugin.getMenuNames" ID="ProjectPyramidPlugin.getMenuNames"></a> +</dl> +<a NAME="ProjectPyramidPlugin.getMenuNames" ID="ProjectPyramidPlugin.getMenuNames"></a> <h4>ProjectPyramidPlugin.getMenuNames</h4> <b>getMenuNames</b>(<i></i>) + <p> Public method to get the names of all menus. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> menu names (list of string) </dd> -</dl><a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a> +</dl> +<a NAME="ProjectPyramidPlugin.getPreferences" ID="ProjectPyramidPlugin.getPreferences"></a> <h4>ProjectPyramidPlugin.getPreferences</h4> <b>getPreferences</b>(<i>key</i>) + <p> Public method to retrieve the various settings. -</p><dl> +</p> +<dl> + <dt><i>key</i></dt> <dd> the key of the value to get </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> the requested setting </dd> -</dl><a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a> +</dl> +<a NAME="ProjectPyramidPlugin.lexerAssociationCallback" ID="ProjectPyramidPlugin.lexerAssociationCallback"></a> <h4>ProjectPyramidPlugin.lexerAssociationCallback</h4> <b>lexerAssociationCallback</b>(<i>filename</i>) + <p> Public method to get the lexer association of the Pyramid project type for a file. -</p><dl> +</p> +<dl> + <dt><i>filename</i></dt> <dd> name of the file (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> name of the lexer (string) (Pygments lexers are prefixed with 'Pygments|') </dd> -</dl><a NAME="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a> +</dl> +<a NAME="ProjectPyramidPlugin.setPreferences" ID="ProjectPyramidPlugin.setPreferences"></a> <h4>ProjectPyramidPlugin.setPreferences</h4> <b>setPreferences</b>(<i>key, value</i>) + <p> Public method to store the various settings. -</p><dl> +</p> +<dl> + <dt><i>key</i></dt> <dd> the key of the setting to be set (string) -</dd><dt><i>value</i></dt> +</dd> +<dt><i>value</i></dt> <dd> the value to be set </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="apiFiles" ID="apiFiles"></a> <h2>apiFiles</h2> <b>apiFiles</b>(<i>language</i>) + <p> Module function to return the API files made available by this plugin. -</p><dl> +</p> +<dl> + <dt><i>language</i></dt> <dd> language to get APIs for (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> list of API filenames (list of string) </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="createPyramidPage" ID="createPyramidPage"></a> <h2>createPyramidPage</h2> <b>createPyramidPage</b>(<i>configDlg</i>) + <p> Module function to create the Pyramid configuration page. -</p><dl> +</p> +<dl> + <dt><i>configDlg</i></dt> <dd> reference to the configuration dialog </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the configuration page </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="getConfigData" ID="getConfigData"></a> <h2>getConfigData</h2> <b>getConfigData</b>(<i></i>) + <p> Module function returning data as required by the configuration dialog. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> dictionary containing the relevant data </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="prepareUninstall" ID="prepareUninstall"></a> <h2>prepareUninstall</h2> <b>prepareUninstall</b>(<i></i>) + <p> Module function to prepare for an uninstallation. </p>
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.PyramidPage.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.PyramidPage.html Thu Apr 09 18:16:19 2020 +0200 @@ -18,104 +18,136 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.PyramidPage</h1> + <p> Module implementing the Pyramid configuration page. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PyramidPage">PyramidPage</a></td> <td>Class implementing the Pyramid configuration page.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PyramidPage" ID="PyramidPage"></a> <h2>PyramidPage</h2> + <p> Class implementing the Pyramid configuration page. </p> <h3>Derived from</h3> ConfigurationPageBase, Ui_PyramidPage <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#PyramidPage.__init__">PyramidPage</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidPage.on_translationsButton_clicked">on_translationsButton_clicked</a></td> <td>Private slot to select the translations editor via a file selection dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidPage.on_urlResetButton_clicked">on_urlResetButton_clicked</a></td> <td>Private slot to reset the Pyramid documentation URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidPage.on_virtualEnvPy2Button_clicked">on_virtualEnvPy2Button_clicked</a></td> <td>Private slot to select the virtual environment for Python 2 via a directory selection dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidPage.on_virtualEnvPy3Button_clicked">on_virtualEnvPy3Button_clicked</a></td> <td>Private slot to select the virtual environment for Python 3 via a directory selection dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidPage.save">save</a></td> <td>Public slot to save the Pyramid configuration.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PyramidPage.__init__" ID="PyramidPage.__init__"></a> <h4>PyramidPage (Constructor)</h4> <b>PyramidPage</b>(<i>plugin</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>plugin</i></dt> <dd> reference to the plugin object </dd> -</dl><a NAME="PyramidPage.on_translationsButton_clicked" ID="PyramidPage.on_translationsButton_clicked"></a> +</dl> +<a NAME="PyramidPage.on_translationsButton_clicked" ID="PyramidPage.on_translationsButton_clicked"></a> <h4>PyramidPage.on_translationsButton_clicked</h4> <b>on_translationsButton_clicked</b>(<i></i>) + <p> Private slot to select the translations editor via a file selection dialog. -</p><a NAME="PyramidPage.on_urlResetButton_clicked" ID="PyramidPage.on_urlResetButton_clicked"></a> +</p> +<a NAME="PyramidPage.on_urlResetButton_clicked" ID="PyramidPage.on_urlResetButton_clicked"></a> <h4>PyramidPage.on_urlResetButton_clicked</h4> <b>on_urlResetButton_clicked</b>(<i></i>) + <p> Private slot to reset the Pyramid documentation URL. -</p><a NAME="PyramidPage.on_virtualEnvPy2Button_clicked" ID="PyramidPage.on_virtualEnvPy2Button_clicked"></a> +</p> +<a NAME="PyramidPage.on_virtualEnvPy2Button_clicked" ID="PyramidPage.on_virtualEnvPy2Button_clicked"></a> <h4>PyramidPage.on_virtualEnvPy2Button_clicked</h4> <b>on_virtualEnvPy2Button_clicked</b>(<i></i>) + <p> Private slot to select the virtual environment for Python 2 via a directory selection dialog. -</p><a NAME="PyramidPage.on_virtualEnvPy3Button_clicked" ID="PyramidPage.on_virtualEnvPy3Button_clicked"></a> +</p> +<a NAME="PyramidPage.on_virtualEnvPy3Button_clicked" ID="PyramidPage.on_virtualEnvPy3Button_clicked"></a> <h4>PyramidPage.on_virtualEnvPy3Button_clicked</h4> <b>on_virtualEnvPy3Button_clicked</b>(<i></i>) + <p> Private slot to select the virtual environment for Python 3 via a directory selection dialog. -</p><a NAME="PyramidPage.save" ID="PyramidPage.save"></a> +</p> +<a NAME="PyramidPage.save" ID="PyramidPage.save"></a> <h4>PyramidPage.save</h4> <b>save</b>(<i></i>) + <p> Public slot to save the Pyramid configuration. </p>
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html Thu Apr 09 18:16:19 2020 +0200 @@ -18,135 +18,177 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog</h1> + <p> Module implementing a dialog for entering the create parameters. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#CreateParametersDialog">CreateParametersDialog</a></td> <td>Class implementing a dialog for entering the create parameters.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="CreateParametersDialog" ID="CreateParametersDialog"></a> <h2>CreateParametersDialog</h2> + <p> Class implementing a dialog for entering the create parameters. </p> <h3>Derived from</h3> QDialog, Ui_CreateParametersDialog <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#CreateParametersDialog.__init__">CreateParametersDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#CreateParametersDialog.__prepareScaffoldString">__prepareScaffoldString</a></td> <td>Private method to prepare a scaffold string for the combo box.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CreateParametersDialog.__updateUi">__updateUi</a></td> <td>Private slot to update the dialog.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CreateParametersDialog.getData">getData</a></td> <td>Public method to get the data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CreateParametersDialog.on_nameEdit_textChanged">on_nameEdit_textChanged</a></td> <td>Private slot to handle changes of the site name.</td> -</tr><tr> +</tr> +<tr> <td><a href="#CreateParametersDialog.on_scaffoldCombo_currentIndexChanged">on_scaffoldCombo_currentIndexChanged</a></td> <td>Private slot to handle changes of the selected scaffold.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="CreateParametersDialog.__init__" ID="CreateParametersDialog.__init__"></a> <h4>CreateParametersDialog (Constructor)</h4> <b>CreateParametersDialog</b>(<i>project, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>project</i></dt> <dd> reference to the project object (Project) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="CreateParametersDialog.__prepareScaffoldString" ID="CreateParametersDialog.__prepareScaffoldString"></a> +</dl> +<a NAME="CreateParametersDialog.__prepareScaffoldString" ID="CreateParametersDialog.__prepareScaffoldString"></a> <h4>CreateParametersDialog.__prepareScaffoldString</h4> <b>__prepareScaffoldString</b>(<i>line</i>) + <p> Private method to prepare a scaffold string for the combo box. -</p><dl> +</p> +<dl> + <dt><i>line</i> (str)</dt> <dd> output line containing the scaffold name and some explanatory text </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> prepared scaffold text </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a> +</dl> +<a NAME="CreateParametersDialog.__updateUi" ID="CreateParametersDialog.__updateUi"></a> <h4>CreateParametersDialog.__updateUi</h4> <b>__updateUi</b>(<i></i>) + <p> Private slot to update the dialog. -</p><a NAME="CreateParametersDialog.getData" ID="CreateParametersDialog.getData"></a> +</p> +<a NAME="CreateParametersDialog.getData" ID="CreateParametersDialog.getData"></a> <h4>CreateParametersDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to get the data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple giving the scaffold (string), the project name (string), a flag indicating to overwrite existing files (boolean) and a flag indicating to simulate the creation (boolean) </dd> -</dl><a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a> +</dl> +<a NAME="CreateParametersDialog.on_nameEdit_textChanged" ID="CreateParametersDialog.on_nameEdit_textChanged"></a> <h4>CreateParametersDialog.on_nameEdit_textChanged</h4> <b>on_nameEdit_textChanged</b>(<i>text</i>) + <p> Private slot to handle changes of the site name. -</p><dl> +</p> +<dl> + <dt><i>text</i></dt> <dd> text of the site entry (string) </dd> -</dl><a NAME="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged"></a> +</dl> +<a NAME="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged" ID="CreateParametersDialog.on_scaffoldCombo_currentIndexChanged"></a> <h4>CreateParametersDialog.on_scaffoldCombo_currentIndexChanged</h4> <b>on_scaffoldCombo_currentIndexChanged</b>(<i>text</i>) + <p> Private slot to handle changes of the selected scaffold. -</p><dl> +</p> +<dl> + <dt><i>text</i></dt> <dd> text of the combo box (string)
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.DistributionTypeSelectionDialog.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.DistributionTypeSelectionDialog.html Thu Apr 09 18:16:19 2020 +0200 @@ -18,79 +18,102 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Pyramid.ProjectPyramid.DistributionTypeSelectionDialog</h1> + <p> Module implementing a dialog to select the distribution file formats. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#DistributionTypeSelectionDialog">DistributionTypeSelectionDialog</a></td> <td>Class implementing a dialog to select the distribution file formats.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="DistributionTypeSelectionDialog" ID="DistributionTypeSelectionDialog"></a> <h2>DistributionTypeSelectionDialog</h2> + <p> Class implementing a dialog to select the distribution file formats. </p> <h3>Derived from</h3> QDialog, Ui_DistributionTypeSelectionDialog <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#DistributionTypeSelectionDialog.__init__">DistributionTypeSelectionDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#DistributionTypeSelectionDialog.getFormats">getFormats</a></td> <td>Public method to retrieve the checked formats.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="DistributionTypeSelectionDialog.__init__" ID="DistributionTypeSelectionDialog.__init__"></a> <h4>DistributionTypeSelectionDialog (Constructor)</h4> <b>DistributionTypeSelectionDialog</b>(<i>project, projectPath, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>project</i></dt> <dd> reference to the project object (ProjectPyramid.Project.Project) -</dd><dt><i>projectPath</i></dt> +</dd> +<dt><i>projectPath</i></dt> <dd> path of the Pyramid project (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="DistributionTypeSelectionDialog.getFormats" ID="DistributionTypeSelectionDialog.getFormats"></a> +</dl> +<a NAME="DistributionTypeSelectionDialog.getFormats" ID="DistributionTypeSelectionDialog.getFormats"></a> <h4>DistributionTypeSelectionDialog.getFormats</h4> <b>getFormats</b>(<i></i>) + <p> Public method to retrieve the checked formats. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of selected formats (list of string)
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.FormSelectionDialog.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.FormSelectionDialog.html Thu Apr 09 18:16:19 2020 +0200 @@ -18,85 +18,111 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Pyramid.ProjectPyramid.FormSelectionDialog</h1> + <p> Module implementing a dialog to select the template type. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#FormSelectionDialog">FormSelectionDialog</a></td> <td>Class implementing a dialog to select the template type.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="FormSelectionDialog" ID="FormSelectionDialog"></a> <h2>FormSelectionDialog</h2> + <p> Class implementing a dialog to select the template type. </p> <h3>Derived from</h3> QDialog, Ui_FormSelectionDialog <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#FormSelectionDialog.__init__">FormSelectionDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#FormSelectionDialog.getTemplateText">getTemplateText</a></td> <td>Public method to get the template text.</td> -</tr><tr> +</tr> +<tr> <td><a href="#FormSelectionDialog.on_typeCombo_currentIndexChanged">on_typeCombo_currentIndexChanged</a></td> <td>Private slot to act upon a change of the selected template type.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="FormSelectionDialog.__init__" ID="FormSelectionDialog.__init__"></a> <h4>FormSelectionDialog (Constructor)</h4> <b>FormSelectionDialog</b>(<i>parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="FormSelectionDialog.getTemplateText" ID="FormSelectionDialog.getTemplateText"></a> +</dl> +<a NAME="FormSelectionDialog.getTemplateText" ID="FormSelectionDialog.getTemplateText"></a> <h4>FormSelectionDialog.getTemplateText</h4> <b>getTemplateText</b>(<i></i>) + <p> Public method to get the template text. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> text of the template (string) </dd> -</dl><a NAME="FormSelectionDialog.on_typeCombo_currentIndexChanged" ID="FormSelectionDialog.on_typeCombo_currentIndexChanged"></a> +</dl> +<a NAME="FormSelectionDialog.on_typeCombo_currentIndexChanged" ID="FormSelectionDialog.on_typeCombo_currentIndexChanged"></a> <h4>FormSelectionDialog.on_typeCombo_currentIndexChanged</h4> <b>on_typeCombo_currentIndexChanged</b>(<i>index</i>) + <p> Private slot to act upon a change of the selected template type. -</p><dl> +</p> +<dl> + <dt><i>index</i></dt> <dd> selected index (integer)
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html Thu Apr 09 18:16:19 2020 +0200 @@ -18,815 +18,1086 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Pyramid.ProjectPyramid.Project</h1> + <p> Module implementing the Pyramid project support. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#Project">Project</a></td> <td>Class implementing the Pyramid project support.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidNoProjectSelectedException">PyramidNoProjectSelectedException</a></td> <td>Exception thrown to signal, that there is no current Pyramid project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#QProcess">QProcess</a></td> <td>Class transforming the call arguments in case of gnome-terminal.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="Project" ID="Project"></a> <h2>Project</h2> + <p> Class implementing the Pyramid project support. </p> <h3>Derived from</h3> QObject <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#Project.__init__">Project</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__adjustWorkingDirectory">__adjustWorkingDirectory</a></td> <td>Private method to adjust the working directory in the arguments list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__buildDistribution">__buildDistribution</a></td> <td>Private slot to build a distribution file for the current Pyramid project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__createProject">__createProject</a></td> <td>Private slot to create a new Pyramid project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__findProjects">__findProjects</a></td> <td>Private method to determine the relative path of all Pyramid projects (= top level dirs).</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__getDebugEnvironment">__getDebugEnvironment</a></td> <td>Private method to get the path of the debugger environment.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__getExecutablePaths">__getExecutablePaths</a></td> <td>Private method to build all full paths of an executable file from the environment.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__getInitDbCommand">__getInitDbCommand</a></td> <td>Private method to create the path to the initialization script.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__getLocale">__getLocale</a></td> <td>Private method to extract the locale out of a file name.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__getVirtualEnvironment">__getVirtualEnvironment</a></td> <td>Private method to get the path of the virtual environment.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__initializeDatabase">__initializeDatabase</a></td> <td>Private slot to initialize the database of the Pyramid project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__isSuitableForVariant">__isSuitableForVariant</a></td> <td>Private method to test, if a detected command file is suitable for the given Python variant.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__normalizeList">__normalizeList</a></td> <td>Private method to normalize a list of file names.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__project">__project</a></td> <td>Private method to get the name of the current Pyramid project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__projectFilteredList">__projectFilteredList</a></td> <td>Private method to filter a list of file names by Pyramid project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__projectLanguageAdded">__projectLanguageAdded</a></td> <td>Private slot handling the addition of a new language.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__projectPath">__projectPath</a></td> <td>Private method to calculate the full path of the Pyramid project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__pyramidInfo">__pyramidInfo</a></td> <td>Private slot to show some info about Pyramid.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__runBrowser">__runBrowser</a></td> <td>Private slot to start the default web browser with the server URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__runLoggingServer">__runLoggingServer</a></td> <td>Private slot to start the Pyramid Web server with logging.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__runPythonShell">__runPythonShell</a></td> <td>Private slot to start a Python console for a Pyramid project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__runServer">__runServer</a></td> <td>Private slot to start the Pyramid Web server.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__selectProject">__selectProject</a></td> <td>Private method to select a Pyramid project to work with.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__serverProcFinished">__serverProcFinished</a></td> <td>Private slot connected to the finished signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__setCurrentProject">__setCurrentProject</a></td> <td>Private slot to set the current project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__setupDevelop">__setupDevelop</a></td> <td>Private slot to set up the development environment for the current project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__showDocumentation">__showDocumentation</a></td> <td>Private slot to show the helpviewer with the Pyramid documentation.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__showMatchingViews">__showMatchingViews</a></td> <td>Private slot showing all views that would match a given URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__showRoutes">__showRoutes</a></td> <td>Private slot showing all URL dispatch routes.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.__showTweens">__showTweens</a></td> <td>Private slot showing all implicit and explicit tween objects.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.compileCatalogs">compileCatalogs</a></td> <td>Public method to compile the message catalogs.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.compileSelectedCatalogs">compileSelectedCatalogs</a></td> <td>Public method to update the message catalogs.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.extractMessages">extractMessages</a></td> <td>Public method to extract the messages catalog template file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.getMenu">getMenu</a></td> <td>Public method to get a reference to the requested menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.getMenuNames">getMenuNames</a></td> <td>Public method to get the names of all menus.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.getPyramidCommand">getPyramidCommand</a></td> <td>Public method to build a Pyramid command.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.getPyramidVersion">getPyramidVersion</a></td> <td>Public method to get the Pyramid version as a tuple.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.getPyramidVersionString">getPyramidVersionString</a></td> <td>Public method to get the Pyramid version as a string.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.getPythonCommand">getPythonCommand</a></td> <td>Public method to build the Python command.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.initActions">initActions</a></td> <td>Public method to define the Pyramid actions.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.initMenu">initMenu</a></td> <td>Public slot to initialize the Pyramid menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.isSpawningConsole">isSpawningConsole</a></td> <td>Public method to check, if the given console is a spawning console.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.newForm">newForm</a></td> <td>Public method to create a new form.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.openPOEditor">openPOEditor</a></td> <td>Public method to edit the given file in an external .po editor.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.projectClosed">projectClosed</a></td> <td>Public method to handle the closing of a project.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.projectClosedHooks">projectClosedHooks</a></td> <td>Public method to remove our hook methods.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.projectOpenedHooks">projectOpenedHooks</a></td> <td>Public method to add our hook methods.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.registerOpenHook">registerOpenHook</a></td> <td>Public method to register the open hook to open a translations file in a translations editor.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.supportedPythonVariants">supportedPythonVariants</a></td> <td>Public method to get the supported Python variants.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.updateCatalogs">updateCatalogs</a></td> <td>Public method to update the message catalogs.</td> -</tr><tr> +</tr> +<tr> <td><a href="#Project.updateSelectedCatalogs">updateSelectedCatalogs</a></td> <td>Public method to update the message catalogs.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="Project.__init__" ID="Project.__init__"></a> <h4>Project (Constructor)</h4> -<b>Project</b>(<i>plugin, parent=None</i>) +<b>Project</b>(<i>plugin, iconSuffix, parent=None</i>) + <p> Constructor -</p><dl> -<dt><i>plugin</i></dt> +</p> +<dl> + +<dt><i>plugin</i> (ProjectPyramidPlugin)</dt> <dd> reference to the plugin object -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>iconSuffix</i> (str)</dt> <dd> -parent (QObject) +suffix for the icons </dd> -</dl><a NAME="Project.__adjustWorkingDirectory" ID="Project.__adjustWorkingDirectory"></a> +<dt><i>parent</i> (QObject)</dt> +<dd> +parent +</dd> +</dl> +<a NAME="Project.__adjustWorkingDirectory" ID="Project.__adjustWorkingDirectory"></a> <h4>Project.__adjustWorkingDirectory</h4> <b>__adjustWorkingDirectory</b>(<i>args, wd</i>) + <p> Private method to adjust the working directory in the arguments list. -</p><dl> +</p> +<dl> + <dt><i>args</i> (list of str)</dt> <dd> list of arguments to be modified -</dd><dt><i>wd</i> (str)</dt> +</dd> +<dt><i>wd</i> (str)</dt> <dd> working directory </dd> -</dl><a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a> +</dl> +<a NAME="Project.__buildDistribution" ID="Project.__buildDistribution"></a> <h4>Project.__buildDistribution</h4> <b>__buildDistribution</b>(<i></i>) + <p> Private slot to build a distribution file for the current Pyramid project. -</p><a NAME="Project.__createProject" ID="Project.__createProject"></a> +</p> +<a NAME="Project.__createProject" ID="Project.__createProject"></a> <h4>Project.__createProject</h4> <b>__createProject</b>(<i></i>) + <p> Private slot to create a new Pyramid project. -</p><a NAME="Project.__findProjects" ID="Project.__findProjects"></a> +</p> +<a NAME="Project.__findProjects" ID="Project.__findProjects"></a> <h4>Project.__findProjects</h4> <b>__findProjects</b>(<i></i>) + <p> Private method to determine the relative path of all Pyramid projects (= top level dirs). -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of projects (list of string) </dd> -</dl><a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a> +</dl> +<a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a> <h4>Project.__getDebugEnvironment</h4> <b>__getDebugEnvironment</b>(<i>language=""</i>) + <p> Private method to get the path of the debugger environment. -</p><dl> +</p> +<dl> + <dt><i>language</i></dt> <dd> Python variant to get the debugger environment for (string, one of '', 'Python2' or 'Python3') </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> path of the debugger environment (string) </dd> -</dl><a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a> +</dl> +<a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a> <h4>Project.__getExecutablePaths</h4> <b>__getExecutablePaths</b>(<i>file</i>) + <p> Private method to build all full paths of an executable file from the environment. -</p><dl> +</p> +<dl> + <dt><i>file</i></dt> <dd> filename of the executable (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> list of full executable names, if the executable file is accessible via the searchpath defined by the PATH environment variable, or an empty list otherwise. </dd> -</dl><a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a> +</dl> +<a NAME="Project.__getInitDbCommand" ID="Project.__getInitDbCommand"></a> <h4>Project.__getInitDbCommand</h4> <b>__getInitDbCommand</b>(<i></i>) + <p> Private method to create the path to the initialization script. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> path to the initialization script (string) </dd> -</dl><a NAME="Project.__getLocale" ID="Project.__getLocale"></a> +</dl> +<a NAME="Project.__getLocale" ID="Project.__getLocale"></a> <h4>Project.__getLocale</h4> <b>__getLocale</b>(<i>filename</i>) + <p> Private method to extract the locale out of a file name. -</p><dl> +</p> +<dl> + <dt><i>filename</i></dt> <dd> name of the file used for extraction (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> extracted locale (string) or None </dd> -</dl><a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> +</dl> +<a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> <h4>Project.__getVirtualEnvironment</h4> <b>__getVirtualEnvironment</b>(<i>language=""</i>) + <p> Private method to get the path of the virtual environment. -</p><dl> +</p> +<dl> + <dt><i>language</i></dt> <dd> Python variant to get the virtual environment for (string, one of '', 'Python2' or 'Python3') </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> path of the virtual environment (string) </dd> -</dl><a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> +</dl> +<a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> <h4>Project.__initializeDatabase</h4> <b>__initializeDatabase</b>(<i></i>) + <p> Private slot to initialize the database of the Pyramid project. -</p><a NAME="Project.__isSuitableForVariant" ID="Project.__isSuitableForVariant"></a> +</p> +<a NAME="Project.__isSuitableForVariant" ID="Project.__isSuitableForVariant"></a> <h4>Project.__isSuitableForVariant</h4> <b>__isSuitableForVariant</b>(<i>variant, line0</i>) + <p> Private method to test, if a detected command file is suitable for the given Python variant. -</p><dl> +</p> +<dl> + <dt><i>variant</i> (str (one of Python2 or Python3))</dt> <dd> Python variant to test for -</dd><dt><i>line0</i> (str)</dt> +</dd> +<dt><i>line0</i> (str)</dt> <dd> first line of the executable </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating a suitable command </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a> +</dl> +<a NAME="Project.__normalizeList" ID="Project.__normalizeList"></a> <h4>Project.__normalizeList</h4> <b>__normalizeList</b>(<i>filenames</i>) + <p> Private method to normalize a list of file names. -</p><dl> +</p> +<dl> + <dt><i>filenames</i></dt> <dd> list of file names to normalize (list of string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> normalized file names (list of string) </dd> -</dl><a NAME="Project.__project" ID="Project.__project"></a> +</dl> +<a NAME="Project.__project" ID="Project.__project"></a> <h4>Project.__project</h4> <b>__project</b>(<i></i>) + <p> Private method to get the name of the current Pyramid project. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> name of the project (string) </dd> -</dl><dl> +</dl> +<dl> + <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt> <dd> raised, if no project is selected </dd> -</dl><a NAME="Project.__projectFilteredList" ID="Project.__projectFilteredList"></a> +</dl> +<a NAME="Project.__projectFilteredList" ID="Project.__projectFilteredList"></a> <h4>Project.__projectFilteredList</h4> <b>__projectFilteredList</b>(<i>filenames</i>) + <p> Private method to filter a list of file names by Pyramid project. -</p><dl> +</p> +<dl> + <dt><i>filenames</i></dt> <dd> list of file names to be filtered (list of string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> file names belonging to the current site (list of string) </dd> -</dl><a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> +</dl> +<a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> <h4>Project.__projectLanguageAdded</h4> <b>__projectLanguageAdded</b>(<i>code</i>) + <p> Private slot handling the addition of a new language. -</p><dl> +</p> +<dl> + <dt><i>code</i></dt> <dd> language code of the new language (string) </dd> -</dl><a NAME="Project.__projectPath" ID="Project.__projectPath"></a> +</dl> +<a NAME="Project.__projectPath" ID="Project.__projectPath"></a> <h4>Project.__projectPath</h4> <b>__projectPath</b>(<i></i>) + <p> Private method to calculate the full path of the Pyramid project. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> path of the project (string) </dd> -</dl><dl> +</dl> +<dl> + <dt>Raises <b>PyramidNoProjectSelectedException</b>:</dt> <dd> raised, if no project is selected </dd> -</dl><a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a> +</dl> +<a NAME="Project.__pyramidInfo" ID="Project.__pyramidInfo"></a> <h4>Project.__pyramidInfo</h4> <b>__pyramidInfo</b>(<i></i>) + <p> Private slot to show some info about Pyramid. -</p><a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a> +</p> +<a NAME="Project.__runBrowser" ID="Project.__runBrowser"></a> <h4>Project.__runBrowser</h4> <b>__runBrowser</b>(<i></i>) + <p> Private slot to start the default web browser with the server URL. -</p><a NAME="Project.__runLoggingServer" ID="Project.__runLoggingServer"></a> +</p> +<a NAME="Project.__runLoggingServer" ID="Project.__runLoggingServer"></a> <h4>Project.__runLoggingServer</h4> <b>__runLoggingServer</b>(<i></i>) + <p> Private slot to start the Pyramid Web server with logging. -</p><a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a> +</p> +<a NAME="Project.__runPythonShell" ID="Project.__runPythonShell"></a> <h4>Project.__runPythonShell</h4> <b>__runPythonShell</b>(<i></i>) + <p> Private slot to start a Python console for a Pyramid project. -</p><a NAME="Project.__runServer" ID="Project.__runServer"></a> +</p> +<a NAME="Project.__runServer" ID="Project.__runServer"></a> <h4>Project.__runServer</h4> <b>__runServer</b>(<i>logging=False</i>) + <p> Private slot to start the Pyramid Web server. -</p><dl> +</p> +<dl> + <dt><i>logging</i></dt> <dd> flag indicating to enable logging (boolean) </dd> -</dl><a NAME="Project.__selectProject" ID="Project.__selectProject"></a> +</dl> +<a NAME="Project.__selectProject" ID="Project.__selectProject"></a> <h4>Project.__selectProject</h4> <b>__selectProject</b>(<i></i>) + <p> Private method to select a Pyramid project to work with. -</p><a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a> +</p> +<a NAME="Project.__serverProcFinished" ID="Project.__serverProcFinished"></a> <h4>Project.__serverProcFinished</h4> <b>__serverProcFinished</b>(<i></i>) + <p> Private slot connected to the finished signal. -</p><a NAME="Project.__setCurrentProject" ID="Project.__setCurrentProject"></a> +</p> +<a NAME="Project.__setCurrentProject" ID="Project.__setCurrentProject"></a> <h4>Project.__setCurrentProject</h4> <b>__setCurrentProject</b>(<i>project</i>) + <p> Private slot to set the current project. -</p><dl> +</p> +<dl> + <dt><i>project</i></dt> <dd> name of the project (string) </dd> -</dl><a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a> +</dl> +<a NAME="Project.__setupDevelop" ID="Project.__setupDevelop"></a> <h4>Project.__setupDevelop</h4> <b>__setupDevelop</b>(<i></i>) + <p> Private slot to set up the development environment for the current project. -</p><a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a> +</p> +<a NAME="Project.__showDocumentation" ID="Project.__showDocumentation"></a> <h4>Project.__showDocumentation</h4> <b>__showDocumentation</b>(<i></i>) + <p> Private slot to show the helpviewer with the Pyramid documentation. -</p><a NAME="Project.__showMatchingViews" ID="Project.__showMatchingViews"></a> +</p> +<a NAME="Project.__showMatchingViews" ID="Project.__showMatchingViews"></a> <h4>Project.__showMatchingViews</h4> <b>__showMatchingViews</b>(<i></i>) + <p> Private slot showing all views that would match a given URL. -</p><a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a> +</p> +<a NAME="Project.__showRoutes" ID="Project.__showRoutes"></a> <h4>Project.__showRoutes</h4> <b>__showRoutes</b>(<i></i>) + <p> Private slot showing all URL dispatch routes. -</p><a NAME="Project.__showTweens" ID="Project.__showTweens"></a> +</p> +<a NAME="Project.__showTweens" ID="Project.__showTweens"></a> <h4>Project.__showTweens</h4> <b>__showTweens</b>(<i></i>) + <p> Private slot showing all implicit and explicit tween objects. -</p><a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a> +</p> +<a NAME="Project.compileCatalogs" ID="Project.compileCatalogs"></a> <h4>Project.compileCatalogs</h4> <b>compileCatalogs</b>(<i>filenames</i>) + <p> Public method to compile the message catalogs. -</p><dl> +</p> +<dl> + <dt><i>filenames</i></dt> <dd> list of filenames (not used) </dd> -</dl><a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a> +</dl> +<a NAME="Project.compileSelectedCatalogs" ID="Project.compileSelectedCatalogs"></a> <h4>Project.compileSelectedCatalogs</h4> <b>compileSelectedCatalogs</b>(<i>filenames</i>) + <p> Public method to update the message catalogs. -</p><dl> +</p> +<dl> + <dt><i>filenames</i></dt> <dd> list of file names (list of string) </dd> -</dl><a NAME="Project.extractMessages" ID="Project.extractMessages"></a> +</dl> +<a NAME="Project.extractMessages" ID="Project.extractMessages"></a> <h4>Project.extractMessages</h4> <b>extractMessages</b>(<i></i>) + <p> Public method to extract the messages catalog template file. -</p><a NAME="Project.getMenu" ID="Project.getMenu"></a> +</p> +<a NAME="Project.getMenu" ID="Project.getMenu"></a> <h4>Project.getMenu</h4> <b>getMenu</b>(<i>name</i>) + <p> Public method to get a reference to the requested menu. -</p><dl> +</p> +<dl> + <dt><i>name</i></dt> <dd> name of the menu (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the menu (QMenu) or None, if no menu with the given name exists </dd> -</dl><a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a> +</dl> +<a NAME="Project.getMenuNames" ID="Project.getMenuNames"></a> <h4>Project.getMenuNames</h4> <b>getMenuNames</b>(<i></i>) + <p> Public method to get the names of all menus. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> menu names (list of string) </dd> -</dl><a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> +</dl> +<a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> <h4>Project.getPyramidCommand</h4> <b>getPyramidCommand</b>(<i>cmd, language=""</i>) + <p> Public method to build a Pyramid command. -</p><dl> +</p> +<dl> + <dt><i>cmd</i></dt> <dd> command (string) -</dd><dt><i>language</i></dt> +</dd> +<dt><i>language</i></dt> <dd> Python variant to get the virtual environment for (string, one of '', 'Python2' or 'Python3') </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> full pyramid command (string) </dd> -</dl><a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a> +</dl> +<a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a> <h4>Project.getPyramidVersion</h4> <b>getPyramidVersion</b>(<i></i>) + <p> Public method to get the Pyramid version as a tuple. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> Pyramid version </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of int </dd> -</dl><a NAME="Project.getPyramidVersionString" ID="Project.getPyramidVersionString"></a> +</dl> +<a NAME="Project.getPyramidVersionString" ID="Project.getPyramidVersionString"></a> <h4>Project.getPyramidVersionString</h4> <b>getPyramidVersionString</b>(<i></i>) + <p> Public method to get the Pyramid version as a string. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> Pyramid version </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a> +</dl> +<a NAME="Project.getPythonCommand" ID="Project.getPythonCommand"></a> <h4>Project.getPythonCommand</h4> <b>getPythonCommand</b>(<i></i>) + <p> Public method to build the Python command. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> python command (string) </dd> -</dl><a NAME="Project.initActions" ID="Project.initActions"></a> +</dl> +<a NAME="Project.initActions" ID="Project.initActions"></a> <h4>Project.initActions</h4> <b>initActions</b>(<i></i>) + <p> Public method to define the Pyramid actions. -</p><a NAME="Project.initMenu" ID="Project.initMenu"></a> +</p> +<a NAME="Project.initMenu" ID="Project.initMenu"></a> <h4>Project.initMenu</h4> <b>initMenu</b>(<i></i>) + <p> Public slot to initialize the Pyramid menu. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> the menu generated (QMenu) </dd> -</dl><a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a> +</dl> +<a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a> <h4>Project.isSpawningConsole</h4> <b>isSpawningConsole</b>(<i>consoleCmd</i>) + <p> Public method to check, if the given console is a spawning console. -</p><dl> +</p> +<dl> + <dt><i>consoleCmd</i></dt> <dd> console command (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> tuple of two entries giving an indication, if the console is spawning (boolean) and the (possibly) cleaned console command (string) </dd> -</dl><a NAME="Project.newForm" ID="Project.newForm"></a> +</dl> +<a NAME="Project.newForm" ID="Project.newForm"></a> <h4>Project.newForm</h4> <b>newForm</b>(<i>path</i>) + <p> Public method to create a new form. -</p><dl> +</p> +<dl> + <dt><i>path</i></dt> <dd> full directory path for the new form file (string) </dd> -</dl><a NAME="Project.openPOEditor" ID="Project.openPOEditor"></a> +</dl> +<a NAME="Project.openPOEditor" ID="Project.openPOEditor"></a> <h4>Project.openPOEditor</h4> <b>openPOEditor</b>(<i>poFile</i>) + <p> Public method to edit the given file in an external .po editor. -</p><dl> +</p> +<dl> + <dt><i>poFile</i></dt> <dd> name of the .po file (string) </dd> -</dl><a NAME="Project.projectClosed" ID="Project.projectClosed"></a> +</dl> +<a NAME="Project.projectClosed" ID="Project.projectClosed"></a> <h4>Project.projectClosed</h4> <b>projectClosed</b>(<i></i>) + <p> Public method to handle the closing of a project. -</p><a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a> +</p> +<a NAME="Project.projectClosedHooks" ID="Project.projectClosedHooks"></a> <h4>Project.projectClosedHooks</h4> <b>projectClosedHooks</b>(<i></i>) + <p> Public method to remove our hook methods. -</p><a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a> +</p> +<a NAME="Project.projectOpenedHooks" ID="Project.projectOpenedHooks"></a> <h4>Project.projectOpenedHooks</h4> <b>projectOpenedHooks</b>(<i></i>) + <p> Public method to add our hook methods. -</p><a NAME="Project.registerOpenHook" ID="Project.registerOpenHook"></a> +</p> +<a NAME="Project.registerOpenHook" ID="Project.registerOpenHook"></a> <h4>Project.registerOpenHook</h4> <b>registerOpenHook</b>(<i></i>) + <p> Public method to register the open hook to open a translations file in a translations editor. -</p><a NAME="Project.supportedPythonVariants" ID="Project.supportedPythonVariants"></a> +</p> +<a NAME="Project.supportedPythonVariants" ID="Project.supportedPythonVariants"></a> <h4>Project.supportedPythonVariants</h4> <b>supportedPythonVariants</b>(<i></i>) + <p> Public method to get the supported Python variants. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of supported Python variants (list of strings) </dd> -</dl><a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> +</dl> +<a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> <h4>Project.updateCatalogs</h4> <b>updateCatalogs</b>(<i>filenames</i>) + <p> Public method to update the message catalogs. -</p><dl> +</p> +<dl> + <dt><i>filenames</i></dt> <dd> list of filenames (not used) </dd> -</dl><a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a> +</dl> +<a NAME="Project.updateSelectedCatalogs" ID="Project.updateSelectedCatalogs"></a> <h4>Project.updateSelectedCatalogs</h4> <b>updateSelectedCatalogs</b>(<i>filenames</i>) + <p> Public method to update the message catalogs. -</p><dl> +</p> +<dl> + <dt><i>filenames</i></dt> <dd> list of filenames </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PyramidNoProjectSelectedException" ID="PyramidNoProjectSelectedException"></a> <h2>PyramidNoProjectSelectedException</h2> + <p> Exception thrown to signal, that there is no current Pyramid project. </p> <h3>Derived from</h3> Exception <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="QProcess" ID="QProcess"></a> <h2>QProcess</h2> + <p> Class transforming the call arguments in case of gnome-terminal. </p> <h3>Derived from</h3> QProcessPyQt <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#QProcess.start">start</a></td> <td>Public method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args.</td> </tr> </table> <h3>Static Methods</h3> + <table> + <tr> <td><a href="#QProcess.startDetached">startDetached</a></td> <td>Public static method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args.</td> </tr> </table> + <a NAME="QProcess.start" ID="QProcess.start"></a> <h4>QProcess.start</h4> <b>start</b>(<i>cmd, args=None, mode=QProcessPyQt.ReadWrite</i>) + <p> Public method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args. -</p><dl> +</p> +<dl> + <dt><i>cmd</i></dt> <dd> start the given program cmd (string) -</dd><dt><i>args=</i></dt> +</dd> +<dt><i>args=</i></dt> <dd> list of parameters (list of strings) -</dd><dt><i>mode=</i></dt> +</dd> +<dt><i>mode=</i></dt> <dd> access mode (QIODevice.OpenMode) </dd> -</dl><a NAME="QProcess.startDetached" ID="QProcess.startDetached"></a> +</dl> +<a NAME="QProcess.startDetached" ID="QProcess.startDetached"></a> <h4>QProcess.startDetached (static)</h4> <b>startDetached</b>(<i>args=None, path=''</i>) + <p> Public static method to start the given program (cmd) in a new process, if none is already running, passing the command line arguments in args. -</p><dl> +</p> +<dl> + <dt><i>cmd</i></dt> <dd> start the given program cmd (string) -</dd><dt><i>args=</i></dt> +</dd> +<dt><i>args=</i></dt> <dd> list of parameters (list of strings) -</dd><dt><i>path=</i></dt> +</dd> +<dt><i>path=</i></dt> <dd> new working directory (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> tuple of successful start and process id (boolean, integer)
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html Thu Apr 09 18:16:19 2020 +0200 @@ -18,32 +18,41 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog</h1> + <p> Module implementing a dialog starting a process and showing its output. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PyramidDialog">PyramidDialog</a></td> <td>Class implementing a dialog starting a process and showing its output.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PyramidDialog" ID="PyramidDialog"></a> <h2>PyramidDialog</h2> + <p> Class implementing a dialog starting a process and showing its output. -</p><p> +</p> +<p> It starts a QProcess and displays a dialog that shows the output of the process. The dialog is modal, which causes a synchronized execution of the process. @@ -51,226 +60,302 @@ <h3>Derived from</h3> QDialog, Ui_PyramidDialog <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#PyramidDialog.__init__">PyramidDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.__procFinished">__procFinished</a></td> <td>Private slot connected to the finished signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.__readStderr">__readStderr</a></td> <td>Private slot to handle the readyReadStandardError signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.__readStdout">__readStdout</a></td> <td>Private slot to handle the readyReadStandardOutput signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.finish">finish</a></td> <td>Public slot called when the process finished or the user pressed the button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.keyPressEvent">keyPressEvent</a></td> <td>Protected slot to handle a key press event.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.normalExit">normalExit</a></td> <td>Public method to check for a normal process termination.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td> <td>Public method to check for a normal process termination without error messages.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot called by a button of the button box clicked.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.on_input_returnPressed">on_input_returnPressed</a></td> <td>Private slot to handle the press of the return key in the input field.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> <td>Private slot to handle the password checkbox toggled.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> <td>Private slot to send the input to the subversion process.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.startBatchProcesses">startBatchProcesses</a></td> <td>Public slot used to start a batch of processes.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidDialog.startProcess">startProcess</a></td> <td>Public slot used to start the process.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PyramidDialog.__init__" ID="PyramidDialog.__init__"></a> <h4>PyramidDialog (Constructor)</h4> <b>PyramidDialog</b>(<i>text, fixed=False, linewrap=True, msgSuccess=None, msgError=None, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>text</i></dt> <dd> text to be shown by the label (string) -</dd><dt><i>fixed=</i></dt> +</dd> +<dt><i>fixed=</i></dt> <dd> flag indicating a fixed font should be used (boolean) -</dd><dt><i>linewrap=</i></dt> +</dd> +<dt><i>linewrap=</i></dt> <dd> flag indicating to wrap long lines (boolean) -</dd><dt><i>msgSuccess=</i></dt> +</dd> +<dt><i>msgSuccess=</i></dt> <dd> optional string to show upon successful execution (string) -</dd><dt><i>msgError=</i></dt> +</dd> +<dt><i>msgError=</i></dt> <dd> optional string to show upon unsuccessful execution (string) -</dd><dt><i>parent=</i></dt> +</dd> +<dt><i>parent=</i></dt> <dd> parent widget (QWidget) </dd> -</dl><a NAME="PyramidDialog.__procFinished" ID="PyramidDialog.__procFinished"></a> +</dl> +<a NAME="PyramidDialog.__procFinished" ID="PyramidDialog.__procFinished"></a> <h4>PyramidDialog.__procFinished</h4> <b>__procFinished</b>(<i>exitCode, exitStatus</i>) + <p> Private slot connected to the finished signal. -</p><dl> +</p> +<dl> + <dt><i>exitCode</i></dt> <dd> exit code of the process (integer) -</dd><dt><i>exitStatus</i></dt> +</dd> +<dt><i>exitStatus</i></dt> <dd> exit status of the process (QProcess.ExitStatus) </dd> -</dl><a NAME="PyramidDialog.__readStderr" ID="PyramidDialog.__readStderr"></a> +</dl> +<a NAME="PyramidDialog.__readStderr" ID="PyramidDialog.__readStderr"></a> <h4>PyramidDialog.__readStderr</h4> <b>__readStderr</b>(<i></i>) + <p> Private slot to handle the readyReadStandardError signal. -</p><p> +</p> +<p> It reads the error output of the process and inserts it into the error pane. -</p><a NAME="PyramidDialog.__readStdout" ID="PyramidDialog.__readStdout"></a> +</p> +<a NAME="PyramidDialog.__readStdout" ID="PyramidDialog.__readStdout"></a> <h4>PyramidDialog.__readStdout</h4> <b>__readStdout</b>(<i></i>) + <p> Private slot to handle the readyReadStandardOutput signal. -</p><p> +</p> +<p> It reads the output of the process, formats it and inserts it into the contents pane. -</p><a NAME="PyramidDialog.finish" ID="PyramidDialog.finish"></a> +</p> +<a NAME="PyramidDialog.finish" ID="PyramidDialog.finish"></a> <h4>PyramidDialog.finish</h4> <b>finish</b>(<i></i>) + <p> Public slot called when the process finished or the user pressed the button. -</p><a NAME="PyramidDialog.keyPressEvent" ID="PyramidDialog.keyPressEvent"></a> +</p> +<a NAME="PyramidDialog.keyPressEvent" ID="PyramidDialog.keyPressEvent"></a> <h4>PyramidDialog.keyPressEvent</h4> <b>keyPressEvent</b>(<i>evt</i>) + <p> Protected slot to handle a key press event. -</p><dl> +</p> +<dl> + <dt><i>evt</i></dt> <dd> the key press event (QKeyEvent) </dd> -</dl><a NAME="PyramidDialog.normalExit" ID="PyramidDialog.normalExit"></a> +</dl> +<a NAME="PyramidDialog.normalExit" ID="PyramidDialog.normalExit"></a> <h4>PyramidDialog.normalExit</h4> <b>normalExit</b>(<i></i>) + <p> Public method to check for a normal process termination. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating normal process termination (boolean) </dd> -</dl><a NAME="PyramidDialog.normalExitWithoutErrors" ID="PyramidDialog.normalExitWithoutErrors"></a> +</dl> +<a NAME="PyramidDialog.normalExitWithoutErrors" ID="PyramidDialog.normalExitWithoutErrors"></a> <h4>PyramidDialog.normalExitWithoutErrors</h4> <b>normalExitWithoutErrors</b>(<i></i>) + <p> Public method to check for a normal process termination without error messages. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating normal process termination (boolean) </dd> -</dl><a NAME="PyramidDialog.on_buttonBox_clicked" ID="PyramidDialog.on_buttonBox_clicked"></a> +</dl> +<a NAME="PyramidDialog.on_buttonBox_clicked" ID="PyramidDialog.on_buttonBox_clicked"></a> <h4>PyramidDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) + <p> Private slot called by a button of the button box clicked. -</p><dl> +</p> +<dl> + <dt><i>button</i></dt> <dd> button that was clicked (QAbstractButton) </dd> -</dl><a NAME="PyramidDialog.on_input_returnPressed" ID="PyramidDialog.on_input_returnPressed"></a> +</dl> +<a NAME="PyramidDialog.on_input_returnPressed" ID="PyramidDialog.on_input_returnPressed"></a> <h4>PyramidDialog.on_input_returnPressed</h4> <b>on_input_returnPressed</b>(<i></i>) + <p> Private slot to handle the press of the return key in the input field. -</p><a NAME="PyramidDialog.on_passwordCheckBox_toggled" ID="PyramidDialog.on_passwordCheckBox_toggled"></a> +</p> +<a NAME="PyramidDialog.on_passwordCheckBox_toggled" ID="PyramidDialog.on_passwordCheckBox_toggled"></a> <h4>PyramidDialog.on_passwordCheckBox_toggled</h4> <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) + <p> Private slot to handle the password checkbox toggled. -</p><dl> +</p> +<dl> + <dt><i>isOn</i></dt> <dd> flag indicating the status of the check box (boolean) </dd> -</dl><a NAME="PyramidDialog.on_sendButton_clicked" ID="PyramidDialog.on_sendButton_clicked"></a> +</dl> +<a NAME="PyramidDialog.on_sendButton_clicked" ID="PyramidDialog.on_sendButton_clicked"></a> <h4>PyramidDialog.on_sendButton_clicked</h4> <b>on_sendButton_clicked</b>(<i></i>) + <p> Private slot to send the input to the subversion process. -</p><a NAME="PyramidDialog.startBatchProcesses" ID="PyramidDialog.startBatchProcesses"></a> +</p> +<a NAME="PyramidDialog.startBatchProcesses" ID="PyramidDialog.startBatchProcesses"></a> <h4>PyramidDialog.startBatchProcesses</h4> <b>startBatchProcesses</b>(<i>argsLists, workingDir=None</i>) + <p> Public slot used to start a batch of processes. -</p><dl> +</p> +<dl> + <dt><i>argsLists</i></dt> <dd> list of lists of arguments for the processes (list of list of string) -</dd><dt><i>workingDir</i></dt> +</dd> +<dt><i>workingDir</i></dt> <dd> working directory for the process (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating a successful start of the first process (boolean) </dd> -</dl><a NAME="PyramidDialog.startProcess" ID="PyramidDialog.startProcess"></a> +</dl> +<a NAME="PyramidDialog.startProcess" ID="PyramidDialog.startProcess"></a> <h4>PyramidDialog.startProcess</h4> <b>startProcess</b>(<i>command, args, workingDir=None, showArgs=True</i>) + <p> Public slot used to start the process. -</p><dl> +</p> +<dl> + <dt><i>command</i></dt> <dd> command to start (string) -</dd><dt><i>args</i></dt> +</dd> +<dt><i>args</i></dt> <dd> list of arguments for the process (list of strings) -</dd><dt><i>workingDir=</i></dt> +</dd> +<dt><i>workingDir=</i></dt> <dd> working directory for the process (string) -</dd><dt><i>showArgs=</i></dt> +</dd> +<dt><i>showArgs=</i></dt> <dd> flag indicating to show the arguments (boolean) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating a successful start of the process
--- a/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html Thu Apr 09 18:16:19 2020 +0200 @@ -18,191 +18,256 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog</h1> + <p> Module implementing a dialog showing the available routes. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PyramidRoutesDialog">PyramidRoutesDialog</a></td> <td>Class implementing a dialog showing the available routes.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PyramidRoutesDialog" ID="PyramidRoutesDialog"></a> <h2>PyramidRoutesDialog</h2> + <p> Class implementing a dialog showing the available routes. </p> <h3>Derived from</h3> QDialog, Ui_PyramidRoutesDialog <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#PyramidRoutesDialog.__init__">PyramidRoutesDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.__procFinished">__procFinished</a></td> <td>Private slot connected to the finished signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.__processBuffer">__processBuffer</a></td> <td>Private slot to process the output buffer of the proutes command.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.__readStderr">__readStderr</a></td> <td>Private slot to handle the readyReadStandardError signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.__readStdout">__readStdout</a></td> <td>Private slot to handle the readyReadStandardOutput signal.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.finish">finish</a></td> <td>Public slot called when the process finished or the user pressed the button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.keyPressEvent">keyPressEvent</a></td> <td>Protected slot to handle a key press event.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> <td>Private slot called by a button of the button box clicked.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.on_input_returnPressed">on_input_returnPressed</a></td> <td>Private slot to handle the press of the return key in the input field.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> <td>Private slot to handle the password checkbox toggled.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> <td>Private slot to send the input to the subversion process.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PyramidRoutesDialog.start">start</a></td> <td>Public slot used to start the process.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PyramidRoutesDialog.__init__" ID="PyramidRoutesDialog.__init__"></a> <h4>PyramidRoutesDialog (Constructor)</h4> <b>PyramidRoutesDialog</b>(<i>project, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>project</i></dt> <dd> reference to the project object (ProjectPyramid.Project.Project) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="PyramidRoutesDialog.__procFinished" ID="PyramidRoutesDialog.__procFinished"></a> +</dl> +<a NAME="PyramidRoutesDialog.__procFinished" ID="PyramidRoutesDialog.__procFinished"></a> <h4>PyramidRoutesDialog.__procFinished</h4> <b>__procFinished</b>(<i>exitCode, exitStatus</i>) + <p> Private slot connected to the finished signal. -</p><dl> +</p> +<dl> + <dt><i>exitCode</i></dt> <dd> exit code of the process (integer) -</dd><dt><i>exitStatus</i></dt> +</dd> +<dt><i>exitStatus</i></dt> <dd> exit status of the process (QProcess.ExitStatus) </dd> -</dl><a NAME="PyramidRoutesDialog.__processBuffer" ID="PyramidRoutesDialog.__processBuffer"></a> +</dl> +<a NAME="PyramidRoutesDialog.__processBuffer" ID="PyramidRoutesDialog.__processBuffer"></a> <h4>PyramidRoutesDialog.__processBuffer</h4> <b>__processBuffer</b>(<i></i>) + <p> Private slot to process the output buffer of the proutes command. -</p><a NAME="PyramidRoutesDialog.__readStderr" ID="PyramidRoutesDialog.__readStderr"></a> +</p> +<a NAME="PyramidRoutesDialog.__readStderr" ID="PyramidRoutesDialog.__readStderr"></a> <h4>PyramidRoutesDialog.__readStderr</h4> <b>__readStderr</b>(<i></i>) + <p> Private slot to handle the readyReadStandardError signal. -</p><p> +</p> +<p> It reads the error output of the process and inserts it into the error pane. -</p><a NAME="PyramidRoutesDialog.__readStdout" ID="PyramidRoutesDialog.__readStdout"></a> +</p> +<a NAME="PyramidRoutesDialog.__readStdout" ID="PyramidRoutesDialog.__readStdout"></a> <h4>PyramidRoutesDialog.__readStdout</h4> <b>__readStdout</b>(<i></i>) + <p> Private slot to handle the readyReadStandardOutput signal. -</p><p> +</p> +<p> It reads the output of the process and appends it to a buffer for delayed processing. -</p><a NAME="PyramidRoutesDialog.finish" ID="PyramidRoutesDialog.finish"></a> +</p> +<a NAME="PyramidRoutesDialog.finish" ID="PyramidRoutesDialog.finish"></a> <h4>PyramidRoutesDialog.finish</h4> <b>finish</b>(<i></i>) + <p> Public slot called when the process finished or the user pressed the button. -</p><a NAME="PyramidRoutesDialog.keyPressEvent" ID="PyramidRoutesDialog.keyPressEvent"></a> +</p> +<a NAME="PyramidRoutesDialog.keyPressEvent" ID="PyramidRoutesDialog.keyPressEvent"></a> <h4>PyramidRoutesDialog.keyPressEvent</h4> <b>keyPressEvent</b>(<i>evt</i>) + <p> Protected slot to handle a key press event. -</p><dl> +</p> +<dl> + <dt><i>evt</i></dt> <dd> the key press event (QKeyEvent) </dd> -</dl><a NAME="PyramidRoutesDialog.on_buttonBox_clicked" ID="PyramidRoutesDialog.on_buttonBox_clicked"></a> +</dl> +<a NAME="PyramidRoutesDialog.on_buttonBox_clicked" ID="PyramidRoutesDialog.on_buttonBox_clicked"></a> <h4>PyramidRoutesDialog.on_buttonBox_clicked</h4> <b>on_buttonBox_clicked</b>(<i>button</i>) + <p> Private slot called by a button of the button box clicked. -</p><dl> +</p> +<dl> + <dt><i>button</i></dt> <dd> button that was clicked (QAbstractButton) </dd> -</dl><a NAME="PyramidRoutesDialog.on_input_returnPressed" ID="PyramidRoutesDialog.on_input_returnPressed"></a> +</dl> +<a NAME="PyramidRoutesDialog.on_input_returnPressed" ID="PyramidRoutesDialog.on_input_returnPressed"></a> <h4>PyramidRoutesDialog.on_input_returnPressed</h4> <b>on_input_returnPressed</b>(<i></i>) + <p> Private slot to handle the press of the return key in the input field. -</p><a NAME="PyramidRoutesDialog.on_passwordCheckBox_toggled" ID="PyramidRoutesDialog.on_passwordCheckBox_toggled"></a> +</p> +<a NAME="PyramidRoutesDialog.on_passwordCheckBox_toggled" ID="PyramidRoutesDialog.on_passwordCheckBox_toggled"></a> <h4>PyramidRoutesDialog.on_passwordCheckBox_toggled</h4> <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) + <p> Private slot to handle the password checkbox toggled. -</p><dl> +</p> +<dl> + <dt><i>isOn</i></dt> <dd> flag indicating the status of the check box (boolean) </dd> -</dl><a NAME="PyramidRoutesDialog.on_sendButton_clicked" ID="PyramidRoutesDialog.on_sendButton_clicked"></a> +</dl> +<a NAME="PyramidRoutesDialog.on_sendButton_clicked" ID="PyramidRoutesDialog.on_sendButton_clicked"></a> <h4>PyramidRoutesDialog.on_sendButton_clicked</h4> <b>on_sendButton_clicked</b>(<i></i>) + <p> Private slot to send the input to the subversion process. -</p><a NAME="PyramidRoutesDialog.start" ID="PyramidRoutesDialog.start"></a> +</p> +<a NAME="PyramidRoutesDialog.start" ID="PyramidRoutesDialog.start"></a> <h4>PyramidRoutesDialog.start</h4> <b>start</b>(<i>projectPath</i>) + <p> Public slot used to start the process. -</p><dl> +</p> +<dl> + <dt><i>projectPath</i></dt> <dd> path to the Pyramid project (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating a successful start of the process
--- a/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.html Thu Apr 09 18:16:19 2020 +0200 @@ -20,6 +20,7 @@ </head> <body> <h1>Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage</h1> + <p> Package implementing the Pyramid page of the configuration dialog. </p> @@ -27,6 +28,7 @@ <h3>Modules</h3> <table> + <tr> <td><a href="Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.PyramidPage.html">PyramidPage</a></td> <td>Module implementing the Pyramid configuration page.</td>
--- a/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.ProjectPyramid.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.ProjectPyramid.html Thu Apr 09 18:16:19 2020 +0200 @@ -20,12 +20,14 @@ </head> <body> <h1>Plugin_Project_Pyramid.ProjectPyramid</h1> + <p> Package implementing project support for eric6 Pyramid projects. </p> <h3>Packages</h3> <table> + <tr> <td><a href="index-Plugin_Project_Pyramid.ProjectPyramid.ConfigurationPage.html">ConfigurationPage</a></td> <td>Package implementing the Pyramid page of the configuration dialog.</td> @@ -34,22 +36,28 @@ <h3>Modules</h3> <table> + <tr> <td><a href="Plugin_Project_Pyramid.ProjectPyramid.CreateParametersDialog.html">CreateParametersDialog</a></td> <td>Module implementing a dialog for entering the create parameters.</td> -</tr><tr> +</tr> +<tr> <td><a href="Plugin_Project_Pyramid.ProjectPyramid.DistributionTypeSelectionDialog.html">DistributionTypeSelectionDialog</a></td> <td>Module implementing a dialog to select the distribution file formats.</td> -</tr><tr> +</tr> +<tr> <td><a href="Plugin_Project_Pyramid.ProjectPyramid.FormSelectionDialog.html">FormSelectionDialog</a></td> <td>Module implementing a dialog to select the template type.</td> -</tr><tr> +</tr> +<tr> <td><a href="Plugin_Project_Pyramid.ProjectPyramid.Project.html">Project</a></td> <td>Module implementing the Pyramid project support.</td> -</tr><tr> +</tr> +<tr> <td><a href="Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html">PyramidDialog</a></td> <td>Module implementing a dialog starting a process and showing its output.</td> -</tr><tr> +</tr> +<tr> <td><a href="Plugin_Project_Pyramid.ProjectPyramid.PyramidRoutesDialog.html">PyramidRoutesDialog</a></td> <td>Module implementing a dialog showing the available routes.</td> </tr>
--- a/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/index-Plugin_Project_Pyramid.html Thu Apr 09 18:16:19 2020 +0200 @@ -20,12 +20,14 @@ </head> <body> <h1>Plugin_Project_Pyramid</h1> + <p> Package implementing the Pyramid project plugin. </p> <h3>Packages</h3> <table> + <tr> <td><a href="index-Plugin_Project_Pyramid.ProjectPyramid.html">ProjectPyramid</a></td> <td>Package implementing project support for eric6 Pyramid projects.</td> @@ -34,6 +36,7 @@ <h3>Modules</h3> <table> + <tr> <td><a href="Plugin_Project_Pyramid.PluginProjectPyramid.html">PluginProjectPyramid</a></td> <td>Module implementing the Pyramid project plugin.</td>
--- a/ProjectPyramid/Documentation/source/index.html Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Documentation/source/index.html Thu Apr 09 18:16:19 2020 +0200 @@ -24,6 +24,7 @@ <h3>Packages</h3> <table> + <tr> <td><a href="index-Plugin_Project_Pyramid.html">Plugin_Project_Pyramid</a></td> <td>Package implementing the Pyramid project plugin.</td>
--- a/ProjectPyramid/Project.py Wed Jan 01 11:58:58 2020 +0100 +++ b/ProjectPyramid/Project.py Thu Apr 09 18:16:19 2020 +0200 @@ -96,16 +96,21 @@ """ Class implementing the Pyramid project support. """ - def __init__(self, plugin, parent=None): + def __init__(self, plugin, iconSuffix, parent=None): """ Constructor @param plugin reference to the plugin object - @param parent parent (QObject) + @type ProjectPyramidPlugin + @param iconSuffix suffix for the icons + @type str + @param parent parent + @type QObject """ super(Project, self).__init__(parent) self.__plugin = plugin + self.__iconSuffix = iconSuffix self.__ui = parent self.__e5project = e5App().getObject("Project") try: @@ -896,7 +901,9 @@ modal=True, buttons=E5MessageBox.Ok) msgBox.setIconPixmap(UI.PixmapCache.getPixmap( - os.path.join("ProjectPyramid", "icons", "pyramid64.png"))) + os.path.join("ProjectPyramid", "icons", + "pyramid64-{0}".format(self.__iconSuffix)) + )) msgBox.exec_() def getPyramidVersionString(self):
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/icons/pyramid-dark.svg Thu Apr 09 18:16:19 2020 +0200 @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8"?> +<svg width="22" height="22" version="1.1" viewBox="0 0 22 22" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> +<g transform="matrix(.052632 0 0 .052222 .92153 1)" fill="#eff0f1"> + <g fill="#eff0f1"> + <polygon points="125.64 87.896 191.49 118.33 257.34 87.897 191.49 0"/> + <polygon points="112.74 115.12 60.115 185.37 191.49 251.63 322.87 185.37 270.24 115.12 191.49 151.51"/> + <polygon points="1.491 273.63 191.49 382.98 381.49 273.63 336.25 213.24 191.49 286.25 46.73 213.24"/> + </g> +</g> + + + + + + + + + + + + + + + +</svg>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/icons/pyramid-light.svg Thu Apr 09 18:16:19 2020 +0200 @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8"?> +<svg width="22" height="22" version="1.1" viewBox="0 0 22 22" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> +<g transform="matrix(.052632 0 0 .052222 .92153 1)" fill="#232629"> + <g fill="#232629"> + <polygon points="125.64 87.896 191.49 118.33 257.34 87.897 191.49 0"/> + <polygon points="112.74 115.12 60.115 185.37 191.49 251.63 322.87 185.37 270.24 115.12 191.49 151.51"/> + <polygon points="1.491 273.63 191.49 382.98 381.49 273.63 336.25 213.24 191.49 286.25 46.73 213.24"/> + </g> +</g> + + + + + + + + + + + + + + + +</svg>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/icons/pyramid64-dark.svg Thu Apr 09 18:16:19 2020 +0200 @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8"?> +<svg width="64" height="64" version="1.1" viewBox="0 0 64 64" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> +<g transform="matrix(.16842 0 0 .16711 -.25112 0)" fill="#eff0f1"> + <g fill="#eff0f1"> + <polygon points="125.64 87.896 191.49 118.33 257.34 87.897 191.49 0"/> + <polygon points="270.24 115.12 191.49 151.51 112.74 115.12 60.115 185.37 191.49 251.63 322.87 185.37"/> + <polygon points="191.49 286.25 46.73 213.24 1.491 273.63 191.49 382.98 381.49 273.63 336.25 213.24"/> + </g> +</g> + + + + + + + + + + + + + + + +</svg>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ProjectPyramid/icons/pyramid64-light.svg Thu Apr 09 18:16:19 2020 +0200 @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8"?> +<svg width="64" height="64" version="1.1" viewBox="0 0 64 64" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"> +<g transform="matrix(.16842 0 0 .16711 -.25112 0)" fill="#232629"> + <g fill="#232629"> + <polygon points="125.64 87.896 191.49 118.33 257.34 87.897 191.49 0"/> + <polygon points="270.24 115.12 191.49 151.51 112.74 115.12 60.115 185.37 191.49 251.63 322.87 185.37"/> + <polygon points="191.49 286.25 46.73 213.24 1.491 273.63 191.49 382.98 381.49 273.63 336.25 213.24"/> + </g> +</g> + + + + + + + + + + + + + + + +</svg>
