Mercurial Repositories > Time Tracker / file comparison
comparison: TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html
TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html
- changeset 18
- 73bd1fdd7102
- child 26
- 08e308c7a85d
equal
deleted
inserted
replaced
| 17:2dc5c5af1cf3 | 18:73bd1fdd7102 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>Plugin_Time_Tracker.PluginTimeTracker</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>Plugin_Time_Tracker.PluginTimeTracker</h1> | |
| 24 <p> | |
| 25 Module implementing the Time Tracker plugin. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <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> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#TimeTrackerPlugin">TimeTrackerPlugin</a></td> | |
| 35 <td>Class implementing the Eric assistant plugin.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr> | |
| 41 <td><a href="#createTimeTrackerPage">createTimeTrackerPage</a></td> | |
| 42 <td>Module function to create the Time Tracker configuration page.</td> | |
| 43 </tr><tr> | |
| 44 <td><a href="#getConfigData">getConfigData</a></td> | |
| 45 <td>Module function returning data as required by the configuration dialog.</td> | |
| 46 </tr><tr> | |
| 47 <td><a href="#prepareUninstall">prepareUninstall</a></td> | |
| 48 <td>Module function to prepare for an uninstallation.</td> | |
| 49 </tr> | |
| 50 </table> | |
| 51 <hr /><hr /> | |
| 52 <a NAME="TimeTrackerPlugin" ID="TimeTrackerPlugin"></a> | |
| 53 <h2>TimeTrackerPlugin</h2> | |
| 54 <p> | |
| 55 Class implementing the Eric assistant plugin. | |
| 56 </p> | |
| 57 <h3>Derived from</h3> | |
| 58 QObject | |
| 59 <h3>Class Attributes</h3> | |
| 60 <table> | |
| 61 <tr><td>None</td></tr> | |
| 62 </table> | |
| 63 <h3>Class Methods</h3> | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 <table> | |
| 69 <tr> | |
| 70 <td><a href="#TimeTrackerPlugin.__init__">TimeTrackerPlugin</a></td> | |
| 71 <td>Constructor</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#TimeTrackerPlugin.__checkVersions">__checkVersions</a></td> | |
| 74 <td>Private function to check that the eric5 version is ok.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#TimeTrackerPlugin.__initialize">__initialize</a></td> | |
| 77 <td>Private slot to (re)initialize the plugin.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#TimeTrackerPlugin.__loadTranslator">__loadTranslator</a></td> | |
| 80 <td>Private method to load the translation file.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#TimeTrackerPlugin.activate">activate</a></td> | |
| 83 <td>Public method to activate this plugin.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#TimeTrackerPlugin.deactivate">deactivate</a></td> | |
| 86 <td>Public method to deactivate this plugin.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#TimeTrackerPlugin.getPreferences">getPreferences</a></td> | |
| 89 <td>Public method to retrieve the various settings.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#TimeTrackerPlugin.prepareUninstall">prepareUninstall</a></td> | |
| 92 <td>Public method to prepare for an uninstallation.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#TimeTrackerPlugin.setPreferences">setPreferences</a></td> | |
| 95 <td>Public method to store the various settings.</td> | |
| 96 </tr> | |
| 97 </table> | |
| 98 <h3>Static Methods</h3> | |
| 99 <table> | |
| 100 <tr><td>None</td></tr> | |
| 101 </table> | |
| 102 <a NAME="TimeTrackerPlugin.__init__" ID="TimeTrackerPlugin.__init__"></a> | |
| 103 <h4>TimeTrackerPlugin (Constructor)</h4> | |
| 104 <b>TimeTrackerPlugin</b>(<i>ui</i>) | |
| 105 <p> | |
| 106 Constructor | |
| 107 </p><dl> | |
| 108 <dt><i>ui</i></dt> | |
| 109 <dd> | |
| 110 reference to the user interface object (UI.UserInterface) | |
| 111 </dd> | |
| 112 </dl><a NAME="TimeTrackerPlugin.__checkVersions" ID="TimeTrackerPlugin.__checkVersions"></a> | |
| 113 <h4>TimeTrackerPlugin.__checkVersions</h4> | |
| 114 <b>__checkVersions</b>(<i></i>) | |
| 115 <p> | |
| 116 Private function to check that the eric5 version is ok. | |
| 117 </p><dl> | |
| 118 <dt>Returns:</dt> | |
| 119 <dd> | |
| 120 flag indicating version is ok (boolean) | |
| 121 </dd> | |
| 122 </dl><a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a> | |
| 123 <h4>TimeTrackerPlugin.__initialize</h4> | |
| 124 <b>__initialize</b>(<i></i>) | |
| 125 <p> | |
| 126 Private slot to (re)initialize the plugin. | |
| 127 </p><a NAME="TimeTrackerPlugin.__loadTranslator" ID="TimeTrackerPlugin.__loadTranslator"></a> | |
| 128 <h4>TimeTrackerPlugin.__loadTranslator</h4> | |
| 129 <b>__loadTranslator</b>(<i></i>) | |
| 130 <p> | |
| 131 Private method to load the translation file. | |
| 132 </p><a NAME="TimeTrackerPlugin.activate" ID="TimeTrackerPlugin.activate"></a> | |
| 133 <h4>TimeTrackerPlugin.activate</h4> | |
| 134 <b>activate</b>(<i></i>) | |
| 135 <p> | |
| 136 Public method to activate this plugin. | |
| 137 </p><dl> | |
| 138 <dt>Returns:</dt> | |
| 139 <dd> | |
| 140 tuple of None and activation status (boolean) | |
| 141 </dd> | |
| 142 </dl><a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a> | |
| 143 <h4>TimeTrackerPlugin.deactivate</h4> | |
| 144 <b>deactivate</b>(<i></i>) | |
| 145 <p> | |
| 146 Public method to deactivate this plugin. | |
| 147 </p><a NAME="TimeTrackerPlugin.getPreferences" ID="TimeTrackerPlugin.getPreferences"></a> | |
| 148 <h4>TimeTrackerPlugin.getPreferences</h4> | |
| 149 <b>getPreferences</b>(<i>key</i>) | |
| 150 <p> | |
| 151 Public method to retrieve the various settings. | |
| 152 </p><dl> | |
| 153 <dt><i>key</i></dt> | |
| 154 <dd> | |
| 155 the key of the value to get | |
| 156 </dd> | |
| 157 </dl><dl> | |
| 158 <dt>Returns:</dt> | |
| 159 <dd> | |
| 160 the requested setting | |
| 161 </dd> | |
| 162 </dl><a NAME="TimeTrackerPlugin.prepareUninstall" ID="TimeTrackerPlugin.prepareUninstall"></a> | |
| 163 <h4>TimeTrackerPlugin.prepareUninstall</h4> | |
| 164 <b>prepareUninstall</b>(<i></i>) | |
| 165 <p> | |
| 166 Public method to prepare for an uninstallation. | |
| 167 </p><a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a> | |
| 168 <h4>TimeTrackerPlugin.setPreferences</h4> | |
| 169 <b>setPreferences</b>(<i>key, value</i>) | |
| 170 <p> | |
| 171 Public method to store the various settings. | |
| 172 </p><dl> | |
| 173 <dt><i>key</i></dt> | |
| 174 <dd> | |
| 175 the key of the setting to be set (string) | |
| 176 </dd><dt><i>value</i></dt> | |
| 177 <dd> | |
| 178 the value to be set | |
| 179 </dd><dt><i>prefClass</i></dt> | |
| 180 <dd> | |
| 181 preferences class used as the storage area | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <div align="right"><a href="#top">Up</a></div> | |
| 185 <hr /><hr /> | |
| 186 <a NAME="createTimeTrackerPage" ID="createTimeTrackerPage"></a> | |
| 187 <h2>createTimeTrackerPage</h2> | |
| 188 <b>createTimeTrackerPage</b>(<i>configDlg</i>) | |
| 189 <p> | |
| 190 Module function to create the Time Tracker configuration page. | |
| 191 </p><dl> | |
| 192 <dt>Returns:</dt> | |
| 193 <dd> | |
| 194 reference to the configuration page | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <div align="right"><a href="#top">Up</a></div> | |
| 198 <hr /><hr /> | |
| 199 <a NAME="getConfigData" ID="getConfigData"></a> | |
| 200 <h2>getConfigData</h2> | |
| 201 <b>getConfigData</b>(<i></i>) | |
| 202 <p> | |
| 203 Module function returning data as required by the configuration dialog. | |
| 204 </p><dl> | |
| 205 <dt>Returns:</dt> | |
| 206 <dd> | |
| 207 dictionary containing the relevant data | |
| 208 </dd> | |
| 209 </dl> | |
| 210 <div align="right"><a href="#top">Up</a></div> | |
| 211 <hr /><hr /> | |
| 212 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | |
| 213 <h2>prepareUninstall</h2> | |
| 214 <b>prepareUninstall</b>(<i></i>) | |
| 215 <p> | |
| 216 Module function to prepare for an uninstallation. | |
| 217 </p> | |
| 218 <div align="right"><a href="#top">Up</a></div> | |
| 219 <hr /> | |
| 220 </body></html> |
