Fluent-Qt

捲動

AnnotatedScrollBar 標註捲軸

附帶標籤的捲軸,讓長篇內容更易於導覽。

範例

AnnotatedScrollBar 標註捲軸: 具詳細資訊的標籤捲動範圍

用法

具詳細資訊的標籤捲動範圍

標籤用於標記重要位移位置,詳細資訊提供者則負責解析懸停文字。

#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 捲軸。可與 ScrollView 同步,或直接透過 minimum、maximum 與 value 屬性驅動。

建構函式

解構函式

方法

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 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)

設定為懸停捲動偏移量提供工具提示詳細文字的回呼函式。

void connectToScrollView(ScrollView* scrollView)

繫結至 ScrollView 以鏡像同步其範圍與數值,並將捲動要求轉送回該 ScrollView。

QVector<AnnotatedScrollBarLabel> visibleLabels() const

傳回目前符合繪製條件且經碰撞過濾的標籤。

屬性

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()

訊號

void rangeChanged(int minimum, int maximum)

從已連接的 ScrollView 鏡像或直接設定的最小捲動值。

void valueChanged(int value)

驅動滑塊與註記位置的目前捲動值。

void pageStepChanged(int pageStep)

捲動或範圍移動使用的頁步長。

void layoutMetricsChanged()

控制項的偏好視覺大小。

void scrollRequested(int offset)

使用者互動請求捲動至指定偏移位置時發出。

型別與別名

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

為捲動偏移量解析詳細資料文字的回呼函式。

受保護成員

方法

繼承自 fluent::FluentElement

列舉

enum Theme

解析設計 token 時使用的全域視覺佈景主題。

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

方法

static void setTheme(Theme theme)

更新全域主題,並通知使用中的 FluentElement 執行個體。

static void setThemeDeferred(Theme theme)

排程以可見元素優先的批次主題重新整理,避免阻斷目前的互動。

static Theme currentTheme()

傳回目前生效的全域主題。

static bool themeUsesDarkAppearance(Theme theme)

傳回主題是否使用深色底的視窗框架與材質 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()

在全域主題變更後呼叫。

型別與別名

struct Colors

傳回給元件使用的設計 token 快照。

繼承自 fluent::QMLPlus

方法

AnchorLayout::Anchors* anchors()

傳回 QWidget 宿主的可變錨點。

void setState(const QString& name)

依名稱套用已註冊的狀態,或在 @p name 為空時還原為預設狀態。未知名稱會被忽略,離開該狀態後原有的繫結會恢復同步。

void addState(const QMLState& state)

註冊或取代具名狀態定義;若取代目前啟用中的狀態則會立即套用。

void evaluateStates()

依註冊順序重新評估狀態條件並啟用第一個符合的狀態,若無符合項目則恢復為預設狀態。相依屬性發出通知時也會自動執行;使用 extend 的衍生狀態會繼承上層變更,除非發生循環或缺失。

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)

透過 PropertyBinder::bind() 將 @p source 上的 @p sourceProp 繫結至此 QWidget 宿主上的 @p targetProp。

void addTransition(const StateTransition& transition)

依優先順序註冊狀態轉場。

void setBehavior(const char* propertyName, const PropertyAnimation& animation)

設定透過 writeProperty() 或繫結寫入 @p propertyName 時使用的預設動畫。明確的 StateTransition 規則優先;直接呼叫 C++ setter 不會有動畫。

void clearBehavior(const char* propertyName)

移除後續受管理寫入所使用的預設動畫。

bool writeProperty(const char* propertyName, const QVariant& value)

透過 Behavior 寫入宿主屬性,且不移除該屬性的繫結。

Qt 基底類別文件:QWidget

fluent::scrolling::AnnotatedScrollBarLabel

算繪在 AnnotatedScrollBar 偏移位置旁的區段標籤。`offset` 使用與捲軸範圍相同的捲動值座標空間;`detailText` 非空時會覆寫詳細資料提供者回呼。

建構函式

欄位

fluent::scrolling

方法