summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNg Zhi An <ngzhian@gmail.com>2015-01-18 02:20:42 +0000
committerNg Zhi An <ngzhian@gmail.com>2015-01-22 19:36:15 +0000
commit4669b6a807811d6763b9fdc5df974cb67aa1fb56 (patch)
tree18b1d7b8c069771c299866f977d5a309459e5650 /docs
parent38c17871bb6dafd489367f6fe8bc56199223adb8 (diff)
Fixed #24170 -- Implemented decompress for BaseRangeField widgets
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/postgres/forms.txt26
1 files changed, 25 insertions, 1 deletions
diff --git a/docs/ref/contrib/postgres/forms.txt b/docs/ref/contrib/postgres/forms.txt
index f6226c4b55..405a005f03 100644
--- a/docs/ref/contrib/postgres/forms.txt
+++ b/docs/ref/contrib/postgres/forms.txt
@@ -161,7 +161,8 @@ Range Fields
This group of fields all share similar functionality for accepting range data.
They are based on :class:`~django.forms.MultiValueField`. They treat one
omitted value as an unbounded range. They also validate that the lower bound is
-not greater than the upper bound.
+not greater than the upper bound. All of these fields use
+:class:`~django.contrib.postgres.fields.RangeWidget`.
IntegerRangeField
~~~~~~~~~~~~~~~~~
@@ -199,3 +200,26 @@ DateRangeField
Based on :class:`~django.forms.DateField` and translates its input into
:class:`~psycopg2:psycopg2.extras.DateRange`. Default for
:class:`~django.contrib.postgres.fields.DateRangeField`.
+
+Widgets
+-------
+
+RangeWidget
+~~~~~~~~~~~
+
+.. class:: RangeWidget(base_widget, attrs=None)
+
+ Widget used by all of the range fields.
+ Based on :class:`~django.forms.MultiWidget`.
+
+ :class:`~RangeWidget` has one required argument:
+
+ .. attribute:: base_widget
+
+ A :class:`~RangeWidget` comprises a 2-tuple of ``base_widget``.
+
+ .. method:: decompress(value)
+
+ Takes a single "compressed" value of a field, for example a
+ :class:`~django.contrib.postgres.fields.DateRangeField`,
+ and returns a tuple representing and lower and upper bound.