bec_widgets.utils.widget_highlighter
====================================

.. py:module:: bec_widgets.utils.widget_highlighter


Classes
-------

.. autoapisummary::

   bec_widgets.utils.widget_highlighter.WidgetHighlighter


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

.. py:class:: WidgetHighlighter(*, frame_parent: qtpy.QtWidgets.QWidget | None = None, window_flags: qtpy.QtCore.Qt.WindowType | qtpy.QtCore.Qt.WindowFlags = Qt.WindowType.Tool | Qt.WindowType.FramelessWindowHint | Qt.WindowType.WindowStaysOnTopHint, style_sheet: str = 'border: 2px solid #FF00FF; border-radius: 6px; background: transparent;')

   Utility that highlights widgets by drawing a temporary frame around them.


   .. py:method:: _ensure_frame() -> qtpy.QtWidgets.QFrame


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

      Delete the highlight frame and cancel pending animations.



   .. py:method:: highlight(widget: qtpy.QtWidgets.QWidget | None) -> None

      Highlight the given widget with a pulsing frame.



   .. py:property:: frame
      :type: qtpy.QtWidgets.QFrame | None


      Return the currently allocated highlight frame (if any).