cycle_list_widget
=================

.. py:module:: qfluentwidgets.components.widgets.cycle_list_widget


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



.. autoapisummary::

   qfluentwidgets.components.widgets.cycle_list_widget.ScrollButton
   qfluentwidgets.components.widgets.cycle_list_widget.CycleListWidget




.. py:class:: ScrollButton(icon: qfluentwidgets.common.icon.FluentIcon, parent=None)

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


   Scroll button 


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



   .. py:method:: eventFilter(obj, e: PyQt5.QtCore.QEvent)


   .. py:method:: paintEvent(e)


.. py:class:: CycleListWidget(items: Iterable, itemSize: PyQt5.QtCore.QSize, align=Qt.AlignCenter, parent=None)

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


   Cycle list widget 


   .. py:attribute:: currentItemChanged


   .. py:attribute:: itemSize


   .. py:attribute:: align


   .. py:attribute:: upButton


   .. py:attribute:: downButton


   .. py:attribute:: scrollDuration
      :value: 250



   .. py:attribute:: originItems


   .. py:attribute:: vScrollBar


   .. py:attribute:: visibleNumber
      :value: 9



   .. py:method:: setItems(items: list)

      set items in the list

      Parameters
      ----------
      items: Iterable[Any]
          the items to be added

      itemSize: QSize
          the size of item

      align: Qt.AlignmentFlag
          the text alignment of item



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

      set the selected item 



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

      scroll to item 



   .. py:method:: wheelEvent(e)


   .. py:method:: scrollDown()

      scroll down an item 



   .. py:method:: scrollUp()

      scroll up an item 



   .. py:method:: enterEvent(e)


   .. py:method:: leaveEvent(e)


   .. py:method:: resizeEvent(e)


   .. py:method:: eventFilter(obj, e: PyQt5.QtCore.QEvent)


   .. py:method:: currentItem()


   .. py:method:: currentIndex()


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