Fluent-Qt

Коллекции

FileListView Список файлов

Список файлов на основе модели с полными именами, ходом передачи и действиями восстановления.

Пример

FileListView Список файлов: Файлы и прогресс

Использование

Файлы и прогресс

Примеры состояний передачи. Удалите файл, повторите неудачную передачу или продвиньте прогресс.

#include <FluentQt/Collections.h>
using namespace fluent::collections;

auto* panel = new QWidget(this);
panel->setMaximumWidth(720);
auto* layout = new QVBoxLayout(panel);
layout->setContentsMargins(0, 0, 0, 0);
layout->setSpacing(16);
auto* model = new QStandardItemModel(panel);
auto addFile = [model](const QString& name, const QString& detail,
                       FileListView::Status state, qreal progress) {
    auto* item = new QStandardItem(name);
    item->setData(detail, FileListView::MetadataRole);
    item->setData(state, FileListView::StatusRole);
    item->setData(progress, FileListView::ProgressRole);
    item->setData(state == FileListView::Rejected, FileListView::RetryableRole);
    model->appendRow(item);
};
addFile("brand-guidelines.pdf", "2.4 MB · Ready to use", FileListView::Ready, 1.0);
addFile("product-shot.png", "3.6 / 5.8 MB · Uploading", FileListView::Uploading, 0.62);
addFile("research-notes-for-the-autumn-product-release-and-accessibility-review.pdf",
        "Connection lost · Retry when you are ready", FileListView::Rejected, 0.0);
auto* files = new FileListView(panel);
files->setObjectName("fileList");
files->setAccessibleName("Transfer examples");
files->setMinimumHeight(240);
files->setBackgroundVisible(false);
files->setBorderVisible(false);
files->setProperty("fluentPreserveParentSurface", true);
files->viewport()->setProperty("fluentPreserveParentSurface", true);
files->setModel(model);
layout->addWidget(files);
QObject::connect(files, &FileListView::removeRequested, panel,
                 [model](const QModelIndex& index) { model->removeRow(index.row()); });
QObject::connect(files, &FileListView::retryRequested, panel,
                 [model](const QModelIndex& index) {
    model->setData(index, FileListView::Uploading, FileListView::StatusRole);
    model->setData(index, false, FileListView::RetryableRole);
    model->setData(index, "Reconnected · Uploading", FileListView::MetadataRole);
    model->setData(index, 0.0, FileListView::ProgressRole);
});
auto* advance = new Button("Advance example transfers", panel);
advance->setObjectName("advanceTransfer");
advance->setFluentStyle(Button::Subtle);
QObject::connect(advance, &Button::clicked, panel, [model]() {
    for (int row = 0; row < model->rowCount(); ++row) {
        const QModelIndex index = model->index(row, 0);
        if (index.data(FileListView::StatusRole).toInt() != FileListView::Uploading)
            continue;
        const qreal progress = qMin(1.0, index.data(FileListView::ProgressRole).toReal() + 0.19);
        model->setData(index, progress, FileListView::ProgressRole);
        model->setData(index, progress >= 1.0 ? "Ready to use" : "Uploading",
                       FileListView::MetadataRole);
        if (progress >= 1.0)
            model->setData(index, FileListView::Ready, FileListView::StatusRole);
    }
});
layout->addWidget(advance, 0, Qt::AlignLeft);

fluent::collections::FileListView

Наследует ListView

Представление списка с именами файлов, статусом передачи и действиями удаления/повтора для каждой строки. Управляется моделью элементов Qt без дискового ввода-вывода; Delete запрашивает удаление, а Ctrl/Cmd+R — повтор.

Конструкторы

Деструкторы

Перечисления

enum Status

Отображаемый статус строки файла; фактическая передача выполняется приложением.

  • Ready = 0
  • Uploading = 1
  • Rejected = 2
enum DataRole

Роли модели, считываемые помимо Qt::DisplayRole: MetadataRole (QString), StatusRole (Status, по умолчанию Ready), ProgressRole ([0, 1]), RemovableRole (bool, по умолчанию true) и RetryableRole (bool, по умолчанию false для строк Rejected).

  • MetadataRole = Qt::UserRole + 1
  • StatusRole
  • ProgressRole
  • RemovableRole
  • RetryableRole

Методы

void setModel(QAbstractItemModel* model) override

Задаёт модель элементов (управляется вызывающим кодом).

void setAnimationEnabled(bool enabled)

Включает или отключает анимации перехода при наведении и изменении прогресса (с учётом MotionPolicy).

Свойства

bool animationEnabled
Чтение isAnimationEnabled()Запись setAnimationEnabled()Уведомление animationEnabledChanged()

Сигналы

void removeRequested(const QModelIndex& index)

Испускается, когда пользователь инициирует удаление строки; вызывающая сторона обновляет модель.

void retryRequested(const QModelIndex& index)

Испускается, когда пользователь инициирует повторную попытку для строки со статусом Rejected.

Защищённые члены

Методы

Унаследовано от fluent::collections::ListView

Перечисления

Методы

Flow flow() const

Направление компоновки элементов (TopToBottom или LeftToRight).

void setFlow(Flow flow)

Направление компоновки элементов (TopToBottom или LeftToRight).

SelectionMode selectionMode() const

Режим выделения, используемый представлением коллекции.

void setSelectionMode(SelectionMode mode)

Режим выделения, используемый представлением коллекции.

Typography::FontRole fontRole() const

Роль типографики Fluent, используемая для отрисовки текста.

void setFontRole(Typography::FontRole role)

Роль типографики Fluent, используемая для отрисовки текста.

int trailingTextRole() const

Необязательная роль модели для дополнительного текста в конце строки; значение -1 скрывает его.

void setTrailingTextRole(int role)

Задаёт роль, используемую делегатом по умолчанию для завершающего текста; пользовательские делегаты управляют компоновкой самостоятельно.

bool borderVisible() const

Отрисовывается ли внешняя рамка элемента управления.

void setBorderVisible(bool visible)

Отрисовывается ли внешняя рамка элемента управления.

bool backgroundVisible() const

Отрисовывается ли фон элемента управления.

void setBackgroundVisible(bool visible)

Отрисовывается ли фон элемента управления.

QWidget* header() const

Пользовательский виджет, размещаемый в верхней области ListView.

void setHeader(QWidget* widget)

Пользовательский виджет, размещаемый в верхней области ListView.

QString headerText() const

Вспомогательный текст, отображаемый в области заголовка.

void setHeaderText(const QString& text)

Вспомогательный текст, отображаемый в области заголовка.

QString placeholderText() const

Текст, отображаемый при отсутствии элементов в модели.

void setPlaceholderText(const QString& text)

Текст, отображаемый при отсутствии элементов в модели.

bool viewportHovered() const

Находится ли курсор над областью просмотра.

bool canReorderItems() const

Определяет, включена ли перестановка перетаскиванием.

void setCanReorderItems(bool enabled)

Определяет, включена ли перестановка перетаскиванием.

bool isScrollChainingEnabled() const

Определяет, может ли ввод колёсика на границе прокрутки передаваться внешнему контейнеру прокрутки.

void setScrollChainingEnabled(bool enabled)

Определяет, может ли ввод колёсика на границе прокрутки передаваться внешнему контейнеру прокрутки.

bool sectionEnabled() const

Определяет, группируются ли соседние элементы под заголовками разделов через коллбэк ключа раздела.

void setSectionEnabled(bool enabled)

Определяет, группируются ли соседние элементы под заголовками разделов через коллбэк ключа раздела.

void setSectionKeyFunction(SectionKeyFunc func)

Задаёт обратный вызов, возвращающий ключ секции для строки; соседние строки с одинаковым ключом объединяются общим заголовком секции.

qreal selectedIndicatorProgress() const

Прогресс анимации индикатора выбранного элемента.

IndicatorMotionDirection selectedIndicatorMotionDirection() const

Направление движения выбранного индикатора.

bool selectedIndicatorAnimationEnabled() const

Анимируется ли переход индикатора выбора между строками; без анимации он перемещается мгновенно.

void setSelectedIndicatorAnimationEnabled(bool enabled)

Включена ли анимация индикатора выбранного элемента.

bool selectionIndicatorVisible() const

Отрисовывается ли индикатор выбранного элемента.

void setSelectionIndicatorVisible(bool visible)

Показывает или скрывает индикатор выбора, не влияя на логику выбора.

QRectF selectedIndicatorRect() const

Возвращает текущий прямоугольник индикатора выбора в координатах области просмотра или пустой прямоугольник, если ни один не виден.

QRectF selectedIndicatorRect(qreal progress) const

Возвращает прямоугольник индикатора выбора при нормализованном прогрессе анимации в диапазоне [0, 1].

QRectF selectedIndicatorRectForRow(int row) const

Возвращает прямоугольник индикатора выбора для конкретной строки (используется в режиме множественного выбора).

void refreshFluentScrollChrome()

Скрывает нативные полосы прокрутки и обновляет наложенные полосы прокрутки Fluent. Вызовите повторно после показа, если платформенный стиль (например, во всплывающих списках QComboBox) восстанавливает нативные полосы.

Свойства

SelectionMode selectionMode

Режим выделения, используемый представлением коллекции.

Чтение selectionMode()Запись setSelectionMode()Уведомление selectionModeChanged()
Typography::FontRole fontRole

Роль типографики Fluent, используемая для отрисовки текста.

Чтение fontRole()Запись setFontRole()Уведомление fontRoleChanged()
int trailingTextRole

Необязательная роль модели для дополнительного текста в конце строки; значение -1 скрывает его.

Чтение trailingTextRole()Запись setTrailingTextRole()Уведомление trailingTextRoleChanged()
bool viewportHovered

Находится ли курсор над областью просмотра.

Чтение viewportHovered()Уведомление viewportHoveredChanged()
Flow flow

Направление компоновки элементов (TopToBottom или LeftToRight).

Чтение flow()Запись setFlow()Уведомление flowChanged()
qreal selectedIndicatorProgress

Прогресс анимации индикатора выбранного элемента.

Чтение selectedIndicatorProgress()Уведомление selectedIndicatorProgressChanged()
IndicatorMotionDirection selectedIndicatorMotionDirection

Направление движения выбранного индикатора.

Чтение selectedIndicatorMotionDirection()Уведомление selectedIndicatorMotionDirectionChanged()
bool selectedIndicatorAnimationEnabled

Включена ли анимация индикатора выбранного элемента.

Чтение selectedIndicatorAnimationEnabled()Запись setSelectedIndicatorAnimationEnabled()Уведомление selectedIndicatorAnimationEnabledChanged()
bool selectionIndicatorVisible

Отрисовывается ли индикатор выбранного элемента.

Чтение selectionIndicatorVisible()Запись setSelectionIndicatorVisible()Уведомление selectionIndicatorVisibleChanged()
bool borderVisible

Отрисовывается ли внешняя рамка элемента управления.

Чтение borderVisible()Запись setBorderVisible()Уведомление borderVisibleChanged()
bool backgroundVisible

Отрисовывается ли фон элемента управления.

Чтение backgroundVisible()Запись setBackgroundVisible()Уведомление backgroundVisibleChanged()
QWidget* header

Пользовательский виджет, размещаемый в верхней области ListView.

Чтение header()Запись setHeader()Уведомление headerChanged()
QString headerText

Вспомогательный текст, отображаемый в области заголовка.

Чтение headerText()Запись setHeaderText()Уведомление headerTextChanged()
QString placeholderText

Текст, отображаемый при отсутствии элементов в модели.

Чтение placeholderText()Запись setPlaceholderText()Уведомление placeholderTextChanged()
bool canReorderItems

Определяет, включена ли перестановка перетаскиванием.

Чтение canReorderItems()Запись setCanReorderItems()Уведомление canReorderItemsChanged()
bool scrollChainingEnabled

Определяет, может ли ввод колёсика на границе прокрутки передаваться внешнему контейнеру прокрутки.

Чтение isScrollChainingEnabled()Запись setScrollChainingEnabled()Уведомление scrollChainingEnabledChanged()
bool sectionEnabled

Определяет, группируются ли соседние элементы под заголовками разделов через коллбэк ключа раздела.

Чтение sectionEnabled()Запись setSectionEnabled()Уведомление sectionEnabledChanged()

Сигналы

void selectionModeChanged()

Режим выделения, используемый представлением коллекции.

void fontRoleChanged()

Роль типографики Fluent, используемая для отрисовки текста.

void trailingTextRoleChanged()

Необязательная роль модели для дополнительного текста в конце строки; значение -1 скрывает его.

void viewportHoveredChanged()

Находится ли курсор над областью просмотра.

void flowChanged()

Направление компоновки элементов (TopToBottom или LeftToRight).

void borderVisibleChanged()

Отрисовывается ли внешняя рамка элемента управления.

void backgroundVisibleChanged()

Отрисовывается ли фон элемента управления.

void headerChanged()

Пользовательский виджет, размещаемый в верхней области ListView.

void headerTextChanged()

Вспомогательный текст, отображаемый в области заголовка.

void placeholderTextChanged()

Текст, отображаемый при отсутствии элементов в модели.

void canReorderItemsChanged()

Определяет, включена ли перестановка перетаскиванием.

void scrollChainingEnabledChanged()

Определяет, может ли ввод колёсика на границе прокрутки передаваться внешнему контейнеру прокрутки.

void sectionEnabledChanged()

Определяет, группируются ли соседние элементы под заголовками разделов через коллбэк ключа раздела.

void selectedIndicatorProgressChanged()

Прогресс анимации индикатора выбранного элемента.

void selectedIndicatorMotionDirectionChanged()

Направление движения выбранного индикатора.

void selectedIndicatorAnimationEnabledChanged()

Включена ли анимация индикатора выбранного элемента.

void selectionIndicatorVisibleChanged()

Отрисовывается ли индикатор выбранного элемента.

void itemClicked(int index)

Вспомогательный сигнал, передающий индекс нажатой строки вместе с QAbstractItemView::clicked().

Типы и псевдонимы

Унаследовано от 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: QListView