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 для зеркалирования его диапазона и значения и передачи запросов прокрутки обратно.

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

Глобальная визуальная тема, используемая при разрешении дизайн-токенов.

  • 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

Цвет фона рамки окна для заданного состояния активации.

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)

Связывает @p sourceProp объекта @p source со свойством @p targetProp этого хоста QWidget через PropertyBinder::bind().

BindingHandle bindComputed(const char* targetProp, const QVector<BindingDependency>& dependencies, std::function<QVariant()> evaluate, BindingOptions options = {})

Устанавливает C++-выражение с явными зависимостями на этом хосте QWidget.

void addTransition(const StateTransition& transition)

Регистрирует переход состояния в порядке приоритета.

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

Задаёт анимацию по умолчанию при записи @p propertyName через writeProperty() или привязку. Явные правила 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

Методы