Collections

FlowView

Lays out variable-sized items in wrapping rows, like a tag cloud.

Example

Usage

Network photo flow

Images load asynchronously while the flow layout wraps cards across rows.

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

auto* flowView = new FlowView(this);
flowView->setDefaultItemSize(QSize(160, 118));
flowView->setItemDelegate(photoDelegate);
flowView->setModel(model);
flowView->setSelectionMode(FlowView::SelectionMode::Single);

import fluentqt

from PySide6.QtCore import QSize

flow_view = fluentqt.FlowView()
flow_view.setSelectionMode(fluentqt.SelectionMode.Single)
flow_view.setDefaultItemSize(QSize(160, 118))
flow_view.setItemDelegate(photo_delegate)
flow_view.setModel(model)

API

Declaration

`fluent::collections::FlowView`

Inherits QAbstractItemView · FluentElement · QMLPlus

Fluent collection view that wraps items across rows or columns.

Constructors

explicit FlowView(QWidget* parent = nullptr)

Properties

SelectionMode selectionMode: Selection mode used by the collection view.
Read selectionMode()Write setSelectionMode()Notify selectionModeChanged()
Typography::FontRole fontRole: Fluent typography role used for text rendering.
Read fontRole()Write setFontRole()Notify fontRoleChanged()
bool borderVisible: Whether the control frame border is painted.
Read borderVisible()Write setBorderVisible()Notify borderVisibleChanged()
QString headerText: Convenience text displayed in the header area.
Read headerText()Write setHeaderText()Notify headerTextChanged()
QString placeholderText: Text shown when the flow model has no items to present.
Read placeholderText()Write setPlaceholderText()Notify placeholderTextChanged()
QSize defaultItemSize: Default item size used when the model does not provide one.
Read defaultItemSize()Write setDefaultItemSize()Notify defaultItemSizeChanged()
QSize minimumItemSize: Minimum item size allowed by the flow layout.
Read minimumItemSize()Write setMinimumItemSize()Notify minimumItemSizeChanged()
QSize maximumItemSize: Maximum item size allowed by the flow layout.
Read maximumItemSize()Write setMaximumItemSize()Notify maximumItemSizeChanged()
int itemSizeRole: Model role used to resolve per-item size.
Read itemSizeRole()Write setItemSizeRole()Notify itemSizeRoleChanged()
int horizontalSpacing: Horizontal spacing between items.
Read horizontalSpacing()Write setHorizontalSpacing()Notify horizontalSpacingChanged()
int verticalSpacing: Vertical spacing between items.
Read verticalSpacing()Write setVerticalSpacing()Notify verticalSpacingChanged()
QMargins contentMargins: Margins applied around the control content area.
Read contentMargins()Write setContentMargins()Notify contentMarginsChanged()
bool viewportHovered: Whether the item-view viewport is currently hovered.
Read viewportHovered()Notify viewportHoveredChanged()
bool canReorderItems: Whether drag reordering is enabled.
Read canReorderItems()Write setCanReorderItems()Notify canReorderItemsChanged()
bool scrollChainingEnabled: Whether boundary wheel input may continue to an enclosing scroller.
Read isScrollChainingEnabled()Write setScrollChainingEnabled()Notify scrollChainingEnabledChanged()
bool overscrollEnabled: Whether the view shows an elastic overscroll/bounce at the scroll boundary. Enabled by default; disable for chrome that should stop cleanly at the edge.
Read isOverscrollEnabled()Write setOverscrollEnabled()Notify overscrollEnabledChanged()

Methods

SelectionMode selectionMode() const: Selection mode used by the collection view.
void setSelectionMode(SelectionMode mode): Selection mode used by the collection view.
Typography::FontRole fontRole() const: Fluent typography role used for text rendering.
void setFontRole(Typography::FontRole role): Fluent typography role used for text rendering.
bool borderVisible() const: Whether the control frame border is painted.
bool isBorderVisible() const
void setBorderVisible(bool visible): Whether the control frame border is painted.
QString headerText() const: Convenience text displayed in the header area.
void setHeaderText(const QString& text): Convenience text displayed in the header area.
QString placeholderText() const: Text shown when the flow model has no items to present.
void setPlaceholderText(const QString& text): Text shown when the flow model has no items to present.
QSize defaultItemSize() const: Default item size used when the model does not provide one.
void setDefaultItemSize(const QSize& size): Default item size used when the model does not provide one.
QSize minimumItemSize() const: Minimum item size allowed by the flow layout.
void setMinimumItemSize(const QSize& size): Minimum item size allowed by the flow layout.
QSize maximumItemSize() const: Maximum item size allowed by the flow layout.
void setMaximumItemSize(const QSize& size): Maximum item size allowed by the flow layout.
int itemSizeRole() const: Model role used to resolve per-item size.
void setItemSizeRole(int role): Model role used to resolve per-item size.
int horizontalSpacing() const: Horizontal spacing between items.
void setHorizontalSpacing(int spacing): Horizontal spacing between items.
int verticalSpacing() const: Vertical spacing between items.
void setVerticalSpacing(int spacing): Vertical spacing between items.
QMargins contentMargins() const: Margins applied around the control content area.
void setContentMargins(const QMargins& margins): Margins applied around the control content area.
bool viewportHovered() const: Whether the item-view viewport is currently hovered.
bool isViewportHovered() const
bool canReorderItems() const: Whether drag reordering is enabled.
void setCanReorderItems(bool enabled): Whether drag reordering is enabled.
bool isScrollChainingEnabled() const: Whether boundary wheel input may continue to an enclosing scroller.
void setScrollChainingEnabled(bool enabled): Whether boundary wheel input may continue to an enclosing scroller.
bool isOverscrollEnabled() const: Whether the view shows an elastic overscroll/bounce at the scroll boundary. Enabled by default; disable for chrome that should stop cleanly at the edge.
void setOverscrollEnabled(bool enabled): Whether the view shows an elastic overscroll/bounce at the scroll boundary. Enabled by default; disable for chrome that should stop cleanly at the edge.
int selectedIndex() const
QList<int> selectedRows() const
void setSelectedIndex(int index)
::fluent::scrolling::ScrollBar* verticalFluentScrollBar() const
void refreshFluentScrollChrome()
void setModel(QAbstractItemModel* model) override
void setItemDelegate(QAbstractItemDelegate* delegate)
QRect visualRect(const QModelIndex& index) const override
void scrollTo(const QModelIndex& index, ScrollHint hint = EnsureVisible) override
QModelIndex indexAt(const QPoint& point) const override

Signals

void selectionModeChanged(): Selection mode used by the collection view.
void fontRoleChanged(): Fluent typography role used for text rendering.
void borderVisibleChanged(): Whether the control frame border is painted.
void headerTextChanged(): Convenience text displayed in the header area.
void placeholderTextChanged(): Text shown when the flow model has no items to present.
void defaultItemSizeChanged(): Default item size used when the model does not provide one.
void minimumItemSizeChanged(): Minimum item size allowed by the flow layout.
void maximumItemSizeChanged(): Maximum item size allowed by the flow layout.
void itemSizeRoleChanged(): Model role used to resolve per-item size.
void horizontalSpacingChanged(): Horizontal spacing between items.
void verticalSpacingChanged(): Vertical spacing between items.
void contentMarginsChanged(): Margins applied around the control content area.
void viewportHoveredChanged(): Whether the item-view viewport is currently hovered.
void canReorderItemsChanged(): Whether drag reordering is enabled.
void scrollChainingEnabledChanged(): Whether boundary wheel input may continue to an enclosing scroller.
void overscrollEnabledChanged(): Whether the view shows an elastic overscroll/bounce at the scroll boundary. Enabled by default; disable for chrome that should stop cleanly at the edge.
void itemClicked(int row): Emits the row once for the same pointer action as inherited clicked().
void itemReordered(int fromIndex, int toIndex)

Subclass interfaces

Methods

void paintEvent(QPaintEvent* event) override
void resizeEvent(QResizeEvent* event) override
void showEvent(QShowEvent* event) override
void enterEvent(FluentEnterEvent* event) override
void leaveEvent(QEvent* event) override
void mousePressEvent(QMouseEvent* event) override
void mouseMoveEvent(QMouseEvent* event) override
void mouseReleaseEvent(QMouseEvent* event) override
void wheelEvent(QWheelEvent* event) override
QModelIndex moveCursor(CursorAction cursorAction, Qt::KeyboardModifiers modifiers) override
int horizontalOffset() const override
int verticalOffset() const override
bool isIndexHidden(const QModelIndex& index) const override
void setSelection(const QRect& rect, QItemSelectionModel::SelectionFlags flags) override
QRegion visualRegionForSelection(const QItemSelection& selection) const override
void rowsInserted(const QModelIndex& parent, int start, int end) override
void dataChanged(const QModelIndex& topLeft, const QModelIndex& bottomRight, const FluentItemDataRoles& roles = FluentItemDataRoles()) override
void reset() override
void onThemeUpdated() override

Inherited from fluent::FluentElement

Methods

static void setTheme(Theme theme): Updates the global theme and notifies active FluentElement instances.
static void setThemeDeferred(Theme theme): Schedules a visible-first batched theme refresh without blocking the current interaction.
static Theme currentTheme(): Returns the currently active global theme.
static bool themeUsesDarkAppearance(Theme theme): Returns whether a theme uses dark-backed chrome and material tokens.
static void refreshTheme(): Re-broadcasts the current theme to repaint after a design-token change.
static int themeGeneration(): Monotonic counter bumped on every theme change, for staleness checks.
Theme effectiveTheme() const: Resolves the theme used by this element, honoring an inherited QWidget override.
bool effectiveThemeUsesDarkAppearance() const: Returns whether this element's effective theme uses dark-backed chrome.
bool setThemeOverrides(const QJsonObject& overrides): Component-facing token accessors.
QJsonObject themeOverrides() const: Returns this element's authored overrides.
void clearThemeOverrides(): Restores all token fields to global theme defaults.
Colors themeColors() const
const Colors& themeColorsRef() const: Non-copying access to the active color set (for hot paint paths).
FontStyle themeFont(Typography::FontRole role = Typography::FontRole::Body) const
Radius themeRadius() const
Spacing themeSpacing() const
Animation themeAnimation() const
Material::AcrylicToken themeAcrylic() const: Material, elevation, and adaptive layout tokens.
Material::MicaToken themeMica() const
Material::SmokeToken themeSmoke() const
Elevation::ShadowParams themeShadow(Elevation::Level level) const
int themeBreakpoint(Breakpoints::Breakpoint breakpoint = Breakpoints::Breakpoint::Medium) const
QColor themeBackdrop(bool active) const: Window-chrome backdrop color for the given activation state.
virtual void onThemeUpdated(): Called after the global theme changes.

Enumerations

enum Theme: Global visual theme used when resolving design tokens.
Light = 0
Dark = 1
HighContrast = 2

Types and aliases

struct Colors: Design token snapshots returned to components.
struct FontStyle
struct Radius
struct Spacing
struct Animation

Inherited from fluent::QMLPlus

Methods

AnchorLayout::Anchors* anchors(): Returns mutable anchors for the QWidget host.
void setState(const QString& name): Applies a named state, or clears state when name is empty.
QString state() const
void addState(const QMLState& state): Registers or replaces a named state definition.
void evaluateStates(): Reevaluates conditions; the first registered true condition wins.
QMLPlusRuntime* runtime(): Returns the lazy host-owned state observation object.
void setAnchors(const AnchorLayout::Anchors& anchors): Replaces all host anchors and invalidates the parent layout.
void resetAnchors(): Clears all host anchors and invalidates the parent layout.
void bind(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction dir = PropertyBinder::OneWay): Binds a source property to a property on the QWidget host.
BindingHandle bindManaged(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction direction = PropertyBinder::OneWay, BindingOptions options = {}): Installs a managed direct binding on this QWidget host.
BindingHandle bindComputed(const char* targetProp, const QVector<BindingDependency>& dependencies, std::function<QVariant()> evaluate, BindingOptions options = {}): Installs an explicit-dependency C++ expression on this QWidget host.
void addTransition(const StateTransition& transition): Registers a state transition in precedence order.
void setBehavior(const char* propertyName, const PropertyAnimation& animation): Sets the default animation for this host's managed property writes.
void clearBehavior(const char* propertyName): Removes the default animation for future managed writes.
bool writeProperty(const char* propertyName, const QVariant& value): Writes a host property through Behavior without removing its binding.

All inherited Qt members：QAbstractItemView

Example

Usage

Network photo flow

API

fluent::collections::FlowView

Constructors

Properties

Methods

Signals

Types and aliases

Destructors

PySide6 additions

Methods

Methods

Enumerations

Types and aliases

Methods

`fluent::collections::FlowView`