diff -r 859d59103f9f -r e8b0641eba15 TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html --- a/TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html Sat Dec 23 19:35:14 2023 +0100 +++ b/TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html Sat Jan 06 13:06:58 2024 +0100 @@ -7,28 +7,37 @@ <body> <a NAME="top" ID="top"></a> <h1>Plugin_Time_Tracker.PluginTimeTracker</h1> - <p> Module implementing the Time Tracker 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>shortDescription</td></tr><tr><td>timeTrackerPluginObject</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>timeTrackerPluginObject</td></tr> +<tr><td>version</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#TimeTrackerPlugin">TimeTrackerPlugin</a></td> <td>Class implementing the Eric assistant plugin.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#createTimeTrackerPage">createTimeTrackerPage</a></td> <td>Module function to create the Time Tracker configuration page.</td> @@ -42,30 +51,29 @@ <td>Module function to prepare for an uninstallation.</td> </tr> </table> + <hr /> <hr /> <a NAME="TimeTrackerPlugin" ID="TimeTrackerPlugin"></a> <h2>TimeTrackerPlugin</h2> - <p> Class implementing the Eric assistant plugin. </p> + <h3>Derived from</h3> QObject <h3>Class Attributes</h3> - <table> <tr><td>PreferencesKey</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#TimeTrackerPlugin.__init__">TimeTrackerPlugin</a></td> <td>Constructor</td> @@ -95,19 +103,20 @@ <td>Public method to store the various settings.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="TimeTrackerPlugin.__init__" ID="TimeTrackerPlugin.__init__"></a> <h4>TimeTrackerPlugin (Constructor)</h4> <b>TimeTrackerPlugin</b>(<i>ui</i>) - <p> Constructor </p> + <dl> <dt><i>ui</i> (UserInterface)</dt> @@ -118,24 +127,24 @@ <a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a> <h4>TimeTrackerPlugin.__initialize</h4> <b>__initialize</b>(<i></i>) - <p> Private slot to (re)initialize the plugin. </p> + <a NAME="TimeTrackerPlugin.__loadTranslator" ID="TimeTrackerPlugin.__loadTranslator"></a> <h4>TimeTrackerPlugin.__loadTranslator</h4> <b>__loadTranslator</b>(<i></i>) - <p> Private method to load the translation file. </p> + <a NAME="TimeTrackerPlugin.activate" ID="TimeTrackerPlugin.activate"></a> <h4>TimeTrackerPlugin.activate</h4> <b>activate</b>(<i></i>) - <p> Public method to activate this plugin. </p> + <dl> <dt>Return:</dt> <dd> @@ -151,17 +160,17 @@ <a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a> <h4>TimeTrackerPlugin.deactivate</h4> <b>deactivate</b>(<i></i>) - <p> Public method to deactivate this plugin. </p> + <a NAME="TimeTrackerPlugin.getPreferences" ID="TimeTrackerPlugin.getPreferences"></a> <h4>TimeTrackerPlugin.getPreferences</h4> <b>getPreferences</b>(<i>key</i>) - <p> Public method to retrieve the various settings. </p> + <dl> <dt><i>key</i> (str)</dt> @@ -184,10 +193,10 @@ <a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a> <h4>TimeTrackerPlugin.setPreferences</h4> <b>setPreferences</b>(<i>key, value</i>) - <p> Public method to store the various settings. </p> + <dl> <dt><i>key</i> (str)</dt> @@ -205,10 +214,10 @@ <a NAME="createTimeTrackerPage" ID="createTimeTrackerPage"></a> <h2>createTimeTrackerPage</h2> <b>createTimeTrackerPage</b>(<i>configDlg</i>) - <p> Module function to create the Time Tracker configuration page. </p> + <dl> <dt><i>configDlg</i> (ConfigurationWidget)</dt> @@ -234,10 +243,10 @@ <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> <dt>Return:</dt> <dd> @@ -256,10 +265,10 @@ <a NAME="prepareUninstall" ID="prepareUninstall"></a> <h2>prepareUninstall</h2> <b>prepareUninstall</b>(<i></i>) - <p> Module function to prepare for an uninstallation. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>