--- a/TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTracker.html Sat Dec 23 19:35:14 2023 +0100
+++ b/TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTracker.html Sat Jan 06 13:06:58 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Time_Tracker.TimeTracker.TimeTracker</h1>
-
<p>
Module implementing the time tracker object.
</p>
+
<h3>Global Attributes</h3>
-
<table>
-<tr><td>None</td></tr>
+<tr><td>_Side</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#TimeTracker">TimeTracker</a></td>
<td>Class implementing the time tracker object.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="TimeTracker" ID="TimeTracker"></a>
<h2>TimeTracker</h2>
-
<p>
Class implementing the time tracker object.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
<tr><td>FileName</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#TimeTracker.__init__">TimeTracker</a></td>
<td>Constructor</td>
@@ -143,19 +140,20 @@
<td>Public method to stop the current tracker entry.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="TimeTracker.__init__" ID="TimeTracker.__init__"></a>
<h4>TimeTracker (Constructor)</h4>
<b>TimeTracker</b>(<i>plugin, iconSuffix, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>plugin</i> (TimeTrackerPlugin)</dt>
@@ -174,38 +172,38 @@
<a NAME="TimeTracker.__activateWidget" ID="TimeTracker.__activateWidget"></a>
<h4>TimeTracker.__activateWidget</h4>
<b>__activateWidget</b>(<i></i>)
-
<p>
Private slot to handle the activation of the time tracker widget.
</p>
+
<a NAME="TimeTracker.__initialize" ID="TimeTracker.__initialize"></a>
<h4>TimeTracker.__initialize</h4>
<b>__initialize</b>(<i></i>)
-
<p>
Private slot to initialize some member variables.
</p>
+
<a NAME="TimeTracker.__readTrackerEntries" ID="TimeTracker.__readTrackerEntries"></a>
<h4>TimeTracker.__readTrackerEntries</h4>
<b>__readTrackerEntries</b>(<i></i>)
-
<p>
Private slot to read the time tracker entries from a file.
</p>
+
<a NAME="TimeTracker.activate" ID="TimeTracker.activate"></a>
<h4>TimeTracker.activate</h4>
<b>activate</b>(<i></i>)
-
<p>
Public method to activate the time tracker.
</p>
+
<a NAME="TimeTracker.addTrackerEntry" ID="TimeTracker.addTrackerEntry"></a>
<h4>TimeTracker.addTrackerEntry</h4>
<b>addTrackerEntry</b>(<i>startDateTime, duration, task, comment</i>)
-
<p>
Public method to add a new tracker entry based on the given data.
</p>
+
<dl>
<dt><i>startDateTime</i> (QDateTime)</dt>
@@ -228,24 +226,24 @@
<a NAME="TimeTracker.continueTrackerEntry" ID="TimeTracker.continueTrackerEntry"></a>
<h4>TimeTracker.continueTrackerEntry</h4>
<b>continueTrackerEntry</b>(<i></i>)
-
<p>
Public method to continue the current tracker entry.
</p>
+
<a NAME="TimeTracker.deactivate" ID="TimeTracker.deactivate"></a>
<h4>TimeTracker.deactivate</h4>
<b>deactivate</b>(<i></i>)
-
<p>
Public method to deactivate the time tracker.
</p>
+
<a NAME="TimeTracker.deleteTrackerEntry" ID="TimeTracker.deleteTrackerEntry"></a>
<h4>TimeTracker.deleteTrackerEntry</h4>
<b>deleteTrackerEntry</b>(<i>eid</i>)
-
<p>
Public method to delete a tracker entry given its ID.
</p>
+
<dl>
<dt><i>eid</i> (int)</dt>
@@ -256,17 +254,17 @@
<a NAME="TimeTracker.entryChanged" ID="TimeTracker.entryChanged"></a>
<h4>TimeTracker.entryChanged</h4>
<b>entryChanged</b>(<i></i>)
-
<p>
Public method to indicate an external change to any of the entries.
</p>
+
<a NAME="TimeTracker.getCurrentEntry" ID="TimeTracker.getCurrentEntry"></a>
<h4>TimeTracker.getCurrentEntry</h4>
<b>getCurrentEntry</b>(<i></i>)
-
<p>
Public method to get a reference to the current tracker entry.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -282,10 +280,10 @@
<a NAME="TimeTracker.getEntry" ID="TimeTracker.getEntry"></a>
<h4>TimeTracker.getEntry</h4>
<b>getEntry</b>(<i>eid</i>)
-
<p>
Public method to get a tracker entry given its ID.
</p>
+
<dl>
<dt><i>eid</i> (int)</dt>
@@ -308,10 +306,10 @@
<a NAME="TimeTracker.getPreferences" ID="TimeTracker.getPreferences"></a>
<h4>TimeTracker.getPreferences</h4>
<b>getPreferences</b>(<i>key</i>)
-
<p>
Public method to retrieve the various settings.
</p>
+
<dl>
<dt><i>key</i> (str)</dt>
@@ -334,10 +332,10 @@
<a NAME="TimeTracker.importTrackerEntries" ID="TimeTracker.importTrackerEntries"></a>
<h4>TimeTracker.importTrackerEntries</h4>
<b>importTrackerEntries</b>(<i>fname</i>)
-
<p>
Public slot to import tracker entries from a file.
</p>
+
<dl>
<dt><i>fname</i> (str)</dt>
@@ -348,7 +346,6 @@
<a NAME="TimeTracker.mergeDuplicateTrackerEntries" ID="TimeTracker.mergeDuplicateTrackerEntries"></a>
<h4>TimeTracker.mergeDuplicateTrackerEntries</h4>
<b>mergeDuplicateTrackerEntries</b>(<i></i>)
-
<p>
Public slot to merge duplicate time tracker entries.
</p>
@@ -356,31 +353,31 @@
If entries with the identical start date and time are found, the
durations of these entries are added.
</p>
+
<a NAME="TimeTracker.pauseTrackerEntry" ID="TimeTracker.pauseTrackerEntry"></a>
<h4>TimeTracker.pauseTrackerEntry</h4>
<b>pauseTrackerEntry</b>(<i></i>)
-
<p>
Public method to pause the current tracker entry.
</p>
+
<a NAME="TimeTracker.projectClosed" ID="TimeTracker.projectClosed"></a>
<h4>TimeTracker.projectClosed</h4>
<b>projectClosed</b>(<i></i>)
-
<p>
Public slot to handle the projectClosed signal.
</p>
+
<a NAME="TimeTracker.projectOpened" ID="TimeTracker.projectOpened"></a>
<h4>TimeTracker.projectOpened</h4>
<b>projectOpened</b>(<i></i>)
-
<p>
Public slot to handle the projectOpened signal.
</p>
+
<a NAME="TimeTracker.removeDuplicateTrackerEntries" ID="TimeTracker.removeDuplicateTrackerEntries"></a>
<h4>TimeTracker.removeDuplicateTrackerEntries</h4>
<b>removeDuplicateTrackerEntries</b>(<i></i>)
-
<p>
Public slot to remove duplicate time tracker entries.
</p>
@@ -388,13 +385,14 @@
If entries with the identical start date and time are found, the one
with the longest duration is kept.
</p>
+
<a NAME="TimeTracker.saveTrackerEntries" ID="TimeTracker.saveTrackerEntries"></a>
<h4>TimeTracker.saveTrackerEntries</h4>
<b>saveTrackerEntries</b>(<i>filePath="", ids=None</i>)
-
<p>
Public slot to save the tracker entries to a file.
</p>
+
<dl>
<dt><i>filePath</i> (str)</dt>
@@ -409,17 +407,17 @@
<a NAME="TimeTracker.startTrackerEntry" ID="TimeTracker.startTrackerEntry"></a>
<h4>TimeTracker.startTrackerEntry</h4>
<b>startTrackerEntry</b>(<i></i>)
-
<p>
Public method to start a new tracker entry.
</p>
+
<a NAME="TimeTracker.stopTrackerEntry" ID="TimeTracker.stopTrackerEntry"></a>
<h4>TimeTracker.stopTrackerEntry</h4>
<b>stopTrackerEntry</b>(<i></i>)
-
<p>
Public method to stop the current tracker entry.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -435,4 +433,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
