:py:mod:`acquire.acquire.gui.base`
==================================

.. py:module:: acquire.acquire.gui.base


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

Classes
~~~~~~~

.. autoapisummary::

   acquire.acquire.gui.base.GUI
   acquire.acquire.gui.base.Stub




.. py:exception:: GUIError


   Bases: :py:obj:`RuntimeError`

   Unspecified run-time error.


.. py:class:: GUI


   .. py:property:: shard
      :type: int

      Returns the shard of the progress bar.

   .. py:attribute:: thread

      

   .. py:attribute:: folder

      

   .. py:attribute:: ready
      :value: False

      

   .. py:attribute:: auto_upload

      

   .. py:attribute:: upload_available
      :value: False

      

   .. py:method:: gui() -> GUI
      :classmethod:

      Returns the instance of the GUI.


   .. py:method:: wait_for_start(args: argparse.Namespace) -> tuple[str, bool, bool]

      Starts GUI thread and waits for start button to be clicked.


   .. py:method:: message(message: str) -> None
      :abstractmethod:

      Starts GUI thread and waits for start button to be clicked.


   .. py:method:: wait_for_quit() -> None

      Closes the GUI and waits for the thread to join.


   .. py:method:: show() -> None
      :abstractmethod:

      Subclass needs to implement this.


   .. py:method:: finish() -> None
      :abstractmethod:

      Finishes the progress bar and closes the GUI.



.. py:class:: Stub


   Bases: :py:obj:`GUI`

   Minimal GUI implementation.

   .. py:method:: message(message: str) -> None

      Starts GUI thread and waits for start button to be clicked.


   .. py:method:: wait_for_start(args: argparse.Namespace) -> tuple[str, bool, bool]

      Starts GUI thread and waits for start button to be clicked.


   .. py:method:: wait_for_quit() -> None

      Closes the GUI and waits for the thread to join.


   .. py:method:: finish() -> None

      Finishes the progress bar and closes the GUI.