Mercurial Repositories > Time Tracker / file comparison
comparison: TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html
TimeTracker/Documentation/source/Plugin_Time_Tracker.PluginTimeTracker.html
- changeset 87
- 4ac2329b36da
- parent 71
- 29c55e28d9b5
- child 95
- 7449695cf655
equal
deleted
inserted
replaced
| 86:94ee489db94c | 87:4ac2329b36da |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>Plugin_Time_Tracker.PluginTimeTracker</h1> | 23 <h1>Plugin_Time_Tracker.PluginTimeTracker</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the Time Tracker plugin. | 26 Module implementing the Time Tracker plugin. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 27 <table> | 29 |
| 28 <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>timeTrackerPluginObject</td></tr><tr><td>version</td></tr> | 30 <table> |
| 31 <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> | |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 31 <table> | 34 |
| 35 <table> | |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#TimeTrackerPlugin">TimeTrackerPlugin</a></td> | 38 <td><a href="#TimeTrackerPlugin">TimeTrackerPlugin</a></td> |
| 34 <td>Class implementing the Eric assistant plugin.</td> | 39 <td>Class implementing the Eric assistant plugin.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 38 <table> | 43 |
| 44 <table> | |
| 45 | |
| 39 <tr> | 46 <tr> |
| 40 <td><a href="#createTimeTrackerPage">createTimeTrackerPage</a></td> | 47 <td><a href="#createTimeTrackerPage">createTimeTrackerPage</a></td> |
| 41 <td>Module function to create the Time Tracker configuration page.</td> | 48 <td>Module function to create the Time Tracker configuration page.</td> |
| 42 </tr><tr> | 49 </tr> |
| 50 <tr> | |
| 43 <td><a href="#getConfigData">getConfigData</a></td> | 51 <td><a href="#getConfigData">getConfigData</a></td> |
| 44 <td>Module function returning data as required by the configuration dialog.</td> | 52 <td>Module function returning data as required by the configuration dialog.</td> |
| 45 </tr><tr> | 53 </tr> |
| 54 <tr> | |
| 46 <td><a href="#prepareUninstall">prepareUninstall</a></td> | 55 <td><a href="#prepareUninstall">prepareUninstall</a></td> |
| 47 <td>Module function to prepare for an uninstallation.</td> | 56 <td>Module function to prepare for an uninstallation.</td> |
| 48 </tr> | 57 </tr> |
| 49 </table> | 58 </table> |
| 50 <hr /><hr /> | 59 <hr /> |
| 60 <hr /> | |
| 51 <a NAME="TimeTrackerPlugin" ID="TimeTrackerPlugin"></a> | 61 <a NAME="TimeTrackerPlugin" ID="TimeTrackerPlugin"></a> |
| 52 <h2>TimeTrackerPlugin</h2> | 62 <h2>TimeTrackerPlugin</h2> |
| 63 | |
| 53 <p> | 64 <p> |
| 54 Class implementing the Eric assistant plugin. | 65 Class implementing the Eric assistant plugin. |
| 55 </p> | 66 </p> |
| 56 <h3>Derived from</h3> | 67 <h3>Derived from</h3> |
| 57 QObject | 68 QObject |
| 58 <h3>Class Attributes</h3> | 69 <h3>Class Attributes</h3> |
| 70 | |
| 59 <table> | 71 <table> |
| 60 <tr><td>PreferencesKey</td></tr> | 72 <tr><td>PreferencesKey</td></tr> |
| 61 </table> | 73 </table> |
| 62 <h3>Class Methods</h3> | 74 <h3>Class Methods</h3> |
| 75 | |
| 63 <table> | 76 <table> |
| 64 <tr><td>None</td></tr> | 77 <tr><td>None</td></tr> |
| 65 </table> | 78 </table> |
| 66 <h3>Methods</h3> | 79 <h3>Methods</h3> |
| 67 <table> | 80 |
| 81 <table> | |
| 82 | |
| 68 <tr> | 83 <tr> |
| 69 <td><a href="#TimeTrackerPlugin.__init__">TimeTrackerPlugin</a></td> | 84 <td><a href="#TimeTrackerPlugin.__init__">TimeTrackerPlugin</a></td> |
| 70 <td>Constructor</td> | 85 <td>Constructor</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#TimeTrackerPlugin.__initialize">__initialize</a></td> | 88 <td><a href="#TimeTrackerPlugin.__initialize">__initialize</a></td> |
| 73 <td>Private slot to (re)initialize the plugin.</td> | 89 <td>Private slot to (re)initialize the plugin.</td> |
| 74 </tr><tr> | 90 </tr> |
| 91 <tr> | |
| 75 <td><a href="#TimeTrackerPlugin.__loadTranslator">__loadTranslator</a></td> | 92 <td><a href="#TimeTrackerPlugin.__loadTranslator">__loadTranslator</a></td> |
| 76 <td>Private method to load the translation file.</td> | 93 <td>Private method to load the translation file.</td> |
| 77 </tr><tr> | 94 </tr> |
| 95 <tr> | |
| 78 <td><a href="#TimeTrackerPlugin.activate">activate</a></td> | 96 <td><a href="#TimeTrackerPlugin.activate">activate</a></td> |
| 79 <td>Public method to activate this plugin.</td> | 97 <td>Public method to activate this plugin.</td> |
| 80 </tr><tr> | 98 </tr> |
| 99 <tr> | |
| 81 <td><a href="#TimeTrackerPlugin.deactivate">deactivate</a></td> | 100 <td><a href="#TimeTrackerPlugin.deactivate">deactivate</a></td> |
| 82 <td>Public method to deactivate this plugin.</td> | 101 <td>Public method to deactivate this plugin.</td> |
| 83 </tr><tr> | 102 </tr> |
| 103 <tr> | |
| 84 <td><a href="#TimeTrackerPlugin.getPreferences">getPreferences</a></td> | 104 <td><a href="#TimeTrackerPlugin.getPreferences">getPreferences</a></td> |
| 85 <td>Public method to retrieve the various settings.</td> | 105 <td>Public method to retrieve the various settings.</td> |
| 86 </tr><tr> | 106 </tr> |
| 107 <tr> | |
| 87 <td><a href="#TimeTrackerPlugin.setPreferences">setPreferences</a></td> | 108 <td><a href="#TimeTrackerPlugin.setPreferences">setPreferences</a></td> |
| 88 <td>Public method to store the various settings.</td> | 109 <td>Public method to store the various settings.</td> |
| 89 </tr> | 110 </tr> |
| 90 </table> | 111 </table> |
| 91 <h3>Static Methods</h3> | 112 <h3>Static Methods</h3> |
| 113 | |
| 92 <table> | 114 <table> |
| 93 <tr><td>None</td></tr> | 115 <tr><td>None</td></tr> |
| 94 </table> | 116 </table> |
| 117 | |
| 95 <a NAME="TimeTrackerPlugin.__init__" ID="TimeTrackerPlugin.__init__"></a> | 118 <a NAME="TimeTrackerPlugin.__init__" ID="TimeTrackerPlugin.__init__"></a> |
| 96 <h4>TimeTrackerPlugin (Constructor)</h4> | 119 <h4>TimeTrackerPlugin (Constructor)</h4> |
| 97 <b>TimeTrackerPlugin</b>(<i>ui</i>) | 120 <b>TimeTrackerPlugin</b>(<i>ui</i>) |
| 121 | |
| 98 <p> | 122 <p> |
| 99 Constructor | 123 Constructor |
| 100 </p><dl> | 124 </p> |
| 125 <dl> | |
| 126 | |
| 101 <dt><i>ui</i></dt> | 127 <dt><i>ui</i></dt> |
| 102 <dd> | 128 <dd> |
| 103 reference to the user interface object (UI.UserInterface) | 129 reference to the user interface object (UI.UserInterface) |
| 104 </dd> | 130 </dd> |
| 105 </dl><a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a> | 131 </dl> |
| 132 <a NAME="TimeTrackerPlugin.__initialize" ID="TimeTrackerPlugin.__initialize"></a> | |
| 106 <h4>TimeTrackerPlugin.__initialize</h4> | 133 <h4>TimeTrackerPlugin.__initialize</h4> |
| 107 <b>__initialize</b>(<i></i>) | 134 <b>__initialize</b>(<i></i>) |
| 135 | |
| 108 <p> | 136 <p> |
| 109 Private slot to (re)initialize the plugin. | 137 Private slot to (re)initialize the plugin. |
| 110 </p><a NAME="TimeTrackerPlugin.__loadTranslator" ID="TimeTrackerPlugin.__loadTranslator"></a> | 138 </p> |
| 139 <a NAME="TimeTrackerPlugin.__loadTranslator" ID="TimeTrackerPlugin.__loadTranslator"></a> | |
| 111 <h4>TimeTrackerPlugin.__loadTranslator</h4> | 140 <h4>TimeTrackerPlugin.__loadTranslator</h4> |
| 112 <b>__loadTranslator</b>(<i></i>) | 141 <b>__loadTranslator</b>(<i></i>) |
| 142 | |
| 113 <p> | 143 <p> |
| 114 Private method to load the translation file. | 144 Private method to load the translation file. |
| 115 </p><a NAME="TimeTrackerPlugin.activate" ID="TimeTrackerPlugin.activate"></a> | 145 </p> |
| 146 <a NAME="TimeTrackerPlugin.activate" ID="TimeTrackerPlugin.activate"></a> | |
| 116 <h4>TimeTrackerPlugin.activate</h4> | 147 <h4>TimeTrackerPlugin.activate</h4> |
| 117 <b>activate</b>(<i></i>) | 148 <b>activate</b>(<i></i>) |
| 149 | |
| 118 <p> | 150 <p> |
| 119 Public method to activate this plugin. | 151 Public method to activate this plugin. |
| 120 </p><dl> | 152 </p> |
| 153 <dl> | |
| 121 <dt>Returns:</dt> | 154 <dt>Returns:</dt> |
| 122 <dd> | 155 <dd> |
| 123 tuple of None and activation status (boolean) | 156 tuple of None and activation status (boolean) |
| 124 </dd> | 157 </dd> |
| 125 </dl><a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a> | 158 </dl> |
| 159 <a NAME="TimeTrackerPlugin.deactivate" ID="TimeTrackerPlugin.deactivate"></a> | |
| 126 <h4>TimeTrackerPlugin.deactivate</h4> | 160 <h4>TimeTrackerPlugin.deactivate</h4> |
| 127 <b>deactivate</b>(<i></i>) | 161 <b>deactivate</b>(<i></i>) |
| 162 | |
| 128 <p> | 163 <p> |
| 129 Public method to deactivate this plugin. | 164 Public method to deactivate this plugin. |
| 130 </p><a NAME="TimeTrackerPlugin.getPreferences" ID="TimeTrackerPlugin.getPreferences"></a> | 165 </p> |
| 166 <a NAME="TimeTrackerPlugin.getPreferences" ID="TimeTrackerPlugin.getPreferences"></a> | |
| 131 <h4>TimeTrackerPlugin.getPreferences</h4> | 167 <h4>TimeTrackerPlugin.getPreferences</h4> |
| 132 <b>getPreferences</b>(<i>key</i>) | 168 <b>getPreferences</b>(<i>key</i>) |
| 169 | |
| 133 <p> | 170 <p> |
| 134 Public method to retrieve the various settings. | 171 Public method to retrieve the various settings. |
| 135 </p><dl> | 172 </p> |
| 173 <dl> | |
| 174 | |
| 136 <dt><i>key</i></dt> | 175 <dt><i>key</i></dt> |
| 137 <dd> | 176 <dd> |
| 138 the key of the value to get | 177 the key of the value to get |
| 139 </dd> | 178 </dd> |
| 140 </dl><dl> | 179 </dl> |
| 180 <dl> | |
| 141 <dt>Returns:</dt> | 181 <dt>Returns:</dt> |
| 142 <dd> | 182 <dd> |
| 143 the requested setting | 183 the requested setting |
| 144 </dd> | 184 </dd> |
| 145 </dl><a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a> | 185 </dl> |
| 186 <a NAME="TimeTrackerPlugin.setPreferences" ID="TimeTrackerPlugin.setPreferences"></a> | |
| 146 <h4>TimeTrackerPlugin.setPreferences</h4> | 187 <h4>TimeTrackerPlugin.setPreferences</h4> |
| 147 <b>setPreferences</b>(<i>key, value</i>) | 188 <b>setPreferences</b>(<i>key, value</i>) |
| 189 | |
| 148 <p> | 190 <p> |
| 149 Public method to store the various settings. | 191 Public method to store the various settings. |
| 150 </p><dl> | 192 </p> |
| 193 <dl> | |
| 194 | |
| 151 <dt><i>key</i></dt> | 195 <dt><i>key</i></dt> |
| 152 <dd> | 196 <dd> |
| 153 the key of the setting to be set (string) | 197 the key of the setting to be set (string) |
| 154 </dd><dt><i>value</i></dt> | 198 </dd> |
| 199 <dt><i>value</i></dt> | |
| 155 <dd> | 200 <dd> |
| 156 the value to be set | 201 the value to be set |
| 157 </dd> | 202 </dd> |
| 158 </dl> | 203 </dl> |
| 159 <div align="right"><a href="#top">Up</a></div> | 204 <div align="right"><a href="#top">Up</a></div> |
| 160 <hr /><hr /> | 205 <hr /> |
| 206 <hr /> | |
| 161 <a NAME="createTimeTrackerPage" ID="createTimeTrackerPage"></a> | 207 <a NAME="createTimeTrackerPage" ID="createTimeTrackerPage"></a> |
| 162 <h2>createTimeTrackerPage</h2> | 208 <h2>createTimeTrackerPage</h2> |
| 163 <b>createTimeTrackerPage</b>(<i>configDlg</i>) | 209 <b>createTimeTrackerPage</b>(<i>configDlg</i>) |
| 210 | |
| 164 <p> | 211 <p> |
| 165 Module function to create the Time Tracker configuration page. | 212 Module function to create the Time Tracker configuration page. |
| 166 </p><dl> | 213 </p> |
| 214 <dl> | |
| 215 | |
| 167 <dt><i>configDlg</i></dt> | 216 <dt><i>configDlg</i></dt> |
| 168 <dd> | 217 <dd> |
| 169 reference to the configuration dialog | 218 reference to the configuration dialog |
| 170 </dd> | 219 </dd> |
| 171 </dl><dl> | 220 </dl> |
| 221 <dl> | |
| 172 <dt>Returns:</dt> | 222 <dt>Returns:</dt> |
| 173 <dd> | 223 <dd> |
| 174 reference to the configuration page | 224 reference to the configuration page |
| 175 </dd> | 225 </dd> |
| 176 </dl> | 226 </dl> |
| 177 <div align="right"><a href="#top">Up</a></div> | 227 <div align="right"><a href="#top">Up</a></div> |
| 178 <hr /><hr /> | 228 <hr /> |
| 229 <hr /> | |
| 179 <a NAME="getConfigData" ID="getConfigData"></a> | 230 <a NAME="getConfigData" ID="getConfigData"></a> |
| 180 <h2>getConfigData</h2> | 231 <h2>getConfigData</h2> |
| 181 <b>getConfigData</b>(<i></i>) | 232 <b>getConfigData</b>(<i></i>) |
| 233 | |
| 182 <p> | 234 <p> |
| 183 Module function returning data as required by the configuration dialog. | 235 Module function returning data as required by the configuration dialog. |
| 184 </p><dl> | 236 </p> |
| 237 <dl> | |
| 185 <dt>Returns:</dt> | 238 <dt>Returns:</dt> |
| 186 <dd> | 239 <dd> |
| 187 dictionary containing the relevant data | 240 dictionary containing the relevant data |
| 188 </dd> | 241 </dd> |
| 189 </dl> | 242 </dl> |
| 190 <div align="right"><a href="#top">Up</a></div> | 243 <div align="right"><a href="#top">Up</a></div> |
| 191 <hr /><hr /> | 244 <hr /> |
| 245 <hr /> | |
| 192 <a NAME="prepareUninstall" ID="prepareUninstall"></a> | 246 <a NAME="prepareUninstall" ID="prepareUninstall"></a> |
| 193 <h2>prepareUninstall</h2> | 247 <h2>prepareUninstall</h2> |
| 194 <b>prepareUninstall</b>(<i></i>) | 248 <b>prepareUninstall</b>(<i></i>) |
| 249 | |
| 195 <p> | 250 <p> |
| 196 Module function to prepare for an uninstallation. | 251 Module function to prepare for an uninstallation. |
| 197 </p> | 252 </p> |
| 198 <div align="right"><a href="#top">Up</a></div> | 253 <div align="right"><a href="#top">Up</a></div> |
| 199 <hr /> | 254 <hr /> |
