pips_pager
==========

.. py:module:: qfluentwidgets.components.widgets.pips_pager


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



.. autoapisummary::

   qfluentwidgets.components.widgets.pips_pager.PipsScrollButtonDisplayMode
   qfluentwidgets.components.widgets.pips_pager.ScrollButton
   qfluentwidgets.components.widgets.pips_pager.PipsDelegate
   qfluentwidgets.components.widgets.pips_pager.PipsPager
   qfluentwidgets.components.widgets.pips_pager.HorizontalPipsPager
   qfluentwidgets.components.widgets.pips_pager.VerticalPipsPager




.. py:class:: PipsScrollButtonDisplayMode

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


   Pips pager scroll button display mode 


   .. py:attribute:: ALWAYS
      :value: 0



   .. py:attribute:: ON_HOVER
      :value: 1



   .. py:attribute:: NEVER
      :value: 2



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

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


   Scroll button 


   .. py:method:: paintEvent(e)


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

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


   Pips delegate 


   .. py:attribute:: hoveredRow
      :value: -1



   .. py:attribute:: pressedRow
      :value: -1



   .. py:method:: paint(painter: PyQt5.QtGui.QPainter, option: PyQt5.QtWidgets.QStyleOptionViewItem, index: PyQt5.QtCore.QModelIndex) -> None


   .. py:method:: setPressedRow(row: int)


   .. py:method:: setHoveredRow(row: bool)


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

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


   Pips pager

   Constructors
   ------------
   * PipsPager(`parent`: QWidget = None)
   * PipsPager(`orient`: Qt.Orientation, `parent`: QWidget = None)


   .. py:attribute:: currentIndexChanged


   .. py:attribute:: orientation


   .. py:method:: setPageNumber(n: int)

      set the number of page 



   .. py:method:: getPageNumber()

      get the number of page 



   .. py:method:: getVisibleNumber()

      get the number of visible pips 



   .. py:method:: setVisibleNumber(n: int)


   .. py:method:: scrollNext()

      scroll down an item 



   .. py:method:: scrollPrevious()

      scroll up an item 



   .. py:method:: scrollToItem(item: PyQt5.QtWidgets.QListWidgetItem, hint=QListWidget.PositionAtCenter)

      scroll to item 



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


   .. py:method:: isHorizontal()


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

      set current index 



   .. py:method:: isPreviousButtonVisible()


   .. py:method:: isNextButtonVisible()


   .. py:method:: currentIndex()


   .. py:method:: setPreviousButtonDisplayMode(mode: PipsScrollButtonDisplayMode)

      set the display mode of previous button 



   .. py:method:: setNextButtonDisplayMode(mode: PipsScrollButtonDisplayMode)

      set the display mode of next button 



   .. py:method:: mouseReleaseEvent(e)


   .. py:method:: enterEvent(e)


   .. py:method:: leaveEvent(e)


   .. py:method:: wheelEvent(e)


   .. py:method:: resizeEvent(e)


   .. py:attribute:: visibleNumber


   .. py:attribute:: pageNumber


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

   Bases: :py:obj:`PipsPager`


   Horizontal pips pager 


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

   Bases: :py:obj:`PipsPager`


   Vertical pips pager