Fluent-Qt

Текстовые поля

AutoSuggestBox Поле с автодополнением

Поле поиска с локальными или асинхронными подсказками, индикацией загрузки, пагинацией и повтором.

Пример

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()));
        });

fluent::textfields::AutoSuggestBox

Наследует LineEdit

Поле поиска на базе LineEdit с кнопкой запроса, действием очистки и всплывающим списком подсказок. Поддерживает статические списки подсказок, внешние модели и состояния асинхронной загрузки поиска.

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

Деструкторы

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

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)

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

QueryButtonPlacement queryButtonPlacement() const

Расположение кнопки действия запроса.

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)

Задаёт или добавляет результаты QStringList для requestId, возвращая 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 setQueryButtonPlacement(QueryButtonPlacement placement)

Расположение кнопки действия запроса.

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 отменён или заменён новым запросом.

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

Методы

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

Ширина нижней границы без фокуса; по умолчанию 0 (без подчёркивания).

void setUnfocusedBorderWidth(int width)

Ширина нижней границы без фокуса; по умолчанию 0 (без подчёркивания).

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

Ширина нижней границы без фокуса; по умолчанию 0 (без подчёркивания).

Чтение 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()

Ширина нижней границы без фокуса; по умолчанию 0 (без подчёркивания).

void frameVisibleChanged()

Определяет, рисует ли LineEdit рамку ввода и подчёркивание фокуса.

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