Mercurial Repositories > Time Tracker / file diff

diff: TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTrackEntry.html

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

changeset 18
73bd1fdd7102
child 33
a8706d6bd932
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTrackEntry.html	Sun Oct 21 19:36:56 2012 +0200
@@ -0,0 +1,377 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>Plugin_Time_Tracker.TimeTracker.TimeTrackEntry</title>
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>Plugin_Time_Tracker.TimeTracker.TimeTrackEntry</h1>
+<p>
+Module implementing the time track entry class.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#TimeTrackEntry">TimeTrackEntry</a></td>
+<td>Class implementing the time track entry.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="TimeTrackEntry" ID="TimeTrackEntry"></a>
+<h2>TimeTrackEntry</h2>
+<p>
+    Class implementing the time track entry.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>LineMarker</td></tr><tr><td>Separator</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#TimeTrackEntry.__init__">TimeTrackEntry</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.__calculateDuration">__calculateDuration</a></td>
+<td>Private method to calculate the duration in minutes.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.__currentDateTime">__currentDateTime</a></td>
+<td>Private method to get the current date and time without milliseconds.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.__lt__">__lt__</a></td>
+<td>Special method implementing the less than function.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.addDuration">addDuration</a></td>
+<td>Public method to add a duration.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.continue_">continue_</a></td>
+<td>Public method to continue the entry.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.fromString">fromString</a></td>
+<td>Public method to populate the entry from the given string.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.getComment">getComment</a></td>
+<td>Public method to get the comment.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.getDuration">getDuration</a></td>
+<td>Public slot to get the duration.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.getEntryData">getEntryData</a></td>
+<td>Public method to get the entry data.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.getID">getID</a></td>
+<td>Public method to get the ID of the entry.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.getStartDateTime">getStartDateTime</a></td>
+<td>Public method to get the start date and time.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.getTask">getTask</a></td>
+<td>Public method to get the task description.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.isPaused">isPaused</a></td>
+<td>Public method to check for a paused state.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.isValid">isValid</a></td>
+<td>Public method to check the validity of the entry.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.pause">pause</a></td>
+<td>Public method to pause the entry.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.setComment">setComment</a></td>
+<td>Public method to set a comment.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.setDuration">setDuration</a></td>
+<td>Public method to set the duration.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.setID">setID</a></td>
+<td>Public method to assign an ID to the entry.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.setStartDateTime">setStartDateTime</a></td>
+<td>Public method to set the start date and time.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.setTask">setTask</a></td>
+<td>Public method to set the task description.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.start">start</a></td>
+<td>Public method to set the start time of this entry.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.stop">stop</a></td>
+<td>Public method to stop this entry.</td>
+</tr><tr>
+<td><a href="#TimeTrackEntry.toString">toString</a></td>
+<td>Public method to get a string representation of the entry.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="TimeTrackEntry.__init__" ID="TimeTrackEntry.__init__"></a>
+<h4>TimeTrackEntry (Constructor)</h4>
+<b>TimeTrackEntry</b>(<i>plugin</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>plugin</i></dt>
+<dd>
+reference to the plugin object (TimeTrackerPlugin)
+</dd>
+</dl><a NAME="TimeTrackEntry.__calculateDuration" ID="TimeTrackEntry.__calculateDuration"></a>
+<h4>TimeTrackEntry.__calculateDuration</h4>
+<b>__calculateDuration</b>(<i>start, stop</i>)
+<p>
+        Private method to calculate the duration in minutes.
+</p><dl>
+<dt><i>start</i></dt>
+<dd>
+start date and time (QDateTime)
+</dd><dt><i>stop</i></dt>
+<dd>
+end date and time (QDateTime)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+duration in minutes (int)
+</dd>
+</dl><a NAME="TimeTrackEntry.__currentDateTime" ID="TimeTrackEntry.__currentDateTime"></a>
+<h4>TimeTrackEntry.__currentDateTime</h4>
+<b>__currentDateTime</b>(<i></i>)
+<p>
+        Private method to get the current date and time without milliseconds.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+current date and time (QDateTime)
+</dd>
+</dl><a NAME="TimeTrackEntry.__lt__" ID="TimeTrackEntry.__lt__"></a>
+<h4>TimeTrackEntry.__lt__</h4>
+<b>__lt__</b>(<i>other</i>)
+<p>
+        Special method implementing the less than function.
+</p><dl>
+<dt><i>other</i></dt>
+<dd>
+reference to the other object (TimeTrackEntry)
+</dd>
+</dl><a NAME="TimeTrackEntry.addDuration" ID="TimeTrackEntry.addDuration"></a>
+<h4>TimeTrackEntry.addDuration</h4>
+<b>addDuration</b>(<i>duration</i>)
+<p>
+        Public method to add a duration.
+</p><dl>
+<dt><i>duration</i></dt>
+<dd>
+duration to be added in minutes (integer). Negative values
+            are ignored.
+</dd>
+</dl><a NAME="TimeTrackEntry.continue_" ID="TimeTrackEntry.continue_"></a>
+<h4>TimeTrackEntry.continue_</h4>
+<b>continue_</b>(<i></i>)
+<p>
+        Public method to continue the entry.
+</p><a NAME="TimeTrackEntry.fromString" ID="TimeTrackEntry.fromString"></a>
+<h4>TimeTrackEntry.fromString</h4>
+<b>fromString</b>(<i>line</i>)
+<p>
+        Public method to populate the entry from the given string.
+</p><dl>
+<dt><i>line</i></dt>
+<dd>
+stringified entry data as generated by toString() (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+ID of the tracker entry; -1 indicates an error (integer)
+</dd>
+</dl><a NAME="TimeTrackEntry.getComment" ID="TimeTrackEntry.getComment"></a>
+<h4>TimeTrackEntry.getComment</h4>
+<b>getComment</b>(<i></i>)
+<p>
+        Public method to get the comment.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+comment (string)
+</dd>
+</dl><a NAME="TimeTrackEntry.getDuration" ID="TimeTrackEntry.getDuration"></a>
+<h4>TimeTrackEntry.getDuration</h4>
+<b>getDuration</b>(<i></i>)
+<p>
+        Public slot to get the duration.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+duration (integer)
+</dd>
+</dl><a NAME="TimeTrackEntry.getEntryData" ID="TimeTrackEntry.getEntryData"></a>
+<h4>TimeTrackEntry.getEntryData</h4>
+<b>getEntryData</b>(<i></i>)
+<p>
+        Public method to get the entry data.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+entry data as a tuple of start date (string), start time (string),
+            duration (integer), task (string), comment (string) and flag indicating
+            a paused state (boolean)
+</dd>
+</dl><a NAME="TimeTrackEntry.getID" ID="TimeTrackEntry.getID"></a>
+<h4>TimeTrackEntry.getID</h4>
+<b>getID</b>(<i></i>)
+<p>
+        Public method to get the ID of the entry.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+ID of the entry (integer)
+</dd>
+</dl><a NAME="TimeTrackEntry.getStartDateTime" ID="TimeTrackEntry.getStartDateTime"></a>
+<h4>TimeTrackEntry.getStartDateTime</h4>
+<b>getStartDateTime</b>(<i></i>)
+<p>
+        Public method to get the start date and time.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+start date and time (QDateTime)
+</dd>
+</dl><a NAME="TimeTrackEntry.getTask" ID="TimeTrackEntry.getTask"></a>
+<h4>TimeTrackEntry.getTask</h4>
+<b>getTask</b>(<i></i>)
+<p>
+        Public method to get the task description.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+task description (string)
+</dd>
+</dl><a NAME="TimeTrackEntry.isPaused" ID="TimeTrackEntry.isPaused"></a>
+<h4>TimeTrackEntry.isPaused</h4>
+<b>isPaused</b>(<i></i>)
+<p>
+        Public method to check for a paused state.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a paused state (boolean)
+</dd>
+</dl><a NAME="TimeTrackEntry.isValid" ID="TimeTrackEntry.isValid"></a>
+<h4>TimeTrackEntry.isValid</h4>
+<b>isValid</b>(<i></i>)
+<p>
+        Public method to check the validity of the entry.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+validity of the entry (boolean)
+</dd>
+</dl><a NAME="TimeTrackEntry.pause" ID="TimeTrackEntry.pause"></a>
+<h4>TimeTrackEntry.pause</h4>
+<b>pause</b>(<i></i>)
+<p>
+        Public method to pause the entry.
+</p><a NAME="TimeTrackEntry.setComment" ID="TimeTrackEntry.setComment"></a>
+<h4>TimeTrackEntry.setComment</h4>
+<b>setComment</b>(<i>comment</i>)
+<p>
+        Public method to set a comment.
+</p><dl>
+<dt><i>comment</i></dt>
+<dd>
+comment to set (string)
+</dd>
+</dl><a NAME="TimeTrackEntry.setDuration" ID="TimeTrackEntry.setDuration"></a>
+<h4>TimeTrackEntry.setDuration</h4>
+<b>setDuration</b>(<i>duration</i>)
+<p>
+        Public method to set the duration.
+</p><dl>
+<dt><i>duration</i></dt>
+<dd>
+duration in minutes (integer)
+</dd>
+</dl><a NAME="TimeTrackEntry.setID" ID="TimeTrackEntry.setID"></a>
+<h4>TimeTrackEntry.setID</h4>
+<b>setID</b>(<i>eid</i>)
+<p>
+        Public method to assign an ID to the entry.
+</p><dl>
+<dt><i>eid</i></dt>
+<dd>
+ID for the entry (integer)
+</dd>
+</dl><a NAME="TimeTrackEntry.setStartDateTime" ID="TimeTrackEntry.setStartDateTime"></a>
+<h4>TimeTrackEntry.setStartDateTime</h4>
+<b>setStartDateTime</b>(<i>startDateTime</i>)
+<p>
+        Public method to set the start date and time.
+</p><dl>
+<dt><i>startDateTime</i></dt>
+<dd>
+start date and time (QDateTime)
+</dd>
+</dl><a NAME="TimeTrackEntry.setTask" ID="TimeTrackEntry.setTask"></a>
+<h4>TimeTrackEntry.setTask</h4>
+<b>setTask</b>(<i>description</i>)
+<p>
+        Public method to set the task description.
+</p><dl>
+<dt><i>description</i></dt>
+<dd>
+task description (string)
+</dd>
+</dl><a NAME="TimeTrackEntry.start" ID="TimeTrackEntry.start"></a>
+<h4>TimeTrackEntry.start</h4>
+<b>start</b>(<i></i>)
+<p>
+        Public method to set the start time of this entry.
+</p><a NAME="TimeTrackEntry.stop" ID="TimeTrackEntry.stop"></a>
+<h4>TimeTrackEntry.stop</h4>
+<b>stop</b>(<i></i>)
+<p>
+        Public method to stop this entry.
+</p><a NAME="TimeTrackEntry.toString" ID="TimeTrackEntry.toString"></a>
+<h4>TimeTrackEntry.toString</h4>
+<b>toString</b>(<i></i>)
+<p>
+        Public method to get a string representation of the entry.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+string representation of the entry (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

Mercurial Repository: Time Tracker

eric ide

mercurial