ion.ui
======

.. module:: ion.ui

.. include:: ../rst/ion.ui.rst

UI elements: popup menus, messages, and tooltips.

Functions
---------

.. function:: popup_dismiss()

   Dismiss the popup currently shown, if any.

   :rtype: None

.. function:: popup_menu(items)

   Show a context menu built from ``(label, operator)`` tuples.

   Every operator is polled before the menu is shown, as it is for the
   named menus :meth:`~ion.types.MenuRegistry.show` displays, so an item
   whose operator refuses is drawn greyed rather than looking live and
   doing nothing when clicked.

   :param items: The entries to show, as ``(label, operator)`` tuples.
   :type items: list[tuple[str, NamedTuple]]
   :rtype: None

.. function:: popup_message(text)

   Show a transient message popup.

   :param text: The message to show.
   :type text: str
   :rtype: None

.. function:: popup_tooltip(text)

   Show a tooltip.

   :param text: The tooltip text.
   :type text: str
   :rtype: None