router
======

.. py:module:: qfluentwidgets.common.router


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



.. autoapisummary::

   qfluentwidgets.common.router.RouteItem
   qfluentwidgets.common.router.StackedHistory
   qfluentwidgets.common.router.Router






.. autoapisummary::

   qfluentwidgets.common.router.qrouter


.. py:class:: RouteItem(stacked: PyQt5.QtWidgets.QStackedWidget, routeKey: str)

   Route item 


   .. py:attribute:: stacked


   .. py:attribute:: routeKey


   .. py:method:: __eq__(other)


.. py:class:: StackedHistory(stacked: PyQt5.QtWidgets.QStackedWidget)

   Stacked history 


   .. py:attribute:: stacked


   .. py:attribute:: defaultRouteKey
      :type:  str
      :value: None



   .. py:attribute:: history
      :type:  List[str]


   .. py:method:: __len__()


   .. py:method:: isEmpty()


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


   .. py:method:: pop()


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


   .. py:method:: top()


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


   .. py:method:: goToTop()


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

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


   Router 


   .. py:attribute:: emptyChanged


   .. py:attribute:: history
      :type:  List[RouteItem]
      :value: []



   .. py:attribute:: stackHistories
      :type:  Dict[PyQt5.QtWidgets.QStackedWidget, StackedHistory]


   .. py:method:: setDefaultRouteKey(stacked: PyQt5.QtWidgets.QStackedWidget, routeKey: str)

      set the default route key of stacked widget 



   .. py:method:: push(stacked: PyQt5.QtWidgets.QStackedWidget, routeKey: str)

      push history

      Parameters
      ----------
      stacked: QStackedWidget
          stacked widget

      routeKey: str
          route key of sub insterface, it should be the object name of sub interface



   .. py:method:: pop()

      pop history 



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

      remove history 



.. py:data:: qrouter