--- a/ProjectWeb/Documentation/source/Plugin_Project_Web.PluginProjectWeb.html Wed Jan 01 11:58:59 2020 +0100 +++ b/ProjectWeb/Documentation/source/Plugin_Project_Web.PluginProjectWeb.html Tue Jun 23 18:59:26 2020 +0200 @@ -18,211 +18,283 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Project_Web.PluginProjectWeb</h1> + <p> Module implementing the Web 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>python2Compatible</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> +<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>shortDescription</td></tr><tr><td>version</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#ProjectWebPlugin">ProjectWebPlugin</a></td> <td>Class implementing the Web project plugin.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="ProjectWebPlugin" ID="ProjectWebPlugin"></a> <h2>ProjectWebPlugin</h2> + <p> Class implementing the Web project plugin. </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="#ProjectWebPlugin.__init__">ProjectWebPlugin</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__editorClosed">__editorClosed</a></td> <td>Private slot called, when an editor was closed.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__editorOpened">__editorOpened</a></td> <td>Private slot called, when a new editor was opened.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__editorShowMenu">__editorShowMenu</a></td> <td>Private slot called, when the the editor context menu or a submenu is about to be shown.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__html5Prettify">__html5Prettify</a></td> <td>Private slot handling the Prettify HTML action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__html5ToCss3">__html5ToCss3</a></td> <td>Private slot handling the HTML5 to CSS3 conversion.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__html5ToJs">__html5ToJs</a></td> <td>Private slot handling the HTML5 to JavaScript conversion.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__initMenu">__initMenu</a></td> <td>Private method to initialize the web tools menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__initialize">__initialize</a></td> <td>Private slot to (re)initialize the plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__loadTranslator">__loadTranslator</a></td> <td>Private method to load the translation file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__menuAboutToShow">__menuAboutToShow</a></td> <td>Private slot to prepare the menu before it is shown.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.__populateMenu">__populateMenu</a></td> <td>Private slot to populate the tools menu with our entries.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.activate">activate</a></td> <td>Public method to activate this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.deactivate">deactivate</a></td> <td>Public method to deactivate this plugin.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ProjectWebPlugin.fileTypesCallback">fileTypesCallback</a></td> <td>Public method to get the filetype associations of the Web project type.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="ProjectWebPlugin.__init__" ID="ProjectWebPlugin.__init__"></a> <h4>ProjectWebPlugin (Constructor)</h4> <b>ProjectWebPlugin</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="ProjectWebPlugin.__editorClosed" ID="ProjectWebPlugin.__editorClosed"></a> +</dl> +<a NAME="ProjectWebPlugin.__editorClosed" ID="ProjectWebPlugin.__editorClosed"></a> <h4>ProjectWebPlugin.__editorClosed</h4> <b>__editorClosed</b>(<i>editor</i>) + <p> Private slot called, when an editor was closed. -</p><dl> +</p> +<dl> + <dt><i>editor</i></dt> <dd> reference to the editor (QScintilla.Editor) </dd> -</dl><a NAME="ProjectWebPlugin.__editorOpened" ID="ProjectWebPlugin.__editorOpened"></a> +</dl> +<a NAME="ProjectWebPlugin.__editorOpened" ID="ProjectWebPlugin.__editorOpened"></a> <h4>ProjectWebPlugin.__editorOpened</h4> <b>__editorOpened</b>(<i>editor</i>) + <p> Private slot called, when a new editor was opened. -</p><dl> +</p> +<dl> + <dt><i>editor</i></dt> <dd> reference to the new editor (QScintilla.Editor) </dd> -</dl><a NAME="ProjectWebPlugin.__editorShowMenu" ID="ProjectWebPlugin.__editorShowMenu"></a> +</dl> +<a NAME="ProjectWebPlugin.__editorShowMenu" ID="ProjectWebPlugin.__editorShowMenu"></a> <h4>ProjectWebPlugin.__editorShowMenu</h4> <b>__editorShowMenu</b>(<i>menuName, menu, editor</i>) + <p> Private slot called, when the the editor context menu or a submenu is about to be shown. -</p><dl> +</p> +<dl> + <dt><i>menuName</i></dt> <dd> name of the menu to be shown (string) -</dd><dt><i>menu</i></dt> +</dd> +<dt><i>menu</i></dt> <dd> reference to the menu (QMenu) -</dd><dt><i>editor</i></dt> +</dd> +<dt><i>editor</i></dt> <dd> reference to the editor </dd> -</dl><a NAME="ProjectWebPlugin.__html5Prettify" ID="ProjectWebPlugin.__html5Prettify"></a> +</dl> +<a NAME="ProjectWebPlugin.__html5Prettify" ID="ProjectWebPlugin.__html5Prettify"></a> <h4>ProjectWebPlugin.__html5Prettify</h4> <b>__html5Prettify</b>(<i></i>) + <p> Private slot handling the Prettify HTML action. -</p><a NAME="ProjectWebPlugin.__html5ToCss3" ID="ProjectWebPlugin.__html5ToCss3"></a> +</p> +<a NAME="ProjectWebPlugin.__html5ToCss3" ID="ProjectWebPlugin.__html5ToCss3"></a> <h4>ProjectWebPlugin.__html5ToCss3</h4> <b>__html5ToCss3</b>(<i></i>) + <p> Private slot handling the HTML5 to CSS3 conversion. -</p><a NAME="ProjectWebPlugin.__html5ToJs" ID="ProjectWebPlugin.__html5ToJs"></a> +</p> +<a NAME="ProjectWebPlugin.__html5ToJs" ID="ProjectWebPlugin.__html5ToJs"></a> <h4>ProjectWebPlugin.__html5ToJs</h4> <b>__html5ToJs</b>(<i></i>) + <p> Private slot handling the HTML5 to JavaScript conversion. -</p><a NAME="ProjectWebPlugin.__initMenu" ID="ProjectWebPlugin.__initMenu"></a> +</p> +<a NAME="ProjectWebPlugin.__initMenu" ID="ProjectWebPlugin.__initMenu"></a> <h4>ProjectWebPlugin.__initMenu</h4> <b>__initMenu</b>(<i></i>) + <p> Private method to initialize the web tools menu. -</p><a NAME="ProjectWebPlugin.__initialize" ID="ProjectWebPlugin.__initialize"></a> +</p> +<a NAME="ProjectWebPlugin.__initialize" ID="ProjectWebPlugin.__initialize"></a> <h4>ProjectWebPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) + <p> Private slot to (re)initialize the plugin. -</p><a NAME="ProjectWebPlugin.__loadTranslator" ID="ProjectWebPlugin.__loadTranslator"></a> +</p> +<a NAME="ProjectWebPlugin.__loadTranslator" ID="ProjectWebPlugin.__loadTranslator"></a> <h4>ProjectWebPlugin.__loadTranslator</h4> <b>__loadTranslator</b>(<i></i>) + <p> Private method to load the translation file. -</p><a NAME="ProjectWebPlugin.__menuAboutToShow" ID="ProjectWebPlugin.__menuAboutToShow"></a> +</p> +<a NAME="ProjectWebPlugin.__menuAboutToShow" ID="ProjectWebPlugin.__menuAboutToShow"></a> <h4>ProjectWebPlugin.__menuAboutToShow</h4> <b>__menuAboutToShow</b>(<i></i>) + <p> Private slot to prepare the menu before it is shown. -</p><a NAME="ProjectWebPlugin.__populateMenu" ID="ProjectWebPlugin.__populateMenu"></a> +</p> +<a NAME="ProjectWebPlugin.__populateMenu" ID="ProjectWebPlugin.__populateMenu"></a> <h4>ProjectWebPlugin.__populateMenu</h4> <b>__populateMenu</b>(<i>name, menu</i>) + <p> Private slot to populate the tools menu with our entries. -</p><dl> +</p> +<dl> + <dt><i>name</i></dt> <dd> name of the menu (string) -</dd><dt><i>menu</i></dt> +</dd> +<dt><i>menu</i></dt> <dd> reference to the menu to be populated (QMenu) </dd> -</dl><a NAME="ProjectWebPlugin.activate" ID="ProjectWebPlugin.activate"></a> +</dl> +<a NAME="ProjectWebPlugin.activate" ID="ProjectWebPlugin.activate"></a> <h4>ProjectWebPlugin.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="ProjectWebPlugin.deactivate" ID="ProjectWebPlugin.deactivate"></a> +</dl> +<a NAME="ProjectWebPlugin.deactivate" ID="ProjectWebPlugin.deactivate"></a> <h4>ProjectWebPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) + <p> Public method to deactivate this plugin. -</p><a NAME="ProjectWebPlugin.fileTypesCallback" ID="ProjectWebPlugin.fileTypesCallback"></a> +</p> +<a NAME="ProjectWebPlugin.fileTypesCallback" ID="ProjectWebPlugin.fileTypesCallback"></a> <h4>ProjectWebPlugin.fileTypesCallback</h4> <b>fileTypesCallback</b>(<i></i>) + <p> Public method to get the filetype associations of the Web project type. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> dictionary with file type associations