Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Tasks.TaskFilter.html
Documentation/Source/eric5.Tasks.TaskFilter.html
- changeset 1819
- cfcfd617216a
- child 2197
- c4f24f8f34c0
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.TaskFilter</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.TaskFilter</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="#TaskFilter">TaskFilter</a></td> | |
| 35 <td>Class implementing a filter for tasks.</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="TaskFilter" ID="TaskFilter"></a> | |
| 44 <h2>TaskFilter</h2> | |
| 45 <p> | |
| 46 Class implementing a filter for tasks. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 object | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</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="#TaskFilter.__init__">TaskFilter</a></td> | |
| 62 <td>Constructor</td> | |
| 63 </tr><tr> | |
| 64 <td><a href="#TaskFilter.hasActiveFilter">hasActiveFilter</a></td> | |
| 65 <td>Public method to check for active filters.</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#TaskFilter.setActive">setActive</a></td> | |
| 68 <td>Public method to activate the filter.</td> | |
| 69 </tr><tr> | |
| 70 <td><a href="#TaskFilter.setDescriptionFilter">setDescriptionFilter</a></td> | |
| 71 <td>Public method to set the description filter.</td> | |
| 72 </tr><tr> | |
| 73 <td><a href="#TaskFilter.setFileNameFilter">setFileNameFilter</a></td> | |
| 74 <td>Public method to set the filename filter.</td> | |
| 75 </tr><tr> | |
| 76 <td><a href="#TaskFilter.setPrioritiesFilter">setPrioritiesFilter</a></td> | |
| 77 <td>Public method to set the priorities filter.</td> | |
| 78 </tr><tr> | |
| 79 <td><a href="#TaskFilter.setScopeFilter">setScopeFilter</a></td> | |
| 80 <td>Public method to set the scope filter.</td> | |
| 81 </tr><tr> | |
| 82 <td><a href="#TaskFilter.setStatusFilter">setStatusFilter</a></td> | |
| 83 <td>Public method to set the status filter.</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#TaskFilter.setTypeFilter">setTypeFilter</a></td> | |
| 86 <td>Public method to set the type filter.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#TaskFilter.showTask">showTask</a></td> | |
| 89 <td>Public method to check, if a task should be shown.</td> | |
| 90 </tr> | |
| 91 </table> | |
| 92 <h3>Static Methods</h3> | |
| 93 <table> | |
| 94 <tr><td>None</td></tr> | |
| 95 </table> | |
| 96 <a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a> | |
| 97 <h4>TaskFilter (Constructor)</h4> | |
| 98 <b>TaskFilter</b>(<i></i>) | |
| 99 <p> | |
| 100 Constructor | |
| 101 </p><a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a> | |
| 102 <h4>TaskFilter.hasActiveFilter</h4> | |
| 103 <b>hasActiveFilter</b>(<i></i>) | |
| 104 <p> | |
| 105 Public method to check for active filters. | |
| 106 </p><dl> | |
| 107 <dt>Returns:</dt> | |
| 108 <dd> | |
| 109 flag indicating an active filter was found (boolean) | |
| 110 </dd> | |
| 111 </dl><a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a> | |
| 112 <h4>TaskFilter.setActive</h4> | |
| 113 <b>setActive</b>(<i>enabled</i>) | |
| 114 <p> | |
| 115 Public method to activate the filter. | |
| 116 </p><dl> | |
| 117 <dt><i>enabled</i></dt> | |
| 118 <dd> | |
| 119 flag indicating the activation state (boolean) | |
| 120 </dd> | |
| 121 </dl><a NAME="TaskFilter.setDescriptionFilter" ID="TaskFilter.setDescriptionFilter"></a> | |
| 122 <h4>TaskFilter.setDescriptionFilter</h4> | |
| 123 <b>setDescriptionFilter</b>(<i>filter</i>) | |
| 124 <p> | |
| 125 Public method to set the description filter. | |
| 126 </p><dl> | |
| 127 <dt><i>filter</i></dt> | |
| 128 <dd> | |
| 129 a regular expression for the description filter | |
| 130 to set (string) or None | |
| 131 </dd> | |
| 132 </dl><a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a> | |
| 133 <h4>TaskFilter.setFileNameFilter</h4> | |
| 134 <b>setFileNameFilter</b>(<i>filter</i>) | |
| 135 <p> | |
| 136 Public method to set the filename filter. | |
| 137 </p><dl> | |
| 138 <dt><i>filter</i></dt> | |
| 139 <dd> | |
| 140 a wildcard expression for the filename filter | |
| 141 to set (string) or None | |
| 142 </dd> | |
| 143 </dl><a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a> | |
| 144 <h4>TaskFilter.setPrioritiesFilter</h4> | |
| 145 <b>setPrioritiesFilter</b>(<i>priorities</i>) | |
| 146 <p> | |
| 147 Public method to set the priorities filter. | |
| 148 </p><dl> | |
| 149 <dt><i>priorities</i></dt> | |
| 150 <dd> | |
| 151 list of task priorities (list of integer) or None | |
| 152 </dd> | |
| 153 </dl><a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a> | |
| 154 <h4>TaskFilter.setScopeFilter</h4> | |
| 155 <b>setScopeFilter</b>(<i>scope</i>) | |
| 156 <p> | |
| 157 Public method to set the scope filter. | |
| 158 </p><dl> | |
| 159 <dt><i>scope</i></dt> | |
| 160 <dd> | |
| 161 flag indicating a project task (boolean) or None | |
| 162 </dd> | |
| 163 </dl><a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a> | |
| 164 <h4>TaskFilter.setStatusFilter</h4> | |
| 165 <b>setStatusFilter</b>(<i>status</i>) | |
| 166 <p> | |
| 167 Public method to set the status filter. | |
| 168 </p><dl> | |
| 169 <dt><i>status</i></dt> | |
| 170 <dd> | |
| 171 flag indicating a completed task (boolean) or None | |
| 172 </dd> | |
| 173 </dl><a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a> | |
| 174 <h4>TaskFilter.setTypeFilter</h4> | |
| 175 <b>setTypeFilter</b>(<i>taskType</i>) | |
| 176 <p> | |
| 177 Public method to set the type filter. | |
| 178 </p><dl> | |
| 179 <dt><i>taskType</i></dt> | |
| 180 <dd> | |
| 181 type of the task (one of Task.TypeNone, Task.TypeFixme, | |
| 182 Task.TypeTodo, Task.TypeWarning, Task.TypeNote) | |
| 183 </dd> | |
| 184 </dl><a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a> | |
| 185 <h4>TaskFilter.showTask</h4> | |
| 186 <b>showTask</b>(<i>task</i>) | |
| 187 <p> | |
| 188 Public method to check, if a task should be shown. | |
| 189 </p><dl> | |
| 190 <dt><i>task</i></dt> | |
| 191 <dd> | |
| 192 reference to the task object to check (Task) | |
| 193 </dd> | |
| 194 </dl><dl> | |
| 195 <dt>Returns:</dt> | |
| 196 <dd> | |
| 197 flag indicating whether the task should be shown (boolean) | |
| 198 </dd> | |
| 199 </dl> | |
| 200 <div align="right"><a href="#top">Up</a></div> | |
| 201 <hr /> | |
| 202 </body></html> |
