Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Tasks.TaskFilter.html

src/eric7/Documentation/Source/eric7.Tasks.TaskFilter.html

branch
eric7
changeset 10479
856476537696
parent 10431
64157aeb0312
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Tasks.TaskFilter</h1> 9 <h1>eric7.Tasks.TaskFilter</h1>
10
11 <p> 10 <p>
12 Module implementing a class to store task data. 11 Module implementing a class to store task data.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#TaskFilter">TaskFilter</a></td> 22 <td><a href="#TaskFilter">TaskFilter</a></td>
25 <td>Class implementing a filter for tasks.</td> 23 <td>Class implementing a filter for tasks.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="TaskFilter" ID="TaskFilter"></a> 34 <a NAME="TaskFilter" ID="TaskFilter"></a>
36 <h2>TaskFilter</h2> 35 <h2>TaskFilter</h2>
37
38 <p> 36 <p>
39 Class implementing a filter for tasks. 37 Class implementing a filter for tasks.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 None 41 None
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#TaskFilter.__init__">TaskFilter</a></td> 55 <td><a href="#TaskFilter.__init__">TaskFilter</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
93 <tr> 90 <tr>
94 <td><a href="#TaskFilter.showTask">showTask</a></td> 91 <td><a href="#TaskFilter.showTask">showTask</a></td>
95 <td>Public method to check, if a task should be shown.</td> 92 <td>Public method to check, if a task should be shown.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a> 102 <a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a>
105 <h4>TaskFilter (Constructor)</h4> 103 <h4>TaskFilter (Constructor)</h4>
106 <b>TaskFilter</b>(<i></i>) 104 <b>TaskFilter</b>(<i></i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a> 109 <a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a>
112 <h4>TaskFilter.hasActiveFilter</h4> 110 <h4>TaskFilter.hasActiveFilter</h4>
113 <b>hasActiveFilter</b>(<i></i>) 111 <b>hasActiveFilter</b>(<i></i>)
114
115 <p> 112 <p>
116 Public method to check for active filters. 113 Public method to check for active filters.
117 </p> 114 </p>
115
118 <dl> 116 <dl>
119 <dt>Return:</dt> 117 <dt>Return:</dt>
120 <dd> 118 <dd>
121 flag indicating an active filter was found 119 flag indicating an active filter was found
122 </dd> 120 </dd>
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a> 128 <a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a>
131 <h4>TaskFilter.setActive</h4> 129 <h4>TaskFilter.setActive</h4>
132 <b>setActive</b>(<i>enabled</i>) 130 <b>setActive</b>(<i>enabled</i>)
133
134 <p> 131 <p>
135 Public method to activate the filter. 132 Public method to activate the filter.
136 </p> 133 </p>
134
137 <dl> 135 <dl>
138 136
139 <dt><i>enabled</i> (bool)</dt> 137 <dt><i>enabled</i> (bool)</dt>
140 <dd> 138 <dd>
141 flag indicating the activation state 139 flag indicating the activation state
142 </dd> 140 </dd>
143 </dl> 141 </dl>
144 <a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a> 142 <a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a>
145 <h4>TaskFilter.setFileNameFilter</h4> 143 <h4>TaskFilter.setFileNameFilter</h4>
146 <b>setFileNameFilter</b>(<i>filterStr</i>) 144 <b>setFileNameFilter</b>(<i>filterStr</i>)
147
148 <p> 145 <p>
149 Public method to set the filename filter. 146 Public method to set the filename filter.
150 </p> 147 </p>
148
151 <dl> 149 <dl>
152 150
153 <dt><i>filterStr</i> (str)</dt> 151 <dt><i>filterStr</i> (str)</dt>
154 <dd> 152 <dd>
155 a wildcard expression for the filename filter to set 153 a wildcard expression for the filename filter to set
156 </dd> 154 </dd>
157 </dl> 155 </dl>
158 <a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a> 156 <a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a>
159 <h4>TaskFilter.setPrioritiesFilter</h4> 157 <h4>TaskFilter.setPrioritiesFilter</h4>
160 <b>setPrioritiesFilter</b>(<i>priorities</i>) 158 <b>setPrioritiesFilter</b>(<i>priorities</i>)
161
162 <p> 159 <p>
163 Public method to set the priorities filter. 160 Public method to set the priorities filter.
164 </p> 161 </p>
162
165 <dl> 163 <dl>
166 164
167 <dt><i>priorities</i> (list of TaskPriority or None)</dt> 165 <dt><i>priorities</i> (list of TaskPriority or None)</dt>
168 <dd> 166 <dd>
169 list of task priorities or None 167 list of task priorities or None
170 </dd> 168 </dd>
171 </dl> 169 </dl>
172 <a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a> 170 <a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a>
173 <h4>TaskFilter.setScopeFilter</h4> 171 <h4>TaskFilter.setScopeFilter</h4>
174 <b>setScopeFilter</b>(<i>scope</i>) 172 <b>setScopeFilter</b>(<i>scope</i>)
175
176 <p> 173 <p>
177 Public method to set the scope filter. 174 Public method to set the scope filter.
178 </p> 175 </p>
176
179 <dl> 177 <dl>
180 178
181 <dt><i>scope</i> (bool)</dt> 179 <dt><i>scope</i> (bool)</dt>
182 <dd> 180 <dd>
183 flag indicating a project task 181 flag indicating a project task
184 </dd> 182 </dd>
185 </dl> 183 </dl>
186 <a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a> 184 <a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a>
187 <h4>TaskFilter.setStatusFilter</h4> 185 <h4>TaskFilter.setStatusFilter</h4>
188 <b>setStatusFilter</b>(<i>status</i>) 186 <b>setStatusFilter</b>(<i>status</i>)
189
190 <p> 187 <p>
191 Public method to set the status filter. 188 Public method to set the status filter.
192 </p> 189 </p>
190
193 <dl> 191 <dl>
194 192
195 <dt><i>status</i> (bool)</dt> 193 <dt><i>status</i> (bool)</dt>
196 <dd> 194 <dd>
197 flag indicating a completed task 195 flag indicating a completed task
198 </dd> 196 </dd>
199 </dl> 197 </dl>
200 <a NAME="TaskFilter.setSummaryFilter" ID="TaskFilter.setSummaryFilter"></a> 198 <a NAME="TaskFilter.setSummaryFilter" ID="TaskFilter.setSummaryFilter"></a>
201 <h4>TaskFilter.setSummaryFilter</h4> 199 <h4>TaskFilter.setSummaryFilter</h4>
202 <b>setSummaryFilter</b>(<i>filterStr</i>) 200 <b>setSummaryFilter</b>(<i>filterStr</i>)
203
204 <p> 201 <p>
205 Public method to set the description filter. 202 Public method to set the description filter.
206 </p> 203 </p>
204
207 <dl> 205 <dl>
208 206
209 <dt><i>filterStr</i> (str)</dt> 207 <dt><i>filterStr</i> (str)</dt>
210 <dd> 208 <dd>
211 a regular expression for the description filter to set 209 a regular expression for the description filter to set
212 </dd> 210 </dd>
213 </dl> 211 </dl>
214 <a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a> 212 <a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a>
215 <h4>TaskFilter.setTypeFilter</h4> 213 <h4>TaskFilter.setTypeFilter</h4>
216 <b>setTypeFilter</b>(<i>taskType</i>) 214 <b>setTypeFilter</b>(<i>taskType</i>)
217
218 <p> 215 <p>
219 Public method to set the type filter. 216 Public method to set the type filter.
220 </p> 217 </p>
218
221 <dl> 219 <dl>
222 220
223 <dt><i>taskType</i> (TaskType)</dt> 221 <dt><i>taskType</i> (TaskType)</dt>
224 <dd> 222 <dd>
225 type of the task 223 type of the task
226 </dd> 224 </dd>
227 </dl> 225 </dl>
228 <a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a> 226 <a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a>
229 <h4>TaskFilter.showTask</h4> 227 <h4>TaskFilter.showTask</h4>
230 <b>showTask</b>(<i>task</i>) 228 <b>showTask</b>(<i>task</i>)
231
232 <p> 229 <p>
233 Public method to check, if a task should be shown. 230 Public method to check, if a task should be shown.
234 </p> 231 </p>
232
235 <dl> 233 <dl>
236 234
237 <dt><i>task</i> (Task)</dt> 235 <dt><i>task</i> (Task)</dt>
238 <dd> 236 <dd>
239 reference to the task object to check 237 reference to the task object to check

Mercurial Repository: eric

eric ide

mercurial