summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Sandford <nick@sandford.id.au>2013-01-23 21:11:46 +0100
committerClaude Paroz <claude@2xlibre.net>2013-01-24 08:58:17 +0100
commit93e79b45bc5288d1ca0eb5b6eade30d3c7110b24 (patch)
tree38cf93875658c47a5644b3d9cafaded74966e54d /docs
parent71c8539570dec000ad24d1a11fa443812b56f876 (diff)
Fixed #17416 -- Added widgets argument to inlineformset_factory and modelformset_factory
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/forms/models.txt16
-rw-r--r--docs/topics/forms/modelforms.txt23
2 files changed, 35 insertions, 4 deletions
diff --git a/docs/ref/forms/models.txt b/docs/ref/forms/models.txt
index c388f402e6..f3382d32c7 100644
--- a/docs/ref/forms/models.txt
+++ b/docs/ref/forms/models.txt
@@ -25,12 +25,12 @@ Model Form Functions
See :ref:`modelforms-factory` for example usage.
-.. function:: modelformset_factory(model, form=ModelForm, formfield_callback=None, formset=BaseModelFormSet, extra=1, can_delete=False, can_order=False, max_num=None, fields=None, exclude=None)
+.. function:: modelformset_factory(model, form=ModelForm, formfield_callback=None, formset=BaseModelFormSet, extra=1, can_delete=False, can_order=False, max_num=None, fields=None, exclude=None, widgets=None)
Returns a ``FormSet`` class for the given ``model`` class.
- Arguments ``model``, ``form``, ``fields``, ``exclude``, and
- ``formfield_callback`` are all passed through to
+ Arguments ``model``, ``form``, ``fields``, ``exclude``,
+ ``formfield_callback`` and ``widgets`` are all passed through to
:func:`~django.forms.models.modelform_factory`.
Arguments ``formset``, ``extra``, ``max_num``, ``can_order``, and
@@ -39,7 +39,11 @@ Model Form Functions
See :ref:`model-formsets` for example usage.
-.. function:: inlineformset_factory(parent_model, model, form=ModelForm, formset=BaseInlineFormSet, fk_name=None, fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None)
+ .. versionchanged:: 1.6
+
+ The widgets parameter was added.
+
+.. function:: inlineformset_factory(parent_model, model, form=ModelForm, formset=BaseInlineFormSet, fk_name=None, fields=None, exclude=None, extra=3, can_order=False, can_delete=True, max_num=None, formfield_callback=None, widgets=None)
Returns an ``InlineFormSet`` using :func:`modelformset_factory` with
defaults of ``formset=BaseInlineFormSet``, ``can_delete=True``, and
@@ -49,3 +53,7 @@ Model Form Functions
the ``parent_model``, you must specify a ``fk_name``.
See :ref:`inline-formsets` for example usage.
+
+ .. versionchanged:: 1.6
+
+ The widgets parameter was added.
diff --git a/docs/topics/forms/modelforms.txt b/docs/topics/forms/modelforms.txt
index c091e715bb..d9e00d86cf 100644
--- a/docs/topics/forms/modelforms.txt
+++ b/docs/topics/forms/modelforms.txt
@@ -650,6 +650,19 @@ exclude::
>>> AuthorFormSet = modelformset_factory(Author, exclude=('birth_date',))
+Specifying widgets to use in the form with ``widgets``
+------------------------------------------------------
+
+.. versionadded:: 1.6
+
+Using the ``widgets`` parameter, you can specify a dictionary of values to
+customize the ``ModelForm``'s widget class for a particular field. This
+works the same way as the ``widgets`` dictionary on the inner ``Meta``
+class of a ``ModelForm`` works::
+
+ >>> AuthorFormSet = modelformset_factory(
+ ... Author, widgets={'name': Textarea(attrs={'cols': 80, 'rows': 20})
+
Providing initial values
------------------------
@@ -930,3 +943,13 @@ of a model. Here's how you can do that::
})
Notice how we pass ``instance`` in both the ``POST`` and ``GET`` cases.
+
+Specifying widgets to use in the inline form
+--------------------------------------------
+
+.. versionadded:: 1.6
+
+``inlineformset_factory`` uses ``modelformset_factory`` and passes most
+of its arguments to ``modelformset_factory``. This means you can use
+the ``widgets`` parameter in much the same way as passing it to
+``modelformset_factory``. See `Specifying widgets to use in the form with widgets`_ above.