Fluent-Qt

集合檢視

DrawerView 抽屜檢視

從視窗邊緣滑出的面板。

範例

DrawerView 抽屜檢視: 右側抽屜

用法

右側抽屜

用 setEdge() 選擇滑出邊緣,setDrawerLength() 設定抽屜寬度或高度,呼叫 open() 展開(預設點擊外部或按 Esc 鍵關閉)。

#include <FluentQt/Collections.h>
using namespace fluent::collections;

auto* drawer = new DrawerView(host);
drawer->setEdge(DrawerView::DrawerEdge::Right);
drawer->setDrawerLength(260);
drawer->setContentWidget(settingsPanel, WidgetOwnership::Owned);
auto* openButton = new Button("Open drawer", host);
QObject::connect(openButton, &Button::clicked,
                 drawer, &DrawerView::open);

fluent::collections::DrawerView

繼承自 QWidget · FluentElement · QMLPlus

同視窗邊緣抽屜覆蓋層,支援模態阻擋、壓暗與邊緣拖曳;可承載內容控制項,並處理邊緣定位、輕觸關閉、圓角與滑動動畫。

建構函式

解構函式

列舉

enum class DrawerEdge
  • Left
  • Right
  • Top
  • Bottom
enum CloseFlag
  • NoAutoClose = 0
  • CloseOnPressOutside = 1 << 0
  • CloseOnEscape = 1 << 1

方法

bool isOpen() const

抽屜是否處於開啟狀態。

void setIsOpen(bool open)

抽屜是否處於開啟狀態。

DrawerEdge edge() const

抽屜滑入的視窗邊緣。

void setEdge(DrawerEdge edge)

抽屜滑入的視窗邊緣。

qreal position() const

沿開啟軸的正規化滑動進度(0.0 為關閉,1.0 為開啟)。

void setPosition(qreal position)

沿開啟軸的正規化滑動進度(0.0 為關閉,1.0 為開啟)。

int drawerLength() const

抽屜沿開啟軸線量測的長度。

void setDrawerLength(int length)

抽屜沿開啟軸線量測的長度。

QMargins availableMargins() const

放置抽屜前從所屬視窗移除的邊距。

void setAvailableMargins(const QMargins& margins)

放置抽屜前從所屬視窗移除的邊距。

bool isModal() const

浮層是否阻擋其外部互動。

void setModal(bool modal)

浮層是否阻擋其外部互動。

bool isDim() const

浮層後方是否顯示暗化遮罩層。

void setDim(bool dim)

浮層後方是否顯示暗化遮罩層。

double dimOpacity() const

遮罩不透明度,範圍為 [0, 1];啟用 dim 時,-1 會使用主題煙霧 token。

void setDimOpacity(double opacity)

遮罩不透明度,範圍為 [0, 1];啟用 dim 時,-1 會使用主題煙霧 token。

double backdropBlurRadius() const

背景模糊半徑,範圍為 [0, 32] px(0 表示停用模糊;模態時預設為 4,否則為 0)。

void setBackdropBlurRadius(double radius)

背景模糊半徑,範圍為 [0, 32] px(0 表示停用模糊;模態時預設為 4,否則為 0)。

void refreshBackdrop()

背景內容變更後重新擷取視窗背景效果。

ClosePolicy closePolicy() const

控制外部點擊、Esc 或程式關閉行為的策略。

void setClosePolicy(ClosePolicy policy)

控制外部點擊、Esc 或程式關閉行為的策略。

bool isInteractive() const

指標拖曳是否可操作抽屜。

void setInteractive(bool interactive)

指標拖曳是否可操作抽屜。

int dragMargin() const

用來開始拖曳抽屜的邊緣邊距。

void setDragMargin(int margin)

用來開始拖曳抽屜的邊緣邊距。

int outerCornerRadius() const

抽屜外側邊緣使用的圓角半徑。

void setOuterCornerRadius(int radius)

抽屜外側邊緣使用的圓角半徑。

bool isAnimationEnabled() const

抽屜開啟/關閉轉場是否播放動畫。

void setAnimationEnabled(bool enabled)

抽屜開啟/關閉轉場是否播放動畫。

QWidget* contentWidget() const

承載於抽屜面板中的控制項。

void setContentWidget(QWidget* widget)

設定抽屜內容控制項(預設由呼叫端管理,即 WidgetOwnership::Borrowed)。

bool setContentWidget(QWidget* widget, WidgetOwnership ownership)

以明確的 WidgetOwnership 處置模式設定抽屜內容控制項。

QWidget* takeContentWidget()

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

WidgetOwnership contentOwnership() const

目前內容控制項的銷毀原則。

屬性

bool isOpen

抽屜是否處於開啟狀態。

讀取 isOpen()設定 setIsOpen()變更訊號 isOpenChanged()
DrawerEdge edge

抽屜滑入的視窗邊緣。

讀取 edge()設定 setEdge()變更訊號 edgeChanged()
qreal position

沿開啟軸的正規化滑動進度(0.0 為關閉,1.0 為開啟)。

讀取 position()設定 setPosition()變更訊號 positionChanged()
int drawerLength

抽屜沿開啟軸線量測的長度。

讀取 drawerLength()設定 setDrawerLength()變更訊號 drawerLengthChanged()
QMargins availableMargins

放置抽屜前從所屬視窗移除的邊距。

讀取 availableMargins()設定 setAvailableMargins()變更訊號 availableMarginsChanged()
bool modal

浮層是否阻擋其外部互動。

讀取 isModal()設定 setModal()變更訊號 modalChanged()
bool dim

浮層後方是否顯示暗化遮罩層。

讀取 isDim()設定 setDim()變更訊號 dimChanged()
double dimOpacity

遮罩不透明度,範圍為 [0, 1];啟用 dim 時,-1 會使用主題煙霧 token。

讀取 dimOpacity()設定 setDimOpacity()變更訊號 dimOpacityChanged()
double backdropBlurRadius

背景模糊半徑,範圍為 [0, 32] px(0 表示停用模糊;模態時預設為 4,否則為 0)。

讀取 backdropBlurRadius()設定 setBackdropBlurRadius()變更訊號 backdropBlurRadiusChanged()
ClosePolicy closePolicy

控制外部點擊、Esc 或程式關閉行為的策略。

讀取 closePolicy()設定 setClosePolicy()變更訊號 closePolicyChanged()
bool interactive

指標拖曳是否可操作抽屜。

讀取 isInteractive()設定 setInteractive()變更訊號 interactiveChanged()
int dragMargin

用來開始拖曳抽屜的邊緣邊距。

讀取 dragMargin()設定 setDragMargin()變更訊號 dragMarginChanged()
int outerCornerRadius

抽屜外側邊緣使用的圓角半徑。

讀取 outerCornerRadius()設定 setOuterCornerRadius()變更訊號 outerCornerRadiusChanged()
bool animationEnabled

抽屜開啟/關閉轉場是否播放動畫。

讀取 isAnimationEnabled()設定 setAnimationEnabled()變更訊號 animationEnabledChanged()
QWidget* contentWidget

承載於抽屜面板中的控制項。

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

目前內容控制項的銷毀原則。

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

訊號

void isOpenChanged(bool open)

抽屜是否處於開啟狀態。

void edgeChanged(DrawerEdge edge)

抽屜滑入的視窗邊緣。

void positionChanged(qreal position)

沿開啟軸的正規化滑動進度(0.0 為關閉,1.0 為開啟)。

void drawerLengthChanged(int length)

抽屜沿開啟軸線量測的長度。

void availableMarginsChanged(const QMargins& margins)

放置抽屜前從所屬視窗移除的邊距。

void modalChanged(bool modal)

浮層是否阻擋其外部互動。

void dimChanged(bool dim)

浮層後方是否顯示暗化遮罩層。

void dimOpacityChanged(double opacity)

遮罩不透明度,範圍為 [0, 1];啟用 dim 時,-1 會使用主題煙霧 token。

void backdropBlurRadiusChanged(double radius)

背景模糊半徑,範圍為 [0, 32] px(0 表示停用模糊;模態時預設為 4,否則為 0)。

void closePolicyChanged(ClosePolicy policy)

控制外部點擊、Esc 或程式關閉行為的策略。

void interactiveChanged(bool interactive)

指標拖曳是否可操作抽屜。

void dragMarginChanged(int margin)

用來開始拖曳抽屜的邊緣邊距。

void outerCornerRadiusChanged(int radius)

抽屜外側邊緣使用的圓角半徑。

void animationEnabledChanged(bool enabled)

抽屜開啟/關閉轉場是否播放動畫。

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 基底類別文件:QWidget