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