breadcrumb
==========

.. py:module:: qfluentwidgets.components.navigation.breadcrumb


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



.. autoapisummary::

   qfluentwidgets.components.navigation.breadcrumb.BreadcrumbWidget
   qfluentwidgets.components.navigation.breadcrumb.ElideButton
   qfluentwidgets.components.navigation.breadcrumb.BreadcrumbItem
   qfluentwidgets.components.navigation.breadcrumb.BreadcrumbBar




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

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


   Bread crumb widget 


   .. py:attribute:: clicked


   .. py:attribute:: isHover
      :value: False



   .. py:attribute:: isPressed
      :value: False



   .. py:method:: mousePressEvent(e)


   .. py:method:: mouseReleaseEvent(e)


   .. py:method:: enterEvent(e)


   .. py:method:: leaveEvent(e)


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

   Bases: :py:obj:`BreadcrumbWidget`


   Elide button 


   .. py:method:: paintEvent(e)


   .. py:method:: clearState()


.. py:class:: BreadcrumbItem(routeKey: str, text: str, index: int, parent=None)

   Bases: :py:obj:`BreadcrumbWidget`


   Breadcrumb item 


   .. py:attribute:: text


   .. py:attribute:: routeKey


   .. py:attribute:: isHover
      :value: False



   .. py:attribute:: isPressed
      :value: False



   .. py:attribute:: isSelected
      :value: False



   .. py:attribute:: index


   .. py:attribute:: spacing
      :value: 5



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


   .. py:method:: isRoot()


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


   .. py:method:: setFont(font: PyQt5.QtGui.QFont)


   .. py:method:: setSpacing(spacing: int)


   .. py:method:: paintEvent(e)


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

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


   Breadcrumb bar 


   .. py:attribute:: currentItemChanged


   .. py:attribute:: currentIndexChanged


   .. py:attribute:: itemMap
      :type:  Dict[BreadcrumbItem]


   .. py:attribute:: items
      :type:  List[BreadcrumbItem]
      :value: []



   .. py:attribute:: hiddenItems
      :type:  List[BreadcrumbItem]
      :value: []



   .. py:attribute:: elideButton


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

      add item

      Parameters
      ----------
      routeKey: str
          unique key of item

      text: str
          the text of item



   .. py:method:: setCurrentIndex(index: int)


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


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


   .. py:method:: item(routeKey: str) -> BreadcrumbItem


   .. py:method:: itemAt(index: int)


   .. py:method:: currentIndex()


   .. py:method:: currentItem() -> BreadcrumbItem


   .. py:method:: resizeEvent(e)


   .. py:method:: clear()

      clear all items 



   .. py:method:: popItem()

      pop trailing item 



   .. py:method:: count()

      Returns the number of items 



   .. py:method:: updateGeometry()


   .. py:method:: isElideVisible()


   .. py:method:: setFont(font: PyQt5.QtGui.QFont)


   .. py:method:: getSpacing()


   .. py:method:: setSpacing(spacing: int)


   .. py:attribute:: spacing