diff -r 525dc29b6a22 -r 20bea809ae09 WizardDataUriEncoder/Documentation/source/Plugin_Wizard_DataUriEncoder.PluginWizardDataUriEncoder.html --- a/WizardDataUriEncoder/Documentation/source/Plugin_Wizard_DataUriEncoder.PluginWizardDataUriEncoder.html Wed Jan 01 11:59:05 2020 +0100 +++ b/WizardDataUriEncoder/Documentation/source/Plugin_Wizard_DataUriEncoder.PluginWizardDataUriEncoder.html Tue Jun 23 19:56:12 2020 +0200 @@ -18,122 +18,161 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Wizard_DataUriEncoder.PluginWizardDataUriEncoder</h1> + <p> Module implementing the base64 data URI encoder wizard plug-in. </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="#WizardDataUriEncoderPlugin">WizardDataUriEncoderPlugin</a></td> <td>Class implementing the base64 data URI encoder wizard plug-in.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="WizardDataUriEncoderPlugin" ID="WizardDataUriEncoderPlugin"></a> <h2>WizardDataUriEncoderPlugin</h2> + <p> Class implementing the base64 data URI encoder wizard plug-in. </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="#WizardDataUriEncoderPlugin.__init__">WizardDataUriEncoderPlugin</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#WizardDataUriEncoderPlugin.__handle">__handle</a></td> <td>Private method to handle the wizards action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WizardDataUriEncoderPlugin.__initAction">__initAction</a></td> <td>Private method to initialize the action.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WizardDataUriEncoderPlugin.__initMenu">__initMenu</a></td> <td>Private method to add the actions to the right menu.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WizardDataUriEncoderPlugin.__initialize">__initialize</a></td> <td>Private slot to (re)initialize the plug-in.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WizardDataUriEncoderPlugin.__loadTranslator">__loadTranslator</a></td> <td>Private method to load the translation file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WizardDataUriEncoderPlugin.activate">activate</a></td> <td>Public method to activate this plug-in.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WizardDataUriEncoderPlugin.deactivate">deactivate</a></td> <td>Public method to deactivate this plug-in.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="WizardDataUriEncoderPlugin.__init__" ID="WizardDataUriEncoderPlugin.__init__"></a> <h4>WizardDataUriEncoderPlugin (Constructor)</h4> <b>WizardDataUriEncoderPlugin</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="WizardDataUriEncoderPlugin.__handle" ID="WizardDataUriEncoderPlugin.__handle"></a> +</dl> +<a NAME="WizardDataUriEncoderPlugin.__handle" ID="WizardDataUriEncoderPlugin.__handle"></a> <h4>WizardDataUriEncoderPlugin.__handle</h4> <b>__handle</b>(<i></i>) + <p> Private method to handle the wizards action. -</p><a NAME="WizardDataUriEncoderPlugin.__initAction" ID="WizardDataUriEncoderPlugin.__initAction"></a> +</p> +<a NAME="WizardDataUriEncoderPlugin.__initAction" ID="WizardDataUriEncoderPlugin.__initAction"></a> <h4>WizardDataUriEncoderPlugin.__initAction</h4> <b>__initAction</b>(<i></i>) + <p> Private method to initialize the action. -</p><a NAME="WizardDataUriEncoderPlugin.__initMenu" ID="WizardDataUriEncoderPlugin.__initMenu"></a> +</p> +<a NAME="WizardDataUriEncoderPlugin.__initMenu" ID="WizardDataUriEncoderPlugin.__initMenu"></a> <h4>WizardDataUriEncoderPlugin.__initMenu</h4> <b>__initMenu</b>(<i></i>) + <p> Private method to add the actions to the right menu. -</p><a NAME="WizardDataUriEncoderPlugin.__initialize" ID="WizardDataUriEncoderPlugin.__initialize"></a> +</p> +<a NAME="WizardDataUriEncoderPlugin.__initialize" ID="WizardDataUriEncoderPlugin.__initialize"></a> <h4>WizardDataUriEncoderPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) + <p> Private slot to (re)initialize the plug-in. -</p><a NAME="WizardDataUriEncoderPlugin.__loadTranslator" ID="WizardDataUriEncoderPlugin.__loadTranslator"></a> +</p> +<a NAME="WizardDataUriEncoderPlugin.__loadTranslator" ID="WizardDataUriEncoderPlugin.__loadTranslator"></a> <h4>WizardDataUriEncoderPlugin.__loadTranslator</h4> <b>__loadTranslator</b>(<i></i>) + <p> Private method to load the translation file. -</p><a NAME="WizardDataUriEncoderPlugin.activate" ID="WizardDataUriEncoderPlugin.activate"></a> +</p> +<a NAME="WizardDataUriEncoderPlugin.activate" ID="WizardDataUriEncoderPlugin.activate"></a> <h4>WizardDataUriEncoderPlugin.activate</h4> <b>activate</b>(<i></i>) + <p> Public method to activate this plug-in. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple of None and activation status (boolean) </dd> -</dl><a NAME="WizardDataUriEncoderPlugin.deactivate" ID="WizardDataUriEncoderPlugin.deactivate"></a> +</dl> +<a NAME="WizardDataUriEncoderPlugin.deactivate" ID="WizardDataUriEncoderPlugin.deactivate"></a> <h4>WizardDataUriEncoderPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) + <p> Public method to deactivate this plug-in. </p>