TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTracker.html

branch
eric7
changeset 98
693e42176007
parent 95
7449695cf655
child 106
6deb942739dc
equal deleted inserted replaced
97:44ec4168b442 98:693e42176007
72 <td><a href="#TimeTracker.__init__">TimeTracker</a></td> 72 <td><a href="#TimeTracker.__init__">TimeTracker</a></td>
73 <td>Constructor</td> 73 <td>Constructor</td>
74 </tr> 74 </tr>
75 <tr> 75 <tr>
76 <td><a href="#TimeTracker.__activateWidget">__activateWidget</a></td> 76 <td><a href="#TimeTracker.__activateWidget">__activateWidget</a></td>
77 <td>Private slot to handle the activation of the project browser.</td> 77 <td>Private slot to handle the activation of the time tracker widget.</td>
78 </tr> 78 </tr>
79 <tr> 79 <tr>
80 <td><a href="#TimeTracker.__initialize">__initialize</a></td> 80 <td><a href="#TimeTracker.__initialize">__initialize</a></td>
81 <td>Private slot to initialize some member variables.</td> 81 <td>Private slot to initialize some member variables.</td>
82 </tr> 82 </tr>
188 <a NAME="TimeTracker.__activateWidget" ID="TimeTracker.__activateWidget"></a> 188 <a NAME="TimeTracker.__activateWidget" ID="TimeTracker.__activateWidget"></a>
189 <h4>TimeTracker.__activateWidget</h4> 189 <h4>TimeTracker.__activateWidget</h4>
190 <b>__activateWidget</b>(<i></i>) 190 <b>__activateWidget</b>(<i></i>)
191 191
192 <p> 192 <p>
193 Private slot to handle the activation of the project browser. 193 Private slot to handle the activation of the time tracker widget.
194 </p> 194 </p>
195 <a NAME="TimeTracker.__initialize" ID="TimeTracker.__initialize"></a> 195 <a NAME="TimeTracker.__initialize" ID="TimeTracker.__initialize"></a>
196 <h4>TimeTracker.__initialize</h4> 196 <h4>TimeTracker.__initialize</h4>
197 <b>__initialize</b>(<i></i>) 197 <b>__initialize</b>(<i></i>)
198 198
220 <p> 220 <p>
221 Public method to add a new tracker entry based on the given data. 221 Public method to add a new tracker entry based on the given data.
222 </p> 222 </p>
223 <dl> 223 <dl>
224 224
225 <dt><i>startDateTime</i></dt> 225 <dt><i>startDateTime</i> (QDateTime)</dt>
226 <dd> 226 <dd>
227 start date and time (QDateTime) 227 start date and time
228 </dd> 228 </dd>
229 <dt><i>duration</i></dt> 229 <dt><i>duration</i> (int)</dt>
230 <dd> 230 <dd>
231 duration in minutes (integer) 231 duration in minutes
232 </dd> 232 </dd>
233 <dt><i>task</i></dt> 233 <dt><i>task</i> (str)</dt>
234 <dd> 234 <dd>
235 task description (string) 235 task description
236 </dd> 236 </dd>
237 <dt><i>comment</i></dt> 237 <dt><i>comment</i> (str)</dt>
238 <dd> 238 <dd>
239 comment (string) 239 comment
240 </dd> 240 </dd>
241 </dl> 241 </dl>
242 <a NAME="TimeTracker.continueTrackerEntry" ID="TimeTracker.continueTrackerEntry"></a> 242 <a NAME="TimeTracker.continueTrackerEntry" ID="TimeTracker.continueTrackerEntry"></a>
243 <h4>TimeTracker.continueTrackerEntry</h4> 243 <h4>TimeTracker.continueTrackerEntry</h4>
244 <b>continueTrackerEntry</b>(<i></i>) 244 <b>continueTrackerEntry</b>(<i></i>)
260 <p> 260 <p>
261 Public method to delete a tracker entry given its ID. 261 Public method to delete a tracker entry given its ID.
262 </p> 262 </p>
263 <dl> 263 <dl>
264 264
265 <dt><i>eid</i></dt> 265 <dt><i>eid</i> (int)</dt>
266 <dd> 266 <dd>
267 ID of the tracker entry (integer) 267 ID of the tracker entry
268 </dd> 268 </dd>
269 </dl> 269 </dl>
270 <a NAME="TimeTracker.entryChanged" ID="TimeTracker.entryChanged"></a> 270 <a NAME="TimeTracker.entryChanged" ID="TimeTracker.entryChanged"></a>
271 <h4>TimeTracker.entryChanged</h4> 271 <h4>TimeTracker.entryChanged</h4>
272 <b>entryChanged</b>(<i></i>) 272 <b>entryChanged</b>(<i></i>)
282 Public method to get a reference to the current tracker entry. 282 Public method to get a reference to the current tracker entry.
283 </p> 283 </p>
284 <dl> 284 <dl>
285 <dt>Return:</dt> 285 <dt>Return:</dt>
286 <dd> 286 <dd>
287 reference to the current entry (TimeTrackEntry) 287 reference to the current entry
288 </dd>
289 </dl>
290 <dl>
291 <dt>Return Type:</dt>
292 <dd>
293 TimeTrackEntry
288 </dd> 294 </dd>
289 </dl> 295 </dl>
290 <a NAME="TimeTracker.getEntry" ID="TimeTracker.getEntry"></a> 296 <a NAME="TimeTracker.getEntry" ID="TimeTracker.getEntry"></a>
291 <h4>TimeTracker.getEntry</h4> 297 <h4>TimeTracker.getEntry</h4>
292 <b>getEntry</b>(<i>eid</i>) 298 <b>getEntry</b>(<i>eid</i>)
294 <p> 300 <p>
295 Public method to get a tracker entry given its ID. 301 Public method to get a tracker entry given its ID.
296 </p> 302 </p>
297 <dl> 303 <dl>
298 304
299 <dt><i>eid</i></dt> 305 <dt><i>eid</i> (int)</dt>
300 <dd> 306 <dd>
301 ID of the tracker entry (integer) 307 ID of the tracker entry
302 </dd> 308 </dd>
303 </dl> 309 </dl>
304 <dl> 310 <dl>
305 <dt>Return:</dt> 311 <dt>Return:</dt>
306 <dd> 312 <dd>
307 entry for the given ID (TimeTrackEntry) or None 313 entry for the given ID or None
314 </dd>
315 </dl>
316 <dl>
317 <dt>Return Type:</dt>
318 <dd>
319 TimeTrackEntry
308 </dd> 320 </dd>
309 </dl> 321 </dl>
310 <a NAME="TimeTracker.getPreferences" ID="TimeTracker.getPreferences"></a> 322 <a NAME="TimeTracker.getPreferences" ID="TimeTracker.getPreferences"></a>
311 <h4>TimeTracker.getPreferences</h4> 323 <h4>TimeTracker.getPreferences</h4>
312 <b>getPreferences</b>(<i>key</i>) 324 <b>getPreferences</b>(<i>key</i>)
314 <p> 326 <p>
315 Public method to retrieve the various settings. 327 Public method to retrieve the various settings.
316 </p> 328 </p>
317 <dl> 329 <dl>
318 330
319 <dt><i>key</i></dt> 331 <dt><i>key</i> (str)</dt>
320 <dd> 332 <dd>
321 the key of the value to get 333 key of the value to get
322 </dd> 334 </dd>
323 </dl> 335 </dl>
324 <dl> 336 <dl>
325 <dt>Return:</dt> 337 <dt>Return:</dt>
326 <dd> 338 <dd>
327 the requested setting 339 value of the requested setting
340 </dd>
341 </dl>
342 <dl>
343 <dt>Return Type:</dt>
344 <dd>
345 Any
328 </dd> 346 </dd>
329 </dl> 347 </dl>
330 <a NAME="TimeTracker.importTrackerEntries" ID="TimeTracker.importTrackerEntries"></a> 348 <a NAME="TimeTracker.importTrackerEntries" ID="TimeTracker.importTrackerEntries"></a>
331 <h4>TimeTracker.importTrackerEntries</h4> 349 <h4>TimeTracker.importTrackerEntries</h4>
332 <b>importTrackerEntries</b>(<i>fname</i>) 350 <b>importTrackerEntries</b>(<i>fname</i>)
391 <p> 409 <p>
392 Public slot to save the tracker entries to a file. 410 Public slot to save the tracker entries to a file.
393 </p> 411 </p>
394 <dl> 412 <dl>
395 413
396 <dt><i>filePath=</i></dt> 414 <dt><i>filePath</i> (str)</dt>
397 <dd> 415 <dd>
398 path and name of the file to write the entries to 416 path and name of the file to write the entries to
399 (string) 417 </dd>
400 </dd> 418 <dt><i>ids</i> (list of int)</dt>
401 <dt><i>ids=</i></dt> 419 <dd>
402 <dd> 420 list of entry IDs to be written
403 list of entry IDs to be written (list of integer)
404 </dd> 421 </dd>
405 </dl> 422 </dl>
406 <a NAME="TimeTracker.startTrackerEntry" ID="TimeTracker.startTrackerEntry"></a> 423 <a NAME="TimeTracker.startTrackerEntry" ID="TimeTracker.startTrackerEntry"></a>
407 <h4>TimeTracker.startTrackerEntry</h4> 424 <h4>TimeTracker.startTrackerEntry</h4>
408 <b>startTrackerEntry</b>(<i></i>) 425 <b>startTrackerEntry</b>(<i></i>)
419 </p> 436 </p>
420 <dl> 437 <dl>
421 <dt>Return:</dt> 438 <dt>Return:</dt>
422 <dd> 439 <dd>
423 tuple of the ID assigned to the stopped tracker entry and 440 tuple of the ID assigned to the stopped tracker entry and
424 the duration (integer, integer) 441 the duration
442 </dd>
443 </dl>
444 <dl>
445 <dt>Return Type:</dt>
446 <dd>
447 tuple of (int, int)
425 </dd> 448 </dd>
426 </dl> 449 </dl>
427 <div align="right"><a href="#top">Up</a></div> 450 <div align="right"><a href="#top">Up</a></div>
428 <hr /> 451 <hr />
429 </body></html> 452 </body></html>

eric ide

mercurial