plesty.lib.ui.qt.app
====================

.. py:module:: plesty.lib.ui.qt.app

.. autoapi-nested-parse::

   Launching a shell: the two lines between a list of panels and a window.



Functions
---------

.. autoapisummary::

   plesty.lib.ui.qt.app.application
   plesty.lib.ui.qt.app.build_shell
   plesty.lib.ui.qt.app.run


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

.. py:function:: application(name: str = 'PLESTY') -> PySide6.QtWidgets.QApplication

   Return the running Qt application, creating it when there is none.

   :param name: Application name, used by the window manager.

   :returns: The :class:`QApplication` instance.


.. py:function:: build_shell(panels: Sequence[plesty.lib.ui.panel.Panel], *, title: str = 'PLESTY', theme: Optional[plesty.lib.ui.theme.Theme] = None, interval_ms: int = 500, layout_file: Optional[str | pathlib.Path] = None, remember_layout: bool = True) -> plesty.lib.ui.qt.shell.Shell

   Create a shell hosting *panels*, without starting the event loop.

   :param panels: Panels to add, in the order they should be docked.
   :param title: Window title and layout key.
   :param theme: Palette; ``None`` loads the packaged PLESTY theme.
   :param interval_ms: Panel refresh interval in milliseconds.
   :param layout_file: Where the arrangement is stored.
   :param remember_layout: Restore and save the arrangement.

   :returns: The shell, ready for :meth:`~plesty.lib.ui.qt.shell.Shell.start`.


.. py:function:: run(panels: Sequence[plesty.lib.ui.panel.Panel], *, title: str = 'PLESTY', theme: Optional[plesty.lib.ui.theme.Theme] = None, interval_ms: int = 500, layout_file: Optional[str | pathlib.Path] = None, remember_layout: bool = True) -> int

   Open a shell on *panels* and run it until the window is closed.

   :param panels: Panels to add, in the order they should be docked.
   :param title: Window title and layout key.
   :param theme: Palette; ``None`` loads the packaged PLESTY theme.
   :param interval_ms: Panel refresh interval in milliseconds.
   :param layout_file: Where the arrangement is stored.
   :param remember_layout: Restore and save the arrangement.

   :returns: The Qt exit code.