flip_view
=========

.. py:module:: qfluentwidgets.components.widgets.flip_view


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



.. autoapisummary::

   qfluentwidgets.components.widgets.flip_view.ScrollButton
   qfluentwidgets.components.widgets.flip_view.FlipImageDelegate
   qfluentwidgets.components.widgets.flip_view.FlipView
   qfluentwidgets.components.widgets.flip_view.HorizontalFlipView
   qfluentwidgets.components.widgets.flip_view.VerticalFlipView




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

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


   Scroll button 


   .. py:method:: opacity()


   .. py:method:: isTransparent()


   .. py:method:: fadeIn()


   .. py:method:: fadeOut()


   .. py:method:: paintEvent(e)


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

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


   Flip view image delegate 


   .. py:attribute:: borderRadius
      :value: 0



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


   .. py:method:: setBorderRadius(radius: int)


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


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

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


   Flip view

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


   .. py:attribute:: currentIndexChanged


   .. py:attribute:: orientation


   .. py:method:: isHorizontal()


   .. py:method:: setItemSize(size: PyQt5.QtCore.QSize)

      set the size of item 



   .. py:method:: getItemSize()

      get the size of item 



   .. py:method:: setBorderRadius(radius: int)

      set the border radius of item 



   .. py:method:: getBorderRadius()


   .. py:method:: scrollPrevious()

      scroll to previous item 



   .. py:method:: scrollNext()

      scroll to next item 



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

      set current index 



   .. py:method:: scrollToIndex(index)


   .. py:method:: currentIndex()


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


   .. py:method:: addImage(image: Union[PyQt5.QtGui.QImage, PyQt5.QtGui.QPixmap, str])

      add image 



   .. py:method:: addImages(images: List[Union[PyQt5.QtGui.QImage, PyQt5.QtGui.QPixmap, str]], targetSize: PyQt5.QtCore.QSize = None)

      add images 



   .. py:method:: setItemImage(index: int, image: Union[PyQt5.QtGui.QImage, PyQt5.QtGui.QPixmap, str], targetSize: PyQt5.QtCore.QSize = None)

      set the image of specified item 



   .. py:method:: itemImage(index: int, load=True) -> PyQt5.QtGui.QImage

      get the image of specified item

      Parameters
      ----------
      index: int
          the index of image

      load: bool
          whether to load image data



   .. py:method:: resizeEvent(e)


   .. py:method:: enterEvent(e)


   .. py:method:: leaveEvent(e)


   .. py:method:: showEvent(e)


   .. py:method:: wheelEvent(e: PyQt5.QtGui.QWheelEvent)


   .. py:method:: getAspectRatioMode()


   .. py:method:: setAspectRatioMode(mode: PyQt5.QtCore.Qt.AspectRatioMode)


   .. py:attribute:: itemSize


   .. py:attribute:: borderRadius


   .. py:attribute:: aspectRatioMode


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

   Bases: :py:obj:`FlipView`


   Horizontal flip view 


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

   Bases: :py:obj:`FlipView`


   Vertical flip view