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

Одна связь привязки от края к краю целевого виджета.

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)

Связывает @p sPropName объекта @p source со свойством @p tPropName объекта @p target с помощью доступных сигналов NOTIFY. Оба объекта должны находиться в вызывающем потоке; корректный вызов заменяет существующую привязку целевого свойства.

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 = {})

Устанавливает привязку C++-выражения на основе явных @p dependencies. Целевое свойство должно быть доступно для чтения и записи; уничтожение любой зависимости навсегда делает привязку недействительной.

fluent::PropertyChange

Присваивание свойства, применяемое состоянием QMLPlus.

Поля

fluent::AnchorChange

Полный замещающий набор привязок, применяемый и восстанавливаемый состоянием.

Поля

fluent::QMLState

Именованный набор изменений свойств.

Поля

fluent::PropertyAnimation

Параметры анимации для управляемой записи свойств с учётом MotionPolicy.

Поля

fluent::StateTransition

Анимация для соответствующих переходов состояний; пустой список properties соответствует всем свойствам. Пустые from/to обозначают состояние по умолчанию, а "*" — любое состояние; изменения привязки не анимируются.

Поля

fluent::QMLPlusRuntime

Наследует QObject

Лениво создаваемый наблюдатель переходов состояний QMLPlus, принадлежащий хосту QObject. Однократно испускает 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)

Связывает @p sourceProp объекта @p source со свойством @p targetProp этого хоста QWidget через PropertyBinder::bind().

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

Устанавливает C++-выражение с явными зависимостями на этом хосте QWidget.

void addTransition(const StateTransition& transition)

Регистрирует переход состояния в порядке приоритета.

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

Задаёт анимацию по умолчанию при записи @p propertyName через writeProperty() или привязку. Явные правила StateTransition имеют приоритет; прямые вызовы C++ сеттеров не анимируются.

void clearBehavior(const char* propertyName)

Удаляет анимацию по умолчанию для последующих управляемых записей.

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

Записывает свойство хоста через Behavior без удаления его привязки.

Защищённые члены

Методы