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

ホバー時のスクロールオフセットに対応するツールチップ詳細テキストを返すコールバックを設定します。

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

スクロールオフセットに対応する詳細テキストを解決するコールバック。

protected メンバー

メソッド

fluent::FluentElement から継承

列挙型

enum Theme

デザイントークン解決時に使用されるグローバルな視覚テーマ。

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

テーマがダークベースのクロームおよびマテリアルトークンを使用するかどうかを返します。

static void refreshTheme()

デザイントークンの変更後に再描画するため、現在のテーマを再ブロードキャストします。

static int themeGeneration()

テーマ変更ごとに加算される単調増加カウンターです。鮮度チェックに使用されます。

Theme effectiveTheme() const

継承された QWidget の上書きを尊重し、この要素が使用するテーマを解決します。

bool effectiveThemeUsesDarkAppearance() const

この要素の有効なテーマがダークベースのクロームを使用するかどうかを返します。

bool setThemeOverrides(const QJsonObject& overrides)

この要素のスパースな色、角丸半径、フォントトークンの上書きを置き換えます。

QJsonObject themeOverrides() const

この要素に設定されたオーバーライドを返します。

void clearThemeOverrides()

すべてのトークンフィールドをグローバルテーマの既定値に復元します。

const Colors& themeColorsRef() const

描画のホットパス向けにアクティブなカラーセットへ非コピーでアクセスします。

Material::AcrylicToken themeAcrylic() const

マテリアル、エレベーション、およびアダプティブレイアウトのトークン。

QColor themeBackdrop(bool active) const

指定されたアクティブ状態に対するウィンドウ chrome の背景色。

virtual void onThemeUpdated()

グローバルテーマの変更後に呼び出されます。

型とエイリアス

struct Colors

コンポーネントに返されるデザイントークンのスナップショット。

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++ のセッターを直接呼び出した場合はアニメーションしません。

void clearBehavior(const char* propertyName)

今後のマネージド書き込みに使用するデフォルトアニメーションを削除します。

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

バインディングを削除せずに Behavior 経由でホストプロパティに書き込みます。

Qt 基底クラスドキュメント:QWidget

fluent::scrolling::AnnotatedScrollBarLabel

AnnotatedScrollBar のオフセット横に描画されるセクションラベルです。`offset` はスクロールバーの範囲と同じスクロール値座標系を使用し、`detailText` が空でない場合は詳細プロバイダーコールバックを上書きします。

コンストラクタ

フィールド

fluent::scrolling

メソッド