Fluent-Qt

API リファレンス

QMLPlus

QWidget ベースのコントロールにアンカー、プロパティバインディング、簡易ステートを追加するミックスインです。ステートおよび 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

ある端からターゲットウィジェットの端への 1 つのアンカー関係。

struct Anchors

1 つの子ウィジェットに対する完全なアンカーセット。

Qt 基底クラスドキュメント:QLayout

fluent::AnchorLayout::Anchor

ある端からターゲットウィジェットの端への 1 つのアンカー関係。

コンストラクタ

フィールド

fluent::AnchorLayout::Anchors

1 つの子ウィジェットに対する完全なアンカーセット。

コンストラクタ

フィールド

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 の state によって適用されるプロパティ割り当て。

フィールド

fluent::AnchorChange

状態によって適用および復元される完全な置換アンカーセット。

フィールド

fluent::QMLState

名前付きのプロパティ変更セット。

フィールド

fluent::PropertyAnimation

MotionPolicy に準拠した、管理対象プロパティ書き込み用のアニメーション設定。

フィールド

fluent::StateTransition

一致する状態変化に対して選択されるアニメーションです(properties リストが空の場合はすべてのプロパティに一致)。空の from/to はデフォルト状態に一致し、"*" は任意の状態に一致します。アンカーの変更はアニメーションされません。

フィールド

fluent::QMLPlusRuntime

継承元 QObject

QObject ホストが所有する、QMLPlus の状態遷移を遅延生成で監視するオブザーバーです。即時切り替えを含め、遷移が完了して安定すると(中断されない限り)transitionFinished() を 1 回発行します。

デストラクタ

メソッド

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++ のセッターを直接呼び出した場合はアニメーションしません。

void clearBehavior(const char* propertyName)

今後のマネージド書き込みに使用するデフォルトアニメーションを削除します。

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

バインディングを削除せずに Behavior 経由でホストプロパティに書き込みます。

protected メンバー

メソッド