0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs/reference/viewsets.md

170 lines
5.5 KiB
Markdown
Raw Normal View History

(viewsets_reference)=
2022-06-09 15:48:47 +02:00
# Viewsets
Viewsets are Wagtail's mechanism for defining a group of related admin views with shared properties, as a single unit. See [Generic views](../extending/generic_views).
## ViewSet
2022-06-09 15:48:47 +02:00
```{eval-rst}
2022-06-09 15:48:47 +02:00
.. autoclass:: wagtail.admin.viewsets.base.ViewSet
.. automethod:: on_register
.. automethod:: get_urlpatterns
.. automethod:: get_url_name
```
2022-06-09 16:26:30 +02:00
## ModelViewSet
2022-06-09 16:26:30 +02:00
```{eval-rst}
2022-06-09 16:26:30 +02:00
.. autoclass:: wagtail.admin.viewsets.model.ModelViewSet
.. attribute:: model
Required; the model class that this viewset will work with.
.. attribute:: form_fields
A list of model field names that should be included in the create / edit forms.
.. attribute:: exclude_form_fields
Used in place of ``form_fields`` to indicate that all of the model's fields except the ones listed here should appear in the create / edit forms. Either ``form_fields`` or ``exclude_form_fields`` must be supplied (unless ``get_form_class`` is being overridden).
.. automethod:: get_form_class
.. autoattribute:: icon
.. autoattribute:: index_view_class
.. autoattribute:: add_view_class
.. autoattribute:: edit_view_class
.. autoattribute:: delete_view_class
```
2022-06-09 16:59:52 +02:00
## ChooserViewSet
2022-06-09 16:59:52 +02:00
```{eval-rst}
2022-06-09 16:59:52 +02:00
.. autoclass:: wagtail.admin.viewsets.chooser.ChooserViewSet
.. attribute:: model
Required; the model class that this viewset will work with.
.. autoattribute:: icon
.. autoattribute:: choose_one_text
.. autoattribute:: page_title
.. autoattribute:: choose_another_text
.. autoattribute:: edit_item_text
2022-07-14 13:33:28 +02:00
.. autoattribute:: per_page
.. autoattribute:: preserve_url_parameters
2022-06-09 16:59:52 +02:00
.. autoattribute:: choose_view_class
.. autoattribute:: choose_results_view_class
.. autoattribute:: chosen_view_class
.. autoattribute:: chosen_multiple_view_class
.. autoattribute:: create_view_class
.. autoattribute:: base_widget_class
2022-06-09 16:59:52 +02:00
.. autoattribute:: widget_class
.. autoattribute:: widget_telepath_adapter_class
2022-06-09 16:59:52 +02:00
.. autoattribute:: register_widget
.. autoattribute:: base_block_class
.. automethod:: get_block_class
.. autoattribute:: creation_form_class
.. autoattribute:: form_fields
.. autoattribute:: exclude_form_fields
.. autoattribute:: create_action_label
.. autoattribute:: create_action_clicked_label
.. autoattribute:: creation_tab_label
.. autoattribute:: search_tab_label
2022-06-09 15:48:47 +02:00
```
## SnippetViewSet
```{eval-rst}
.. autoclass:: wagtail.snippets.views.snippets.SnippetViewSet
.. autoattribute:: model
.. autoattribute:: icon
.. autoattribute:: add_to_admin_menu
.. autoattribute:: add_to_settings_menu
.. autoattribute:: menu_label
.. autoattribute:: menu_name
.. autoattribute:: menu_order
.. autoattribute:: list_display
.. autoattribute:: list_export
.. autoattribute:: list_filter
.. autoattribute:: filterset_class
.. autoattribute:: search_fields
.. autoattribute:: search_backend_name
.. autoattribute:: list_per_page
.. autoattribute:: chooser_per_page
.. autoattribute:: export_filename
.. autoattribute:: ordering
.. autoattribute:: inspect_view_enabled
.. autoattribute:: inspect_view_fields
.. autoattribute:: inspect_view_fields_exclude
.. autoattribute:: admin_url_namespace
.. autoattribute:: base_url_path
.. autoattribute:: chooser_admin_url_namespace
.. autoattribute:: chooser_base_url_path
.. autoattribute:: index_view_class
.. autoattribute:: add_view_class
.. autoattribute:: edit_view_class
.. autoattribute:: delete_view_class
.. autoattribute:: usage_view_class
.. autoattribute:: history_view_class
.. autoattribute:: inspect_view_class
.. autoattribute:: revisions_view_class
.. autoattribute:: revisions_revert_view_class
.. autoattribute:: revisions_compare_view_class
.. autoattribute:: revisions_unschedule_view_class
.. autoattribute:: unpublish_view_class
.. autoattribute:: preview_on_add_view_class
.. autoattribute:: preview_on_edit_view_class
.. autoattribute:: lock_view_class
.. autoattribute:: unlock_view_class
.. autoattribute:: chooser_viewset_class
.. autoattribute:: template_prefix
.. autoattribute:: index_template_name
.. autoattribute:: index_results_template_name
.. autoattribute:: create_template_name
.. autoattribute:: edit_template_name
.. autoattribute:: delete_template_name
.. autoattribute:: history_template_name
.. automethod:: get_menu_label
.. automethod:: get_menu_name
.. automethod:: get_menu_icon
.. automethod:: get_menu_order
.. automethod:: get_menu_item
.. automethod:: get_queryset
.. automethod:: get_edit_handler
.. automethod:: get_form_class
.. automethod:: get_index_template
.. automethod:: get_index_results_template
.. automethod:: get_create_template
.. automethod:: get_edit_template
.. automethod:: get_delete_template
.. automethod:: get_history_template
.. automethod:: get_inspect_template
.. automethod:: get_admin_url_namespace
.. automethod:: get_admin_base_path
.. automethod:: get_chooser_admin_url_namespace
.. automethod:: get_chooser_admin_base_path
```
## SnippetViewSetGroup
```{eval-rst}
.. autoclass:: wagtail.snippets.views.snippets.SnippetViewSetGroup
.. autoattribute:: items
.. autoattribute:: add_to_admin_menu
.. autoattribute:: menu_label
.. autoattribute:: menu_name
.. autoattribute:: menu_icon
.. autoattribute:: menu_order
.. automethod:: get_menu_label
.. automethod:: get_menu_name
.. automethod:: get_menu_icon
.. automethod:: get_menu_order
.. automethod:: get_menu_item
```