Documentation/Source/eric5.Tasks.TaskFilter.html

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Tasks.TaskFilter</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Tasks.TaskFilter</h1>
<p>
Module implementing a class to store task data.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#TaskFilter">TaskFilter</a></td>
<td>Class implementing a filter for tasks.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="TaskFilter" ID="TaskFilter"></a>
<h2>TaskFilter</h2>
<p>
    Class implementing a filter for tasks.
</p>
<h3>Derived from</h3>
object
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#TaskFilter.__init__">TaskFilter</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#TaskFilter.hasActiveFilter">hasActiveFilter</a></td>
<td>Public method to check for active filters.</td>
</tr><tr>
<td><a href="#TaskFilter.setActive">setActive</a></td>
<td>Public method to activate the filter.</td>
</tr><tr>
<td><a href="#TaskFilter.setDescriptionFilter">setDescriptionFilter</a></td>
<td>Public method to set the description filter.</td>
</tr><tr>
<td><a href="#TaskFilter.setFileNameFilter">setFileNameFilter</a></td>
<td>Public method to set the filename filter.</td>
</tr><tr>
<td><a href="#TaskFilter.setPrioritiesFilter">setPrioritiesFilter</a></td>
<td>Public method to set the priorities filter.</td>
</tr><tr>
<td><a href="#TaskFilter.setScopeFilter">setScopeFilter</a></td>
<td>Public method to set the scope filter.</td>
</tr><tr>
<td><a href="#TaskFilter.setStatusFilter">setStatusFilter</a></td>
<td>Public method to set the status filter.</td>
</tr><tr>
<td><a href="#TaskFilter.setTypeFilter">setTypeFilter</a></td>
<td>Public method to set the type filter.</td>
</tr><tr>
<td><a href="#TaskFilter.showTask">showTask</a></td>
<td>Public method to check, if a task should be shown.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="TaskFilter.__init__" ID="TaskFilter.__init__"></a>
<h4>TaskFilter (Constructor)</h4>
<b>TaskFilter</b>(<i></i>)
<p>
        Constructor
</p><a NAME="TaskFilter.hasActiveFilter" ID="TaskFilter.hasActiveFilter"></a>
<h4>TaskFilter.hasActiveFilter</h4>
<b>hasActiveFilter</b>(<i></i>)
<p>
        Public method to check for active filters.
</p><dl>
<dt>Returns:</dt>
<dd>
flag indicating an active filter was found (boolean)
</dd>
</dl><a NAME="TaskFilter.setActive" ID="TaskFilter.setActive"></a>
<h4>TaskFilter.setActive</h4>
<b>setActive</b>(<i>enabled</i>)
<p>
        Public method to activate the filter.
</p><dl>
<dt><i>enabled</i></dt>
<dd>
flag indicating the activation state (boolean)
</dd>
</dl><a NAME="TaskFilter.setDescriptionFilter" ID="TaskFilter.setDescriptionFilter"></a>
<h4>TaskFilter.setDescriptionFilter</h4>
<b>setDescriptionFilter</b>(<i>filter</i>)
<p>
        Public method to set the description filter.
</p><dl>
<dt><i>filter</i></dt>
<dd>
a regular expression for the description filter
            to set (string) or None
</dd>
</dl><a NAME="TaskFilter.setFileNameFilter" ID="TaskFilter.setFileNameFilter"></a>
<h4>TaskFilter.setFileNameFilter</h4>
<b>setFileNameFilter</b>(<i>filter</i>)
<p>
        Public method to set the filename filter.
</p><dl>
<dt><i>filter</i></dt>
<dd>
a wildcard expression for the filename filter
            to set (string) or None
</dd>
</dl><a NAME="TaskFilter.setPrioritiesFilter" ID="TaskFilter.setPrioritiesFilter"></a>
<h4>TaskFilter.setPrioritiesFilter</h4>
<b>setPrioritiesFilter</b>(<i>priorities</i>)
<p>
        Public method to set the priorities filter.
</p><dl>
<dt><i>priorities</i></dt>
<dd>
list of task priorities (list of integer) or None
</dd>
</dl><a NAME="TaskFilter.setScopeFilter" ID="TaskFilter.setScopeFilter"></a>
<h4>TaskFilter.setScopeFilter</h4>
<b>setScopeFilter</b>(<i>scope</i>)
<p>
        Public method to set the scope filter.
</p><dl>
<dt><i>scope</i></dt>
<dd>
flag indicating a project task (boolean) or None
</dd>
</dl><a NAME="TaskFilter.setStatusFilter" ID="TaskFilter.setStatusFilter"></a>
<h4>TaskFilter.setStatusFilter</h4>
<b>setStatusFilter</b>(<i>status</i>)
<p>
        Public method to set the status filter.
</p><dl>
<dt><i>status</i></dt>
<dd>
flag indicating a completed task (boolean) or None
</dd>
</dl><a NAME="TaskFilter.setTypeFilter" ID="TaskFilter.setTypeFilter"></a>
<h4>TaskFilter.setTypeFilter</h4>
<b>setTypeFilter</b>(<i>taskType</i>)
<p>
        Public method to set the type filter.
</p><dl>
<dt><i>taskType</i></dt>
<dd>
type of the task (one of Task.TypeNone, Task.TypeFixme,
            Task.TypeTodo, Task.TypeWarning, Task.TypeNote)
</dd>
</dl><a NAME="TaskFilter.showTask" ID="TaskFilter.showTask"></a>
<h4>TaskFilter.showTask</h4>
<b>showTask</b>(<i>task</i>)
<p>
        Public method to check, if a task should be shown.
</p><dl>
<dt><i>task</i></dt>
<dd>
reference to the task object to check (Task)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating whether the task should be shown (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>