Fluent-Qt

文本输入

TagInput 标签输入框

把多个值显示为可以删除的标签。

示例

标签输入框的真实 Gallery 示例

用法

选择和移除标签

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 原生文字编辑区周围排列紧凑的已选标签。

构造函数

属性

QVariantList selectedItems
读取 selectedItems()设置 setSelectedItems()通知 selectionChanged()
int selectedCount
读取 selectedCount()通知 selectionChanged()

方法

void setSelectedItems(const QVariantList& items)

恢复值快照;忽略无效项和重复身份,保留首个出现项及顺序。

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

添加值快照;身份为空或已选中时返回 false。

信号

void tokensSubmitted(const QStringList& tokens)

请应用解析提交文字或分隔粘贴的值;应用添加有效项并保留待修正文字。

析构函数

子类扩展接口

方法

继承自 fluent::textfields::AutoSuggestBox

属性

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

建议项行文本使用的排版角色。

读取 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()

方法

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

建议项行文本使用的排版角色。

int suggestionItemHeight() const

每个建议项行的高度。

bool isSuggestionListOpen() const

建议列表弹层是否打开。

void setSuggestionModel(QAbstractItemModel* model)

借用扁平模型第零列,DisplayRole 显示文字,UserRole 可提供选中项数据。

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

应用修改借用模型之前,用此函数检查请求 token 是否仍有效。

bool completeSuggestionRequest(quint64 requestId, bool hasMore = false)

应用通过 token 检查并更新模型后,完成当前请求;过期结果返回 false。

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

接收当前字符串结果;仅加载更多请求追加结果,过期结果不会写入列表。

void setHeader(const QString& header)

显示在输入行上方的可选标签文本。

void setQueryIconGlyph(const QString& glyph)

查询/搜索入口使用的图标字符。

void setQueryIconVisible(bool visible)

查询图标是否可见。

void setInputHeight(int height)

输入表面的首选高度。

void setQueryButtonSize(int size)

查询操作按钮尺寸。

void setSuggestionFontRole(Typography::FontRole role)

建议项行文本使用的排版角色。

void setSuggestionItemHeight(int height)

每个建议项行的高度。

void setSuggestions(const QStringList& suggestions)

建议弹层显示的候选文本列表。

void requestSuggestions()

开启异步建议时立即请求当前查询。

信号

void suggestionsChanged()

建议弹层显示的候选文本列表。

void headerChanged()

显示在输入行上方的可选标签文本。

void queryIconGlyphChanged()

查询/搜索入口使用的图标字符。

void queryIconVisibleChanged()

查询图标是否可见。

void queryButtonPlacementChanged()

查询操作按钮的位置。

void inputHeightChanged()

输入表面的首选高度。

void queryButtonSizeChanged()

查询操作按钮尺寸。

void suggestionFontRoleChanged()

建议项行文本使用的排版角色。

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)

通知应用取消已失效 token 对应的传输工作。

枚举

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

当前异步查询状态;Ready 也可以没有结果。

  • Idle
  • Loading
  • Ready
  • Failed
继承自 fluent::textfields::LineEdit

属性

QMargins contentMargins

内容边距;水平值已包含 Qt 内部文字留白,零值不会重复增加原生边距。

读取 contentMargins()设置 setContentMargins()通知 contentMarginsChanged()
Typography::FontRole fontRole

文本绘制使用的 Fluent 排版角色。

读取 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()

方法

QMargins contentMargins() const

内容边距;水平值已包含 Qt 内部文字留白,零值不会重复增加原生边距。

void setContentMargins(const QMargins& margins)

内容边距;水平值已包含 Qt 内部文字留白,零值不会重复增加原生边距。

Typography::FontRole fontRole() const

文本绘制使用的 Fluent 排版角色。

void setFontRole(Typography::FontRole role)

文本绘制使用的 Fluent 排版角色。

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)

按显式所有权承载一个尾部控件;拒绝宿主自身及祖先控件。

QWidget* takeTrailingWidget()

脱离并将自定义尾部控件交回调用方。

void releaseTrailingWidget()

按记录的所有权策略释放自定义尾部内容。

信号

void contentMarginsChanged()

内容边距;水平值已包含 Qt 内部文字留白,零值不会重复增加原生边距。

void fontRoleChanged()

文本绘制使用的 Fluent 排版角色。

void clearButtonEnabledChanged()

尾部清除按钮是否启用。

void clearButtonSizeChanged()

清除按钮尺寸,默认为 24 个逻辑像素。

void clearButtonOffsetChanged()

清除按钮应用的像素偏移。

void focusedBorderWidthChanged()

聚焦时底部边框宽度。

void unfocusedBorderWidthChanged()

未聚焦时底部边框宽度。

void frameVisibleChanged()

LineEdit 是否绘制输入框外框和焦点下划线。

继承自 fluent::FluentElement

方法

static void setTheme(Theme theme)

更新全局主题,并通知所有活跃的 FluentElement 实例。

static void setThemeDeferred(Theme theme)

以可见元素优先的批次调度主题刷新,避免阻塞当前交互。

static Theme currentTheme()

返回当前生效的全局主题。

static bool themeUsesDarkAppearance(Theme theme)

返回指定主题是否使用暗色底的 chrome 与材质 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()

全局主题变化后调用。

枚举

enum Theme

解析设计 token 时使用的全局视觉主题。

  • Light = 0
  • Dark = 1
  • HighContrast = 2

类型与别名

struct Colors

返回给组件使用的设计 token 快照。

继承自 fluent::QMLPlus

方法

AnchorLayout::Anchors* anchors()

返回 QWidget 宿主的可变锚点配置。

void setState(const QString& name)

应用具名 state;名称为空时恢复默认状态。

void addState(const QMLState& state)

注册或替换一个具名 state 定义。

void evaluateStates()

重新计算条件;按注册顺序选择首个成立的条件。

QMLPlusRuntime* runtime()

返回按需创建、由宿主持有的状态观察对象。

void setAnchors(const AnchorLayout::Anchors& anchors)

替换宿主的全部锚点,并使父布局失效。

void resetAnchors()

清除宿主全部锚点,并使父布局失效。

void addTransition(const StateTransition& transition)

按优先顺序注册状态过渡。

void setBehavior(const char* propertyName, const PropertyAnimation& animation)

设置宿主受管理属性写入时使用的默认动画。

void clearBehavior(const char* propertyName)

移除后续受管理写入使用的默认动画。

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

通过 Behavior 写入宿主属性,且不移除该属性的绑定。

Qt 基类完整成员:QLineEdit