Fluent-Qt

捲動

ScrollView 捲動檢視

配備 Fluent 捲軸並支援選用縮放功能的可捲動檢視區。

範例

ScrollView 捲動檢視: 內容捲動與縮放

用法

內容捲動與縮放

大型內容表面可雙向捲動,並在設定的範圍內進行縮放。

#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); });

fluent::scrolling::ScrollView

繼承自 QScrollArea · FluentElement · QMLPlus

具備 Fluent 捲軸與選用縮放支援的可捲動內容容器。

建構函式

解構函式

列舉

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

方法

void setWidget(QWidget* widget)

以 Owned 生命週期設定內容控制項(與 QScrollArea 一致)。

QWidget* takeWidget()

卸離並傳回目前的內容控制項(不刪除)。

QWidget* contentWidget() const

顯示於捲動檢視區內的控制項。

WidgetOwnership contentOwnership() const

目前內容控制項的所有權原則。

void setContentWidget(QWidget* widget)

顯示於捲動檢視區內的控制項。

bool setContentWidget(QWidget* widget, WidgetOwnership ownership)

以明確的所有權原則設定內容控制項;成功套用則傳回 true。

QWidget* takeContentWidget()

卸離內容控制項並以無父物件方式傳回,由呼叫端負責銷毀。

ScrollMode horizontalScrollMode() const

水平捲動互動模式。

ScrollMode verticalScrollMode() const

垂直捲動互動模式。

ZoomMode zoomMode() const

縮放互動模式。

void setZoomMode(ZoomMode mode)

縮放互動模式。

qreal zoomFactor() const

套用至內容的目前縮放係數。

void setZoomFactor(qreal factor)

套用至內容的目前縮放係數。

qreal minZoomFactor() const

允許的最小縮放係數。

void setMinZoomFactor(qreal factor)

允許的最小縮放係數。

qreal maxZoomFactor() const

允許的最大縮放係數。

void setMaxZoomFactor(qreal factor)

允許的最大縮放係數。

bool isScrollChainingEnabled() const

滾輪輸入到達捲動邊界時是否繼續捲動外層容器(預設為 false)。

void setScrollChainingEnabled(bool enabled)

滾輪輸入到達捲動邊界時是否繼續捲動外層容器(預設為 false)。

屬性

ScrollMode horizontalScrollMode

水平捲動互動模式。

讀取 horizontalScrollMode()設定 setHorizontalScrollMode()變更訊號 horizontalScrollModeChanged()
ScrollMode verticalScrollMode

垂直捲動互動模式。

讀取 verticalScrollMode()設定 setVerticalScrollMode()變更訊號 verticalScrollModeChanged()
ScrollBarVisibility horizontalScrollBarVisibility

水平捲軸的可見性原則。

讀取 horizontalScrollBarVisibility()設定 setHorizontalScrollBarVisibility()變更訊號 horizontalScrollBarVisibilityChanged()
ScrollBarVisibility verticalScrollBarVisibility

垂直捲軸的可見性原則。

讀取 verticalScrollBarVisibility()設定 setVerticalScrollBarVisibility()變更訊號 verticalScrollBarVisibilityChanged()
ZoomMode zoomMode

縮放互動模式。

讀取 zoomMode()設定 setZoomMode()變更訊號 zoomModeChanged()
qreal zoomFactor

套用至內容的目前縮放係數。

讀取 zoomFactor()設定 setZoomFactor()變更訊號 zoomFactorChanged()
qreal minZoomFactor

允許的最小縮放係數。

讀取 minZoomFactor()設定 setMinZoomFactor()變更訊號 minZoomFactorChanged()
qreal maxZoomFactor

允許的最大縮放係數。

讀取 maxZoomFactor()設定 setMaxZoomFactor()變更訊號 maxZoomFactorChanged()
bool scrollChainingEnabled

滾輪輸入到達捲動邊界時是否繼續捲動外層容器(預設為 false)。

讀取 isScrollChainingEnabled()設定 setScrollChainingEnabled()變更訊號 scrollChainingEnabledChanged()
QWidget* contentWidget

顯示於捲動檢視區內的控制項。

讀取 contentWidget()設定 setContentWidget()變更訊號 contentWidgetChanged()
fluent::WidgetOwnership contentOwnership

目前內容控制項的所有權原則。

讀取 contentOwnership()變更訊號 contentOwnershipChanged()

訊號

void horizontalScrollModeChanged()

水平捲動互動模式。

void verticalScrollModeChanged()

垂直捲動互動模式。

void horizontalScrollBarVisibilityChanged()

水平捲軸的可見性原則。

void verticalScrollBarVisibilityChanged()

垂直捲軸的可見性原則。

void zoomModeChanged()

縮放互動模式。

void zoomFactorChanged()

套用至內容的目前縮放係數。

void minZoomFactorChanged()

允許的最小縮放係數。

void maxZoomFactorChanged()

允許的最大縮放係數。

void scrollChainingEnabledChanged()

滾輪輸入到達捲動邊界時是否繼續捲動外層容器(預設為 false)。

void contentWidgetChanged(QWidget* widget)

顯示於捲動檢視區內的控制項。

void contentOwnershipChanged(WidgetOwnership ownership)

目前內容控制項的所有權原則。

PySide6 擴充

setOwnedContentWidget(widget)

設定內容。從宿主元件移出時會刪除該內容。

setBorrowedContentWidget(widget)

設定借用的內容。從宿主元件移出時,內容會脫離父元件。

setReparentedContentWidget(widget)

設定內容。移出時,內容會回到設定前的 QWidget 父元件。

受保護成員

方法

繼承自 fluent::FluentElement

列舉

enum Theme

解析設計 token 時使用的全域視覺佈景主題。

  • Light = 0
  • Dark = 1
  • HighContrast = 2

方法

static void setTheme(Theme theme)

更新全域主題,並通知使用中的 FluentElement 執行個體。

static void setThemeDeferred(Theme theme)

排程以可見元素優先的批次主題重新整理,避免阻斷目前的互動。

static Theme currentTheme()

傳回目前生效的全域主題。

static bool themeUsesDarkAppearance(Theme theme)

傳回主題是否使用深色底的視窗框架與材質 token。

static void refreshTheme()

在設計 token 變更後重新廣播目前佈景主題以觸發重繪。

static int themeGeneration()

每次主題變更時遞增的單調計數器,用於過期檢查。

Theme effectiveTheme() const

解析此元素所使用的佈景主題,並遵循繼承的 QWidget 覆寫。

bool effectiveThemeUsesDarkAppearance() const

傳回此元素的實際主題是否使用深色底 chrome。

bool setThemeOverrides(const QJsonObject& overrides)

取代此元素的稀疏色彩、圓角與字型 token 覆寫。

QJsonObject themeOverrides() const

傳回此元素的覆寫設定。

void clearThemeOverrides()

將全部 token 欄位還原為全域主題預設值。

const Colors& themeColorsRef() const

對目前使用中色組的不複製存取(適用於繪製熱路徑)。

Material::AcrylicToken themeAcrylic() const

材質、高度層級與自適應版面配置 token。

QColor themeBackdrop(bool active) const

指定啟用狀態下的視窗 chrome 背景色。

virtual void onThemeUpdated()

在全域主題變更後呼叫。

型別與別名

struct Colors

傳回給元件使用的設計 token 快照。

繼承自 fluent::QMLPlus

方法

AnchorLayout::Anchors* anchors()

傳回 QWidget 宿主的可變錨點。

void setState(const QString& name)

依名稱套用已註冊的狀態,或在 @p name 為空時還原為預設狀態。未知名稱會被忽略,離開該狀態後原有的繫結會恢復同步。

void addState(const QMLState& state)

註冊或取代具名狀態定義;若取代目前啟用中的狀態則會立即套用。

void evaluateStates()

依註冊順序重新評估狀態條件並啟用第一個符合的狀態,若無符合項目則恢復為預設狀態。相依屬性發出通知時也會自動執行;使用 extend 的衍生狀態會繼承上層變更,除非發生循環或缺失。

QMLPlusRuntime* runtime()

傳回由此宿主延遲建立並擁有的狀態觀察器。

void setAnchors(const AnchorLayout::Anchors& anchors)

取代所有宿主錨點,並使父層版面配置失效。

void resetAnchors()

清除所有宿主錨點,並使父版面配置失效。

void bind(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction dir = PropertyBinder::OneWay)

透過 PropertyBinder::bind() 將 @p source 上的 @p sourceProp 繫結至此 QWidget 宿主上的 @p targetProp。

void addTransition(const StateTransition& transition)

依優先順序註冊狀態轉場。

void setBehavior(const char* propertyName, const PropertyAnimation& animation)

設定透過 writeProperty() 或繫結寫入 @p propertyName 時使用的預設動畫。明確的 StateTransition 規則優先;直接呼叫 C++ setter 不會有動畫。

void clearBehavior(const char* propertyName)

移除後續受管理寫入所使用的預設動畫。

bool writeProperty(const char* propertyName, const QVariant& value)

透過 Behavior 寫入宿主屬性,且不移除該屬性的繫結。

Qt 基底類別文件:QScrollArea

fluent::scrolling::ScrollViewZoomAware

供直接處理縮放的 ScrollView 內容控制項實作的介面。

解構函式

方法