Status & info

ToolTip

A popup label that shows extra information about a control on hover.

Example

Usage

Hover target

ToolTip shows a lightweight message while the target is hovered.

#include <FluentQt/StatusInfo.h>
using namespace fluent::status_info;

auto* button = new Button("Archive", this);
auto* toolTip = new ToolTip();
toolTip->setText("Move the selected message to Archive");

// Show the tooltip from the button Enter event and hide it on Leave.
new HoverToolTipController(button, toolTip);

import fluentqt

button = fluentqt.Button("Archive")
tooltip = fluentqt.ToolTip.attach(
    button,
    "Move the selected message to Archive",
    fluentqt.ToolTip.Placement.Above
)

API

Declaration

`fluent::status_info::ToolTip`

Inherits QWidget · FluentElement · QMLPlus

Fluent tooltip bubble with margin and animation controls.

Constructors

explicit ToolTip(QWidget* parent = nullptr)

Properties

QMargins margins: Margins around tooltip content.
Read margins()Write setMargins()Notify marginsChanged()
bool animationEnabled: Whether tooltip show/hide transitions are animated.
Read isAnimationEnabled()Write setAnimationEnabled()Notify animationEnabledChanged()

Methods

static ToolTip* attach(QWidget* target, const QString& text, Placement placement = Above): Attaches a Fluent tooltip to a widget and reuses an existing attachment.
void setText(const QString& text)
QString text() const
QMargins margins() const: Margins around tooltip content.
void setMargins(const QMargins& margins): Margins around tooltip content.
int shadowMargin() const: Transparent border (px) reserved on every side for the drop shadow; callers that position the visible bubble precisely should offset by this.
void setFont(const QFont& font): Shadows QWidget::setFont so it reaches the inner label.
void setThemeSource(QWidget* source): Uses a widget as the local theme source for this top-level tooltip.
bool isAnimationEnabled() const: Whether tooltip show/hide transitions are animated.
void setAnimationEnabled(bool enabled): Whether tooltip show/hide transitions are animated.
void setVisible(bool visible) override
void onThemeUpdated() override

Signals

void marginsChanged(): Margins around tooltip content.
void animationEnabledChanged(bool enabled): Whether tooltip show/hide transitions are animated.

Enumerations

enum Placement: Preferred side of the target used by an attached tooltip.
Above
Below
Left
Right

Subclass interfaces

Methods

bool eventFilter(QObject* watched, QEvent* event) override
void paintEvent(QPaintEvent* event) override

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() const: Resolves the theme used by this element, honoring an inherited QWidget override.
bool effectiveThemeUsesDarkAppearance() const: Returns whether this element's effective theme uses dark-backed chrome.
bool setThemeOverrides(const QJsonObject& overrides): Component-facing token accessors.
QJsonObject themeOverrides() const: Returns this element's authored overrides.
void clearThemeOverrides(): Restores all token fields to global theme defaults.
Colors themeColors() const
const Colors& themeColorsRef() const: Non-copying access to the active color set (for hot paint paths).
FontStyle themeFont(Typography::FontRole role = Typography::FontRole::Body) const
Radius themeRadius() const
Spacing themeSpacing() const
Animation themeAnimation() const
Material::AcrylicToken themeAcrylic() const: Material, elevation, and adaptive layout tokens.
Material::MicaToken themeMica() const
Material::SmokeToken themeSmoke() const
Elevation::ShadowParams themeShadow(Elevation::Level level) const
int themeBreakpoint(Breakpoints::Breakpoint breakpoint = Breakpoints::Breakpoint::Medium) const
QColor themeBackdrop(bool active) const: Window-chrome backdrop color for the given activation state.
virtual void onThemeUpdated(): Called after the global theme changes.

Enumerations

enum Theme: Global visual theme used when resolving design tokens.
Light = 0
Dark = 1
HighContrast = 2

Types and aliases

struct Colors: Design token snapshots returned to components.
struct FontStyle
struct Radius
struct Spacing
struct Animation

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.
QString state() const
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