Basic input

ToggleSwitch

A switch that flips between on and off states.

Example

Usage

ToggleSwitch state

The toggled signal mirrors the on/off state into surrounding UI.

#include <FluentQt/BasicInput.h>
using namespace fluent::basicinput;

auto* toggle = new ToggleSwitch(this);
toggle->setOnContent("On");
toggle->setOffContent("Off");
toggle->setAccessibleName("Feature toggle");
auto* status = new Label("State: Off", this);
connect(toggle, &ToggleSwitch::toggled,
        status, [status](bool on) {
            status->setText(on ? "State: On" : "State: Off");
        });

import fluentqt

toggle = fluentqt.ToggleSwitch()
toggle.setOnContent("On")
toggle.setOffContent("Off")
toggle.setAccessibleName("Feature toggle")
status = fluentqt.Label("State: Off")
toggle.toggled.connect(
    lambda on: status.setText("State: On" if on else "State: Off")
)

API

Declaration

`fluent::basicinput::ToggleSwitch`

Inherits QWidget · FluentElement · QMLPlus

Fluent switch for binary on/off settings.

Constructors

explicit ToggleSwitch(QWidget* parent = nullptr)

Properties

bool isOn: Current on/off state of the switch.
Read isOn()Write setIsOn()Notify toggled()
QString onContent: Text shown for the on state.
Read onContent()Write setOnContent()Notify onContentChanged()
QString offContent: Text shown for the off state.
Read offContent()Write setOffContent()Notify offContentChanged()
Typography::FontRole fontRole: Fluent typography role used while the switch follows theme fonts.
Read fontRole()Write setFontRole()Notify fontRoleChanged()
qreal visualScale: Scale of the switch graphics and content gap, independent of widget size and font.
Read visualScale()Write setVisualScale()Notify visualScaleChanged()
qreal knobPosition: Animated switch knob position, normalized from off to on.
Read knobPosition()Write setKnobPosition()

Methods

void onThemeUpdated() override
bool isOn() const: Current on/off state of the switch.
void setIsOn(bool on): Current on/off state of the switch.
QString onContent() const: Text shown for the on state.
void setOnContent(const QString& content): Text shown for the on state.
QString offContent() const: Text shown for the off state.
void setOffContent(const QString& content): Text shown for the off state.
Typography::FontRole fontRole() const: Fluent typography role used while the switch follows theme fonts.
void setFontRole(Typography::FontRole role): Fluent typography role used while the switch follows theme fonts.
qreal visualScale() const: Scale of the switch graphics and content gap, independent of widget size and font.
void setVisualScale(qreal scale): Sets the visual scale and updates layout hints without resizing a fixed widget.
void setFont(const QFont& font): Sets an explicit font that remains unchanged by later theme refreshes.
qreal knobPosition() const: Animated switch knob position, normalized from off to on.
void setKnobPosition(qreal pos): Animated switch knob position, normalized from off to on.
QSize sizeHint() const override
QSize minimumSizeHint() const override

Signals

void toggled(bool isOn): Current on/off state of the switch.
void onContentChanged(const QString& content): Text shown for the on state.
void offContentChanged(const QString& content): Text shown for the off state.
void fontRoleChanged(): Fluent typography role used while the switch follows theme fonts.
void visualScaleChanged(qreal scale): Scale of the switch graphics and content gap, independent of widget size and font.

Subclass interfaces

Methods

void paintEvent(QPaintEvent* event) override
void mousePressEvent(QMouseEvent* event) override
void mouseReleaseEvent(QMouseEvent* event) override
void enterEvent(FluentEnterEvent* event) override
void leaveEvent(QEvent* event) override
void keyPressEvent(QKeyEvent* event) override
void focusInEvent(QFocusEvent* event) override
void focusOutEvent(QFocusEvent* event) override
void changeEvent(QEvent* 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