Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.Tasks.TaskFilter.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Tasks.TaskFilter</h1> 23 <h1>eric6.Tasks.TaskFilter</h1>
24
23 <p> 25 <p>
24 Module implementing a class to store task data. 26 Module implementing a class to store task data.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#TaskFilter">TaskFilter</a></td> 38 <td><a href="#TaskFilter">TaskFilter</a></td>
34 <td>Class implementing a filter for tasks.</td> 39 <td>Class implementing a filter for tasks.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
39 <tr><td>None</td></tr> 44 <table>
40 </table> 45 <tr><td>None</td></tr>
41 <hr /><hr /> 46 </table>
47 <hr />
48 <hr />
42 <a NAME="TaskFilter" ID="TaskFilter"></a> 49 <a NAME="TaskFilter" ID="TaskFilter"></a>
43 <h2>TaskFilter</h2> 50 <h2>TaskFilter</h2>
51
44 <p> 52 <p>
45 Class implementing a filter for tasks. 53 Class implementing a filter for tasks.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 object 56 object
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
58 <table> 68
69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#TaskFilter.__init__">TaskFilter</a></td> 72 <td><a href="#TaskFilter.__init__">TaskFilter</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#TaskFilter.hasActiveFilter">hasActiveFilter</a></td> 76 <td><a href="#TaskFilter.hasActiveFilter">hasActiveFilter</a></td>
64 <td>Public method to check for active filters.</td> 77 <td>Public method to check for active filters.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#TaskFilter.setActive">setActive</a></td> 80 <td><a href="#TaskFilter.setActive">setActive</a></td>
67 <td>Public method to activate the filter.</td> 81 <td>Public method to activate the filter.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#TaskFilter.setFileNameFilter">setFileNameFilter</a></td> 84 <td><a href="#TaskFilter.setFileNameFilter">setFileNameFilter</a></td>
70 <td>Public method to set the filename filter.</td> 85 <td>Public method to set the filename filter.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#TaskFilter.setPrioritiesFilter">setPrioritiesFilter</a></td> 88 <td><a href="#TaskFilter.setPrioritiesFilter">setPrioritiesFilter</a></td>
73 <td>Public method to set the priorities filter.</td> 89 <td>Public method to set the priorities filter.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#TaskFilter.setScopeFilter">setScopeFilter</a></td> 92 <td><a href="#TaskFilter.setScopeFilter">setScopeFilter</a></td>
76 <td>Public method to set the scope filter.</td> 93 <td>Public method to set the scope filter.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#TaskFilter.setStatusFilter">setStatusFilter</a></td> 96 <td><a href="#TaskFilter.setStatusFilter">setStatusFilter</a></td>
79 <td>Public method to set the status filter.</td> 97 <td>Public method to set the status filter.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#TaskFilter.setSummaryFilter">setSummaryFilter</a></td> 100 <td><a href="#TaskFilter.setSummaryFilter">setSummaryFilter</a></td>
82 <td>Public method to set the description filter.</td> 101 <td>Public method to set the description filter.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#TaskFilter.setTypeFilter">setTypeFilter</a></td> 104 <td><a href="#TaskFilter.setTypeFilter">setTypeFilter</a></td>
85 <td>Public method to set the type filter.</td> 105 <td>Public method to set the type filter.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#TaskFilter.showTask">showTask</a></td> 108 <td><a href="#TaskFilter.showTask">showTask</a></td>
88 <td>Public method to check, if a task should be shown.</td> 109 <td>Public method to check, if a task should be shown.</td>
89 </tr> 110 </tr>
90 </table> 111 </table>
91 <h3>Static Methods</h3> 112 <h3>Static Methods</h3>
92 <table> 113
93 <tr><td>None</td></tr> 114 <table>
94 </table> 115 <tr><td>None</td></tr>
116 </table>
117
95 <a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a> 118 <a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a>
96 <h4>TaskFilter (Constructor)</h4> 119 <h4>TaskFilter (Constructor)</h4>
97 <b>TaskFilter</b>(<i></i>) 120 <b>TaskFilter</b>(<i></i>)
121
98 <p> 122 <p>
99 Constructor 123 Constructor
100 </p><a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a> 124 </p>
125 <a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a>
101 <h4>TaskFilter.hasActiveFilter</h4> 126 <h4>TaskFilter.hasActiveFilter</h4>
102 <b>hasActiveFilter</b>(<i></i>) 127 <b>hasActiveFilter</b>(<i></i>)
128
103 <p> 129 <p>
104 Public method to check for active filters. 130 Public method to check for active filters.
105 </p><dl> 131 </p>
132 <dl>
106 <dt>Returns:</dt> 133 <dt>Returns:</dt>
107 <dd> 134 <dd>
108 flag indicating an active filter was found (boolean) 135 flag indicating an active filter was found (boolean)
109 </dd> 136 </dd>
110 </dl><a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a> 137 </dl>
138 <a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a>
111 <h4>TaskFilter.setActive</h4> 139 <h4>TaskFilter.setActive</h4>
112 <b>setActive</b>(<i>enabled</i>) 140 <b>setActive</b>(<i>enabled</i>)
141
113 <p> 142 <p>
114 Public method to activate the filter. 143 Public method to activate the filter.
115 </p><dl> 144 </p>
145 <dl>
146
116 <dt><i>enabled</i></dt> 147 <dt><i>enabled</i></dt>
117 <dd> 148 <dd>
118 flag indicating the activation state (boolean) 149 flag indicating the activation state (boolean)
119 </dd> 150 </dd>
120 </dl><a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a> 151 </dl>
152 <a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a>
121 <h4>TaskFilter.setFileNameFilter</h4> 153 <h4>TaskFilter.setFileNameFilter</h4>
122 <b>setFileNameFilter</b>(<i>filterStr</i>) 154 <b>setFileNameFilter</b>(<i>filterStr</i>)
155
123 <p> 156 <p>
124 Public method to set the filename filter. 157 Public method to set the filename filter.
125 </p><dl> 158 </p>
159 <dl>
160
126 <dt><i>filterStr</i></dt> 161 <dt><i>filterStr</i></dt>
127 <dd> 162 <dd>
128 a wildcard expression for the filename filter 163 a wildcard expression for the filename filter
129 to set (string) or None 164 to set (string) or None
130 </dd> 165 </dd>
131 </dl><a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a> 166 </dl>
167 <a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a>
132 <h4>TaskFilter.setPrioritiesFilter</h4> 168 <h4>TaskFilter.setPrioritiesFilter</h4>
133 <b>setPrioritiesFilter</b>(<i>priorities</i>) 169 <b>setPrioritiesFilter</b>(<i>priorities</i>)
170
134 <p> 171 <p>
135 Public method to set the priorities filter. 172 Public method to set the priorities filter.
136 </p><dl> 173 </p>
174 <dl>
175
137 <dt><i>priorities</i></dt> 176 <dt><i>priorities</i></dt>
138 <dd> 177 <dd>
139 list of task priorities (list of integer) or None 178 list of task priorities (list of integer) or None
140 </dd> 179 </dd>
141 </dl><a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a> 180 </dl>
181 <a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a>
142 <h4>TaskFilter.setScopeFilter</h4> 182 <h4>TaskFilter.setScopeFilter</h4>
143 <b>setScopeFilter</b>(<i>scope</i>) 183 <b>setScopeFilter</b>(<i>scope</i>)
184
144 <p> 185 <p>
145 Public method to set the scope filter. 186 Public method to set the scope filter.
146 </p><dl> 187 </p>
188 <dl>
189
147 <dt><i>scope</i></dt> 190 <dt><i>scope</i></dt>
148 <dd> 191 <dd>
149 flag indicating a project task (boolean) or None 192 flag indicating a project task (boolean) or None
150 </dd> 193 </dd>
151 </dl><a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a> 194 </dl>
195 <a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a>
152 <h4>TaskFilter.setStatusFilter</h4> 196 <h4>TaskFilter.setStatusFilter</h4>
153 <b>setStatusFilter</b>(<i>status</i>) 197 <b>setStatusFilter</b>(<i>status</i>)
198
154 <p> 199 <p>
155 Public method to set the status filter. 200 Public method to set the status filter.
156 </p><dl> 201 </p>
202 <dl>
203
157 <dt><i>status</i></dt> 204 <dt><i>status</i></dt>
158 <dd> 205 <dd>
159 flag indicating a completed task (boolean) or None 206 flag indicating a completed task (boolean) or None
160 </dd> 207 </dd>
161 </dl><a NAME="TaskFilter.setSummaryFilter" ID="TaskFilter.setSummaryFilter"></a> 208 </dl>
209 <a NAME="TaskFilter.setSummaryFilter" ID="TaskFilter.setSummaryFilter"></a>
162 <h4>TaskFilter.setSummaryFilter</h4> 210 <h4>TaskFilter.setSummaryFilter</h4>
163 <b>setSummaryFilter</b>(<i>filterStr</i>) 211 <b>setSummaryFilter</b>(<i>filterStr</i>)
212
164 <p> 213 <p>
165 Public method to set the description filter. 214 Public method to set the description filter.
166 </p><dl> 215 </p>
216 <dl>
217
167 <dt><i>filterStr</i></dt> 218 <dt><i>filterStr</i></dt>
168 <dd> 219 <dd>
169 a regular expression for the description filter 220 a regular expression for the description filter
170 to set (string) or None 221 to set (string) or None
171 </dd> 222 </dd>
172 </dl><a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a> 223 </dl>
224 <a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a>
173 <h4>TaskFilter.setTypeFilter</h4> 225 <h4>TaskFilter.setTypeFilter</h4>
174 <b>setTypeFilter</b>(<i>taskType</i>) 226 <b>setTypeFilter</b>(<i>taskType</i>)
227
175 <p> 228 <p>
176 Public method to set the type filter. 229 Public method to set the type filter.
177 </p><dl> 230 </p>
231 <dl>
232
178 <dt><i>taskType</i></dt> 233 <dt><i>taskType</i></dt>
179 <dd> 234 <dd>
180 type of the task (one of Task.TypeNone, Task.TypeFixme, 235 type of the task (one of Task.TypeNone, Task.TypeFixme,
181 Task.TypeTodo, Task.TypeWarning, Task.TypeNote) 236 Task.TypeTodo, Task.TypeWarning, Task.TypeNote)
182 </dd> 237 </dd>
183 </dl><a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a> 238 </dl>
239 <a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a>
184 <h4>TaskFilter.showTask</h4> 240 <h4>TaskFilter.showTask</h4>
185 <b>showTask</b>(<i>task</i>) 241 <b>showTask</b>(<i>task</i>)
242
186 <p> 243 <p>
187 Public method to check, if a task should be shown. 244 Public method to check, if a task should be shown.
188 </p><dl> 245 </p>
246 <dl>
247
189 <dt><i>task</i></dt> 248 <dt><i>task</i></dt>
190 <dd> 249 <dd>
191 reference to the task object to check (Task) 250 reference to the task object to check (Task)
192 </dd> 251 </dd>
193 </dl><dl> 252 </dl>
253 <dl>
194 <dt>Returns:</dt> 254 <dt>Returns:</dt>
195 <dd> 255 <dd>
196 flag indicating whether the task should be shown (boolean) 256 flag indicating whether the task should be shown (boolean)
197 </dd> 257 </dd>
198 </dl> 258 </dl>

Mercurial Repository: eric

eric ide

mercurial