tool_tip
========

.. py:module:: qfluentwidgets.components.widgets.tool_tip


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



.. autoapisummary::

   qfluentwidgets.components.widgets.tool_tip.ToolTipPosition
   qfluentwidgets.components.widgets.tool_tip.ItemViewToolTipType
   qfluentwidgets.components.widgets.tool_tip.ToolTip
   qfluentwidgets.components.widgets.tool_tip.ToolTipPositionManager
   qfluentwidgets.components.widgets.tool_tip.TopToolTipManager
   qfluentwidgets.components.widgets.tool_tip.BottomToolTipManager
   qfluentwidgets.components.widgets.tool_tip.LeftToolTipManager
   qfluentwidgets.components.widgets.tool_tip.RightToolTipManager
   qfluentwidgets.components.widgets.tool_tip.TopRightToolTipManager
   qfluentwidgets.components.widgets.tool_tip.TopLeftToolTipManager
   qfluentwidgets.components.widgets.tool_tip.BottomRightToolTipManager
   qfluentwidgets.components.widgets.tool_tip.BottomLeftToolTipManager
   qfluentwidgets.components.widgets.tool_tip.ItemViewToolTipManager
   qfluentwidgets.components.widgets.tool_tip.TableItemToolTipManager
   qfluentwidgets.components.widgets.tool_tip.ToolTipFilter
   qfluentwidgets.components.widgets.tool_tip.ItemViewToolTip
   qfluentwidgets.components.widgets.tool_tip.ItemViewToolTipDelegate




.. py:class:: ToolTipPosition

   Bases: :py:obj:`enum.Enum`


   Info bar position 


   .. py:attribute:: TOP
      :value: 0



   .. py:attribute:: BOTTOM
      :value: 1



   .. py:attribute:: LEFT
      :value: 2



   .. py:attribute:: RIGHT
      :value: 3



   .. py:attribute:: TOP_LEFT
      :value: 4



   .. py:attribute:: TOP_RIGHT
      :value: 5



   .. py:attribute:: BOTTOM_LEFT
      :value: 6



   .. py:attribute:: BOTTOM_RIGHT
      :value: 7



.. py:class:: ItemViewToolTipType

   Bases: :py:obj:`enum.Enum`


   Info bar position 


   .. py:attribute:: LIST
      :value: 0



   .. py:attribute:: TABLE
      :value: 1



.. py:class:: ToolTip(text='', parent=None)

   Bases: :py:obj:`PyQt5.QtWidgets.QFrame`


   Tool tip 


   .. py:attribute:: container


   .. py:attribute:: timer


   .. py:attribute:: containerLayout


   .. py:attribute:: label


   .. py:attribute:: opacityAni


   .. py:attribute:: shadowEffect


   .. py:method:: text()


   .. py:method:: setText(text)

      set text on tooltip 



   .. py:method:: duration()


   .. py:method:: setDuration(duration: int)

      set tooltip duration in milliseconds

      Parameters
      ----------
      duration: int
          display duration in milliseconds, if `duration <= 0`, tooltip won't disappear automatically



   .. py:method:: showEvent(e)


   .. py:method:: hideEvent(e)


   .. py:method:: adjustPos(widget, position: ToolTipPosition)

      adjust the position of tooltip relative to widget 



.. py:class:: ToolTipPositionManager

   Tooltip position manager 


   .. py:method:: position(tooltip: ToolTip, parent: PyQt5.QtWidgets.QWidget) -> PyQt5.QtCore.QPoint


   .. py:method:: make(position: ToolTipPosition)
      :staticmethod:


      mask info bar manager according to the display position 



.. py:class:: TopToolTipManager

   Bases: :py:obj:`ToolTipPositionManager`


   Top tooltip position manager 


.. py:class:: BottomToolTipManager

   Bases: :py:obj:`ToolTipPositionManager`


   Bottom tooltip position manager 


.. py:class:: LeftToolTipManager

   Bases: :py:obj:`ToolTipPositionManager`


   Left tooltip position manager 


.. py:class:: RightToolTipManager

   Bases: :py:obj:`ToolTipPositionManager`


   Right tooltip position manager 


.. py:class:: TopRightToolTipManager

   Bases: :py:obj:`ToolTipPositionManager`


   Top right tooltip position manager 


.. py:class:: TopLeftToolTipManager

   Bases: :py:obj:`ToolTipPositionManager`


   Top left tooltip position manager 


.. py:class:: BottomRightToolTipManager

   Bases: :py:obj:`ToolTipPositionManager`


   Bottom right tooltip position manager 


.. py:class:: BottomLeftToolTipManager

   Bases: :py:obj:`ToolTipPositionManager`


   Bottom left tooltip position manager 


.. py:class:: ItemViewToolTipManager(itemRect=QRect())

   Bases: :py:obj:`ToolTipPositionManager`


   Item view tooltip position manager 


   .. py:attribute:: itemRect


   .. py:method:: make(tipType: ItemViewToolTipType, itemRect: PyQt5.QtCore.QRect)
      :staticmethod:


      mask info bar manager according to the display tipType 



.. py:class:: TableItemToolTipManager(itemRect=QRect())

   Bases: :py:obj:`ItemViewToolTipManager`


   Table item view tooltip position manager 


.. py:class:: ToolTipFilter(parent: PyQt5.QtWidgets.QWidget, showDelay=300, position=ToolTipPosition.TOP)

   Bases: :py:obj:`PyQt5.QtCore.QObject`


   Tool tip filter 


   .. py:attribute:: isEnter
      :value: False



   .. py:attribute:: position


   .. py:attribute:: timer


   .. py:method:: eventFilter(obj: PyQt5.QtCore.QObject, e: PyQt5.QtCore.QEvent) -> bool


   .. py:method:: hideToolTip()

      hide tool tip 



   .. py:method:: showToolTip()

      show tool tip 



   .. py:method:: setToolTipDelay(delay: int)

      set the delay of tool tip 



.. py:class:: ItemViewToolTip(text='', parent=None)

   Bases: :py:obj:`ToolTip`


   Item view tool tip 


   .. py:method:: adjustPos(view: PyQt5.QtWidgets.QAbstractItemView, itemRect: PyQt5.QtCore.QRect, tooltipType: ItemViewToolTipType)

      adjust the position of tooltip relative to widget 



.. py:class:: ItemViewToolTipDelegate(parent: PyQt5.QtWidgets.QAbstractItemView, showDelay=300, tooltipType=ItemViewToolTipType.TABLE)

   Bases: :py:obj:`ToolTipFilter`


   Item view tool tip 


   .. py:attribute:: text
      :value: ''



   .. py:attribute:: currentIndex
      :value: None



   .. py:attribute:: tooltipDuration
      :value: -1



   .. py:attribute:: tooltipType


   .. py:attribute:: viewport


   .. py:method:: eventFilter(obj: PyQt5.QtCore.QObject, e: PyQt5.QtCore.QEvent) -> bool


   .. py:method:: showToolTip()

      show tool tip 



   .. py:method:: setText(text: str)


   .. py:method:: setToolTipDuration(duration)


   .. py:method:: helpEvent(event: PyQt5.QtGui.QHelpEvent, view: PyQt5.QtWidgets.QAbstractItemView, option: PyQt5.QtWidgets.QStyleOptionViewItem, index: PyQt5.QtCore.QModelIndex) -> bool