Fluent-Qt

滚动

AnnotatedScrollBar 标注滚动条

带位置标签的滚动条,方便在长内容中跳转。

示例

标注滚动条的真实 Gallery 示例

用法

带标签的滚动范围

setLabels() 在指定位置添加标签,setDetailLabelProvider() 返回悬停时显示的文字。

#include <FluentQt/Scrolling.h>
using namespace fluent::scrolling;

auto* bar = new AnnotatedScrollBar(this);
bar->setRange(0, 960);
bar->setPageStep(120);
bar->setLabels({
    {"2023", 0, "October 2023"},
    {"2022", 120, "October 2022"},
    {"2021", 240, "October 2021"},
    {"2020", 360, "October 2020"},
    {"2019", 480, "October 2019"},
    {"2018", 600, "October 2018"},
    {"2017", 720, "October 2017"},
    {"2016", 840, "October 2016"},
    {"2015", 960, "October 2015"}
});
bar->setDetailLabelProvider([](int offset) {
    const int year = 2023 - std::clamp(offset / 120, 0, 8);
    return QStringLiteral("October %1").arg(year);
});

fluent::scrolling::AnnotatedScrollBar

继承自 QWidget · FluentElement · QMLPlus

带偏移标签和可选详情提示的垂直 Fluent 滚动条。

构造函数

属性

int minimum

从连接的 ScrollView 镜像或直接设置的最小滚动值。

读取 minimum()设置 setMinimum()通知 rangeChanged()
int maximum

从连接的 ScrollView 镜像或直接设置的最大滚动值。

读取 maximum()设置 setMaximum()通知 rangeChanged()
int value

驱动滑块和注释位置的当前滚动值。

读取 value()设置 setValue()通知 valueChanged()
int pageStep

滚动或范围移动使用的页步长。

读取 pageStep()设置 setPageStep()通知 pageStepChanged()
QSize preferredSize

控件首选视觉尺寸。

读取 preferredSize()设置 setPreferredSize()通知 layoutMetricsChanged()
QSize minimumBarSize

滚动条最小绘制尺寸。

读取 minimumBarSize()设置 setMinimumBarSize()通知 layoutMetricsChanged()
int verticalPadding

控件内部垂直内边距。

读取 verticalPadding()设置 setVerticalPadding()通知 layoutMetricsChanged()
QSize caretSize

滚动入口使用的箭头图形尺寸。

读取 caretSize()设置 setCaretSize()通知 layoutMetricsChanged()
int labelColumnWidth

为标注标签保留的列宽。

读取 labelColumnWidth()设置 setLabelColumnWidth()通知 layoutMetricsChanged()
int labelLineHeight

标注标签使用的行高。

读取 labelLineHeight()设置 setLabelLineHeight()通知 layoutMetricsChanged()
int minimumLabelSpacing

可见标签之间保留的最小间距。

读取 minimumLabelSpacing()设置 setMinimumLabelSpacing()通知 layoutMetricsChanged()
int indicatorWidth

滚动位置指示器区域宽度。

读取 indicatorWidth()设置 setIndicatorWidth()通知 layoutMetricsChanged()
int indicatorThickness

滚动位置指示器绘制厚度。

读取 indicatorThickness()设置 setIndicatorThickness()通知 layoutMetricsChanged()
int lineStepFallback

未连接滚动视图时使用的备用单行步长。

读取 lineStepFallback()设置 setLineStepFallback()通知 layoutMetricsChanged()

方法

int minimum() const

从连接的 ScrollView 镜像或直接设置的最小滚动值。

int maximum() const

从连接的 ScrollView 镜像或直接设置的最大滚动值。

int value() const

驱动滑块和注释位置的当前滚动值。

int pageStep() const

滚动或范围移动使用的页步长。

QSize preferredSize() const

控件首选视觉尺寸。

QSize minimumBarSize() const

滚动条最小绘制尺寸。

int verticalPadding() const

控件内部垂直内边距。

QSize caretSize() const

滚动入口使用的箭头图形尺寸。

int labelColumnWidth() const

为标注标签保留的列宽。

int labelLineHeight() const

标注标签使用的行高。

int minimumLabelSpacing() const

可见标签之间保留的最小间距。

int indicatorWidth() const

滚动位置指示器区域宽度。

int indicatorThickness() const

滚动位置指示器绘制厚度。

int lineStepFallback() const

未连接滚动视图时使用的备用单行步长。

void setMinimum(int minimum)

从连接的 ScrollView 镜像或直接设置的最小滚动值。

void setMaximum(int maximum)

从连接的 ScrollView 镜像或直接设置的最大滚动值。

void setValue(int value)

驱动滑块和注释位置的当前滚动值。

void setPageStep(int pageStep)

滚动或范围移动使用的页步长。

void setPreferredSize(const QSize& size)

控件首选视觉尺寸。

void setMinimumBarSize(const QSize& size)

滚动条最小绘制尺寸。

void setVerticalPadding(int padding)

控件内部垂直内边距。

void setCaretSize(const QSize& size)

滚动入口使用的箭头图形尺寸。

void setLabelColumnWidth(int width)

为标注标签保留的列宽。

void setLabelLineHeight(int height)

标注标签使用的行高。

void setMinimumLabelSpacing(int spacing)

可见标签之间保留的最小间距。

void setIndicatorWidth(int width)

滚动位置指示器区域宽度。

void setIndicatorThickness(int thickness)

滚动位置指示器绘制厚度。

void setLineStepFallback(int step)

未连接滚动视图时使用的备用单行步长。

QVector<AnnotatedScrollBarLabel> labels() const

返回所有设置过的标签,包括因碰撞过滤而未显示的标签。

void setLabels(const QVector<AnnotatedScrollBarLabel>& labels)

替换全部标签,并使可见标签布局失效。

void setDetailLabelProvider(DetailLabelProvider provider)

设置标签 hover 时用于生成详情文本的 provider。

void connectToScrollView(ScrollView* scrollView)

从 ScrollView 同步 range/value,并将滚动请求回传给该 ScrollView。

QVector<AnnotatedScrollBarLabel> visibleLabels() const

返回当前可绘制的、经过碰撞过滤后的标签。

信号

void rangeChanged(int minimum, int maximum)

属性与交互通知信号。

void valueChanged(int value)

驱动滑块和注释位置的当前滚动值。

void pageStepChanged(int pageStep)

滚动或范围移动使用的页步长。

void layoutMetricsChanged()

控件首选视觉尺寸。

void scrollRequested(int offset)

用户交互请求滚动到某个偏移位置时发出。

类型与别名

using DetailLabelProvider = std::function<QString(int offset)>

根据滚动偏移生成详情文本的回调。

析构函数

子类扩展接口

方法

继承自 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 跟随全局主题。

const Colors& themeColorsRef() const

对当前色板的零拷贝访问(用于绘制热路径)。

Material::AcrylicToken themeAcrylic() const

材质、阴影和自适应布局 token。

QColor themeBackdrop(bool active) const

给定激活状态下的窗口 chrome 背景色。

virtual void onThemeUpdated()

全局主题变化后调用。

枚举

enum Theme

解析设计 token 时使用的全局视觉主题。

  • Light = 0
  • Dark = 1
  • HighContrast = 2

类型与别名

struct Colors

返回给组件使用的设计 token 快照。

继承自 fluent::QMLPlus

方法

AnchorLayout::Anchors* anchors()

返回 QWidget 宿主的可变锚点配置。

void setState(const QString& name)

应用具名 state;名称为空时恢复默认状态。

void addState(const QMLState& state)

注册或替换一个具名 state 定义。

void evaluateStates()

重新计算条件;按注册顺序选择首个成立的条件。

QMLPlusRuntime* runtime()

返回按需创建、由宿主持有的状态观察对象。

void setAnchors(const AnchorLayout::Anchors& anchors)

替换宿主的全部锚点,并使父布局失效。

void resetAnchors()

清除宿主全部锚点,并使父布局失效。

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

fluent::scrolling::AnnotatedScrollBarLabel

渲染在 AnnotatedScrollBar 偏移位置旁的标签元数据。

构造函数

字段

fluent::scrolling

方法