Fluent-Qt

API 參考

QMLPlus

為 QWidget 控制項提供錨點版面配置、屬性繫結與簡易狀態切換能力的 mixin。狀態與 runtime() 需要 QObject 宿主,錨點與面向宿主的繫結輔助函式則需要 QWidget。

fluent::AnchorLayout

繼承自 QLayout

適用於 QWidget 控制項的輕量級錨點版面配置。儲存各子控制項的邊緣錨點,並在版面配置階段解析控制項幾何位置。

建構函式

解構函式

列舉

enum class Edge

可錨定的邊緣或中心線。

  • None
  • Left
  • Right
  • Top
  • Bottom
  • HCenter
  • VCenter

方法

Anchors anchorsForWidget(QWidget* widget) const

傳回已註冊控制項的目前錨點。

bool setWidgetAnchors(QWidget* widget, const Anchors& anchors)

取代已註冊控制項的錨點,並使版面配置失效。

型別與別名

struct Anchor

從某個邊緣到目標控制項邊緣的單一錨定關係。

struct Anchors

單一子控制項的完整錨點集合。

Qt 基底類別文件:QLayout

fluent::AnchorLayout::Anchor

從某個邊緣到目標控制項邊緣的單一錨定關係。

建構函式

欄位

fluent::AnchorLayout::Anchors

單一子控制項的完整錨點集合。

建構函式

欄位

fluent::BindingDependency

計算繫結或狀態條件的可觀察屬性相依項;該屬性必須在呼叫執行緒上可讀且具備 NOTIFY 訊號。

欄位

fluent::BindingOptions

繫結的初始啟用狀態,以及可選的事件迴圈合併更新設定。

欄位

fluent::BindingHandle

指向由目標物件管理之屬性繫結的可複製控制代碼。複製或銷毀該控制代碼不會解除繫結;請呼叫 unbind() 以永久移除繫結。

建構函式

方法

bool isValid() const

回報繫結及其端點是否仍然有效。

bool isEnabled() const

傳回啟用狀態,不受暫停或狀態暫止影響。

bool isSuspended() const

回報是否處於手動暫停或作用中的狀態覆寫。

void setEnabled(bool enabled) const

啟用或停用同步;啟用時會立即重新整理。

void pause() const

保持目前顯示值,並保留啟用狀態。

void resume() const

解除手動暫停,並重新整理已啟用且未被覆蓋的繫結。

void refresh() const

立即評估作用中的繫結,略過延遲排程。

void unbind() const

永久移除繫結,並保留目前的顯示值。

fluent::PropertyBinder

透過 Qt 中繼屬性與 NOTIFY 訊號進行受管屬性同步。有效的替換會使舊繫結控制代碼失效;無效請求則保留現有繫結。

列舉

enum Direction

繫結方向。

  • OneWay
  • TwoWay

方法

static void bind(QObject* source, const char* sPropName, QObject* target, const char* tPropName, Direction dir = OneWay)

使用可用的 NOTIFY 訊號,將 @p source 上的 @p sPropName 繫結至 @p target 上的 @p tPropName。兩個物件都必須位於呼叫執行緒上;有效的呼叫會取代目標屬性上既有的繫結。

static BindingHandle bindManaged(QObject* source, const char* sourceProp, QObject* target, const char* targetProp, Direction direction = OneWay, BindingOptions options = {})

安裝受管理的直接繫結並立即同步初始值。兩個物件必須位於呼叫端執行緒;@p sourceProp 需具備 NOTIFY 且 @p targetProp 必須可寫(TwoWay 要求雙向皆須可讀、可寫且具備通知訊號)。

static BindingHandle bindComputed(QObject* target, const char* targetProp, const QVector<BindingDependency>& dependencies, std::function<QVariant()> evaluate, BindingOptions options = {})

安裝由明確的 @p dependencies 驅動的 C++ 運算式繫結。目標屬性必須可讀且可寫;銷毀任何相依項目都會使繫結永久失效。

fluent::PropertyChange

由 QMLPlus 狀態套用的屬性指派。

欄位

fluent::AnchorChange

由狀態套用並還原的完整取代錨點集合。

欄位

fluent::QMLState

具名的屬性變更集合。

欄位

fluent::PropertyAnimation

受管理屬性寫入的動畫設定,會遵循 MotionPolicy 動態策略。

欄位

fluent::StateTransition

為相符的狀態切換指定動畫(properties 為空時比對全部屬性)。空的 from/to 表示預設狀態,"*" 比對任意狀態;錨點變更不播放動畫。

欄位

fluent::QMLPlusRuntime

繼承自 QObject

由 QObject 宿主延遲建立並擁有的 QMLPlus 狀態轉場觀察物件。轉場穩定後(包含立即切換)會發出一次 transitionFinished(),除非遭中斷。

解構函式

方法

QString state() const

傳回動畫完成前的邏輯目標狀態。

bool isTransitionRunning() const

回報受管理的狀態轉換動畫是否正在執行。

屬性

QString state

傳回動畫完成前的邏輯目標狀態。

讀取 state()變更訊號 stateChanged()
bool transitionRunning

回報受管理的狀態轉換動畫是否正在執行。

讀取 isTransitionRunning()變更訊號 transitionRunningChanged()

訊號

void stateChanged(const QString& state)

傳回動畫完成前的邏輯目標狀態。

void transitionRunningChanged(bool running)

回報受管理的狀態轉換動畫是否正在執行。

Qt 基底類別文件:QObject

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 寫入宿主屬性,且不移除該屬性的繫結。

受保護成員

方法