Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Tasks.Task.html

Documentation/Source/eric6.Tasks.Task.html

changeset 3673
e26d7d0c1088
child 3990
5dd6edf8540a
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Tasks.Task</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Tasks.Task</h1>
23 <p>
24 Module implementing a class to store task data.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#Task">Task</a></td>
34 <td>Class implementing the task data structure.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="Task" ID="Task"></a>
43 <h2>Task</h2>
44 <p>
45 Class implementing the task data structure.
46 </p>
47 <h3>Derived from</h3>
48 QTreeWidgetItem
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>TypeFixme</td></tr><tr><td>TypeNone</td></tr><tr><td>TypeNote</td></tr><tr><td>TypeTodo</td></tr><tr><td>TypeWarning</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#Task.__init__">Task</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#Task.colorizeTask">colorizeTask</a></td>
64 <td>Public slot to set the colors of the task item.</td>
65 </tr><tr>
66 <td><a href="#Task.getFilename">getFilename</a></td>
67 <td>Public method to retrieve the tasks filename.</td>
68 </tr><tr>
69 <td><a href="#Task.getLineno">getLineno</a></td>
70 <td>Public method to retrieve the tasks linenumber.</td>
71 </tr><tr>
72 <td><a href="#Task.isCompleted">isCompleted</a></td>
73 <td>Public slot to return the completion status.</td>
74 </tr><tr>
75 <td><a href="#Task.isProjectFileTask">isProjectFileTask</a></td>
76 <td>Public slot to get an indication, if this task is related to a project file.</td>
77 </tr><tr>
78 <td><a href="#Task.isProjectTask">isProjectTask</a></td>
79 <td>Public slot to return the project relation status.</td>
80 </tr><tr>
81 <td><a href="#Task.setCompleted">setCompleted</a></td>
82 <td>Public slot to update the completed flag.</td>
83 </tr><tr>
84 <td><a href="#Task.setDescription">setDescription</a></td>
85 <td>Public slot to update the description field.</td>
86 </tr><tr>
87 <td><a href="#Task.setPriority">setPriority</a></td>
88 <td>Public slot to update the priority.</td>
89 </tr><tr>
90 <td><a href="#Task.setProjectTask">setProjectTask</a></td>
91 <td>Public method to set the project relation flag.</td>
92 </tr><tr>
93 <td><a href="#Task.setSummary">setSummary</a></td>
94 <td>Public slot to update the description.</td>
95 </tr>
96 </table>
97 <h3>Static Methods</h3>
98 <table>
99 <tr><td>None</td></tr>
100 </table>
101 <a NAME="Task.__init__" ID="Task.__init__"></a>
102 <h4>Task (Constructor)</h4>
103 <b>Task</b>(<i>summary, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TypeTodo, project=None, description=""</i>)
104 <p>
105 Constructor
106 </p><dl>
107 <dt><i>summary</i></dt>
108 <dd>
109 summary text of the task (string)
110 </dd><dt><i>priority</i></dt>
111 <dd>
112 priority of the task (0=high, 1=normal, 2=low)
113 </dd><dt><i>filename</i></dt>
114 <dd>
115 filename containing the task (string)
116 </dd><dt><i>lineno</i></dt>
117 <dd>
118 line number containing the task (integer)
119 </dd><dt><i>completed</i></dt>
120 <dd>
121 flag indicating completion status (boolean)
122 </dd><dt><i>_time</i></dt>
123 <dd>
124 creation time of the task (float, if 0 use current time)
125 </dd><dt><i>isProjectTask</i></dt>
126 <dd>
127 flag indicating a task related to the current
128 project (boolean)
129 </dd><dt><i>taskType</i></dt>
130 <dd>
131 type of the task (one of TypeFixme, TypeTodo,
132 TypeWarning, TypeNote)
133 </dd><dt><i>project</i></dt>
134 <dd>
135 reference to the project object (Project)
136 </dd><dt><i>description</i></dt>
137 <dd>
138 explanatory text of the task (string)
139 </dd>
140 </dl><a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
141 <h4>Task.colorizeTask</h4>
142 <b>colorizeTask</b>(<i></i>)
143 <p>
144 Public slot to set the colors of the task item.
145 </p><a NAME="Task.getFilename" ID="Task.getFilename"></a>
146 <h4>Task.getFilename</h4>
147 <b>getFilename</b>(<i></i>)
148 <p>
149 Public method to retrieve the tasks filename.
150 </p><dl>
151 <dt>Returns:</dt>
152 <dd>
153 filename (string)
154 </dd>
155 </dl><a NAME="Task.getLineno" ID="Task.getLineno"></a>
156 <h4>Task.getLineno</h4>
157 <b>getLineno</b>(<i></i>)
158 <p>
159 Public method to retrieve the tasks linenumber.
160 </p><dl>
161 <dt>Returns:</dt>
162 <dd>
163 linenumber (integer)
164 </dd>
165 </dl><a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
166 <h4>Task.isCompleted</h4>
167 <b>isCompleted</b>(<i></i>)
168 <p>
169 Public slot to return the completion status.
170 </p><dl>
171 <dt>Returns:</dt>
172 <dd>
173 flag indicating the completion status (boolean)
174 </dd>
175 </dl><a NAME="Task.isProjectFileTask" ID="Task.isProjectFileTask"></a>
176 <h4>Task.isProjectFileTask</h4>
177 <b>isProjectFileTask</b>(<i></i>)
178 <p>
179 Public slot to get an indication, if this task is related to a
180 project file.
181 </p><dl>
182 <dt>Returns:</dt>
183 <dd>
184 flag indicating a project file task (boolean)
185 </dd>
186 </dl><a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
187 <h4>Task.isProjectTask</h4>
188 <b>isProjectTask</b>(<i></i>)
189 <p>
190 Public slot to return the project relation status.
191 </p><dl>
192 <dt>Returns:</dt>
193 <dd>
194 flag indicating the project relation status (boolean)
195 </dd>
196 </dl><a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
197 <h4>Task.setCompleted</h4>
198 <b>setCompleted</b>(<i>completed</i>)
199 <p>
200 Public slot to update the completed flag.
201 </p><dl>
202 <dt><i>completed</i></dt>
203 <dd>
204 flag indicating completion status (boolean)
205 </dd>
206 </dl><a NAME="Task.setDescription" ID="Task.setDescription"></a>
207 <h4>Task.setDescription</h4>
208 <b>setDescription</b>(<i>description</i>)
209 <p>
210 Public slot to update the description field.
211 </p><dl>
212 <dt><i>description</i></dt>
213 <dd>
214 descriptive text of the task (string)
215 </dd>
216 </dl><a NAME="Task.setPriority" ID="Task.setPriority"></a>
217 <h4>Task.setPriority</h4>
218 <b>setPriority</b>(<i>priority</i>)
219 <p>
220 Public slot to update the priority.
221 </p><dl>
222 <dt><i>priority</i></dt>
223 <dd>
224 priority of the task (0=high, 1=normal, 2=low)
225 </dd>
226 </dl><a NAME="Task.setProjectTask" ID="Task.setProjectTask"></a>
227 <h4>Task.setProjectTask</h4>
228 <b>setProjectTask</b>(<i>pt</i>)
229 <p>
230 Public method to set the project relation flag.
231 </p><dl>
232 <dt><i>pt</i></dt>
233 <dd>
234 flag indicating a project task (boolean)
235 </dd>
236 </dl><a NAME="Task.setSummary" ID="Task.setSummary"></a>
237 <h4>Task.setSummary</h4>
238 <b>setSummary</b>(<i>summary</i>)
239 <p>
240 Public slot to update the description.
241 </p><dl>
242 <dt><i>summary</i></dt>
243 <dd>
244 summary text of the task (string)
245 </dd>
246 </dl>
247 <div align="right"><a href="#top">Up</a></div>
248 <hr />
249 </body></html>

Mercurial Repository: eric

eric ide

mercurial