Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric5.Tasks.Task.html

changeset 1819
cfcfd617216a
child 2001
92a4e822aefe
equal deleted inserted replaced
1818:a5e4cb4bed43 1819:cfcfd617216a
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>eric5.Tasks.Task</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>eric5.Tasks.Task</h1>
24 <p>
25 Module implementing a class to store task data.
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="#Task">Task</a></td>
35 <td>Class implementing the task data structure.</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="Task" ID="Task"></a>
44 <h2>Task</h2>
45 <p>
46 Class implementing the task data structure.
47 </p>
48 <h3>Derived from</h3>
49 QTreeWidgetItem
50 <h3>Class Attributes</h3>
51 <table>
52 <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>
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="#Task.__init__">Task</a></td>
62 <td>Constructor</td>
63 </tr><tr>
64 <td><a href="#Task.colorizeTask">colorizeTask</a></td>
65 <td>Public slot to set the colors of the task item.</td>
66 </tr><tr>
67 <td><a href="#Task.getFilename">getFilename</a></td>
68 <td>Public method to retrieve the tasks filename.</td>
69 </tr><tr>
70 <td><a href="#Task.getLineno">getLineno</a></td>
71 <td>Public method to retrieve the tasks linenumber.</td>
72 </tr><tr>
73 <td><a href="#Task.isCompleted">isCompleted</a></td>
74 <td>Public slot to return the completion status.</td>
75 </tr><tr>
76 <td><a href="#Task.isProjectTask">isProjectTask</a></td>
77 <td>Public slot to return the project relation status.</td>
78 </tr><tr>
79 <td><a href="#Task.setCompleted">setCompleted</a></td>
80 <td>Public slot to update the completed flag.</td>
81 </tr><tr>
82 <td><a href="#Task.setDescription">setDescription</a></td>
83 <td>Public slot to update the description.</td>
84 </tr><tr>
85 <td><a href="#Task.setLongText">setLongText</a></td>
86 <td>Public slot to update the longtext field.</td>
87 </tr><tr>
88 <td><a href="#Task.setPriority">setPriority</a></td>
89 <td>Public slot to update the priority.</td>
90 </tr><tr>
91 <td><a href="#Task.setProjectTask">setProjectTask</a></td>
92 <td>Public method to set the project relation flag.</td>
93 </tr>
94 </table>
95 <h3>Static Methods</h3>
96 <table>
97 <tr><td>None</td></tr>
98 </table>
99 <a NAME="Task.__init__" ID="Task.__init__"></a>
100 <h4>Task (Constructor)</h4>
101 <b>Task</b>(<i>description, priority=1, filename="", lineno=0, completed=False, _time=0, isProjectTask=False, taskType=TypeTodo, project=None, longtext=""</i>)
102 <p>
103 Constructor
104 </p><dl>
105 <dt><i>parent</i></dt>
106 <dd>
107 parent widget of the task (QWidget)
108 </dd><dt><i>description</i></dt>
109 <dd>
110 descriptive text of the task (string)
111 </dd><dt><i>priority</i></dt>
112 <dd>
113 priority of the task (0=high, 1=normal, 2=low)
114 </dd><dt><i>filename</i></dt>
115 <dd>
116 filename containing the task (string)
117 </dd><dt><i>lineno</i></dt>
118 <dd>
119 line number containing the task (integer)
120 </dd><dt><i>completed</i></dt>
121 <dd>
122 flag indicating completion status (boolean)
123 </dd><dt><i>_time</i></dt>
124 <dd>
125 creation time of the task (float, if 0 use current time)
126 </dd><dt><i>isProjectTask</i></dt>
127 <dd>
128 flag indicating a task related to the current project
129 (boolean)
130 </dd><dt><i>taskType</i></dt>
131 <dd>
132 type of the task (one of TypeFixme, TypeTodo,
133 TypeWarning, TypeNote)
134 </dd><dt><i>project</i></dt>
135 <dd>
136 reference to the project object (Project)
137 </dd><dt><i>longtext</i></dt>
138 <dd>
139 explanatory text of the task (string)
140 </dd>
141 </dl><a NAME="Task.colorizeTask" ID="Task.colorizeTask"></a>
142 <h4>Task.colorizeTask</h4>
143 <b>colorizeTask</b>(<i></i>)
144 <p>
145 Public slot to set the colors of the task item.
146 </p><a NAME="Task.getFilename" ID="Task.getFilename"></a>
147 <h4>Task.getFilename</h4>
148 <b>getFilename</b>(<i></i>)
149 <p>
150 Public method to retrieve the tasks filename.
151 </p><dl>
152 <dt>Returns:</dt>
153 <dd>
154 filename (string)
155 </dd>
156 </dl><a NAME="Task.getLineno" ID="Task.getLineno"></a>
157 <h4>Task.getLineno</h4>
158 <b>getLineno</b>(<i></i>)
159 <p>
160 Public method to retrieve the tasks linenumber.
161 </p><dl>
162 <dt>Returns:</dt>
163 <dd>
164 linenumber (integer)
165 </dd>
166 </dl><a NAME="Task.isCompleted" ID="Task.isCompleted"></a>
167 <h4>Task.isCompleted</h4>
168 <b>isCompleted</b>(<i></i>)
169 <p>
170 Public slot to return the completion status.
171 </p><dl>
172 <dt>Returns:</dt>
173 <dd>
174 flag indicating the completion status (boolean)
175 </dd>
176 </dl><a NAME="Task.isProjectTask" ID="Task.isProjectTask"></a>
177 <h4>Task.isProjectTask</h4>
178 <b>isProjectTask</b>(<i></i>)
179 <p>
180 Public slot to return the project relation status.
181 </p><dl>
182 <dt>Returns:</dt>
183 <dd>
184 flag indicating the project relation status (boolean)
185 </dd>
186 </dl><a NAME="Task.setCompleted" ID="Task.setCompleted"></a>
187 <h4>Task.setCompleted</h4>
188 <b>setCompleted</b>(<i>completed</i>)
189 <p>
190 Public slot to update the completed flag.
191 </p><dl>
192 <dt><i>completed</i></dt>
193 <dd>
194 flag indicating completion status (boolean)
195 </dd>
196 </dl><a NAME="Task.setDescription" ID="Task.setDescription"></a>
197 <h4>Task.setDescription</h4>
198 <b>setDescription</b>(<i>description</i>)
199 <p>
200 Public slot to update the description.
201 </p><dl>
202 <dt><i>longtext</i></dt>
203 <dd>
204 explanatory text of the task (string)
205 </dd>
206 </dl><a NAME="Task.setLongText" ID="Task.setLongText"></a>
207 <h4>Task.setLongText</h4>
208 <b>setLongText</b>(<i>longtext</i>)
209 <p>
210 Public slot to update the longtext field.
211 </p><dl>
212 <dt><i>longtext</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>
237 <div align="right"><a href="#top">Up</a></div>
238 <hr />
239 </body></html>

Mercurial Repository: eric

eric ide

mercurial