文字輸入
AutoSuggestBox 自動建議方塊
輸入關鍵字時彈出建議清單的搜尋輸入框,支援本機與非同步建議、載入、分頁與重試。
範例
屬性預覽載入失敗。請再次點選屬性預覽重試。

用法
建議與提交
使用 setSuggestions() 填入建議項目,並連接 textChangedWithReason、suggestionChosen 與 querySubmitted 來處理輸入、點擊與搜尋提交。
#include <FluentQt/TextFields.h>
using namespace fluent::textfields;
auto* box = new AutoSuggestBox(this);
box->setHeader("Fruit");
box->setPlaceholderText("Type a fruit name");
box->setSuggestions({"Apple", "Apricot", "Banana", "Blueberry"});
connect(box, &AutoSuggestBox::textChangedWithReason,
statusLabel, [statusLabel](const QString& text,
AutoSuggestBox::TextChangeReason reason) {
statusLabel->setText(QStringLiteral("Text: %1, reason: %2")
.arg(text, textChangeReasonName(reason)));
});
connect(box, &AutoSuggestBox::suggestionChosen,
statusLabel, [statusLabel](const QVariant& item) {
statusLabel->setText(QStringLiteral("Chosen: %1").arg(item.toString()));
});
connect(box, &AutoSuggestBox::querySubmitted,
statusLabel, [statusLabel](const QString& query, const QVariant& chosen) {
statusLabel->setText(QStringLiteral("Submitted: %1 (%2)")
.arg(query, chosen.toString()));
});import fluentqt
box = fluentqt.AutoSuggestBox()
box.setHeader('Fruit')
box.setPlaceholderText('Type a fruit name')
box.setSuggestions(
[
"Apple",
"Apricot",
"Banana",
"Blueberry",
"Cherry",
"Grape",
"Orange",
"Strawberry",
]
)
def reason_name(reason):
name = reason.name
return name.decode('ascii') if isinstance(name, bytes) else str(name)
box.textChangedWithReason.connect(
lambda text, reason: status.setText(
f"Text: {text}, reason: {reason_name(reason)}"
)
)
box.suggestionChosen.connect(lambda item: status.setText(f'Chosen: {item}'))
box.querySubmitted.connect(
lambda query, chosen: status.setText(f"Submitted: {query} ({chosen})")
)API
檢視宣告沒有符合的 API 成員。
fluent::textfields::AutoSuggestBox
繼承自 LineEdit
基於 LineEdit 的搜尋方塊,附帶查詢按鈕、清除動作與建議快顯清單。支援靜態建議清單、外部模型及非同步搜尋載入狀態。
建構函式
解構函式
列舉
enum class TextChangeReasonUserInputProgrammaticChangeSuggestionChosen
enum class QueryButtonPlacementRightLeftLeadingTrailing
enum class LoadState目前非同步查詢的狀態;Ready 也可能不含任何資料列。
IdleLoadingReadyFailed
方法
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 setInputHeight(int height)輸入方塊的偏好高度。
void setQueryButtonSize(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 被取消或被取代時發出。
受保護成員
方法
void setQueryIconDecorative(bool decorative)將查詢圖示顯示為非互動式裝飾,供複合選擇器使用。
繼承自 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() constLineEdit 是否繪製輸入框外框與焦點底線。
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 frameVisibleLineEdit 是否繪製輸入框外框與焦點底線。
讀取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 = 0Dark = 1HighContrast = 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。
BindingHandle bindManaged(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction direction = PropertyBinder::OneWay, BindingOptions options = {})在此 QWidget 宿主上安裝受管理的直接繫結。
BindingHandle bindComputed(const char* targetProp, const QVector<BindingDependency>& dependencies, std::function<QVariant()> evaluate, BindingOptions options = {})在此 QWidget 宿主上安裝使用明確相依項目的 C++ 運算式繫結。
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