Dialogs & flyouts
CoachMark
A standalone teaching tip in its own window that points a tail at a target and glides between them.
Example
Usage
Targeted coach mark with glide
CoachMark overlays its owning window, points a tail at a target, and glides to a new target when retargeted while open.
#include <FluentQt/DialogsFlyouts.h>
using namespace fluent::dialogs_flyouts;
auto* coach = new CoachMark(window());
connect(this, &QObject::destroyed, coach, &QObject::deleteLater);
coach->setCardSize(QSize(320, 150));
coach->setPlacement(CoachMark::Bottom);
coach->setTarget(targetButton); // glides if already open
closeButton->setAccessibleName("Close");
connect(closeButton, &Button::clicked, coach, &CoachMark::close);
coach->open();import fluentqt
from PySide6.QtCore import QSize
coach = fluentqt.CoachMark(window)
page.destroyed.connect(coach.deleteLater)
coach.setCardSize(QSize(320, 150))
coach.setPlacement(fluentqt.CoachMark.Placement.Bottom)
coach.setTarget(target_button)
close_button.setAccessibleName("Close")
close_button.clicked.connect(coach.close)
coach.open()API
DeclarationNo matching API members.
fluent::dialogs_flyouts::CoachMark
Inherits QWidget · fluent::FluentElement · fluent::QMLPlus
Same-window teaching tip with a tail aimed at a target.
Constructors
Properties
double fadeOpacity- Read
fadeOpacity()WritesetFadeOpacity() QSize cardSize- Read
cardSize()WritesetCardSize() QWidget* target- Read
target()WritesetTarget() Placement placement- Read
placement()WritesetPlacement() bool open- Read
isOpen()WritesetOpen()NotifyopenChanged()
Methods
SurfaceMode surfaceMode() constAlways SameWindowSurface; retained for API compatibility.
Signals
void opened()Emitted after the entrance fade completes.
void closed()Emitted after the exit fade completes and the surface is hidden.
Enumerations
enum SurfaceModeHistorical surface mode; both values host the tip inside the owner top-level.
TopLevelSurfaceDeprecated alias of SameWindowSurface.SameWindowSurfaceChild widget inside the owner top-level.
enum PlacementAutoResolves to Bottom.TopCard above the target, tail down.BottomCard below the target, tail up.LeftCard left of the target, tail right.RightCard right of the target, tail left.
Destructors
Subclass interfaces
Methods
Inherited from fluent::FluentElement
Methods
static void setTheme(Theme theme)Updates the global theme and notifies active FluentElement instances.
static void setThemeDeferred(Theme theme)Schedules a visible-first batched theme refresh without blocking the current interaction.
static Theme currentTheme()Returns the currently active global theme.
static bool themeUsesDarkAppearance(Theme theme)Returns whether a theme uses dark-backed chrome and material tokens.
static void refreshTheme()Re-broadcasts the current theme to repaint after a design-token change.
static int themeGeneration()Monotonic counter bumped on every theme change, for staleness checks.
Theme effectiveTheme() constResolves the theme used by this element, honoring an inherited QWidget override.
bool effectiveThemeUsesDarkAppearance() constReturns whether this element's effective theme uses dark-backed chrome.
bool setThemeOverrides(const QJsonObject& overrides)Component-facing token accessors.
QJsonObject themeOverrides() constReturns this element's authored overrides.
void clearThemeOverrides()Restores all token fields to global theme defaults.
const Colors& themeColorsRef() constNon-copying access to the active color set (for hot paint paths).
Material::AcrylicToken themeAcrylic() constMaterial, elevation, and adaptive layout tokens.
QColor themeBackdrop(bool active) constWindow-chrome backdrop color for the given activation state.
virtual void onThemeUpdated()Called after the global theme changes.
Enumerations
enum ThemeGlobal visual theme used when resolving design tokens.
Light = 0Dark = 1HighContrast = 2
Types and aliases
struct ColorsDesign token snapshots returned to components.
Inherited from fluent::QMLPlus
Methods
AnchorLayout::Anchors* anchors()Returns mutable anchors for the QWidget host.
void setState(const QString& name)Applies a named state, or clears state when name is empty.
void addState(const QMLState& state)Registers or replaces a named state definition.
void evaluateStates()Reevaluates conditions; the first registered true condition wins.
QMLPlusRuntime* runtime()Returns the lazy host-owned state observation object.
void setAnchors(const AnchorLayout::Anchors& anchors)Replaces all host anchors and invalidates the parent layout.
void resetAnchors()Clears all host anchors and invalidates the parent layout.
void bind(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction dir = PropertyBinder::OneWay)Binds a source property to a property on the QWidget host.
BindingHandle bindManaged(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction direction = PropertyBinder::OneWay, BindingOptions options = {})Installs a managed direct binding on this QWidget host.
BindingHandle bindComputed(const char* targetProp, const QVector<BindingDependency>& dependencies, std::function<QVariant()> evaluate, BindingOptions options = {})Installs an explicit-dependency C++ expression on this QWidget host.
void addTransition(const StateTransition& transition)Registers a state transition in precedence order.
void setBehavior(const char* propertyName, const PropertyAnimation& animation)Sets the default animation for this host's managed property writes.
void clearBehavior(const char* propertyName)Removes the default animation for future managed writes.
bool writeProperty(const char* propertyName, const QVariant& value)Writes a host property through Behavior without removing its binding.
All inherited Qt members：QWidget