stepsequence.extension
======================

.. py:module:: stepsequence.extension


Classes
-------

.. autoapisummary::

   stepsequence.extension.StepsModelExtension
   stepsequence.extension.StepsLayoutExtension


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

.. py:class:: StepsModelExtension

   Can serve as Model Extension. However, if you need some
   translations, is better to register steps on layouts that have access to
   the model. 


   .. py:property:: step_position
      :type: int | None


      Can be overwritten by the model and based on its attributes. 



   .. py:method:: get_step_sequence(position: int | None = None) -> list[onegov.stepsequence.core.Step]


   .. py:method:: registered_steps() -> onegov.stepsequence.core.StepCollection
      :classmethod:



.. py:class:: StepsLayoutExtension(*args: Any, hide_steps: bool = False, **kwargs: Any)

   For steps registered on layouts.


   .. py:attribute:: hide_steps
      :value: False



   .. py:property:: step_position
      :type: int | None

      :abstractmethod:


      Can be overwritten by the model and based request params. 



   .. py:property:: registered_steps
      :type: onegov.stepsequence.core.StepCollection



   .. py:method:: get_step_sequence(position: int | None = None) -> list[onegov.stepsequence.core.Step]

      Retrieve the full step sequence for the current model.
      If the latter has multiple steps registered, you must provide
      the position or a ValueError gets raised.