8000 [3.1.x] Fixed #32430 -- Doc'd base class-based views. · django/django@b1416cb · GitHub
[go: up one dir, main page]
8000
Skip to content

Commit b1416cb

Browse files
imkakafelixxm
imkaka
authored and
felixxm
committed
[3.1.x] Fixed #32430 -- Doc'd base class-based views.
Backport of 6ee86a1 from master
1 parent 4f5e550 commit b1416cb

File tree

1 file changed

+76
-4
lines changed

1 file changed

+76
-4
lines changed

‎docs/ref/class-based-views/generic-editing.txt

Lines changed: 76 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ editing content:
4343
This view inherits methods and attributes from the following views:
4444

4545
* :class:`django.views.generic.base.TemplateResponseMixin`
46-
* ``django.views.generic.edit.BaseFormView``
46+
* :class:`django.views.generic.edit.BaseFormView`
4747
* :class:`django.views.generic.edit.FormMixin`
4848
* :class:`django.views.generic.edit.ProcessFormView`
4949
* :class:`django.views.generic.base.View`
@@ -85,6 +85,19 @@ editing content:
8585
<input type="submit" value="Send message">
8686
</form>
8787

88+
.. class:: django.views.generic.edit.BaseFormView
89+
90+
A base view for displaying a form. It is not intended to be used directly,
91+
but rather as a parent class of the
92+
:class:`django.views.generic.edit.FormView` or other views displaying a
93+
form.
94+
95+
**Ancestors (MRO)**
96+
97+
This view inherits methods and attributes from the following views:
98+
99+
* :class:`django.views.generic.edit.FormMixin`
100+
* :class:`django.views.generic.edit.ProcessFormView`
88101

89102
``CreateView``
90103
==============
@@ -100,7 +113,7 @@ editing content:
100113

101114
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
102115
* :class:`django.views.generic.base.TemplateResponseMixin`
103-
* ``django.views.generic.edit.BaseCreateView``
116+
* :class:`django.views.generic.edit.BaseCreateView`
104117
* :class:`django.views.generic.edit.ModelFormMixin`
105118
* :class:`django.views.generic.edit.FormMixin`
106119
* :class:`django.views.generic.detail.SingleObjectMixin`
@@ -141,6 +154,29 @@ editing content:
141154
<input type="submit" value="Save">
142155
</form>
143156

157+
.. class:: django.views.generic.edit.BaseCreateView
158+
159+
A base view for creating a new object instance. It is not intended to be
160+
used directly, but rather as a parent class of the
161+
:class:`django.views.generic.edit.CreateView`.
162+
163+
**Ancestors (MRO)**
164+
165+
This view inherits methods and attributes from the following views:
166+
167+
* :class:`django.views.generic.edit.ModelFormMixin`
168+
* :class:`django.views.generic.edit.ProcessFormView`
169+
170+
**Methods**
171+
172+
.. method:: get(request, *args, **kwargs)
173+
174+
Sets the current object instance (``self.object``) to ``None``.
175+
176+
.. method:: post(request, *args, **kwargs)
177+
178+
Sets the current object instance (``self.object``) to ``None``.
179+
144180
``UpdateView``
145181
==============
146182

@@ -157,7 +193,7 @@ editing content:
157193

158194
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
159195
* :class:`django.views.generic.base.TemplateResponseMixin`
160-
* ``django.views.generic.edit.BaseUpdateView``
196+
* :class:`django.views.generic.edit.BaseUpdateView`
161197
* :class:`django.views.generic.edit.ModelFormMixin`
162198
* :class:`django.views.generic.edit.FormMixin`
163199
* :class:`django.views.generic.detail.SingleObjectMixin`
@@ -198,6 +234,29 @@ editing content:
198234
<input type="submit" value="Update">
199235
</form>
200236

237+
.. class:: django.views.generic.edit.BaseUpdateView
238+
239+
A base view for updating an existing object instance. It is not intended to
240+
be used directly, but rather as a parent class of the
241+
:class:`django.views.generic.edit.UpdateView`.
242+
243+
**Ancestors (MRO)**
244+
245+
This view inherits methods and attributes from the following views:
246+
247+
* :class:`django.views.generic.edit.ModelFormMixin`
248+
* :class:`django.views.generic.edit.ProcessFormView`
249+
250+
**Methods**
251+
252+
.. method:: get(request, *args, **kwargs)
253+
254+
Sets the current object instance (``self.object``).
255+
256+
.. method:: post(request, *args, **kwargs)
257+
258+
Sets the current object instance (``self.object``).
259+
201260
``DeleteView``
202261
==============
203262

@@ -214,7 +273,7 @@ editing content:
214273

215274
* :class:`django.views.generic.detail.SingleObjectTemplateResponseMixin`
216275
* :class:`django.views.generic.base.TemplateResponseMixin`
217-
* ``django.views.generic.edit.BaseDeleteView``
276+
* :class:`django.views.generic.edit.BaseDeleteView`
218277
* :class:`django.views.generic.edit.DeletionMixin`
219278
* :class:`django.views.generic.detail.BaseDetailView`
220279
* :class:`django.views.generic.detail.SingleObjectMixin`
@@ -248,3 +307,16 @@ editing content:
248307
<p>Are you sure you want to delete "{{ object }}"?</p>
249308
<input type="submit" value="Confirm">
250309
</form>
310+
311+
.. class:: django.views.generic.edit.BaseDeleteView
312+
313+
A base view for deleting an object instance. It is not intended to be used
314+
directly, but rather as a parent class of the
315+
:class:`django.views.generic.edit.DeleteView`.
316+
317+
**Ancestors (MRO)**
318+
319+
This view inherits methods and attributes from the following views:
320+
321+
* :class:`django.views.generic.edit.DeletionMixin`
322+
* :class:`django.views.generic.detail.BaseDetailView`

0 commit comments

Comments
 (0)
0