Fluent-Qt

Диалоги и всплывающие окна

TeachingTip Обучающая подсказка

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

Пример

TeachingTip Обучающая подсказка: Целевая подсказка с причинами закрытия

Использование

Целевая подсказка с причинами закрытия

TeachingTip указывает на целевой элемент, может закрываться по клику снаружи и сообщает способ закрытия.

#include <FluentQt/DialogsFlyouts.h>
using namespace fluent::dialogs_flyouts;

auto* tip = new TeachingTip(window());
tip->setPreferredPlacement(TeachingTip::Right);
tip->setLightDismissEnabled(true);
tip->setCardSize(QSize(320, 154));
connect(tip, &TeachingTip::closing, status,
        [status](TeachingTip::CloseReason reason) { updateStatus(reason); });
tip->showAt(targetButton);

fluent::dialogs_flyouts::TeachingTip

Наследует Popup

Контекстное обучающее всплывающее окно с привязкой к цели, настройками размещения и опциональным хвостиком.

Конструкторы

Перечисления

enum PreferredPlacement
  • Auto
  • Top
  • TopLeft
  • TopRight
  • Bottom
  • BottomLeft
  • BottomRight
  • Left
  • LeftTop
  • LeftBottom
  • Right
  • RightTop
  • RightBottom
enum CloseReason
  • Programmatic = Popup::Programmatic
  • ActionButton = Popup::ActionButton
  • CloseButton = Popup::CloseButton
  • LightDismiss = Popup::LightDismiss
  • TargetDestroyed = Popup::TargetDestroyed

Методы

QWidget* target() const

Целевой виджет для привязки обучающей подсказки.

void setTarget(QWidget* target)

Целевой виджет для привязки обучающей подсказки.

PreferredPlacement preferredPlacement() const

Предпочтительное расположение обучающей подсказки вокруг цели.

void setPreferredPlacement(PreferredPlacement placement)

Предпочтительное расположение обучающей подсказки вокруг цели.

int placementMargin() const

Отступ, сохраняемый между обучающей подсказкой и целью.

void setPlacementMargin(int margin)

Отступ, сохраняемый между обучающей подсказкой и целью.

bool isLightDismissEnabled() const

Закрывает ли обучающую подсказку взаимодействие за её пределами.

void setLightDismissEnabled(bool enabled)

Закрывает ли обучающую подсказку взаимодействие за её пределами.

bool isTailVisible() const

Отрисовывается ли указатель (хвостик) обучающей подсказки.

void setTailVisible(bool visible)

Отрисовывается ли указатель (хвостик) обучающей подсказки.

QWidget* contentHost() const

Контейнер содержимого, геометрия которого автоматически обновляется в соответствии с размещением и cardSize().

void setCardSize(const QSize& size)

Задаёт размер содержимого карточки без учёта тени и указателя (по умолчанию 360x200).

Свойства

QWidget* target

Целевой виджет для привязки обучающей подсказки.

Чтение target()Запись setTarget()Уведомление targetChanged()
PreferredPlacement preferredPlacement

Предпочтительное расположение обучающей подсказки вокруг цели.

Чтение preferredPlacement()Запись setPreferredPlacement()Уведомление preferredPlacementChanged()
int placementMargin

Отступ, сохраняемый между обучающей подсказкой и целью.

Чтение placementMargin()Запись setPlacementMargin()Уведомление placementMarginChanged()
bool lightDismissEnabled

Закрывает ли обучающую подсказку взаимодействие за её пределами.

Чтение isLightDismissEnabled()Запись setLightDismissEnabled()Уведомление lightDismissEnabledChanged()
bool tailVisible

Отрисовывается ли указатель (хвостик) обучающей подсказки.

Чтение isTailVisible()Запись setTailVisible()Уведомление tailVisibleChanged()

Сигналы

void targetChanged(QWidget* target)

Целевой виджет для привязки обучающей подсказки.

void preferredPlacementChanged(PreferredPlacement placement)

Предпочтительное расположение обучающей подсказки вокруг цели.

void placementMarginChanged(int margin)

Отступ, сохраняемый между обучающей подсказкой и целью.

void lightDismissEnabledChanged(bool enabled)

Закрывает ли обучающую подсказку взаимодействие за её пределами.

void tailVisibleChanged(bool visible)

Отрисовывается ли указатель (хвостик) обучающей подсказки.

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

Методы

Унаследовано от fluent::dialogs_flyouts::Popup

Перечисления

enum CloseFlag
  • NoAutoClose = 0
  • CloseOnPressOutside = 1 << 0
  • CloseOnEscape = 1 << 1
enum CloseReason

Причина закрытия оверлея. Значения 0–4 соответствуют TeachingTip::CloseReason.

  • Programmatic = 0
  • ActionButton = 1
  • CloseButton = 2
  • LightDismiss = 3
  • TargetDestroyed = 4
  • Escape = 5

Методы

bool isOpen() const

Запрошенное состояние открытия (независимо от хода анимации или видимости виджета).

ClosePolicy closePolicy() const

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

void setClosePolicy(ClosePolicy p)

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

bool isModal() const

Блокирует ли оверлей взаимодействие за своими пределами.

void setModal(bool m)

Блокирует ли оверлей взаимодействие за своими пределами.

bool lightDismissConsumesPress() const

Определяет, поглощает ли закрытие по CloseOnPressOutside нажатие кнопки мыши вместо его передачи дальше (по умолчанию false).

void addLightDismissPassthrough(QWidget* widget)

Исключает виджет из lightDismissConsumesPress(), не принимая владение.

bool isDim() const

Определяет, отображается ли затемняющий слой позади оверлея.

void setDim(bool d)

Определяет, отображается ли затемняющий слой позади оверлея.

double dimOpacity() const

Непрозрачность подложки в диапазоне [0, 1]; -1 использует токен smoke темы. Применяется только при включённом dim.

void setDimOpacity(double opacity)

Непрозрачность подложки в диапазоне [0, 1]; -1 использует токен smoke темы. Применяется только при включённом dim.

double backdropBlurRadius() const

Радиус размытия [0, 32] для захваченного фона (0 отключает; по умолчанию 4 для модального режима и 0 иначе).

void setBackdropBlurRadius(double radius)

Радиус размытия [0, 32] для захваченного фона (0 отключает; по умолчанию 4 для модального режима и 0 иначе).

bool isAnimationEnabled() const

Анимируются ли переходы открытия и закрытия всплывающего окна.

void setAnimationEnabled(bool e)

Анимируются ли переходы открытия и закрытия всплывающего окна.

bool isExitAnimationEnabled() const

Определяет, воспроизводит ли close() анимацию затухания при закрытии (анимация открытия не затрагивается).

void setThemeSource(QWidget* source)

Задаёт виджет в качестве резервного источника темы, если у всплывающего окна нет привязки.

double popupProgress() const

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

void setPopupProgress(double p)

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

void setPosition(QWidget* relativeTo, const QPoint& localPos)

Размещает левый верхний угол всплывающего окна в точке localPos в координатах relativeTo; если не задано, open() центрирует окно.

void setIsOpen(bool open)

Запрошенное состояние открытия (независимо от хода анимации или видимости виджета).

void refreshBackdrop()

Обновляет кэшированный фон после изменения содержимого приложения под открытым всплывающим окном.

void closeWithReason(CloseReason reason)

Закрывает с явной причиной; close() использует Programmatic, если нет ожидающей причины.

Свойства

bool isOpen

Запрошенное состояние открытия (независимо от хода анимации или видимости виджета).

Чтение isOpen()Запись setIsOpen()Уведомление isOpenChanged()
ClosePolicy closePolicy

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

Чтение closePolicy()Запись setClosePolicy()Уведомление closePolicyChanged()
bool modal

Блокирует ли оверлей взаимодействие за своими пределами.

Чтение isModal()Запись setModal()Уведомление modalChanged()
bool dim

Определяет, отображается ли затемняющий слой позади оверлея.

Чтение isDim()Запись setDim()Уведомление dimChanged()
double dimOpacity

Непрозрачность подложки в диапазоне [0, 1]; -1 использует токен smoke темы. Применяется только при включённом dim.

Чтение dimOpacity()Запись setDimOpacity()Уведомление dimOpacityChanged()
double backdropBlurRadius

Радиус размытия [0, 32] для захваченного фона (0 отключает; по умолчанию 4 для модального режима и 0 иначе).

Чтение backdropBlurRadius()Запись setBackdropBlurRadius()Уведомление backdropBlurRadiusChanged()
bool animationEnabled

Анимируются ли переходы открытия и закрытия всплывающего окна.

Чтение isAnimationEnabled()Запись setAnimationEnabled()Уведомление animationEnabledChanged()
double popupProgress

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

Чтение popupProgress()Запись setPopupProgress()Уведомление popupProgressChanged()

Сигналы

void isOpenChanged(bool open)

Запрошенное состояние открытия (независимо от хода анимации или видимости виджета).

void opening()

Запущен переход открытия. Псевдоним совместимости: aboutToShow().

void closing(CloseReason reason)

Начат переход закрытия. aboutToHide() — псевдоним совместимости без параметров.

void popupProgressChanged(double progress)

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

void closePolicyChanged(ClosePolicy policy)

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

void modalChanged(bool modal)

Блокирует ли оверлей взаимодействие за своими пределами.

void dimChanged(bool dim)

Определяет, отображается ли затемняющий слой позади оверлея.

void dimOpacityChanged(double opacity)

Непрозрачность подложки в диапазоне [0, 1]; -1 использует токен smoke темы. Применяется только при включённом dim.

void backdropBlurRadiusChanged(double radius)

Радиус размытия [0, 32] для захваченного фона (0 отключает; по умолчанию 4 для модального режима и 0 иначе).

void animationEnabledChanged(bool enabled)

Анимируются ли переходы открытия и закрытия всплывающего окна.

Типы и псевдонимы

Унаследовано от fluent::FluentElement

Перечисления

enum Theme

Глобальная визуальная тема, используемая при разрешении дизайн-токенов.

  • 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)

Возвращает, использует ли тема токены тёмного оформления и материалов.

static void refreshTheme()

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

static int themeGeneration()

Монотонный счётчик, увеличиваемый при каждом изменении темы для проверки актуальности.

Theme effectiveTheme() const

Определяет тему, используемую этим элементом, с учётом унаследованного переопределения QWidget.

bool effectiveThemeUsesDarkAppearance() const

Возвращает, использует ли действующая тема этого элемента тёмную основу оформления.

bool setThemeOverrides(const QJsonObject& overrides)

Заменяет разреженные переопределения токенов цвета, скругления и шрифта этого элемента.

QJsonObject themeOverrides() const

Возвращает заданные переопределения этого элемента.

void clearThemeOverrides()

Восстанавливает для всех полей токенов значения глобальной темы по умолчанию.

const Colors& themeColorsRef() const

Доступ без копирования к активному набору цветов для горячих путей отрисовки.

Material::AcrylicToken themeAcrylic() const

Токены материалов, возвышения и адаптивной компоновки.

QColor themeBackdrop(bool active) const

Цвет фона рамки окна для заданного состояния активации.

virtual void onThemeUpdated()

Вызывается после изменения глобальной темы.

Типы и псевдонимы

struct Colors

Снимки дизайн-токенов, возвращаемые компонентам.

Унаследовано от 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 без удаления его привязки.

Документация базового класса Qt: QWidget