Fluent-Qt

文字輸入

TagInput 標籤輸入框

以精簡標籤形式選取多個值,支援非同步建議與原生文字輸入。

範例

TagInput 標籤輸入框: 選取與移除標籤

用法

選取與移除標籤

使用 setSuggestions() 提供補全建議、addItem() 新增標籤,並支援滑鼠點擊或鍵盤刪除標籤。

#include <FluentQt/TextFields.h>
using namespace fluent::textfields;

auto* input = new fluent::textfields::TagInput(this);
input->setAccessibleName("Technologies");
input->setPlaceholderText("Choose a technology");
input->setSuggestions({"Qt", "C++", "Python"});
input->addItem("Qt", "Qt");
input->setMaximumWidth(360);

fluent::textfields::TagInput

繼承自 AutoSuggestBox

圍繞 AutoSuggestBox 文字編輯器排列的多值標籤輸入控制項。

建構函式

解構函式

方法

void setSelectedItems(const QVariantList& items)

取代所選取的標籤,忽略格式錯誤的項目與重複的 key(保留首次出現順序)。

bool addItem(const QString& key, const QString& text)

新增標籤快照;key 為空或已選取時傳回 false。

屬性

QVariantList selectedItems
讀取 selectedItems()設定 setSelectedItems()變更訊號 selectionChanged()
int selectedCount
讀取 selectedCount()變更訊號 selectionChanged()

訊號

void tokensSubmitted(const QStringList& tokens)

當輸入文字或以分隔符號區隔的貼上項目需要外部解析時發出。

受保護成員

方法

繼承自 fluent::textfields::AutoSuggestBox

列舉

enum class TextChangeReason
  • UserInput
  • ProgrammaticChange
  • SuggestionChosen
enum class QueryButtonPlacement
  • Right
  • Left
  • Leading
  • Trailing
enum class LoadState

目前非同步查詢的狀態;Ready 也可能不含任何資料列。

  • Idle
  • Loading
  • Ready
  • Failed

方法

QStringList suggestions() const

建議彈出層顯示的候選文字清單。

QString header() const

顯示於輸入列上方的可選標籤文字。

QString queryIconGlyph() const

查詢/搜尋功能使用的圖示字形。

bool isQueryIconVisible() const

查詢圖示是否可見。

bool isClearButtonEnabled() const

獨立於查詢按鈕控制內嵌清除動作。

void setClearButtonEnabled(bool enabled)

獨立於查詢按鈕控制內嵌清除動作。

int inputHeight() const

輸入方塊的偏好高度。

int queryButtonSize() const

查詢動作按鈕的尺寸。

int clearButtonSize() const

清除按鈕的尺寸。

Typography::FontRole suggestionFontRole() const

建議列使用的 Fluent Typography 預設樣式。

int suggestionItemHeight() const

每個建議項目列的高度。

bool isSuggestionListOpen() const

建議清單彈出層是否開啟。

void setSuggestionModel(QAbstractItemModel* model)

使用外部模型(第 0 欄 DisplayRole,選用 UserRole 資料)作為建議項目,不會複製或刪除該模型;傳入 nullptr 或呼叫 setSuggestions() 可切換回字串清單模式。

QString loadingMoreText() const

載入下一頁結果時顯示的文字。

void setLoadingMoreText(const QString& text)

載入下一頁結果時顯示的文字。

QString moreResultsText() const

更多結果操作旁的提示文字。

void setMoreResultsText(const QString& text)

更多結果操作旁的提示文字。

QString retryText() const

要求失敗後重試操作的標題。

void setRetryText(const QString& text)

要求失敗後重試操作的標題。

QString loadMoreText() const

要求下一頁結果的操作標題。

void setLoadMoreText(const QString& text)

要求下一頁結果的操作標題。

bool isSuggestionRequestCurrent(quint64 requestId) const

更新外部模型前檢查 requestId 是否仍為目前請求(更新必須在 GUI 執行緒上執行);編輯、關閉彈出視窗、更換模型或停用非同步模式都會使先前的請求失效。

bool completeSuggestionRequest(quint64 requestId, bool hasMore = false)

更新外部建議模型後完成 requestId;若已過期則傳回 false。

bool setSuggestionsForRequest(quint64 requestId, const QStringList& suggestions, bool hasMore = false)

為 requestId 設定或附加 QStringList 結果,若已過時則傳回 false;外部模型模式應改為更新模型並呼叫 completeSuggestionRequest()。

bool failSuggestionRequest(quint64 requestId, const QString& message, const QString& details = QString())

顯示 requestId 的錯誤狀態(分頁載入失敗時保留現有資料列)。

void setHeader(const QString& header)

顯示於輸入列上方的可選標籤文字。

void setQueryIconGlyph(const QString& glyph)

查詢/搜尋功能使用的圖示字形。

void setQueryIconVisible(bool visible)

查詢圖示是否可見。

void setInputHeight(int height)

輸入方塊的偏好高度。

void setQueryButtonSize(int size)

查詢動作按鈕的尺寸。

void setClearButtonSize(int size)

清除按鈕的尺寸。

void setSuggestionFontRole(Typography::FontRole role)

建議列使用的 Fluent Typography 預設樣式。

void setSuggestionItemHeight(int height)

每個建議項目列的高度。

void setSuggestions(const QStringList& suggestions)

建議彈出層顯示的候選文字清單。

void requestSuggestions()

啟用非同步建議時立即請求目前查詢。

屬性

QStringList suggestions

建議彈出層顯示的候選文字清單。

讀取 suggestions()設定 setSuggestions()變更訊號 suggestionsChanged()
QString header

顯示於輸入列上方的可選標籤文字。

讀取 header()設定 setHeader()變更訊號 headerChanged()
QString queryIconGlyph

查詢/搜尋功能使用的圖示字形。

讀取 queryIconGlyph()設定 setQueryIconGlyph()變更訊號 queryIconGlyphChanged()
bool queryIconVisible

查詢圖示是否可見。

讀取 isQueryIconVisible()設定 setQueryIconVisible()變更訊號 queryIconVisibleChanged()
bool clearButtonEnabled

獨立於查詢按鈕控制內嵌清除動作。

讀取 isClearButtonEnabled()設定 setClearButtonEnabled()變更訊號 clearButtonEnabledChanged()
QueryButtonPlacement queryButtonPlacement

查詢動作按鈕的位置。

讀取 queryButtonPlacement()設定 setQueryButtonPlacement()變更訊號 queryButtonPlacementChanged()
int inputHeight

輸入方塊的偏好高度。

讀取 inputHeight()設定 setInputHeight()變更訊號 inputHeightChanged()
int queryButtonSize

查詢動作按鈕的尺寸。

讀取 queryButtonSize()設定 setQueryButtonSize()變更訊號 queryButtonSizeChanged()
int clearButtonSize

清除按鈕的尺寸。

讀取 clearButtonSize()設定 setClearButtonSize()變更訊號 clearButtonSizeChanged()
Typography::FontRole suggestionFontRole

建議列使用的 Fluent Typography 預設樣式。

讀取 suggestionFontRole()設定 setSuggestionFontRole()變更訊號 suggestionFontRoleChanged()
int suggestionItemHeight

每個建議項目列的高度。

讀取 suggestionItemHeight()設定 setSuggestionItemHeight()變更訊號 suggestionItemHeightChanged()
bool isSuggestionListOpen

建議清單彈出層是否開啟。

讀取 isSuggestionListOpen()變更訊號 suggestionListOpenChanged()
QAbstractItemModel* suggestionModel
讀取 suggestionModel()設定 setSuggestionModel()變更訊號 suggestionModelChanged()
int suggestionCount
讀取 suggestionCount()變更訊號 suggestionCountChanged()
bool asyncSuggestionsEnabled
讀取 isAsyncSuggestionsEnabled()設定 setAsyncSuggestionsEnabled()變更訊號 asyncSuggestionsEnabledChanged()
int debounceInterval
讀取 debounceInterval()設定 setDebounceInterval()變更訊號 debounceIntervalChanged()
LoadState loadState
讀取 loadState()變更訊號 loadStateChanged()
bool hasMoreSuggestions
讀取 hasMoreSuggestions()變更訊號 hasMoreSuggestionsChanged()
QString loadingText
讀取 loadingText()設定 setLoadingText()變更訊號 loadingTextChanged()
QString emptyText
讀取 emptyText()設定 setEmptyText()變更訊號 emptyTextChanged()
QString emptyDescription
讀取 emptyDescription()設定 setEmptyDescription()變更訊號 emptyDescriptionChanged()
QString loadingMoreText

載入下一頁結果時顯示的文字。

讀取 loadingMoreText()設定 setLoadingMoreText()變更訊號 loadingMoreTextChanged()
QString moreResultsText

更多結果操作旁的提示文字。

讀取 moreResultsText()設定 setMoreResultsText()變更訊號 moreResultsTextChanged()
QString retryText

要求失敗後重試操作的標題。

讀取 retryText()設定 setRetryText()變更訊號 retryTextChanged()
QString loadMoreText

要求下一頁結果的操作標題。

讀取 loadMoreText()設定 setLoadMoreText()變更訊號 loadMoreTextChanged()

訊號

void suggestionsChanged()

建議彈出層顯示的候選文字清單。

void headerChanged()

顯示於輸入列上方的可選標籤文字。

void queryIconGlyphChanged()

查詢/搜尋功能使用的圖示字形。

void queryIconVisibleChanged()

查詢圖示是否可見。

void queryButtonPlacementChanged()

查詢動作按鈕的位置。

void inputHeightChanged()

輸入方塊的偏好高度。

void queryButtonSizeChanged()

查詢動作按鈕的尺寸。

void suggestionFontRoleChanged()

建議列使用的 Fluent Typography 預設樣式。

void suggestionItemHeightChanged()

每個建議項目列的高度。

void suggestionListOpenChanged(bool open)

建議清單彈出層是否開啟。

void loadingMoreTextChanged()

載入下一頁結果時顯示的文字。

void moreResultsTextChanged()

更多結果操作旁的提示文字。

void retryTextChanged()

要求失敗後重試操作的標題。

void loadMoreTextChanged()

要求下一頁結果的操作標題。

void suggestionsRequested(const QString& query, quint64 requestId, bool append)

請求建議資料時發出;載入或重試下一頁時 append 為 true。

void suggestionRequestCanceled(quint64 requestId)

進行中的 requestId 被取消或被取代時發出。

繼承自 fluent::textfields::LineEdit

方法

QMargins contentMargins() const

文字周圍的內容邊距(水平值包含 Qt 內部的文字內縮)。

void setContentMargins(const QMargins& margins)

文字周圍的內容邊距(水平值包含 Qt 內部的文字內縮)。

Typography::FontRole fontRole() const

文字使用的 Fluent Typography 預設樣式。

void setFontRole(Typography::FontRole role)

文字使用的 Fluent Typography 預設樣式。

bool isClearButtonEnabled() const

尾端清除按鈕是否啟用。

void setClearButtonEnabled(bool enabled)

尾端清除按鈕是否啟用。

int clearButtonSize() const

清除按鈕的尺寸,預設為 24 個邏輯像素。

void setClearButtonSize(int size)

清除按鈕的尺寸,預設為 24 個邏輯像素。

QPoint clearButtonOffset() const

套用於清除按鈕的像素位移。

void setClearButtonOffset(const QPoint& offset)

套用於清除按鈕的像素位移。

int focusedBorderWidth() const

取得焦點時的底部邊框寬度。

void setFocusedBorderWidth(int width)

取得焦點時的底部邊框寬度。

int unfocusedBorderWidth() const

未取得焦點時的底部邊框寬度;預設為零(無底線)。

void setUnfocusedBorderWidth(int width)

未取得焦點時的底部邊框寬度;預設為零(無底線)。

bool isFrameVisible() const

LineEdit 是否繪製輸入框外框與焦點底線。

void setFrameVisible(bool visible)

LineEdit 是否繪製輸入框外框與焦點底線。

void setTrailingText(const QString& text)

在尾端顯示純文字後綴,並取代任何現有的尾端控制項。

bool setTrailingWidget(QWidget* widget, WidgetOwnership ownership)

使用 WidgetOwnership 設定自訂尾端控制項與其清理方式(不接受自身或上層控制項);切換所有權模式前需先呼叫 takeTrailingWidget()。

QWidget* takeTrailingWidget()

移除並回傳尾端控制項,交由呼叫端管理或刪除。

void releaseTrailingWidget()

移除尾端控制項,並依其 WidgetOwnership 模式進行清理。

屬性

QMargins contentMargins

文字周圍的內容邊距(水平值包含 Qt 內部的文字內縮)。

讀取 contentMargins()設定 setContentMargins()變更訊號 contentMarginsChanged()
Typography::FontRole fontRole

文字使用的 Fluent Typography 預設樣式。

讀取 fontRole()設定 setFontRole()變更訊號 fontRoleChanged()
bool clearButtonEnabled

尾端清除按鈕是否啟用。

讀取 isClearButtonEnabled()設定 setClearButtonEnabled()變更訊號 clearButtonEnabledChanged()
int clearButtonSize

清除按鈕的尺寸,預設為 24 個邏輯像素。

讀取 clearButtonSize()設定 setClearButtonSize()變更訊號 clearButtonSizeChanged()
QPoint clearButtonOffset

套用於清除按鈕的像素位移。

讀取 clearButtonOffset()設定 setClearButtonOffset()變更訊號 clearButtonOffsetChanged()
int focusedBorderWidth

取得焦點時的底部邊框寬度。

讀取 focusedBorderWidth()設定 setFocusedBorderWidth()變更訊號 focusedBorderWidthChanged()
int unfocusedBorderWidth

未取得焦點時的底部邊框寬度;預設為零(無底線)。

讀取 unfocusedBorderWidth()設定 setUnfocusedBorderWidth()變更訊號 unfocusedBorderWidthChanged()
bool frameVisible

LineEdit 是否繪製輸入框外框與焦點底線。

讀取 isFrameVisible()設定 setFrameVisible()變更訊號 frameVisibleChanged()
QString trailingText
讀取 trailingText()設定 setTrailingText()變更訊號 trailingTextChanged()
QWidget* trailingWidget
讀取 trailingWidget()變更訊號 trailingWidgetChanged()
fluent::WidgetOwnership trailingWidgetOwnership
讀取 trailingWidgetOwnership()變更訊號 trailingWidgetOwnershipChanged()
QString clearButtonAccessibleName
讀取 clearButtonAccessibleName()設定 setClearButtonAccessibleName()變更訊號 clearButtonAccessibleNameChanged()
Qt::FocusPolicy clearButtonFocusPolicy
讀取 clearButtonFocusPolicy()設定 setClearButtonFocusPolicy()變更訊號 clearButtonFocusPolicyChanged()

訊號

void contentMarginsChanged()

文字周圍的內容邊距(水平值包含 Qt 內部的文字內縮)。

void fontRoleChanged()

文字使用的 Fluent Typography 預設樣式。

void clearButtonEnabledChanged()

尾端清除按鈕是否啟用。

void clearButtonSizeChanged()

清除按鈕的尺寸,預設為 24 個邏輯像素。

void clearButtonOffsetChanged()

套用於清除按鈕的像素位移。

void focusedBorderWidthChanged()

取得焦點時的底部邊框寬度。

void unfocusedBorderWidthChanged()

未取得焦點時的底部邊框寬度;預設為零(無底線)。

void frameVisibleChanged()

LineEdit 是否繪製輸入框外框與焦點底線。

繼承自 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 基底類別文件:QLineEdit