API reference

OverlayScrim

Same-window dim/scrim used behind modal overlays, drawers, and spotlights.

`fluent::overlay::OverlayScrim`

Inherits QWidget · FluentElement

Constructors

explicit OverlayScrim(QWidget* parent = nullptr, const QString& objectName = QString())

Properties

double progress: Shared blur and dim fade progress from 0 (clear) to 1 (fully shown).
Read progress()Write setProgress()
QRect spotlightRect: Rounded cut-out kept undimmed (scrim-local coordinates).
Read spotlightRect()Write setSpotlightRect()

Methods

void setModalAndDim(bool modal, bool dim)
void setOpacityProgress(qreal progress)
qreal opacityProgress() const
double progress() const: Alias used by Dialog smoke fade and Gallery intro tour animations.
void setProgress(double progress): Shared blur and dim fade progress from 0 (clear) to 1 (fully shown).
void setColor(const QColor& color): Overrides the theme smoke color; an invalid color restores the theme token.
QColor color() const
void setDimOpacity(qreal opacity)
void setBackdrop(QWidget* overlay, qreal radius)
void refreshBackdrop()
void setSurfaceRadius(int radius)
int surfaceRadius() const
bool spotlightEnabled() const
void setSpotlightEnabled(bool enabled)
QRect spotlightRect() const: Rounded cut-out kept undimmed (scrim-local coordinates).
void setSpotlightRect(const QRect& rect): Rounded cut-out kept undimmed (scrim-local coordinates).
void setSpotlightRadius(int radius)
int spotlightRadius() const
void onThemeUpdated() override

Signals

void pressed(const QPoint& globalPos)

Subclass interfaces

Methods

void paintEvent(QPaintEvent* event) override
void mousePressEvent(QMouseEvent* event) override
void mouseReleaseEvent(QMouseEvent* event) override
void mouseMoveEvent(QMouseEvent* event) override
void wheelEvent(QWheelEvent* event) override
void resizeEvent(QResizeEvent* 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

All inherited Qt members：QWidget