Fluent-Qt

Коллекции

DrawerView Выдвижная панель

Панель, выезжающая от края окна поверх содержимого.

Пример

DrawerView Выдвижная панель: Панель у правого края

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

Панель у правого края

Выберите край с помощью setEdge(), задайте ширину или высоту через setDrawerLength() и вызовите open() (по умолчанию закрывается кликом снаружи или клавишей Escape).

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

auto* drawer = new DrawerView(host);
drawer->setEdge(DrawerView::DrawerEdge::Right);
drawer->setDrawerLength(260);
drawer->setContentWidget(settingsPanel, WidgetOwnership::Owned);
auto* openButton = new Button("Open drawer", host);
QObject::connect(openButton, &Button::clicked,
                 drawer, &DrawerView::open);

fluent::collections::DrawerView

Наследует QWidget · FluentElement · QMLPlus

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

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

Деструкторы

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

enum class DrawerEdge
  • Left
  • Right
  • Top
  • Bottom
enum CloseFlag
  • NoAutoClose = 0
  • CloseOnPressOutside = 1 << 0
  • CloseOnEscape = 1 << 1

Методы

bool isOpen() const

Открыта ли выдвижная панель.

void setIsOpen(bool open)

Открыта ли выдвижная панель.

DrawerEdge edge() const

Край окна, от которого выезжает панель.

void setEdge(DrawerEdge edge)

Край окна, от которого выезжает панель.

qreal position() const

Нормализованный прогресс сдвига вдоль оси открытия (0.0 — закрыто, 1.0 — открыто).

void setPosition(qreal position)

Нормализованный прогресс сдвига вдоль оси открытия (0.0 — закрыто, 1.0 — открыто).

int drawerLength() const

Длина выдвижной панели вдоль оси открытия.

void setDrawerLength(int length)

Длина выдвижной панели вдоль оси открытия.

QMargins availableMargins() const

Поля, вычитаемые из области окна-владельца перед размещением выдвижной панели.

void setAvailableMargins(const QMargins& margins)

Поля, вычитаемые из области окна-владельца перед размещением выдвижной панели.

bool isModal() const

Блокирует ли оверлей взаимодействие за своими пределами.

void setModal(bool modal)

Блокирует ли оверлей взаимодействие за своими пределами.

bool isDim() const

Определяет, отображается ли затемняющий слой позади оверлея.

void setDim(bool dim)

Определяет, отображается ли затемняющий слой позади оверлея.

double dimOpacity() const

Непрозрачность подложки в диапазоне [0, 1]; -1 использует токен smoke темы при включённом dim.

void setDimOpacity(double opacity)

Непрозрачность подложки в диапазоне [0, 1]; -1 использует токен smoke темы при включённом dim.

double backdropBlurRadius() const

Радиус размытия фона в диапазоне [0, 32] px (0 отключает размытие; по умолчанию 4 для модального режима и 0 иначе).

void setBackdropBlurRadius(double radius)

Радиус размытия фона в диапазоне [0, 32] px (0 отключает размытие; по умолчанию 4 для модального режима и 0 иначе).

void refreshBackdrop()

Повторно захватывает фон окна после изменения фонового содержимого.

ClosePolicy closePolicy() const

Политика, определяющая поведение при клике вне области, нажатии Esc или программном закрытии.

void setClosePolicy(ClosePolicy policy)

Политика, определяющая поведение при клике вне области, нажатии Esc или программном закрытии.

bool isInteractive() const

Можно ли управлять выдвижной панелью перетаскиванием.

void setInteractive(bool interactive)

Можно ли управлять выдвижной панелью перетаскиванием.

int dragMargin() const

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

void setDragMargin(int margin)

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

int outerCornerRadius() const

Радиус скругления внешнего края выдвижной панели.

void setOuterCornerRadius(int radius)

Радиус скругления внешнего края выдвижной панели.

bool isAnimationEnabled() const

Определяет, анимируются ли переходы открытия и закрытия выдвижной панели.

void setAnimationEnabled(bool enabled)

Определяет, анимируются ли переходы открытия и закрытия выдвижной панели.

QWidget* contentWidget() const

Виджет, размещённый внутри выдвижной панели.

void setContentWidget(QWidget* widget)

Задаёт виджет содержимого выдвижной панели (по умолчанию управляется вызывающим кодом, WidgetOwnership::Borrowed).

bool setContentWidget(QWidget* widget, WidgetOwnership ownership)

Задаёт виджет содержимого выдвижной панели с явным режимом удаления WidgetOwnership.

QWidget* takeContentWidget()

Отсоединяет и возвращает текущий виджет содержимого без его удаления.

WidgetOwnership contentOwnership() const

Политика удаления текущего виджета содержимого.

Свойства

bool isOpen

Открыта ли выдвижная панель.

Чтение isOpen()Запись setIsOpen()Уведомление isOpenChanged()
DrawerEdge edge

Край окна, от которого выезжает панель.

Чтение edge()Запись setEdge()Уведомление edgeChanged()
qreal position

Нормализованный прогресс сдвига вдоль оси открытия (0.0 — закрыто, 1.0 — открыто).

Чтение position()Запись setPosition()Уведомление positionChanged()
int drawerLength

Длина выдвижной панели вдоль оси открытия.

Чтение drawerLength()Запись setDrawerLength()Уведомление drawerLengthChanged()
QMargins availableMargins

Поля, вычитаемые из области окна-владельца перед размещением выдвижной панели.

Чтение availableMargins()Запись setAvailableMargins()Уведомление availableMarginsChanged()
bool modal

Блокирует ли оверлей взаимодействие за своими пределами.

Чтение isModal()Запись setModal()Уведомление modalChanged()
bool dim

Определяет, отображается ли затемняющий слой позади оверлея.

Чтение isDim()Запись setDim()Уведомление dimChanged()
double dimOpacity

Непрозрачность подложки в диапазоне [0, 1]; -1 использует токен smoke темы при включённом dim.

Чтение dimOpacity()Запись setDimOpacity()Уведомление dimOpacityChanged()
double backdropBlurRadius

Радиус размытия фона в диапазоне [0, 32] px (0 отключает размытие; по умолчанию 4 для модального режима и 0 иначе).

Чтение backdropBlurRadius()Запись setBackdropBlurRadius()Уведомление backdropBlurRadiusChanged()
ClosePolicy closePolicy

Политика, определяющая поведение при клике вне области, нажатии Esc или программном закрытии.

Чтение closePolicy()Запись setClosePolicy()Уведомление closePolicyChanged()
bool interactive

Можно ли управлять выдвижной панелью перетаскиванием.

Чтение isInteractive()Запись setInteractive()Уведомление interactiveChanged()
int dragMargin

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

Чтение dragMargin()Запись setDragMargin()Уведомление dragMarginChanged()
int outerCornerRadius

Радиус скругления внешнего края выдвижной панели.

Чтение outerCornerRadius()Запись setOuterCornerRadius()Уведомление outerCornerRadiusChanged()
bool animationEnabled

Определяет, анимируются ли переходы открытия и закрытия выдвижной панели.

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

Виджет, размещённый внутри выдвижной панели.

Чтение contentWidget()Запись setContentWidget()Уведомление contentWidgetChanged()
fluent::WidgetOwnership contentOwnership

Политика удаления текущего виджета содержимого.

Чтение contentOwnership()Уведомление contentOwnershipChanged()

Сигналы

void isOpenChanged(bool open)

Открыта ли выдвижная панель.

void edgeChanged(DrawerEdge edge)

Край окна, от которого выезжает панель.

void positionChanged(qreal position)

Нормализованный прогресс сдвига вдоль оси открытия (0.0 — закрыто, 1.0 — открыто).

void drawerLengthChanged(int length)

Длина выдвижной панели вдоль оси открытия.

void availableMarginsChanged(const QMargins& margins)

Поля, вычитаемые из области окна-владельца перед размещением выдвижной панели.

void modalChanged(bool modal)

Блокирует ли оверлей взаимодействие за своими пределами.

void dimChanged(bool dim)

Определяет, отображается ли затемняющий слой позади оверлея.

void dimOpacityChanged(double opacity)

Непрозрачность подложки в диапазоне [0, 1]; -1 использует токен smoke темы при включённом dim.

void backdropBlurRadiusChanged(double radius)

Радиус размытия фона в диапазоне [0, 32] px (0 отключает размытие; по умолчанию 4 для модального режима и 0 иначе).

void closePolicyChanged(ClosePolicy policy)

Политика, определяющая поведение при клике вне области, нажатии Esc или программном закрытии.

void interactiveChanged(bool interactive)

Можно ли управлять выдвижной панелью перетаскиванием.

void dragMarginChanged(int margin)

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

void outerCornerRadiusChanged(int radius)

Радиус скругления внешнего края выдвижной панели.

void animationEnabledChanged(bool enabled)

Определяет, анимируются ли переходы открытия и закрытия выдвижной панели.

void contentWidgetChanged(QWidget* widget)

Виджет, размещённый внутри выдвижной панели.

void contentOwnershipChanged(WidgetOwnership ownership)

Политика удаления текущего виджета содержимого.

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

Дополнения PySide6

setOwnedContentWidget(widget)

Устанавливает содержимое выдвижной панели. При извлечении оно уничтожается.

setBorrowedContentWidget(widget)

Устанавливает заимствованное содержимое. При освобождении у него больше нет родительского виджета.

setReparentedContentWidget(widget)

Устанавливает содержимое, которое при освобождении возвращается к прежнему родительскому QWidget.

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

Методы

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