Mercurial Repositories > Time Tracker / file comparison

comparison: TimeTracker/Documentation/source/Plugin_Time_Tracker.TimeTracker.TimeTracker.html

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

changeset 18
73bd1fdd7102
child 21
28b7956c9608
equal deleted inserted replaced
17:2dc5c5af1cf3 18:73bd1fdd7102
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>Plugin_Time_Tracker.TimeTracker.TimeTracker</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>Plugin_Time_Tracker.TimeTracker.TimeTracker</h1>
24 <p>
25 Module implementing the time tracker object.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#TimeTracker">TimeTracker</a></td>
35 <td>Class implementing the time tracker object.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="TimeTracker" ID="TimeTracker"></a>
44 <h2>TimeTracker</h2>
45 <p>
46 Class implementing the time tracker object.
47 </p>
48 <h3>Derived from</h3>
49 QObject
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>FileName</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Methods</h3>
59 <table>
60 <tr>
61 <td><a href="#TimeTracker.__init__">TimeTracker</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#TimeTracker.__initialize">__initialize</a></td>
65 <td>Public slot to initialize some member variables.</td>
66 </tr><tr>
67 <td><a href="#TimeTracker.__readTrackerEntries">__readTrackerEntries</a></td>
68 <td>Private slot to read the time tracker entries from a file.</td>
69 </tr><tr>
70 <td><a href="#TimeTracker.addTrackerEntry">addTrackerEntry</a></td>
71 <td>Public method to add a new tracker entry based on the given data.</td>
72 </tr><tr>
73 <td><a href="#TimeTracker.continueTrackerEntry">continueTrackerEntry</a></td>
74 <td>Public method to continue the current tracker entry.</td>
75 </tr><tr>
76 <td><a href="#TimeTracker.deleteTrackerEntry">deleteTrackerEntry</a></td>
77 <td>Public method to delete a tracker entry given its ID.</td>
78 </tr><tr>
79 <td><a href="#TimeTracker.entryChanged">entryChanged</a></td>
80 <td>Public method to indicate an external change to any of the entries.</td>
81 </tr><tr>
82 <td><a href="#TimeTracker.getCurrentEntry">getCurrentEntry</a></td>
83 <td>Public method to get a reference to the current tracker entry.</td>
84 </tr><tr>
85 <td><a href="#TimeTracker.getEntry">getEntry</a></td>
86 <td>Public method to get a tracker entry given its ID.</td>
87 </tr><tr>
88 <td><a href="#TimeTracker.getPreferences">getPreferences</a></td>
89 <td>Public method to retrieve the various settings.</td>
90 </tr><tr>
91 <td><a href="#TimeTracker.importTrackerEntries">importTrackerEntries</a></td>
92 <td>Public slot to import tracker entries from a file.</td>
93 </tr><tr>
94 <td><a href="#TimeTracker.mergeDuplicateTrackerEntries">mergeDuplicateTrackerEntries</a></td>
95 <td>Public slot to merge duplicate time tracker entries.</td>
96 </tr><tr>
97 <td><a href="#TimeTracker.pauseTrackerEntry">pauseTrackerEntry</a></td>
98 <td>Public method to pause the current tracker entry.</td>
99 </tr><tr>
100 <td><a href="#TimeTracker.projectClosed">projectClosed</a></td>
101 <td>Public slot to handle the projectClosed signal.</td>
102 </tr><tr>
103 <td><a href="#TimeTracker.projectOpened">projectOpened</a></td>
104 <td>Public slot to handle the projectOpened signal.</td>
105 </tr><tr>
106 <td><a href="#TimeTracker.removeDuplicateTrackerEntries">removeDuplicateTrackerEntries</a></td>
107 <td>Public slot to remove duplicate time tracker entries.</td>
108 </tr><tr>
109 <td><a href="#TimeTracker.saveTrackerEntries">saveTrackerEntries</a></td>
110 <td>Public slot to save the tracker entries to a file.</td>
111 </tr><tr>
112 <td><a href="#TimeTracker.startTrackerEntry">startTrackerEntry</a></td>
113 <td>Public method to start a new tracker entry.</td>
114 </tr><tr>
115 <td><a href="#TimeTracker.stopTrackerEntry">stopTrackerEntry</a></td>
116 <td>Public method to stop the current tracker entry.</td>
117 </tr>
118 </table>
119 <h3>Static Methods</h3>
120 <table>
121 <tr><td>None</td></tr>
122 </table>
123 <a NAME="TimeTracker.__init__" ID="TimeTracker.__init__"></a>
124 <h4>TimeTracker (Constructor)</h4>
125 <b>TimeTracker</b>(<i>plugin, parent=None</i>)
126 <p>
127 Constructor
128 </p><dl>
129 <dt><i>plugin</i></dt>
130 <dd>
131 reference to the plugin object (TimeTrackerPlugin)
132 </dd><dt><i>parent</i></dt>
133 <dd>
134 parent (QObject)
135 </dd>
136 </dl><a NAME="TimeTracker.__initialize" ID="TimeTracker.__initialize"></a>
137 <h4>TimeTracker.__initialize</h4>
138 <b>__initialize</b>(<i></i>)
139 <p>
140 Public slot to initialize some member variables.
141 </p><a NAME="TimeTracker.__readTrackerEntries" ID="TimeTracker.__readTrackerEntries"></a>
142 <h4>TimeTracker.__readTrackerEntries</h4>
143 <b>__readTrackerEntries</b>(<i></i>)
144 <p>
145 Private slot to read the time tracker entries from a file.
146 </p><a NAME="TimeTracker.addTrackerEntry" ID="TimeTracker.addTrackerEntry"></a>
147 <h4>TimeTracker.addTrackerEntry</h4>
148 <b>addTrackerEntry</b>(<i>startDateTime, duration, task, comment</i>)
149 <p>
150 Public method to add a new tracker entry based on the given data.
151 </p><dl>
152 <dt><i>startDateTime</i></dt>
153 <dd>
154 start date and time (QDateTime)
155 </dd><dt><i>duration</i></dt>
156 <dd>
157 duration in minutes (integer)
158 </dd><dt><i>task</i></dt>
159 <dd>
160 task description (string)
161 </dd><dt><i>comment</i></dt>
162 <dd>
163 comment (string)
164 </dd>
165 </dl><a NAME="TimeTracker.continueTrackerEntry" ID="TimeTracker.continueTrackerEntry"></a>
166 <h4>TimeTracker.continueTrackerEntry</h4>
167 <b>continueTrackerEntry</b>(<i></i>)
168 <p>
169 Public method to continue the current tracker entry.
170 </p><a NAME="TimeTracker.deleteTrackerEntry" ID="TimeTracker.deleteTrackerEntry"></a>
171 <h4>TimeTracker.deleteTrackerEntry</h4>
172 <b>deleteTrackerEntry</b>(<i>eid</i>)
173 <p>
174 Public method to delete a tracker entry given its ID.
175 </p><dl>
176 <dt><i>eid</i></dt>
177 <dd>
178 ID of the tracker entry (integer)
179 </dd>
180 </dl><a NAME="TimeTracker.entryChanged" ID="TimeTracker.entryChanged"></a>
181 <h4>TimeTracker.entryChanged</h4>
182 <b>entryChanged</b>(<i></i>)
183 <p>
184 Public method to indicate an external change to any of the entries.
185 </p><a NAME="TimeTracker.getCurrentEntry" ID="TimeTracker.getCurrentEntry"></a>
186 <h4>TimeTracker.getCurrentEntry</h4>
187 <b>getCurrentEntry</b>(<i></i>)
188 <p>
189 Public method to get a reference to the current tracker entry.
190 </p><a NAME="TimeTracker.getEntry" ID="TimeTracker.getEntry"></a>
191 <h4>TimeTracker.getEntry</h4>
192 <b>getEntry</b>(<i>eid</i>)
193 <p>
194 Public method to get a tracker entry given its ID.
195 </p><dl>
196 <dt><i>eid</i></dt>
197 <dd>
198 ID of the tracker entry (integer)
199 </dd>
200 </dl><dl>
201 <dt>Returns:</dt>
202 <dd>
203 entry for the given ID (TimeTrackEntry) or None
204 </dd>
205 </dl><a NAME="TimeTracker.getPreferences" ID="TimeTracker.getPreferences"></a>
206 <h4>TimeTracker.getPreferences</h4>
207 <b>getPreferences</b>(<i>key</i>)
208 <p>
209 Public method to retrieve the various settings.
210 </p><dl>
211 <dt><i>key</i></dt>
212 <dd>
213 the key of the value to get
214 </dd>
215 </dl><dl>
216 <dt>Returns:</dt>
217 <dd>
218 the requested setting
219 </dd>
220 </dl><a NAME="TimeTracker.importTrackerEntries" ID="TimeTracker.importTrackerEntries"></a>
221 <h4>TimeTracker.importTrackerEntries</h4>
222 <b>importTrackerEntries</b>(<i>fname</i>)
223 <p>
224 Public slot to import tracker entries from a file.
225 </p><dl>
226 <dt><i>fname</i></dt>
227 <dd>
228 name of the file to import (string)
229 </dd>
230 </dl><a NAME="TimeTracker.mergeDuplicateTrackerEntries" ID="TimeTracker.mergeDuplicateTrackerEntries"></a>
231 <h4>TimeTracker.mergeDuplicateTrackerEntries</h4>
232 <b>mergeDuplicateTrackerEntries</b>(<i></i>)
233 <p>
234 Public slot to merge duplicate time tracker entries.
235 </p><p>
236 If entries with the identical start date and time are found, the durations
237 of these entries are added.
238 </p><a NAME="TimeTracker.pauseTrackerEntry" ID="TimeTracker.pauseTrackerEntry"></a>
239 <h4>TimeTracker.pauseTrackerEntry</h4>
240 <b>pauseTrackerEntry</b>(<i></i>)
241 <p>
242 Public method to pause the current tracker entry.
243 </p><a NAME="TimeTracker.projectClosed" ID="TimeTracker.projectClosed"></a>
244 <h4>TimeTracker.projectClosed</h4>
245 <b>projectClosed</b>(<i></i>)
246 <p>
247 Public slot to handle the projectClosed signal.
248 </p><a NAME="TimeTracker.projectOpened" ID="TimeTracker.projectOpened"></a>
249 <h4>TimeTracker.projectOpened</h4>
250 <b>projectOpened</b>(<i></i>)
251 <p>
252 Public slot to handle the projectOpened signal.
253 </p><a NAME="TimeTracker.removeDuplicateTrackerEntries" ID="TimeTracker.removeDuplicateTrackerEntries"></a>
254 <h4>TimeTracker.removeDuplicateTrackerEntries</h4>
255 <b>removeDuplicateTrackerEntries</b>(<i></i>)
256 <p>
257 Public slot to remove duplicate time tracker entries.
258 </p><p>
259 If entries with the identical start date and time are found, the one
260 with the longest duration is kept.
261 </p><a NAME="TimeTracker.saveTrackerEntries" ID="TimeTracker.saveTrackerEntries"></a>
262 <h4>TimeTracker.saveTrackerEntries</h4>
263 <b>saveTrackerEntries</b>(<i>filePath="", ids=[]</i>)
264 <p>
265 Public slot to save the tracker entries to a file.
266 </p><dl>
267 <dt><i>filePath=</i></dt>
268 <dd>
269 path and name of the file to write the entries to (string)
270 </dd><dt><i>ids=</i></dt>
271 <dd>
272 list of entry IDs to be written (list of integer)
273 </dd>
274 </dl><a NAME="TimeTracker.startTrackerEntry" ID="TimeTracker.startTrackerEntry"></a>
275 <h4>TimeTracker.startTrackerEntry</h4>
276 <b>startTrackerEntry</b>(<i></i>)
277 <p>
278 Public method to start a new tracker entry.
279 </p><a NAME="TimeTracker.stopTrackerEntry" ID="TimeTracker.stopTrackerEntry"></a>
280 <h4>TimeTracker.stopTrackerEntry</h4>
281 <b>stopTrackerEntry</b>(<i></i>)
282 <p>
283 Public method to stop the current tracker entry.
284 </p><dl>
285 <dt>Returns:</dt>
286 <dd>
287 tuple of the ID assigned to the stopped tracker entry and
288 the duration (integer, integer)
289 </dd>
290 </dl>
291 <div align="right"><a href="#top">Up</a></div>
292 <hr />
293 </body></html>

Mercurial Repository: Time Tracker

eric ide

mercurial