基础输入

ToggleSwitch 开关

打开或关闭一项设置。

示例

用法

读取开关状态

setOnContent() 和 setOffContent() 设置两种状态的文字，toggled(bool) 给出当前状态。

#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

查看声明

`fluent::basicinput::ToggleSwitch`

继承自 QWidget · FluentElement · QMLPlus

用于二元开关设置的 Fluent 切换控件。

构造函数

explicit ToggleSwitch(QWidget* parent = nullptr)

属性

bool isOn: 开关当前的开启/关闭状态。
读取 isOn()设置 setIsOn()通知 toggled()
QString onContent: 开启状态显示的文本。
读取 onContent()设置 setOnContent()通知 onContentChanged()
QString offContent: 关闭状态显示的文本。
读取 offContent()设置 setOffContent()通知 offContentChanged()
Typography::FontRole fontRole: 开关跟随主题字体时用于文本绘制的 Fluent 排版角色。
读取 fontRole()设置 setFontRole()通知 fontRoleChanged()
qreal visualScale: 开关图形及文字间距的缩放比例，独立于控件大小和字体；默认为 1.0。
读取 visualScale()设置 setVisualScale()通知 visualScaleChanged()
qreal knobPosition: 开关滑块位置动画值，从关闭到开启归一化。
读取 knobPosition()设置 setKnobPosition()

方法

void onThemeUpdated() override
bool isOn() const: 开关当前的开启/关闭状态。
void setIsOn(bool on): 开关当前的开启/关闭状态。
QString onContent() const: 开启状态显示的文本。
void setOnContent(const QString& content): 开启状态显示的文本。
QString offContent() const: 关闭状态显示的文本。
void setOffContent(const QString& content): 关闭状态显示的文本。
Typography::FontRole fontRole() const: 开关跟随主题字体时用于文本绘制的 Fluent 排版角色。
void setFontRole(Typography::FontRole role): 开关跟随主题字体时用于文本绘制的 Fluent 排版角色。
qreal visualScale() const: 开关图形及文字间距的缩放比例，独立于控件大小和字体；默认为 1.0。
void setVisualScale(qreal scale): 设置视觉缩放并更新布局建议尺寸，不改变已固定的控件大小。
void setFont(const QFont& font): 设置显式字体；后续主题刷新不会覆盖该字体。
qreal knobPosition() const: 开关滑块位置动画值，从关闭到开启归一化。
void setKnobPosition(qreal pos): 开关滑块位置动画值，从关闭到开启归一化。
QSize sizeHint() const override
QSize minimumSizeHint() const override

信号

void toggled(bool isOn): 开关当前的开启/关闭状态。
void onContentChanged(const QString& content): 开启状态显示的文本。
void offContentChanged(const QString& content): 关闭状态显示的文本。
void fontRoleChanged(): 开关跟随主题字体时用于文本绘制的 Fluent 排版角色。
void visualScaleChanged(qreal scale): 开关图形及文字间距的缩放比例，独立于控件大小和字体；默认为 1.0。

子类扩展接口

方法

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

继承自 fluent::FluentElement

方法

static void setTheme(Theme theme): 更新全局主题，并通知所有活跃的 FluentElement 实例。
static void setThemeDeferred(Theme theme): 以可见元素优先的批次调度主题刷新，避免阻塞当前交互。
static Theme currentTheme(): 返回当前生效的全局主题。
static bool themeUsesDarkAppearance(Theme theme): 返回指定主题是否使用暗色底的 chrome 与材质 token。
static void refreshTheme(): 在设计 token 变化后重新广播当前主题以触发重绘。
static int themeGeneration(): 每次主题变化自增的单调计数器，用于过期判断。
Theme effectiveTheme() const: 解析此元素实际使用的主题，会优先读取 QWidget 父链上的局部主题覆盖。
bool effectiveThemeUsesDarkAppearance() const: 返回此元素的实际主题是否使用暗色底 chrome。
bool setThemeOverrides(const QJsonObject& overrides): 供组件侧访问的设计 token 接口。
QJsonObject themeOverrides() const: 返回当前元素的覆盖配置。
void clearThemeOverrides(): 恢复全部 token 跟随全局主题。
Colors themeColors() const
const Colors& themeColorsRef() const: 对当前色板的零拷贝访问（用于绘制热路径）。
FontStyle themeFont(Typography::FontRole role = Typography::FontRole::Body) const
Radius themeRadius() const
Spacing themeSpacing() const
Animation themeAnimation() const
Material::AcrylicToken themeAcrylic() const: 材质、阴影和自适应布局 token。
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: 给定激活状态下的窗口 chrome 背景色。
virtual void onThemeUpdated(): 全局主题变化后调用。

枚举

enum Theme: 解析设计 token 时使用的全局视觉主题。
Light = 0
Dark = 1
HighContrast = 2

类型与别名

struct Colors: 返回给组件使用的设计 token 快照。
struct FontStyle
struct Radius
struct Spacing
struct Animation

继承自 fluent::QMLPlus

方法

AnchorLayout::Anchors* anchors(): 返回 QWidget 宿主的可变锚点配置。
void setState(const QString& name): 应用具名 state；名称为空时恢复默认状态。
QString state() const
void addState(const QMLState& state): 注册或替换一个具名 state 定义。
void evaluateStates(): 重新计算条件；按注册顺序选择首个成立的条件。
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): 将 source 属性绑定到 QWidget 宿主上的 target 属性。
BindingHandle bindManaged(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction direction = PropertyBinder::OneWay, BindingOptions options = {}): 在当前 QWidget 宿主上安装可管理的直接绑定。
BindingHandle bindComputed(const char* targetProp, const QVector<BindingDependency>& dependencies, std::function<QVariant()> evaluate, BindingOptions options = {}): 在当前 QWidget 宿主上安装使用显式依赖的 C++ 表达式绑定。
void addTransition(const StateTransition& transition): 按优先顺序注册状态过渡。
void setBehavior(const char* propertyName, const PropertyAnimation& animation): 设置宿主受管理属性写入时使用的默认动画。
void clearBehavior(const char* propertyName): 移除后续受管理写入使用的默认动画。
bool writeProperty(const char* propertyName, const QVariant& value): 通过 Behavior 写入宿主属性，且不移除该属性的绑定。

Qt 基类完整成员：QWidget