form.widgets
============

.. py:module:: form.widgets


Classes
-------

.. autoapisummary::

   form.widgets.OrderedListWidget
   form.widgets.MultiCheckboxWidget
   form.widgets.OrderedMultiCheckboxWidget
   form.widgets.CoordinateWidget
   form.widgets.UploadWidget
   form.widgets.UploadMultipleWidget
   form.widgets.TextAreaWithTextModules
   form.widgets.TagsWidget
   form.widgets.IconWidget
   form.widgets.ChosenSelectWidget
   form.widgets.PreviewWidget
   form.widgets.PanelWidget
   form.widgets.LinkPanelWidget
   form.widgets.HoneyPotWidget
   form.widgets.DateRangeMixin
   form.widgets.DateRangeInput
   form.widgets.DateTimeLocalRangeInput
   form.widgets.DurationInput
   form.widgets.TypeAheadInput


Module Contents
---------------

.. py:class:: OrderedListWidget(html_tag='ul', prefix_label=True)

   Bases: :py:obj:`wtforms.widgets.ListWidget`


   Extends the default list widget with automated ordering using the
   translated text of each element.



   .. py:method:: __call__(field: wtforms.Field, **kwargs: Any) -> markupsafe.Markup


.. py:class:: MultiCheckboxWidget(html_tag: Literal['ul', 'ol'] = 'ul')

   Bases: :py:obj:`wtforms.widgets.ListWidget`


   The default list widget with the label behind the checkbox. 


.. py:class:: OrderedMultiCheckboxWidget(html_tag: Literal['ul', 'ol'] = 'ul')

   Bases: :py:obj:`MultiCheckboxWidget`, :py:obj:`OrderedListWidget`


   The sorted list widget with the label behind the checkbox. 


.. py:class:: CoordinateWidget(input_type=None)

   Bases: :py:obj:`wtforms.widgets.TextInput`


   Widget containing the coordinates for the
   :class:`onegov.form.fields.CoordinateField` class.

   Basically a text input with a class. Meant to be enhanced on the browser
   using javascript.



   .. py:method:: __call__(field: wtforms.Field, **kwargs: Any) -> markupsafe.Markup


.. py:class:: UploadWidget(multiple=False)

   Bases: :py:obj:`wtforms.widgets.FileInput`


   An upload widget for the :class:`onegov.form.fields.UploadField` class,
   which supports keeping, removing and replacing already uploaded files.

   This is necessary as file inputs are read-only on the client and it's
   therefore rather easy for users to lose their input otherwise (e.g. a
   form with a file is rejected because of some mistake - the file disappears
   once the response is rendered on the client).



   .. py:attribute:: simple_template


   .. py:attribute:: template


   .. py:method:: image_source(field: onegov.form.fields.UploadField) -> str | None

      Returns the image source url if the field points to an image and
      if it can be done (it looks like it's possible, but I'm not super
      sure this is always possible).




   .. py:method:: template_data(field: onegov.form.fields.UploadField, force_simple: bool, resend_upload: bool, wrapper_css_class: str, input_html: markupsafe.Markup, **kwargs: Any) -> tuple[bool, dict[str, Any]]


   .. py:method:: __call__(field: onegov.form.fields.UploadField, **kwargs: Any) -> markupsafe.Markup


.. py:class:: UploadMultipleWidget

   Bases: :py:obj:`wtforms.widgets.FileInput`


   A widget for the :class:`onegov.form.fields.UploadMultipleField` class,
   which supports keeping, removing and replacing already uploaded files.

   This is necessary as file inputs are read-only on the client and it's
   therefore rather easy for users to lose their input otherwise (e.g. a
   form with a file is rejected because of some mistake - the file disappears
   once the response is rendered on the client).

   We deviate slightly from the norm by rendering the errors ourselves
   since we're essentially a list of fields and not a single field most
   of the time.



   .. py:attribute:: additional_label


   .. py:attribute:: multiple
      :value: True



   .. py:method:: render_input(field: onegov.form.fields.UploadMultipleField, **kwargs: Any) -> markupsafe.Markup


   .. py:method:: __call__(field: onegov.form.fields.UploadMultipleField, **kwargs: Any) -> markupsafe.Markup


.. py:class:: TextAreaWithTextModules

   Bases: :py:obj:`wtforms.widgets.TextArea`


   An extension of a regular textarea with a button that lets
   you select and insert text modules. If no text modules have
   been defined this will be no different from textarea.


   .. py:attribute:: template


   .. py:method:: text_modules(field: wtforms.StringField) -> list[onegov.chat.TextModule]


   .. py:method:: __call__(field: wtforms.StringField, **kwargs: Any) -> markupsafe.Markup


.. py:class:: TagsWidget(input_type=None)

   Bases: :py:obj:`wtforms.widgets.TextInput`


   Render a single-line text input.


   .. py:attribute:: input_type
      :value: 'tags'



.. py:class:: IconWidget(input_type=None)

   Bases: :py:obj:`wtforms.widgets.TextInput`


   Render a single-line text input.


   .. py:attribute:: iconfont
      :value: 'FontAwesome'



   .. py:attribute:: icons


   .. py:attribute:: template


   .. py:method:: __call__(field: wtforms.Field, **kwargs: Any) -> markupsafe.Markup


.. py:class:: ChosenSelectWidget(multiple=False)

   Bases: :py:obj:`wtforms.widgets.Select`


   Renders a select field.

   If `multiple` is True, then the `size` property should be specified on
   rendering to make the field useful.

   The field must provide an `iter_choices()` method which the widget will
   call on rendering; this method must yield tuples of
   `(value, label, selected)` or `(value, label, selected, render_kw)`.
   It also must provide a `has_groups()` method which tells whether choices
   are divided into groups, and if they do, the field must have an
   `iter_groups()` method that yields tuples of `(label, choices)`, where
   `choices` is a iterable of `(value, label, selected)` tuples.


   .. py:method:: __call__(field: wtforms.fields.choices.SelectFieldBase, **kwargs: Any) -> markupsafe.Markup


.. py:class:: PreviewWidget

   A widget that displays the html of a specific view whenever there's
   a change in other fields. JavaScript is used to facilitate this.



   .. py:attribute:: template


   .. py:method:: __call__(field: onegov.form.fields.PreviewField, **kwargs: Any) -> markupsafe.Markup


.. py:class:: PanelWidget

   A widget that displays the field's text as panel (no input). 


   .. py:method:: __call__(field: onegov.form.fields.PanelField, **kwargs: Any) -> markupsafe.Markup


.. py:class:: LinkPanelWidget

   Bases: :py:obj:`PanelWidget`


   A widget that displays a clickable link as panel (no input). 


   .. py:method:: __call__(field: onegov.form.fields.PanelField, **kwargs: Any) -> markupsafe.Markup


.. py:class:: HoneyPotWidget(input_type=None)

   Bases: :py:obj:`wtforms.widgets.TextInput`


   A widget that displays the input normally not visible to the user. 


   .. py:method:: __call__(field: wtforms.Field, **kwargs: Any) -> markupsafe.Markup


.. py:class:: DateRangeMixin(min: datetime.date | dateutil.relativedelta.relativedelta | None = None, max: datetime.date | dateutil.relativedelta.relativedelta | None = None)

   .. py:attribute:: min
      :value: None



   .. py:attribute:: max
      :value: None



   .. py:property:: min_date
      :type: datetime.date | None



   .. py:property:: max_date
      :type: datetime.date | None



.. py:class:: DateRangeInput(min: datetime.date | dateutil.relativedelta.relativedelta | None = None, max: datetime.date | dateutil.relativedelta.relativedelta | None = None)

   Bases: :py:obj:`DateRangeMixin`, :py:obj:`wtforms.widgets.DateInput`


   A date widget which set the min and max values that are
   supported in some browsers based on a date or relativedelta.


   .. py:method:: __call__(field: wtforms.Field, **kwargs: Any) -> markupsafe.Markup


.. py:class:: DateTimeLocalRangeInput(min: datetime.date | dateutil.relativedelta.relativedelta | None = None, max: datetime.date | dateutil.relativedelta.relativedelta | None = None)

   Bases: :py:obj:`DateRangeMixin`, :py:obj:`wtforms.widgets.DateTimeLocalInput`


   A datetime-local widget which set the min and max values that
   are supported in some browsers based on a date or relativedelta.


   .. py:method:: __call__(field: wtforms.Field, **kwargs: Any) -> markupsafe.Markup


.. py:class:: DurationInput

   .. py:attribute:: minutes_widget


   .. py:attribute:: hours_widget


   .. py:method:: __call__(field: onegov.form.fields.DurationField, **kwargs: Any) -> markupsafe.Markup


.. py:class:: TypeAheadInput(input_type=None)

   Bases: :py:obj:`wtforms.widgets.TextInput`


   A widget with typeahead. 


   .. py:method:: __call__(field: onegov.form.fields.TypeAheadField, **kwargs: Any) -> markupsafe.Markup