Scrolling

ScrollView

A scrollable viewport with Fluent scrollbars and optional zoom.

Example

Usage

Content scrolling and zoom

A large content surface can scroll in both directions and zoom within configured bounds.

#include <FluentQt/Scrolling.h>
using namespace fluent::scrolling;

auto* scrollView = new ScrollView(this);
scrollView->setFixedSize(420, 240);
scrollView->setWidget(new ScrollViewDemoCanvas(
    QSize(760, 520), "Content canvas"));
scrollView->setZoomMode(ScrollView::ZoomMode::Enabled);
scrollView->setMinZoomFactor(0.5);
scrollView->setMaxZoomFactor(2.0);
scrollView->setHorizontalScrollBarVisibility(
    ScrollView::ScrollBarVisibility::Auto);
scrollView->setVerticalScrollBarVisibility(
    ScrollView::ScrollBarVisibility::Auto);

connect(zoomInButton, &QPushButton::clicked,
        scrollView, [scrollView] { scrollView->zoomBy(1.25, true); });
connect(zoomOutButton, &QPushButton::clicked,
        scrollView, [scrollView] { scrollView->zoomBy(0.8, true); });
connect(resetButton, &QPushButton::clicked,
        scrollView, [scrollView] { scrollView->resetZoom(true); });

import fluentqt

from PySide6.QtCore import QSize

scroll_view = fluentqt.ScrollView()
scroll_view.setFixedSize(420, 240)
scroll_view.setOwnedContentWidget(
    ScrollViewDemoCanvas(QSize(760, 520), "Content canvas")
)
scroll_view.setZoomMode(fluentqt.ScrollView.ZoomMode.Enabled)
scroll_view.setMinZoomFactor(0.5)
scroll_view.setMaxZoomFactor(2.0)
scroll_view.setHorizontalScrollBarVisibility(
    fluentqt.ScrollView.ScrollBarVisibility.Auto
)
scroll_view.setVerticalScrollBarVisibility(
    fluentqt.ScrollView.ScrollBarVisibility.Auto
)
zoom_in.clicked.connect(lambda: scroll_view.zoomBy(1.25, True))
zoom_out.clicked.connect(lambda: scroll_view.zoomBy(0.8, True))
reset.clicked.connect(lambda: scroll_view.resetZoom(True))

API

Declaration

`fluent::scrolling::ScrollView`

Inherits QScrollArea · FluentElement · QMLPlus

Scrollable content host with Fluent scroll bars and optional zoom support.

Constructors

explicit ScrollView(QWidget* parent = nullptr)

Properties

ScrollMode horizontalScrollMode: Horizontal scrolling interaction mode.
Read horizontalScrollMode()Write setHorizontalScrollMode()Notify horizontalScrollModeChanged()
ScrollMode verticalScrollMode: Vertical scrolling interaction mode.
Read verticalScrollMode()Write setVerticalScrollMode()Notify verticalScrollModeChanged()
ScrollBarVisibility horizontalScrollBarVisibility: Visibility policy for the horizontal scrollbar.
Read horizontalScrollBarVisibility()Write setHorizontalScrollBarVisibility()Notify horizontalScrollBarVisibilityChanged()
ScrollBarVisibility verticalScrollBarVisibility: Visibility policy for the vertical scrollbar.
Read verticalScrollBarVisibility()Write setVerticalScrollBarVisibility()Notify verticalScrollBarVisibilityChanged()
ZoomMode zoomMode: Zoom interaction mode.
Read zoomMode()Write setZoomMode()Notify zoomModeChanged()
qreal zoomFactor: Current zoom factor applied to content.
Read zoomFactor()Write setZoomFactor()Notify zoomFactorChanged()
qreal minZoomFactor: Minimum allowed zoom factor.
Read minZoomFactor()Write setMinZoomFactor()Notify minZoomFactorChanged()
qreal maxZoomFactor: Maximum allowed zoom factor.
Read maxZoomFactor()Write setMaxZoomFactor()Notify maxZoomFactorChanged()
bool scrollChainingEnabled: Whether boundary wheel input chains to an enclosing scroller (WinUI ScrollViewer.IsScrollChainingEnabled).
Read isScrollChainingEnabled()Write setScrollChainingEnabled()Notify scrollChainingEnabledChanged()
QWidget* contentWidget: Widget displayed inside the scroll viewport.
Read contentWidget()Write setContentWidget()Notify contentWidgetChanged()
fluent::WidgetOwnership contentOwnership: Release policy for the current content widget.
Read contentOwnership()Notify contentOwnershipChanged()

Methods

void setWidget(QWidget* widget): Installs content using QScrollArea-compatible owned semantics.
QWidget* takeWidget(): Removes and returns the current content without deleting it.
QWidget* contentWidget() const: Widget displayed inside the scroll viewport.
WidgetOwnership contentOwnership() const: Release policy for the current content widget.
void setContentWidget(QWidget* widget): Widget displayed inside the scroll viewport.
bool setContentWidget(QWidget* widget, WidgetOwnership ownership): Installs content with an explicit release policy.
QWidget* takeContentWidget(): Removes and returns content as a parentless caller-owned widget.
ScrollMode horizontalScrollMode() const: Horizontal scrolling interaction mode.
void setHorizontalScrollMode(ScrollMode mode): Horizontal scrolling interaction mode.
ScrollMode verticalScrollMode() const: Vertical scrolling interaction mode.
void setVerticalScrollMode(ScrollMode mode): Vertical scrolling interaction mode.
ScrollBarVisibility horizontalScrollBarVisibility() const: Visibility policy for the horizontal scrollbar.
void setHorizontalScrollBarVisibility(ScrollBarVisibility visibility): Visibility policy for the horizontal scrollbar.
ScrollBarVisibility verticalScrollBarVisibility() const: Visibility policy for the vertical scrollbar.
void setVerticalScrollBarVisibility(ScrollBarVisibility visibility): Visibility policy for the vertical scrollbar.
ZoomMode zoomMode() const: Zoom interaction mode.
void setZoomMode(ZoomMode mode): Zoom interaction mode.
qreal zoomFactor() const: Current zoom factor applied to content.
void setZoomFactor(qreal factor): Current zoom factor applied to content.
qreal minZoomFactor() const: Minimum allowed zoom factor.
void setMinZoomFactor(qreal factor): Minimum allowed zoom factor.
qreal maxZoomFactor() const: Maximum allowed zoom factor.
void setMaxZoomFactor(qreal factor): Maximum allowed zoom factor.
bool isScrollChainingEnabled() const: Whether boundary wheel input chains to an enclosing scroller (WinUI ScrollViewer.IsScrollChainingEnabled).
void setScrollChainingEnabled(bool enabled): Whether boundary wheel input chains to an enclosing scroller (WinUI ScrollViewer.IsScrollChainingEnabled).
int horizontalOffset() const
int verticalOffset() const
int scrollableWidth() const
int scrollableHeight() const
void scrollTo(int x, int y, bool animated = false)
void scrollBy(int dx, int dy, bool animated = false)
void zoomTo(qreal factor, bool animated = false)
void zoomBy(qreal factorMultiplier, bool animated = false)
void resetZoom(bool animated = false)

Signals

void horizontalScrollModeChanged(): Horizontal scrolling interaction mode.
void verticalScrollModeChanged(): Vertical scrolling interaction mode.
void horizontalScrollBarVisibilityChanged(): Visibility policy for the horizontal scrollbar.
void verticalScrollBarVisibilityChanged(): Visibility policy for the vertical scrollbar.
void zoomModeChanged(): Zoom interaction mode.
void zoomFactorChanged(): Current zoom factor applied to content.
void minZoomFactorChanged(): Minimum allowed zoom factor.
void maxZoomFactorChanged(): Maximum allowed zoom factor.
void scrollChainingEnabledChanged(): Whether boundary wheel input chains to an enclosing scroller (WinUI ScrollViewer.IsScrollChainingEnabled).
void scrollPositionChanged(int horizontalOffset, int verticalOffset)
void contentWidgetChanged(QWidget* widget): Widget displayed inside the scroll viewport.
void contentOwnershipChanged(WidgetOwnership ownership): Release policy for the current content widget.

Enumerations

enum class ScrollMode: Disabled
Enabled
Auto
enum class ScrollBarVisibility: Disabled
Auto
Visible
Hidden
enum class ZoomMode: Disabled
Enabled

Destructors

~ScrollView() override

PySide6 additions

setOwnedContentWidget(widget): Install content that is deleted when it leaves the host.
setBorrowedContentWidget(widget): Install content that becomes parentless when it leaves the host.
setReparentedContentWidget(widget): Install content that returns to its current QWidget parent.

Subclass interfaces