Changes between Version 45 and Version 46 of S3/FilterForms

Timestamp:

04/02/13 09:50:26 (13 years ago)

Author:

Dominic König

Comment:

--

S3/FilterForms

@@ -82 +82 @@
 
 {{{#!python
-instance = S3OptionsFilter(field, _class="class", _name="name", options=None, represent=None, widget=None, comment=None)
-}}}
-
-Parameters:
-
-  - '''field''' is a field selector (or a list of field selectors) for the field(s) to filter by
-
-Options:
-
-  - '''options''' is a dict {value:label} of options for the widget, or a callable that returns such a dict
-  - '''represent''' is a callable to render a label for each option
-  - '''widget''' selects the widget, either "groupedopts" (S3 grouped checkboxes, default) or "multiselect" (jQuery UI Multiselect-Dropdown by Eric Hynds) or "multiselect-bootstrap" (Bootstrap Multiselect-Dropdown)
-  - '''comment''' is a help text or tooltip widget to render with the filter widget (only rendered by S3FilterForm)
-
-HTML Attributes:
-
-  - '''_class''' is the CSS class for the input field
-  - '''_name''' is a name for the input field
+instance = S3OptionsFilter(field,
+                           label=None,
+                           options=None,
+                           represent=None,
+                           widget=None,
+                           _class="class",
+                           _name="name",
+                           comment=None)
+}}}
+
+'''Parameters''':
+
+  ||'''Parameter'''||'''Type'''||'''Explanation'''||'''Default'''||
+  ||field||string||field selector for the field to filter by ''(required)''||-||
+  ||label||string or lazyT||the label for the fitler widget||None||
+  ||options||dict or callable||dict {value:label} of options for the widget, or a callable that returns such a dict||None||
+  ||represent||callable||a callable to render a label for an option||None||
+  ||widget||string||selects the widget, either "groupedopts" (S3 grouped checkboxes) or "multiselect" (jQuery UI Multiselect-Dropdown by Eric Hynds) or "multiselect-bootstrap" (Bootstrap Multiselect-Dropdown)||"groupedopts"||
+  ||_class||string||the CSS class for the input field||None||
+  ||_name||string||name for the input field||None||
+  ||comment||string or HTML widget||help text or tooltip widget to render with the filter widget (only rendered by S3FilterForm)||None||
 
 Note: if no '''options''' are specified, the widget will determine the options from the field (=all unique values for this field currently available in the DB)