Fluent-Qt

選單與工具列

CommandBarFlyout 浮動命令列

包含主要與次要動作的內容相關命令介面。

範例

CommandBarFlyout 浮動命令列: 相片的內容相關動作

用法

相片的內容相關動作

使用 addPrimaryAction() 與 addSecondaryAction() 加入命令,再將 Standard 或 Transient 模式傳入 showAt() 以配合點按或右鍵叫用。

#include <FluentQt/MenusToolbars.h>
using namespace fluent::menus_toolbars;

auto* flyout = new CommandBarFlyout(this);
auto* shareAction = new QAction(
    QIcon(":/icons/share.svg"), "Share", this);
auto* saveAction = new QAction(
    QIcon(":/icons/save.svg"), "Save", this);
auto* deleteAction = new QAction(
    QIcon(":/icons/delete.svg"), "Delete", this);
auto* resizeAction = new QAction(
    QIcon(":/icons/resize.svg"), "Resize", this);
auto* moveAction = new QAction(
    QIcon(":/icons/move.svg"), "Move", this);
flyout->addPrimaryAction(shareAction);
flyout->addPrimaryAction(saveAction);
flyout->addPrimaryAction(deleteAction);
flyout->addSecondaryAction(resizeAction);
flyout->addSecondaryAction(moveAction);

// Proactive click: keep focus on the invoking content.
connect(photo, &QAbstractButton::clicked, flyout, [=] {
    flyout->showAt(
        photo, CommandBarFlyout::ShowMode::Transient);
});

// Reactive context invocation: expand and enter the menu.
photo->setContextMenuPolicy(Qt::CustomContextMenu);
connect(photo, &QWidget::customContextMenuRequested,
        flyout, [=](const QPoint& localPosition) {
    flyout->showAtPoint(
        photo, localPosition,
        CommandBarFlyout::ShowMode::Standard);
});
using fluent::status_info::Toast;
for (QAction* action : flyout->primaryActions() + flyout->secondaryActions()) {
    if (action->isSeparator()) continue;
    connect(action, &QAction::triggered, this, [this, action] {
        QString text = action->text().section('\t', 0, 0).remove('&');
        Toast::showOrUpdateToast(this, "gallery.action-feedback", text + " selected",
            Toast::Informational, 2200, Toast::Top, QMargins(16, 50, 16, 16));
    });
}

fluent::menus_toolbars::CommandBarFlyout

繼承自 dialogs_flyouts::Flyout

顯示於目標控制項附近的內容浮動命令列,具備可展開的次要動作,並在觸發命令時自動關閉。

建構函式

解構函式

列舉

enum class ShowMode

控制開啟時的焦點與初始展開行為。

  • Standard
  • Transient

方法

void addAction(QAction* action)

新增至主命令區(不負責銷毀 QAction)。

void insertAction(QAction* before, QAction* action)

在 `before` 之前將動作插入主要區段(不取得所有權)。

void removeAction(QAction* action)

從快顯命令列移除動作,但不將其刪除。

bool addPrimaryAction(QAction* action)

附加至主命令區(不負責銷毀 QAction)。

bool insertPrimaryAction(QAction* before, QAction* action)

在 `before` 之前插入主要動作(不取得所有權)。

bool addSecondaryAction(QAction* action)

附加至次命令區(不負責銷毀 QAction)。

bool insertSecondaryAction(QAction* before, QAction* action)

在 `before` 之前插入次要動作(不取得所有權)。

bool removeCommandAction(QAction* action)

從任一區段移除動作,但不將其刪除。

void clearPrimaryActions()

清除所有主要命令而不刪除對應動作。

void clearSecondaryActions()

清除所有次要命令而不刪除對應動作。

QList<QAction*> primaryActions() const

依顯示順序傳回主要動作。

QList<QAction*> secondaryActions() const

依顯示順序傳回次要動作。

void setAnchor(QWidget* anchor)

設定用於定位的錨點控制項,但不開啟飛出視窗。

void showAt(QWidget* anchor)

使用目前顯示模式開啟錨定至 `anchor` 的浮出視窗。

void showAt(QWidget* anchor, ShowMode mode)

使用 `mode` 開啟錨定至 `anchor` 的浮出視窗。

void showAtPoint(QWidget* relativeTo, const QPoint& localPosition)

依目前顯示模式在相對於 `relativeTo` 的 `localPosition` 附近開啟浮層。

void showAtPoint(QWidget* relativeTo, const QPoint& localPosition, ShowMode mode)

依 `mode` 在相對於 `relativeTo` 的 `localPosition` 附近開啟浮層。

void setExpanded(bool expanded)

在飛出視窗開啟時展開或收合次要命令功能表。

屬性

ShowMode showMode
讀取 showMode()設定 setShowMode()變更訊號 showModeChanged()
bool expanded
讀取 isExpanded()設定 setExpanded()變更訊號 expandedChanged()
bool alwaysExpanded
讀取 isAlwaysExpanded()設定 setAlwaysExpanded()變更訊號 alwaysExpandedChanged()

訊號

型別與別名

受保護成員

方法

繼承自 fluent::dialogs_flyouts::Flyout

列舉

enum Placement
  • Top 在 anchor 上方。
  • Bottom 位於錨點下方。
  • Left 位於 anchor 左側。
  • Right 位於 anchor 右側。
  • Full 於頂層視窗中置中(基底類別預設值)。
  • Auto 優先使用 Bottom,空間不足時翻轉至 Top。

方法

Placement placement() const

浮出視窗相對於其錨點的偏好位置。

void setPlacement(Placement p)

浮出視窗相對於其錨點的偏好位置。

int anchorOffset() const

距離錨點邊緣的像素位移。

void setAnchorOffset(int px)

距離錨點邊緣的像素位移。

bool clampToWindow() const

快顯浮層幾何範圍是否限制在宿主視窗內。

void setClampToWindow(bool e)

快顯浮層幾何範圍是否限制在宿主視窗內。

void showAt(QWidget* anchor)

開啟錨定至 anchor 的浮出視窗(等同於 setAnchor(anchor) + open())。

void setAnchor(QWidget* anchor)

設定錨點控制項,但不開啟飛出視窗。

屬性

Placement placement

浮出視窗相對於其錨點的偏好位置。

讀取 placement()設定 setPlacement()變更訊號 placementChanged()
int anchorOffset

距離錨點邊緣的像素位移。

讀取 anchorOffset()設定 setAnchorOffset()變更訊號 anchorOffsetChanged()
bool clampToWindow

快顯浮層幾何範圍是否限制在宿主視窗內。

讀取 clampToWindow()設定 setClampToWindow()變更訊號 clampToWindowChanged()

訊號

void placementChanged(Placement p)

浮出視窗相對於其錨點的偏好位置。

void anchorOffsetChanged(int px)

距離錨點邊緣的像素位移。

void clampToWindowChanged(bool enabled)

快顯浮層幾何範圍是否限制在宿主視窗內。

繼承自 fluent::dialogs_flyouts::Popup

列舉

enum CloseFlag
  • NoAutoClose = 0
  • CloseOnPressOutside = 1 << 0
  • CloseOnEscape = 1 << 1
enum CloseReason

浮層關閉原因;數值 0–4 與 TeachingTip::CloseReason 保持一致以相容原始碼。

  • Programmatic = 0
  • ActionButton = 1
  • CloseButton = 2
  • LightDismiss = 3
  • TargetDestroyed = 4
  • Escape = 5

方法

bool isOpen() const

請求的開啟狀態(獨立於動畫進度或控制項可見性)。

ClosePolicy closePolicy() const

控制外部點擊、Esc 或程式關閉行為的策略。

void setClosePolicy(ClosePolicy p)

控制外部點擊、Esc 或程式關閉行為的策略。

bool isModal() const

浮層是否阻擋其外部互動。

void setModal(bool m)

浮層是否阻擋其外部互動。

bool lightDismissConsumesPress() const

以 CloseOnPressOutside 關閉時是否攔截滑鼠按下事件而非向下傳遞(預設為 false)。

void addLightDismissPassthrough(QWidget* widget)

使控制項免於受 lightDismissConsumesPress() 影響,且不取得擁有權。

bool isDim() const

浮層後方是否顯示暗化遮罩層。

void setDim(bool d)

浮層後方是否顯示暗化遮罩層。

double dimOpacity() const

遮罩不透明度,範圍為 [0, 1];-1 表示使用主題煙霧 token。僅在啟用 dim 時套用。

void setDimOpacity(double opacity)

遮罩不透明度,範圍為 [0, 1];-1 表示使用主題煙霧 token。僅在啟用 dim 時套用。

double backdropBlurRadius() const

擷取背景的模糊半徑 [0, 32](0 表示停用;模態時預設為 4,否則為 0)。

void setBackdropBlurRadius(double radius)

擷取背景的模糊半徑 [0, 32](0 表示停用;模態時預設為 4,否則為 0)。

bool isAnimationEnabled() const

彈出層開啟/關閉過程是否播放轉場動畫。

void setAnimationEnabled(bool e)

彈出層開啟/關閉過程是否播放轉場動畫。

bool isExitAnimationEnabled() const

控制 close() 是否播放離場淡出動畫(不影響開啟動畫)。

void setThemeSource(QWidget* source)

設定彈出視窗無錨點時作為備援佈景主題來源的控制項。

double popupProgress() const

彈出層開啟/關閉動畫進度。

void setPopupProgress(double p)

彈出層開啟/關閉動畫進度。

void setPosition(QWidget* relativeTo, const QPoint& localPos)

依 relativeTo 區域座標定位彈出層左上角;未設定時 open() 會置中顯示。

void setIsOpen(bool open)

請求的開啟狀態(獨立於動畫進度或控制項可見性)。

void refreshBackdrop()

當開啟的彈出層後方應用程式內容變更時,重新整理快取的背景效果。

void closeWithReason(CloseReason reason)

以明確的原因關閉;除非另有待處理原因,否則 close() 會使用 Programmatic。

屬性

bool isOpen

請求的開啟狀態(獨立於動畫進度或控制項可見性)。

讀取 isOpen()設定 setIsOpen()變更訊號 isOpenChanged()
ClosePolicy closePolicy

控制外部點擊、Esc 或程式關閉行為的策略。

讀取 closePolicy()設定 setClosePolicy()變更訊號 closePolicyChanged()
bool modal

浮層是否阻擋其外部互動。

讀取 isModal()設定 setModal()變更訊號 modalChanged()
bool dim

浮層後方是否顯示暗化遮罩層。

讀取 isDim()設定 setDim()變更訊號 dimChanged()
double dimOpacity

遮罩不透明度,範圍為 [0, 1];-1 表示使用主題煙霧 token。僅在啟用 dim 時套用。

讀取 dimOpacity()設定 setDimOpacity()變更訊號 dimOpacityChanged()
double backdropBlurRadius

擷取背景的模糊半徑 [0, 32](0 表示停用;模態時預設為 4,否則為 0)。

讀取 backdropBlurRadius()設定 setBackdropBlurRadius()變更訊號 backdropBlurRadiusChanged()
bool animationEnabled

彈出層開啟/關閉過程是否播放轉場動畫。

讀取 isAnimationEnabled()設定 setAnimationEnabled()變更訊號 animationEnabledChanged()
double popupProgress

彈出層開啟/關閉動畫進度。

讀取 popupProgress()設定 setPopupProgress()變更訊號 popupProgressChanged()

訊號

void isOpenChanged(bool open)

請求的開啟狀態(獨立於動畫進度或控制項可見性)。

void opening()

開啟轉場已開始。相容性別名:aboutToShow()。

void closing(CloseReason reason)

已開始關閉轉場。aboutToHide() 為無參數的相容別名。

void popupProgressChanged(double progress)

彈出層開啟/關閉動畫進度。

void closePolicyChanged(ClosePolicy policy)

控制外部點擊、Esc 或程式關閉行為的策略。

void modalChanged(bool modal)

浮層是否阻擋其外部互動。

void dimChanged(bool dim)

浮層後方是否顯示暗化遮罩層。

void dimOpacityChanged(double opacity)

遮罩不透明度,範圍為 [0, 1];-1 表示使用主題煙霧 token。僅在啟用 dim 時套用。

void backdropBlurRadiusChanged(double radius)

擷取背景的模糊半徑 [0, 32](0 表示停用;模態時預設為 4,否則為 0)。

void animationEnabledChanged(bool enabled)

彈出層開啟/關閉過程是否播放轉場動畫。

型別與別名

繼承自 fluent::FluentElement

列舉

enum Theme

解析設計 token 時使用的全域視覺佈景主題。

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

傳回主題是否使用深色底的視窗框架與材質 token。

static void refreshTheme()

在設計 token 變更後重新廣播目前佈景主題以觸發重繪。

static int themeGeneration()

每次主題變更時遞增的單調計數器,用於過期檢查。

Theme effectiveTheme() const

解析此元素所使用的佈景主題,並遵循繼承的 QWidget 覆寫。

bool effectiveThemeUsesDarkAppearance() const

傳回此元素的實際主題是否使用深色底 chrome。

bool setThemeOverrides(const QJsonObject& overrides)

取代此元素的稀疏色彩、圓角與字型 token 覆寫。

QJsonObject themeOverrides() const

傳回此元素的覆寫設定。

void clearThemeOverrides()

將全部 token 欄位還原為全域主題預設值。

const Colors& themeColorsRef() const

對目前使用中色組的不複製存取(適用於繪製熱路徑)。

Material::AcrylicToken themeAcrylic() const

材質、高度層級與自適應版面配置 token。

QColor themeBackdrop(bool active) const

指定啟用狀態下的視窗 chrome 背景色。

virtual void onThemeUpdated()

在全域主題變更後呼叫。

型別與別名

struct Colors

傳回給元件使用的設計 token 快照。

繼承自 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++ setter 不會有動畫。

void clearBehavior(const char* propertyName)

移除後續受管理寫入所使用的預設動畫。

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

透過 Behavior 寫入宿主屬性,且不移除該屬性的繫結。

Qt 基底類別文件:QWidget