Fluent-Qt

基礎輸入

ToggleSwitch 切換開關

在開啟與關閉狀態之間切換的開關控制項。

範例

ToggleSwitch 切換開關: 讀取開關狀態

用法

讀取開關狀態

setOnContent() 與 setOffContent() 用於設定兩種狀態的文字,toggled(bool) 訊號可將開關狀態同步至周圍介面。

#include <FluentQt/BasicInput.h>
using namespace fluent::basicinput;

auto* toggle = new ToggleSwitch(this);
toggle->setOnContent("On");
toggle->setOffContent("Off");
toggle->setAccessibleName("Feature toggle");
auto* status = new Label("State: Off", this);
connect(toggle, &ToggleSwitch::toggled,
        status, [status](bool on) {
            status->setText(on ? "State: On" : "State: Off");
        });

fluent::basicinput::ToggleSwitch

繼承自 QWidget · FluentElement · QMLPlus

Fluent 開啟/關閉切換開關控制項。僅繪製軌道、旋鈕與選用狀態文字;欄位標籤請置於外部(例如搭配 Field)。

建構函式

方法

bool isOn() const

切換開關目前的開啟/關閉狀態。

void setIsOn(bool on)

切換開關目前的開啟/關閉狀態。

QString onContent() const

開啟狀態顯示的文字。

void setOnContent(const QString& content)

開啟狀態顯示的文字。

QString offContent() const

關閉狀態顯示的文字。

void setOffContent(const QString& content)

關閉狀態顯示的文字。

Typography::FontRole fontRole() const

跟隨佈景主題字型時使用的 Fluent Typography 預設樣式。

void setFontRole(Typography::FontRole role)

跟隨佈景主題字型時使用的 Fluent Typography 預設樣式。

qreal visualScale() const

切換開關圖形與內容間距的縮放比例,獨立於控制項大小與字型。

void setVisualScale(qreal scale)

設定切換開關的視覺縮放倍率(限制於 [0.5, 10.0],預設 1.0 為 40x20 px),不變更固定控制項尺寸或文字。

void setFont(const QFont& font)

設定明確字型;後續佈景主題重新整理不會變更此字型。

qreal knobPosition() const

切換開關圓鈕位置的動畫值,依關閉至開啟正規化。

void setKnobPosition(qreal pos)

切換開關圓鈕位置的動畫值,依關閉至開啟正規化。

屬性

bool isOn

切換開關目前的開啟/關閉狀態。

讀取 isOn()設定 setIsOn()變更訊號 toggled()
QString onContent

開啟狀態顯示的文字。

讀取 onContent()設定 setOnContent()變更訊號 onContentChanged()
QString offContent

關閉狀態顯示的文字。

讀取 offContent()設定 setOffContent()變更訊號 offContentChanged()
Typography::FontRole fontRole

跟隨佈景主題字型時使用的 Fluent Typography 預設樣式。

讀取 fontRole()設定 setFontRole()變更訊號 fontRoleChanged()
qreal visualScale

切換開關圖形與內容間距的縮放比例,獨立於控制項大小與字型。

讀取 visualScale()設定 setVisualScale()變更訊號 visualScaleChanged()
qreal knobPosition

切換開關圓鈕位置的動畫值,依關閉至開啟正規化。

讀取 knobPosition()設定 setKnobPosition()

訊號

void toggled(bool isOn)

切換開關目前的開啟/關閉狀態。

void onContentChanged(const QString& content)

開啟狀態顯示的文字。

void fontRoleChanged()

跟隨佈景主題字型時使用的 Fluent Typography 預設樣式。

void visualScaleChanged(qreal scale)

切換開關圖形與內容間距的縮放比例,獨立於控制項大小與字型。

受保護成員

方法

繼承自 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