pivot
=====

.. py:module:: qfluentwidgets.components.navigation.pivot


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



.. autoapisummary::

   qfluentwidgets.components.navigation.pivot.PivotItem
   qfluentwidgets.components.navigation.pivot.Pivot




.. py:class:: PivotItem(parent: PyQt5.QtWidgets.QWidget = None)

   Bases: :py:obj:`qfluentwidgets.components.widgets.button.PushButton`


   Pivot item 


   .. py:attribute:: itemClicked


   .. py:method:: setSelected(isSelected: bool)


.. py:class:: Pivot(parent=None)

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


   Pivot 


   .. py:attribute:: currentItemChanged


   .. py:attribute:: items
      :type:  Dict[str, PivotItem]


   .. py:attribute:: lightIndicatorColor


   .. py:attribute:: darkIndicatorColor


   .. py:attribute:: hBoxLayout


   .. py:attribute:: slideAni


   .. py:method:: addItem(routeKey: str, text: str, onClick=None, icon=None)

      add item

      Parameters
      ----------
      routeKey: str
          the unique name of item

      text: str
          the text of navigation item

      onClick: callable
          the slot connected to item clicked signal

      icon: str
          the icon of navigation item



   .. py:method:: addWidget(routeKey: str, widget: PivotItem, onClick=None)

      add widget

      Parameters
      ----------
      routeKey: str
          the unique name of item

      widget: PivotItem
          navigation widget

      onClick: callable
          the slot connected to item clicked signal



   .. py:method:: insertItem(index: int, routeKey: str, text: str, onClick=None, icon=None)

      insert item

      Parameters
      ----------
      index: int
          insert position

      routeKey: str
          the unique name of item

      text: str
          the text of navigation item

      onClick: callable
          the slot connected to item clicked signal

      icon: str
          the icon of navigation item



   .. py:method:: insertWidget(index: int, routeKey: str, widget: PivotItem, onClick=None)

      insert item

      Parameters
      ----------
      index: int
          insert position

      routeKey: str
          the unique name of item

      widget: PivotItem
          navigation widget

      onClick: callable
          the slot connected to item clicked signal



   .. py:method:: removeWidget(routeKey: str)

      remove widget

      Parameters
      ----------
      routeKey: str
          the unique name of item



   .. py:method:: clear()

      clear all navigation items 



   .. py:method:: currentItem()

      Returns the current selected item 



   .. py:method:: currentRouteKey()


   .. py:method:: setCurrentItem(routeKey: str)

      set current selected item

      Parameters
      ----------
      routeKey: str
          the unique name of item



   .. py:method:: showEvent(e)


   .. py:method:: setIndicatorLength(len: int)


   .. py:method:: indicatorLength()


   .. py:method:: setItemFontSize(size: int)

      set the pixel font size of items 



   .. py:method:: setItemText(routeKey: str, text: str)

      set the text of item 



   .. py:method:: setIndicatorColor(light, dark)


   .. py:method:: widget(routeKey: str)


   .. py:method:: resizeEvent(e) -> None


   .. py:method:: currentIndicatorGeometry()


   .. py:method:: paintEvent(e)