diff -r 01822a402c97 -r 6a12561fc0b5 ProjectWeb/Documentation/source/Plugin_Project_Web.PluginProjectWeb.html --- a/ProjectWeb/Documentation/source/Plugin_Project_Web.PluginProjectWeb.html Tue May 25 19:44:14 2021 +0200 +++ b/ProjectWeb/Documentation/source/Plugin_Project_Web.PluginProjectWeb.html Tue May 25 20:12:47 2021 +0200 @@ -42,7 +42,11 @@ <h3>Functions</h3> <table> -<tr><td>None</td></tr> + +<tr> +<td><a href="#installDependencies">installDependencies</a></td> +<td>Function to install dependencies of this plug-in.</td> +</tr> </table> <hr /> <hr /> @@ -144,9 +148,9 @@ </p> <dl> -<dt><i>ui</i></dt> +<dt><i>ui</i> (UserInterface)</dt> <dd> -reference to the user interface object (UI.UserInterface) +reference to the user interface object </dd> </dl> <a NAME="ProjectWebPlugin.__editorClosed" ID="ProjectWebPlugin.__editorClosed"></a> @@ -158,9 +162,9 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> -reference to the editor (QScintilla.Editor) +reference to the editor </dd> </dl> <a NAME="ProjectWebPlugin.__editorOpened" ID="ProjectWebPlugin.__editorOpened"></a> @@ -172,9 +176,9 @@ </p> <dl> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> -reference to the new editor (QScintilla.Editor) +reference to the new editor </dd> </dl> <a NAME="ProjectWebPlugin.__editorShowMenu" ID="ProjectWebPlugin.__editorShowMenu"></a> @@ -187,15 +191,15 @@ </p> <dl> -<dt><i>menuName</i></dt> +<dt><i>menuName</i> (str)</dt> <dd> -name of the menu to be shown (string) +name of the menu to be shown </dd> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu (QMenu) +reference to the menu </dd> -<dt><i>editor</i></dt> +<dt><i>editor</i> (Editor)</dt> <dd> reference to the editor </dd> @@ -258,13 +262,13 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the menu (string) +name of the menu </dd> -<dt><i>menu</i></dt> +<dt><i>menu</i> (QMenu)</dt> <dd> -reference to the menu to be populated (QMenu) +reference to the menu to be populated </dd> </dl> <a NAME="ProjectWebPlugin.activate" ID="ProjectWebPlugin.activate"></a> @@ -277,7 +281,13 @@ <dl> <dt>Return:</dt> <dd> -tuple of None and activation status (boolean) +tuple of None and activation status +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (None, bool) </dd> </dl> <a NAME="ProjectWebPlugin.deactivate" ID="ProjectWebPlugin.deactivate"></a> @@ -300,6 +310,29 @@ dictionary with file type associations </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="installDependencies" ID="installDependencies"></a> +<h2>installDependencies</h2> +<b>installDependencies</b>(<i>pipInstall</i>) + +<p> + Function to install dependencies of this plug-in. +</p> +<dl> + +<dt><i>pipInstall</i> (function)</dt> +<dd> +function to be called with a list of package names. +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html> \ No newline at end of file