scroll_area
===========

.. py:module:: qfluentwidgets.components.widgets.scroll_area


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



.. autoapisummary::

   qfluentwidgets.components.widgets.scroll_area.ScrollArea
   qfluentwidgets.components.widgets.scroll_area.SingleDirectionScrollArea
   qfluentwidgets.components.widgets.scroll_area.SmoothScrollArea




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

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


   Smooth scroll area 


   .. py:attribute:: scrollDelagate


   .. py:method:: setSmoothMode(mode: qfluentwidgets.common.smooth_scroll.SmoothMode, orientation: PyQt5.QtCore.Qt.Orientation)

      set smooth mode

      Parameters
      ----------
      mode: SmoothMode
          smooth scroll mode

      orientation: Qt.Orientation
          scroll direction



   .. py:method:: enableTransparentBackground()


.. py:class:: SingleDirectionScrollArea(parent=None, orient=Qt.Vertical)

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


   Single direction scroll area


   .. py:attribute:: orient


   .. py:attribute:: smoothScroll


   .. py:attribute:: vScrollBar


   .. py:attribute:: hScrollBar


   .. py:method:: setVerticalScrollBarPolicy(policy)


   .. py:method:: setHorizontalScrollBarPolicy(policy)


   .. py:method:: setSmoothMode(mode)

      set smooth mode

      Parameters
      ----------
      mode: SmoothMode
          smooth scroll mode



   .. py:method:: keyPressEvent(e)


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


   .. py:method:: enableTransparentBackground()


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

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


   Smooth scroll area 


   .. py:attribute:: delegate


   .. py:method:: setScrollAnimation(orient, duration, easing=QEasingCurve.OutCubic)

      set scroll animation

      Parameters
      ----------
      orient: Orient
          scroll orientation

      duration: int
          scroll duration

      easing: QEasingCurve
          animation type



   .. py:method:: enableTransparentBackground()