Fluent-Qt

Champs de texte

AutoSuggestBox Champ de suggestion

Un champ de recherche avec suggestions locales ou asynchrones, chargement, pagination et nouvelle tentative.

Exemple

AutoSuggestBox Champ de suggestion: Suggestions et validation de requête

Utilisation

Suggestions et validation de requête

Remplissez les éléments avec setSuggestions() et connectez textChangedWithReason, suggestionChosen et querySubmitted pour gérer la saisie, les clics et l'envoi de la recherche.

#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

Hérite de LineEdit

Champ de recherche basé sur LineEdit avec bouton de requête, action d'effacement et menu de suggestions. Prend en charge les listes statiques, les modèles externes et les états de chargement de recherche asynchrone.

Constructeurs

Destructeurs

Énumérations

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

État de la requête asynchrone en cours ; Ready peut ne contenir aucune ligne.

  • Idle
  • Loading
  • Ready
  • Failed

Méthodes

QStringList suggestions() const

Chaînes de suggestion affichées par la fenêtre contextuelle de suggestions.

QString header() const

Texte d'étiquette optionnel affiché au-dessus de la ligne de saisie.

QString queryIconGlyph() const

Glyphe d'icône utilisé par le bouton de requête/recherche.

bool isQueryIconVisible() const

Indique si l'icône de recherche est visible.

bool isClearButtonEnabled() const

Contrôle l'action d'effacement intégrée indépendamment du bouton de requête.

void setClearButtonEnabled(bool enabled)

Contrôle l'action d'effacement intégrée indépendamment du bouton de requête.

QueryButtonPlacement queryButtonPlacement() const

Emplacement du bouton d'action de requête.

int inputHeight() const

Hauteur préférée de la zone de saisie.

int queryButtonSize() const

Taille du bouton d'action de requête.

int clearButtonSize() const

Taille du bouton d'effacement.

Typography::FontRole suggestionFontRole() const

Préréglage Fluent Typography utilisé pour les lignes de suggestion.

int suggestionItemHeight() const

Hauteur de chaque ligne de suggestion.

bool isSuggestionListOpen() const

Indique si la fenêtre contextuelle de suggestions est ouverte.

void setSuggestionModel(QAbstractItemModel* model)

Utilise un modèle externe (colonne 0 DisplayRole, données UserRole optionnelles) comme suggestions sans le copier ni le supprimer. Passez nullptr ou appelez setSuggestions() pour revenir au mode liste de chaînes.

QString loadingMoreText() const

Texte affiché pendant le chargement d'une autre page de résultats.

void setLoadingMoreText(const QString& text)

Texte affiché pendant le chargement d'une autre page de résultats.

QString moreResultsText() const

Texte accompagnant l'action permettant d'afficher une autre page de résultats.

void setMoreResultsText(const QString& text)

Texte accompagnant l'action permettant d'afficher une autre page de résultats.

QString retryText() const

Libellé de l'action de nouvelle tentative après l'échec d'une requête.

void setRetryText(const QString& text)

Libellé de l'action de nouvelle tentative après l'échec d'une requête.

QString loadMoreText() const

Libellé de l'action demandant une page de résultats supplémentaire.

void setLoadMoreText(const QString& text)

Libellé de l'action demandant une page de résultats supplémentaire.

bool isSuggestionRequestCurrent(quint64 requestId) const

Vérifie si requestId est toujours actif avant de mettre à jour un modèle externe (les mises à jour doivent s'exécuter sur le thread GUI). L'édition, la fermeture de la fenêtre contextuelle, le remplacement du modèle ou la désactivation du mode asynchrone invalident les requêtes précédentes.

bool completeSuggestionRequest(quint64 requestId, bool hasMore = false)

Termine requestId après la mise à jour d'un modèle de suggestions externe ; retourne false s'il est obsolète.

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

Définit ou ajoute des résultats QStringList pour requestId, en retournant false s'il est obsolète. En mode modèle externe, mettez plutôt à jour le modèle et appelez completeSuggestionRequest().

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

Affiche un état d'erreur pour requestId (conserve les lignes existantes en cas d'erreur de pagination).

void setHeader(const QString& header)

Texte d'étiquette optionnel affiché au-dessus de la ligne de saisie.

void setQueryIconGlyph(const QString& glyph)

Glyphe d'icône utilisé par le bouton de requête/recherche.

void setQueryIconVisible(bool visible)

Indique si l'icône de recherche est visible.

void setQueryButtonPlacement(QueryButtonPlacement placement)

Emplacement du bouton d'action de requête.

void setInputHeight(int height)

Hauteur préférée de la zone de saisie.

void setQueryButtonSize(int size)

Taille du bouton d'action de requête.

void setClearButtonSize(int size)

Taille du bouton d'effacement.

void setSuggestionFontRole(Typography::FontRole role)

Préréglage Fluent Typography utilisé pour les lignes de suggestion.

void setSuggestionItemHeight(int height)

Hauteur de chaque ligne de suggestion.

void setSuggestions(const QStringList& suggestions)

Chaînes de suggestion affichées par la fenêtre contextuelle de suggestions.

void requestSuggestions()

Demande immédiatement la requête actuelle lorsque les suggestions asynchrones sont activées.

Propriétés

QStringList suggestions

Chaînes de suggestion affichées par la fenêtre contextuelle de suggestions.

Lecture suggestions()Écriture setSuggestions()Notification suggestionsChanged()
QString header

Texte d'étiquette optionnel affiché au-dessus de la ligne de saisie.

Lecture header()Écriture setHeader()Notification headerChanged()
QString queryIconGlyph

Glyphe d'icône utilisé par le bouton de requête/recherche.

Lecture queryIconGlyph()Écriture setQueryIconGlyph()Notification queryIconGlyphChanged()
bool queryIconVisible

Indique si l'icône de recherche est visible.

Lecture isQueryIconVisible()Écriture setQueryIconVisible()Notification queryIconVisibleChanged()
bool clearButtonEnabled

Contrôle l'action d'effacement intégrée indépendamment du bouton de requête.

Lecture isClearButtonEnabled()Écriture setClearButtonEnabled()Notification clearButtonEnabledChanged()
QueryButtonPlacement queryButtonPlacement

Emplacement du bouton d'action de requête.

Lecture queryButtonPlacement()Écriture setQueryButtonPlacement()Notification queryButtonPlacementChanged()
int inputHeight

Hauteur préférée de la zone de saisie.

Lecture inputHeight()Écriture setInputHeight()Notification inputHeightChanged()
int queryButtonSize

Taille du bouton d'action de requête.

Lecture queryButtonSize()Écriture setQueryButtonSize()Notification queryButtonSizeChanged()
int clearButtonSize

Taille du bouton d'effacement.

Lecture clearButtonSize()Écriture setClearButtonSize()Notification clearButtonSizeChanged()
Typography::FontRole suggestionFontRole

Préréglage Fluent Typography utilisé pour les lignes de suggestion.

Lecture suggestionFontRole()Écriture setSuggestionFontRole()Notification suggestionFontRoleChanged()
int suggestionItemHeight

Hauteur de chaque ligne de suggestion.

Lecture suggestionItemHeight()Écriture setSuggestionItemHeight()Notification suggestionItemHeightChanged()
bool isSuggestionListOpen

Indique si la fenêtre contextuelle de suggestions est ouverte.

Lecture isSuggestionListOpen()Notification suggestionListOpenChanged()
QAbstractItemModel* suggestionModel
Lecture suggestionModel()Écriture setSuggestionModel()Notification suggestionModelChanged()
int suggestionCount
Lecture suggestionCount()Notification suggestionCountChanged()
bool asyncSuggestionsEnabled
Lecture isAsyncSuggestionsEnabled()Écriture setAsyncSuggestionsEnabled()Notification asyncSuggestionsEnabledChanged()
int debounceInterval
Lecture debounceInterval()Écriture setDebounceInterval()Notification debounceIntervalChanged()
LoadState loadState
Lecture loadState()Notification loadStateChanged()
bool hasMoreSuggestions
Lecture hasMoreSuggestions()Notification hasMoreSuggestionsChanged()
QString loadingText
Lecture loadingText()Écriture setLoadingText()Notification loadingTextChanged()
QString emptyText
Lecture emptyText()Écriture setEmptyText()Notification emptyTextChanged()
QString emptyDescription
Lecture emptyDescription()Écriture setEmptyDescription()Notification emptyDescriptionChanged()
QString loadingMoreText

Texte affiché pendant le chargement d'une autre page de résultats.

Lecture loadingMoreText()Écriture setLoadingMoreText()Notification loadingMoreTextChanged()
QString moreResultsText

Texte accompagnant l'action permettant d'afficher une autre page de résultats.

Lecture moreResultsText()Écriture setMoreResultsText()Notification moreResultsTextChanged()
QString retryText

Libellé de l'action de nouvelle tentative après l'échec d'une requête.

Lecture retryText()Écriture setRetryText()Notification retryTextChanged()
QString loadMoreText

Libellé de l'action demandant une page de résultats supplémentaire.

Lecture loadMoreText()Écriture setLoadMoreText()Notification loadMoreTextChanged()

Signaux

void suggestionsChanged()

Chaînes de suggestion affichées par la fenêtre contextuelle de suggestions.

void headerChanged()

Texte d'étiquette optionnel affiché au-dessus de la ligne de saisie.

void queryIconGlyphChanged()

Glyphe d'icône utilisé par le bouton de requête/recherche.

void queryIconVisibleChanged()

Indique si l'icône de recherche est visible.

void queryButtonPlacementChanged()

Emplacement du bouton d'action de requête.

void inputHeightChanged()

Hauteur préférée de la zone de saisie.

void queryButtonSizeChanged()

Taille du bouton d'action de requête.

void suggestionFontRoleChanged()

Préréglage Fluent Typography utilisé pour les lignes de suggestion.

void suggestionItemHeightChanged()

Hauteur de chaque ligne de suggestion.

void suggestionListOpenChanged(bool open)

Indique si la fenêtre contextuelle de suggestions est ouverte.

void loadingMoreTextChanged()

Texte affiché pendant le chargement d'une autre page de résultats.

void moreResultsTextChanged()

Texte accompagnant l'action permettant d'afficher une autre page de résultats.

void retryTextChanged()

Libellé de l'action de nouvelle tentative après l'échec d'une requête.

void loadMoreTextChanged()

Libellé de l'action demandant une page de résultats supplémentaire.

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

Émis pour demander des données de suggestion ; append vaut true lors du chargement ou d'une nouvelle tentative de la page suivante.

void suggestionRequestCanceled(quint64 requestId)

Émis lorsqu'un requestId en cours est annulé ou remplacé.

Membres protégés

Méthodes

void setQueryIconDecorative(bool decorative)

Affiche l'icône de requête comme décoration non interactive pour les sélecteurs composites.

Hérité de fluent::textfields::LineEdit

Méthodes

QMargins contentMargins() const

Marges de contenu autour du texte (les valeurs horizontales incluent le retrait interne du texte de Qt).

void setContentMargins(const QMargins& margins)

Marges de contenu autour du texte (les valeurs horizontales incluent le retrait interne du texte de Qt).

Typography::FontRole fontRole() const

Préréglage Fluent Typography utilisé pour le texte.

void setFontRole(Typography::FontRole role)

Préréglage Fluent Typography utilisé pour le texte.

bool isClearButtonEnabled() const

Indique si le bouton d'effacement final est activé.

void setClearButtonEnabled(bool enabled)

Indique si le bouton d'effacement final est activé.

int clearButtonSize() const

Taille du bouton d'effacement, 24 pixels logiques par défaut.

void setClearButtonSize(int size)

Taille du bouton d'effacement, 24 pixels logiques par défaut.

QPoint clearButtonOffset() const

Décalage en pixels appliqué au bouton d'effacement.

void setClearButtonOffset(const QPoint& offset)

Décalage en pixels appliqué au bouton d'effacement.

int focusedBorderWidth() const

Largeur de la bordure inférieure lorsqu'il a le focus.

void setFocusedBorderWidth(int width)

Largeur de la bordure inférieure lorsqu'il a le focus.

int unfocusedBorderWidth() const

Largeur de la bordure inférieure hors focus ; vaut zéro par défaut (aucun soulignement).

void setUnfocusedBorderWidth(int width)

Largeur de la bordure inférieure hors focus ; vaut zéro par défaut (aucun soulignement).

bool isFrameVisible() const

Indique si LineEdit dessine son cadre de saisie et son soulignement de focus.

void setFrameVisible(bool visible)

Indique si LineEdit dessine son cadre de saisie et son soulignement de focus.

void setTrailingText(const QString& text)

Affiche un suffixe en texte brut au bord de fin, en remplaçant tout widget de fin.

bool setTrailingWidget(QWidget* widget, WidgetOwnership ownership)

Définit un widget de fin personnalisé en utilisant WidgetOwnership pour préciser le nettoyage (rejette lui-même ou ses ancêtres). Appelez takeTrailingWidget() avant de changer de mode de propriété.

QWidget* takeTrailingWidget()

Retire et retourne le widget de fin pour que l'appelant le gère ou le supprime.

void releaseTrailingWidget()

Retire le widget de fin et gère le nettoyage selon son mode WidgetOwnership.

Propriétés

QMargins contentMargins

Marges de contenu autour du texte (les valeurs horizontales incluent le retrait interne du texte de Qt).

Lecture contentMargins()Écriture setContentMargins()Notification contentMarginsChanged()
Typography::FontRole fontRole

Préréglage Fluent Typography utilisé pour le texte.

Lecture fontRole()Écriture setFontRole()Notification fontRoleChanged()
bool clearButtonEnabled

Indique si le bouton d'effacement final est activé.

Lecture isClearButtonEnabled()Écriture setClearButtonEnabled()Notification clearButtonEnabledChanged()
int clearButtonSize

Taille du bouton d'effacement, 24 pixels logiques par défaut.

Lecture clearButtonSize()Écriture setClearButtonSize()Notification clearButtonSizeChanged()
QPoint clearButtonOffset

Décalage en pixels appliqué au bouton d'effacement.

Lecture clearButtonOffset()Écriture setClearButtonOffset()Notification clearButtonOffsetChanged()
int focusedBorderWidth

Largeur de la bordure inférieure lorsqu'il a le focus.

Lecture focusedBorderWidth()Écriture setFocusedBorderWidth()Notification focusedBorderWidthChanged()
int unfocusedBorderWidth

Largeur de la bordure inférieure hors focus ; vaut zéro par défaut (aucun soulignement).

Lecture unfocusedBorderWidth()Écriture setUnfocusedBorderWidth()Notification unfocusedBorderWidthChanged()
bool frameVisible

Indique si LineEdit dessine son cadre de saisie et son soulignement de focus.

Lecture isFrameVisible()Écriture setFrameVisible()Notification frameVisibleChanged()
QString trailingText
Lecture trailingText()Écriture setTrailingText()Notification trailingTextChanged()
QWidget* trailingWidget
Lecture trailingWidget()Notification trailingWidgetChanged()
fluent::WidgetOwnership trailingWidgetOwnership
Lecture trailingWidgetOwnership()Notification trailingWidgetOwnershipChanged()
QString clearButtonAccessibleName
Lecture clearButtonAccessibleName()Écriture setClearButtonAccessibleName()Notification clearButtonAccessibleNameChanged()
Qt::FocusPolicy clearButtonFocusPolicy
Lecture clearButtonFocusPolicy()Écriture setClearButtonFocusPolicy()Notification clearButtonFocusPolicyChanged()

Signaux

void contentMarginsChanged()

Marges de contenu autour du texte (les valeurs horizontales incluent le retrait interne du texte de Qt).

void fontRoleChanged()

Préréglage Fluent Typography utilisé pour le texte.

void clearButtonEnabledChanged()

Indique si le bouton d'effacement final est activé.

void clearButtonSizeChanged()

Taille du bouton d'effacement, 24 pixels logiques par défaut.

void clearButtonOffsetChanged()

Décalage en pixels appliqué au bouton d'effacement.

void focusedBorderWidthChanged()

Largeur de la bordure inférieure lorsqu'il a le focus.

void unfocusedBorderWidthChanged()

Largeur de la bordure inférieure hors focus ; vaut zéro par défaut (aucun soulignement).

void frameVisibleChanged()

Indique si LineEdit dessine son cadre de saisie et son soulignement de focus.

Hérité de fluent::FluentElement

Énumérations

enum Theme

Thème visuel global utilisé lors de la résolution des tokens de design.

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

Méthodes

static void setTheme(Theme theme)

Met à jour le thème global et notifie les instances FluentElement actives.

static void setThemeDeferred(Theme theme)

Planifie une actualisation par lots du thème en donnant la priorité aux éléments visibles sans bloquer l'interaction en cours.

static Theme currentTheme()

Retourne le thème global actuellement actif.

static bool themeUsesDarkAppearance(Theme theme)

Indique si un thème utilise un habillage à fond sombre et des jetons de matériau.

static void refreshTheme()

Rediffuse le thème actuel pour redessiner après une modification de jeton de design.

static int themeGeneration()

Compteur monotone incrémenté à chaque changement de thème pour la vérification d'obsolescence.

Theme effectiveTheme() const

Résout le thème utilisé par cet élément, en respectant une surcharge héritée de QWidget.

bool effectiveThemeUsesDarkAppearance() const

Indique si le thème effectif de cet élément utilise un habillage à fond sombre.

bool setThemeOverrides(const QJsonObject& overrides)

Remplace les surcharges éparses de jetons de couleur, de rayon et de police de cet élément.

QJsonObject themeOverrides() const

Renvoie les surcharges définies pour cet élément.

void clearThemeOverrides()

Restaure tous les champs de tokens aux valeurs par défaut du thème global.

const Colors& themeColorsRef() const

Accès sans copie au jeu de couleurs actif pour les chemins de peinture critiques.

Material::AcrylicToken themeAcrylic() const

Jetons de matériau, d'élévation et de mise en page adaptative.

QColor themeBackdrop(bool active) const

Couleur d'arrière-plan du chrome de fenêtre pour l'état d'activation donné.

virtual void onThemeUpdated()

Appelé après un changement du thème global.

Types et alias

struct Colors

Instantanés de tokens de design renvoyés aux composants.

Hérité de fluent::QMLPlus

Méthodes

AnchorLayout::Anchors* anchors()

Retourne les ancres modifiables pour l'hôte QWidget.

void setState(const QString& name)

Applique un état enregistré par son nom, ou restaure l'état par défaut lorsque @p name est vide. Les noms inconnus sont ignorés et les liaisons existantes reprennent à la sortie de l'état.

void addState(const QMLState& state)

Enregistre ou remplace une définition d'état nommée ; remplacer l'état actif l'applique immédiatement.

void evaluateStates()

Réévalue les conditions d'état dans l'ordre d'enregistrement et active la première correspondance, ou l'état par défaut si aucune ne correspond. S'exécute aussi automatiquement lorsque les propriétés dépendantes notifient ; les états dérivés utilisant extend héritent des modifications ancêtres sauf en cas de cycle ou d'absence.

QMLPlusRuntime* runtime()

Retourne l'observateur d'état créé à la demande et détenu par cet hôte.

void setAnchors(const AnchorLayout::Anchors& anchors)

Remplace toutes les ancres de l'hôte et invalide la mise en page parente.

void resetAnchors()

Efface tous les ancrages de l'hôte et invalide la mise en page parente.

void bind(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction dir = PropertyBinder::OneWay)

Lie @p sourceProp sur @p source à @p targetProp sur cet hôte QWidget via PropertyBinder::bind().

void addTransition(const StateTransition& transition)

Enregistre une transition d'état par ordre de priorité.

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

Définit l'animation par défaut utilisée lorsque @p propertyName est modifié via writeProperty() ou une liaison. Les règles StateTransition explicites ont la priorité ; les appels directs aux setters C++ ne sont pas animés.

void clearBehavior(const char* propertyName)

Supprime l'animation par défaut pour les futures écritures gérées.

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

Écrit une propriété hôte via Behavior sans supprimer sa liaison.

Documentation de la classe de base Qt : QLineEdit