Mercurial Repositories > Time Tracker / file comparison
comparison: TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html
TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html
- branch
- eric7
- changeset 116
- e8b0641eba15
- parent 106
- 6deb942739dc
equal
deleted
inserted
replaced
| 115:859d59103f9f | 116:e8b0641eba15 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>Plugin_Time_Tracker.PluginTimeTracker</h1> | 9 <h1>Plugin_Time_Tracker.PluginTimeTracker</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the Time Tracker plugin. | 11 Module implementing the Time Tracker plugin. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>author</td></tr> |
| 17 <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> | 17 <tr><td>autoactivate</td></tr> |
| 18 </table> | 18 <tr><td>className</td></tr> |
| 19 <tr><td>deactivateable</td></tr> | |
| 20 <tr><td>error</td></tr> | |
| 21 <tr><td>longDescription</td></tr> | |
| 22 <tr><td>name</td></tr> | |
| 23 <tr><td>needsRestart</td></tr> | |
| 24 <tr><td>packageName</td></tr> | |
| 25 <tr><td>pyqtApi</td></tr> | |
| 26 <tr><td>shortDescription</td></tr> | |
| 27 <tr><td>timeTrackerPluginObject</td></tr> | |
| 28 <tr><td>version</td></tr> | |
| 29 </table> | |
| 30 | |
| 19 <h3>Classes</h3> | 31 <h3>Classes</h3> |
| 20 | 32 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 33 <tr> |
| 24 <td><a href="#TimeTrackerPlugin">TimeTrackerPlugin</a></td> | 34 <td><a href="#TimeTrackerPlugin">TimeTrackerPlugin</a></td> |
| 25 <td>Class implementing the Eric assistant plugin.</td> | 35 <td>Class implementing the Eric assistant plugin.</td> |
| 26 </tr> | 36 </tr> |
| 27 </table> | 37 </table> |
| 38 | |
| 28 <h3>Functions</h3> | 39 <h3>Functions</h3> |
| 29 | 40 <table> |
| 30 <table> | |
| 31 | |
| 32 <tr> | 41 <tr> |
| 33 <td><a href="#createTimeTrackerPage">createTimeTrackerPage</a></td> | 42 <td><a href="#createTimeTrackerPage">createTimeTrackerPage</a></td> |
| 34 <td>Module function to create the Time Tracker configuration page.</td> | 43 <td>Module function to create the Time Tracker configuration page.</td> |
| 35 </tr> | 44 </tr> |
| 36 <tr> | 45 <tr> |
| 40 <tr> | 49 <tr> |
| 41 <td><a href="#prepareUninstall">prepareUninstall</a></td> | 50 <td><a href="#prepareUninstall">prepareUninstall</a></td> |
| 42 <td>Module function to prepare for an uninstallation.</td> | 51 <td>Module function to prepare for an uninstallation.</td> |
| 43 </tr> | 52 </tr> |
| 44 </table> | 53 </table> |
| 54 | |
| 45 <hr /> | 55 <hr /> |
| 46 <hr /> | 56 <hr /> |
| 47 <a NAME="TimeTrackerPlugin" ID="TimeTrackerPlugin"></a> | 57 <a NAME="TimeTrackerPlugin" ID="TimeTrackerPlugin"></a> |
| 48 <h2>TimeTrackerPlugin</h2> | 58 <h2>TimeTrackerPlugin</h2> |
| 49 | |
| 50 <p> | 59 <p> |
| 51 Class implementing the Eric assistant plugin. | 60 Class implementing the Eric assistant plugin. |
| 52 </p> | 61 </p> |
| 62 | |
| 53 <h3>Derived from</h3> | 63 <h3>Derived from</h3> |
| 54 QObject | 64 QObject |
| 55 <h3>Class Attributes</h3> | 65 <h3>Class Attributes</h3> |
| 56 | |
| 57 <table> | 66 <table> |
| 58 <tr><td>PreferencesKey</td></tr> | 67 <tr><td>PreferencesKey</td></tr> |
| 59 </table> | 68 </table> |
| 69 | |
| 60 <h3>Class Methods</h3> | 70 <h3>Class Methods</h3> |
| 61 | |
| 62 <table> | 71 <table> |
| 63 <tr><td>None</td></tr> | 72 <tr><td>None</td></tr> |
| 64 </table> | 73 </table> |
| 74 | |
| 65 <h3>Methods</h3> | 75 <h3>Methods</h3> |
| 66 | 76 <table> |
| 67 <table> | |
| 68 | |
| 69 <tr> | 77 <tr> |
| 70 <td><a href="#TimeTrackerPlugin.__init__">TimeTrackerPlugin</a></td> | 78 <td><a href="#TimeTrackerPlugin.__init__">TimeTrackerPlugin</a></td> |
| 71 <td>Constructor</td> | 79 <td>Constructor</td> |
| 72 </tr> | 80 </tr> |
| 73 <tr> | 81 <tr> |
| 93 <tr> | 101 <tr> |
| 94 <td><a href="#TimeTrackerPlugin.setPreferences">setPreferences</a></td> | 102 <td><a href="#TimeTrackerPlugin.setPreferences">setPreferences</a></td> |
| 95 <td>Public method to store the various settings.</td> | 103 <td>Public method to store the various settings.</td> |
| 96 </tr> | 104 </tr> |
| 97 </table> | 105 </table> |
| 106 | |
| 98 <h3>Static Methods</h3> | 107 <h3>Static Methods</h3> |
| 99 | |
| 100 <table> | 108 <table> |
| 101 <tr><td>None</td></tr> | 109 <tr><td>None</td></tr> |
| 102 </table> | 110 </table> |
| 111 | |
| 103 | 112 |
| 104 <a NAME="TimeTrackerPlugin.__init__" ID="TimeTrackerPlugin.__init__"></a> | 113 <a NAME="TimeTrackerPlugin.__init__" ID="TimeTrackerPlugin.__init__"></a> |
| 105 <h4>TimeTrackerPlugin (Constructor)</h4> | 114 <h4>TimeTrackerPlugin (Constructor)</h4> |
| 106 <b>TimeTrackerPlugin</b>(<i>ui</i>) | 115 <b>TimeTrackerPlugin</b>(<i>ui</i>) |
| 107 | |
| 108 <p> | 116 <p> |
| 109 Constructor | 117 Constructor |
| 110 </p> | 118 </p> |
| 119 | |
| 111 <dl> | 120 <dl> |
| 112 | 121 |
| 113 <dt><i>ui</i> (UserInterface)</dt> | 122 <dt><i>ui</i> (UserInterface)</dt> |
| 114 <dd> | 123 <dd> |
| 115 reference to the user interface object | 124 reference to the user interface object |
| 116 </dd> | 125 </dd> |
| 117 </dl> | 126 </dl> |
| 118 <a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a> | 127 <a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a> |
| 119 <h4>TimeTrackerPlugin.__initialize</h4> | 128 <h4>TimeTrackerPlugin.__initialize</h4> |
| 120 <b>__initialize</b>(<i></i>) | 129 <b>__initialize</b>(<i></i>) |
| 121 | |
| 122 <p> | 130 <p> |
| 123 Private slot to (re)initialize the plugin. | 131 Private slot to (re)initialize the plugin. |
| 124 </p> | 132 </p> |
| 133 | |
| 125 <a NAME="TimeTrackerPlugin.__loadTranslator" ID="TimeTrackerPlugin.__loadTranslator"></a> | 134 <a NAME="TimeTrackerPlugin.__loadTranslator" ID="TimeTrackerPlugin.__loadTranslator"></a> |
| 126 <h4>TimeTrackerPlugin.__loadTranslator</h4> | 135 <h4>TimeTrackerPlugin.__loadTranslator</h4> |
| 127 <b>__loadTranslator</b>(<i></i>) | 136 <b>__loadTranslator</b>(<i></i>) |
| 128 | |
| 129 <p> | 137 <p> |
| 130 Private method to load the translation file. | 138 Private method to load the translation file. |
| 131 </p> | 139 </p> |
| 140 | |
| 132 <a NAME="TimeTrackerPlugin.activate" ID="TimeTrackerPlugin.activate"></a> | 141 <a NAME="TimeTrackerPlugin.activate" ID="TimeTrackerPlugin.activate"></a> |
| 133 <h4>TimeTrackerPlugin.activate</h4> | 142 <h4>TimeTrackerPlugin.activate</h4> |
| 134 <b>activate</b>(<i></i>) | 143 <b>activate</b>(<i></i>) |
| 135 | |
| 136 <p> | 144 <p> |
| 137 Public method to activate this plugin. | 145 Public method to activate this plugin. |
| 138 </p> | 146 </p> |
| 147 | |
| 139 <dl> | 148 <dl> |
| 140 <dt>Return:</dt> | 149 <dt>Return:</dt> |
| 141 <dd> | 150 <dd> |
| 142 tuple of None and activation status | 151 tuple of None and activation status |
| 143 </dd> | 152 </dd> |
| 149 </dd> | 158 </dd> |
| 150 </dl> | 159 </dl> |
| 151 <a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a> | 160 <a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a> |
| 152 <h4>TimeTrackerPlugin.deactivate</h4> | 161 <h4>TimeTrackerPlugin.deactivate</h4> |
| 153 <b>deactivate</b>(<i></i>) | 162 <b>deactivate</b>(<i></i>) |
| 154 | |
| 155 <p> | 163 <p> |
| 156 Public method to deactivate this plugin. | 164 Public method to deactivate this plugin. |
| 157 </p> | 165 </p> |
| 166 | |
| 158 <a NAME="TimeTrackerPlugin.getPreferences" ID="TimeTrackerPlugin.getPreferences"></a> | 167 <a NAME="TimeTrackerPlugin.getPreferences" ID="TimeTrackerPlugin.getPreferences"></a> |
| 159 <h4>TimeTrackerPlugin.getPreferences</h4> | 168 <h4>TimeTrackerPlugin.getPreferences</h4> |
| 160 <b>getPreferences</b>(<i>key</i>) | 169 <b>getPreferences</b>(<i>key</i>) |
| 161 | |
| 162 <p> | 170 <p> |
| 163 Public method to retrieve the various settings. | 171 Public method to retrieve the various settings. |
| 164 </p> | 172 </p> |
| 173 | |
| 165 <dl> | 174 <dl> |
| 166 | 175 |
| 167 <dt><i>key</i> (str)</dt> | 176 <dt><i>key</i> (str)</dt> |
| 168 <dd> | 177 <dd> |
| 169 key of the value to get | 178 key of the value to get |
| 182 </dd> | 191 </dd> |
| 183 </dl> | 192 </dl> |
| 184 <a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a> | 193 <a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a> |
| 185 <h4>TimeTrackerPlugin.setPreferences</h4> | 194 <h4>TimeTrackerPlugin.setPreferences</h4> |
| 186 <b>setPreferences</b>(<i>key, value</i>) | 195 <b>setPreferences</b>(<i>key, value</i>) |
| 187 | |
| 188 <p> | 196 <p> |
| 189 Public method to store the various settings. | 197 Public method to store the various settings. |
| 190 </p> | 198 </p> |
| 199 | |
| 191 <dl> | 200 <dl> |
| 192 | 201 |
| 193 <dt><i>key</i> (str)</dt> | 202 <dt><i>key</i> (str)</dt> |
| 194 <dd> | 203 <dd> |
| 195 key of the setting to be set | 204 key of the setting to be set |
| 203 <hr /> | 212 <hr /> |
| 204 <hr /> | 213 <hr /> |
| 205 <a NAME="createTimeTrackerPage" ID="createTimeTrackerPage"></a> | 214 <a NAME="createTimeTrackerPage" ID="createTimeTrackerPage"></a> |
| 206 <h2>createTimeTrackerPage</h2> | 215 <h2>createTimeTrackerPage</h2> |
| 207 <b>createTimeTrackerPage</b>(<i>configDlg</i>) | 216 <b>createTimeTrackerPage</b>(<i>configDlg</i>) |
| 208 | |
| 209 <p> | 217 <p> |
| 210 Module function to create the Time Tracker configuration page. | 218 Module function to create the Time Tracker configuration page. |
| 211 </p> | 219 </p> |
| 220 | |
| 212 <dl> | 221 <dl> |
| 213 | 222 |
| 214 <dt><i>configDlg</i> (ConfigurationWidget)</dt> | 223 <dt><i>configDlg</i> (ConfigurationWidget)</dt> |
| 215 <dd> | 224 <dd> |
| 216 reference to the configuration dialog | 225 reference to the configuration dialog |
| 232 <hr /> | 241 <hr /> |
| 233 <hr /> | 242 <hr /> |
| 234 <a NAME="getConfigData" ID="getConfigData"></a> | 243 <a NAME="getConfigData" ID="getConfigData"></a> |
| 235 <h2>getConfigData</h2> | 244 <h2>getConfigData</h2> |
| 236 <b>getConfigData</b>(<i></i>) | 245 <b>getConfigData</b>(<i></i>) |
| 237 | |
| 238 <p> | 246 <p> |
| 239 Module function returning data as required by the configuration dialog. | 247 Module function returning data as required by the configuration dialog. |
| 240 </p> | 248 </p> |
| 249 | |
| 241 <dl> | 250 <dl> |
| 242 <dt>Return:</dt> | 251 <dt>Return:</dt> |
| 243 <dd> | 252 <dd> |
| 244 dictionary containing the relevant data | 253 dictionary containing the relevant data |
| 245 </dd> | 254 </dd> |
| 254 <hr /> | 263 <hr /> |
| 255 <hr /> | 264 <hr /> |
| 256 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 265 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 257 <h2>prepareUninstall</h2> | 266 <h2>prepareUninstall</h2> |
| 258 <b>prepareUninstall</b>(<i></i>) | 267 <b>prepareUninstall</b>(<i></i>) |
| 259 | |
| 260 <p> | 268 <p> |
| 261 Module function to prepare for an uninstallation. | 269 Module function to prepare for an uninstallation. |
| 262 </p> | 270 </p> |
| 271 | |
| 263 <div align="right"><a href="#top">Up</a></div> | 272 <div align="right"><a href="#top">Up</a></div> |
| 264 <hr /> | 273 <hr /> |
| 265 </body></html> | 274 </body></html> |
