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