1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Camelot.camelot.view.filters.Filter</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package Camelot ::
<a href="Camelot.camelot-module.html">Package camelot</a> ::
<a href="Camelot.camelot.view-module.html">Package view</a> ::
<a href="Camelot.camelot.view.filters-module.html">Module filters</a> ::
Class Filter
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Camelot.camelot.view.filters.Filter-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Filter</h1><p class="nomargin-top"><span class="codelink"><a href="Camelot.camelot.view.filters-pysrc.html#Filter">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_camelot__225" name="uml_class_diagram_for_camelot__225">
<area shape="rect" href="Camelot.camelot.view.filters.ComboBoxFilter-class.html" title="Filter where the items are displayed in a QComboBox" alt="" coords="16,123,123,149"/>
<area shape="rect" href="Camelot.camelot.view.filters.GroupBoxFilter-class.html" title="Filter where the items are displayed in a QGroupBox" alt="" coords="173,123,275,149"/>
<area shape="rect" href="Camelot.camelot.view.filters.Filter-class.html#__init__" title="@param attribute: the attribute on which to filter, this attribute may contain dots to indicate relationships that need to be followed, eg.  'person.groups.name' @param value_to_string: function that converts a value of the attribute to a string that will be displayed in the filter" alt="" coords="75,36,512,55"/>
<area shape="rect" href="Camelot.camelot.view.filters.Filter-class.html#render" title="Render this filter as a qt object @param parent: its parent widget @param name: the name of the filter @param options: the options that can be selected, where each option is a list of tuples containting (option_name, query_decorator)" alt="" coords="75,55,512,73"/>
<area shape="rect" href="Camelot.camelot.view.filters.Filter-class.html#get_name_and_options" title="return a tuple of the name of the filter and a list of options that can be selected. Each option is a tuple of the name of the option, and a filter function to decorate a query @return:  (filter_name, [(option_name, query_decorator), ...)" alt="" coords="75,73,512,92"/>
<area shape="rect" href="Camelot.camelot.view.filters.Filter-class.html" title="Base class for filters" alt="" coords="73,11,513,93"/>
<area shape="rect" href="Camelot.camelot.view.filters.EditorFilter-class.html" title="Filter that presents the user with an editor, allowing the user to enter a value on which to filter, and at the same time to show 'All' or 'None'" alt="" coords="325,123,403,149"/>
<area shape="rect" href="Camelot.camelot.view.filters.ValidDateFilter-class.html" title="Filters entities that are valid a certain date. This filter will present a date to the user and filter the entities that have their from date before this date and their end date after this date. If no date is given, all entities will be shown" alt="" coords="453,123,552,149"/>
</map>
<img src="uml_class_diagram_for_camelot__225.gif" alt='' usemap="#uml_class_diagram_for_camelot__225" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
Base class for filters
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.filters.Filter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">attribute</span>,
<span class="summary-sig-arg">value_to_string</span>=<span class="summary-sig-default"><function <lambda> at 0xb95f614></span>)</span><br />
@param attribute: the attribute on which to filter, this attribute
may contain dots to indicate relationships that need to be followed,
eg. 'person.groups.name'
@param value_to_string: function that converts a value of the attribute to
a string that will be displayed in the filter</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.filters-pysrc.html#Filter.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Camelot.camelot.view.filters.Filter-class.html#render" class="summary-sig-name">render</a>(<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Render this filter as a qt object
@param parent: its parent widget
@param name: the name of the filter
@param options: the options that can be selected, where each option is a list
of tuples containting (option_name, query_decorator)</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.filters-pysrc.html#Filter.render">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_name_and_options"></a><span class="summary-sig-name">get_name_and_options</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">admin</span>)</span><br />
return a tuple of the name of the filter and a list of options that can be selected.
Each option is a tuple of the name of the option, and a filter function to
decorate a query
@return: (filter_name, [(option_name, query_decorator), ...)</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.view.filters-pysrc.html#Filter.get_name_and_options">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">attribute</span>,
<span class="sig-arg">value_to_string</span>=<span class="sig-default"><function <lambda> at 0xb95f614></span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.filters-pysrc.html#Filter.__init__">source code</a></span>
</td>
</tr></table>
@param attribute: the attribute on which to filter, this attribute
may contain dots to indicate relationships that need to be followed,
eg. 'person.groups.name'
@param value_to_string: function that converts a value of the attribute to
a string that will be displayed in the filter
<dl class="fields">
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="render"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">render</span>(<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.view.filters-pysrc.html#Filter.render">source code</a></span>
</td>
</tr></table>
<p>Render this filter as a qt object
@param parent: its parent widget
@param name: the name of the filter
@param options: the options that can be selected, where each option is a list
of tuples containting (option_name, query_decorator)</p>
<p>The name and the list of options can be fetched with get_name_and_options</p>
<dl class="fields">
<dt>Decorators:</dt>
<dd><ul class="nomargin-top">
<li><code>@gui_function</code></li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sat Jun 12 15:41:54 2010
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|