Fluent-Qt

Textfelder

AutoSuggestBox Vorschlagsfeld

Ein Sucheingabefeld mit lokalen oder asynchronen Vorschlägen, Ladeanzeige, Seitenumbruch und erneutem Versuch.

Beispiel

AutoSuggestBox Vorschlagsfeld: Vorschläge und Suchanfrage senden

Verwendung

Vorschläge und Suchanfrage senden

Befüllen Sie Einträge mit setSuggestions() und verbinden Sie textChangedWithReason, suggestionChosen sowie querySubmitted für Eingabe, Auswahl und Suchübermittlung.

#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

Erbt von LineEdit

LineEdit-basiertes Suchfeld mit Suchschaltfläche, Löschaktion und Vorschlags-Popup. Unterstützt statische Vorschlagslisten, externe Modelle und asynchrone Suchladezustände.

Konstruktoren

Destruktoren

Enumerationen

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

Status der aktuellen asynchronen Abfrage; Ready kann auch keine Zeilen enthalten.

  • Idle
  • Loading
  • Ready
  • Failed

Methoden

QStringList suggestions() const

Im Vorschlags-Popup angezeigte Vorschlagstexte.

QString header() const

Optionaler Beschriftungstext über der Eingabezeile.

QString queryIconGlyph() const

Symbolglyphe für die Abfrage-/Suchfunktion.

bool isQueryIconVisible() const

Ob das Abfragesymbol sichtbar ist.

bool isClearButtonEnabled() const

Steuert die Inline-Löschaktion unabhängig von der Suchschaltfläche.

void setClearButtonEnabled(bool enabled)

Steuert die Inline-Löschaktion unabhängig von der Suchschaltfläche.

QueryButtonPlacement queryButtonPlacement() const

Platzierung der Abfrage-Aktionsschaltfläche.

int inputHeight() const

Bevorzugte Höhe des Eingabefelds.

int queryButtonSize() const

Größe der Abfrageaktions-Schaltfläche.

int clearButtonSize() const

Größe der Löschen-Schaltfläche.

Typography::FontRole suggestionFontRole() const

Fluent-Typography-Voreinstellung für Vorschlagszeilen.

int suggestionItemHeight() const

Höhe jeder Vorschlagszeile.

bool isSuggestionListOpen() const

Ob das Vorschlags-Popup geöffnet ist.

void setSuggestionModel(QAbstractItemModel* model)

Verwendet ein externes Modell (Spalte 0 DisplayRole, optional UserRole-Daten) als Vorschläge, ohne es zu kopieren oder zu löschen. Übergeben Sie nullptr oder rufen Sie setSuggestions() auf, um in den String-Listen-Modus zurückzuwechseln.

QString loadingMoreText() const

Text, der angezeigt wird, während eine weitere Ergebnisseite geladen wird.

void setLoadingMoreText(const QString& text)

Text, der angezeigt wird, während eine weitere Ergebnisseite geladen wird.

QString moreResultsText() const

Begleittext zur Aktion für eine weitere Ergebnisseite.

void setMoreResultsText(const QString& text)

Begleittext zur Aktion für eine weitere Ergebnisseite.

QString retryText() const

Beschriftung der Aktion zum erneuten Versuch nach einer fehlgeschlagenen Anfrage.

void setRetryText(const QString& text)

Beschriftung der Aktion zum erneuten Versuch nach einer fehlgeschlagenen Anfrage.

QString loadMoreText() const

Beschriftung der Aktion, die eine weitere Ergebnisseite anfordert.

void setLoadMoreText(const QString& text)

Beschriftung der Aktion, die eine weitere Ergebnisseite anfordert.

bool isSuggestionRequestCurrent(quint64 requestId) const

Prüft vor dem Aktualisieren eines externen Modells, ob requestId noch aktuell ist (Aktualisierungen müssen im GUI-Thread erfolgen). Bearbeiten, Schließen des Popups, Ersetzen des Modells oder Deaktivieren des Async-Modus macht frühere Anfragen ungültig.

bool completeSuggestionRequest(quint64 requestId, bool hasMore = false)

Schließt requestId nach dem Aktualisieren eines externen Vorschlagsmodells ab; gibt false zurück, wenn veraltet.

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

Setzt oder hängt QStringList-Ergebnisse für requestId an und gibt false zurück, falls veraltet. Im externen Modellmodus sollte stattdessen das Modell aktualisiert und completeSuggestionRequest() aufgerufen werden.

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

Zeigt einen Fehlerzustand für requestId an (behält vorhandene Zeilen bei Paginierungsfehlern bei).

void setHeader(const QString& header)

Optionaler Beschriftungstext über der Eingabezeile.

void setQueryIconGlyph(const QString& glyph)

Symbolglyphe für die Abfrage-/Suchfunktion.

void setQueryIconVisible(bool visible)

Ob das Abfragesymbol sichtbar ist.

void setQueryButtonPlacement(QueryButtonPlacement placement)

Platzierung der Abfrage-Aktionsschaltfläche.

void setInputHeight(int height)

Bevorzugte Höhe des Eingabefelds.

void setQueryButtonSize(int size)

Größe der Abfrageaktions-Schaltfläche.

void setClearButtonSize(int size)

Größe der Löschen-Schaltfläche.

void setSuggestionFontRole(Typography::FontRole role)

Fluent-Typography-Voreinstellung für Vorschlagszeilen.

void setSuggestionItemHeight(int height)

Höhe jeder Vorschlagszeile.

void setSuggestions(const QStringList& suggestions)

Im Vorschlags-Popup angezeigte Vorschlagstexte.

void requestSuggestions()

Fragt die aktuelle Eingabe sofort an, wenn asynchrone Vorschläge aktiviert sind.

Eigenschaften

QStringList suggestions

Im Vorschlags-Popup angezeigte Vorschlagstexte.

Lesen suggestions()Schreiben setSuggestions()Benachrichtigung suggestionsChanged()
QString header

Optionaler Beschriftungstext über der Eingabezeile.

Lesen header()Schreiben setHeader()Benachrichtigung headerChanged()
QString queryIconGlyph

Symbolglyphe für die Abfrage-/Suchfunktion.

Lesen queryIconGlyph()Schreiben setQueryIconGlyph()Benachrichtigung queryIconGlyphChanged()
bool queryIconVisible

Ob das Abfragesymbol sichtbar ist.

Lesen isQueryIconVisible()Schreiben setQueryIconVisible()Benachrichtigung queryIconVisibleChanged()
bool clearButtonEnabled

Steuert die Inline-Löschaktion unabhängig von der Suchschaltfläche.

Lesen isClearButtonEnabled()Schreiben setClearButtonEnabled()Benachrichtigung clearButtonEnabledChanged()
QueryButtonPlacement queryButtonPlacement

Platzierung der Abfrage-Aktionsschaltfläche.

Lesen queryButtonPlacement()Schreiben setQueryButtonPlacement()Benachrichtigung queryButtonPlacementChanged()
int inputHeight

Bevorzugte Höhe des Eingabefelds.

Lesen inputHeight()Schreiben setInputHeight()Benachrichtigung inputHeightChanged()
int queryButtonSize

Größe der Abfrageaktions-Schaltfläche.

Lesen queryButtonSize()Schreiben setQueryButtonSize()Benachrichtigung queryButtonSizeChanged()
int clearButtonSize

Größe der Löschen-Schaltfläche.

Lesen clearButtonSize()Schreiben setClearButtonSize()Benachrichtigung clearButtonSizeChanged()
Typography::FontRole suggestionFontRole

Fluent-Typography-Voreinstellung für Vorschlagszeilen.

Lesen suggestionFontRole()Schreiben setSuggestionFontRole()Benachrichtigung suggestionFontRoleChanged()
int suggestionItemHeight

Höhe jeder Vorschlagszeile.

Lesen suggestionItemHeight()Schreiben setSuggestionItemHeight()Benachrichtigung suggestionItemHeightChanged()
bool isSuggestionListOpen

Ob das Vorschlags-Popup geöffnet ist.

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

Text, der angezeigt wird, während eine weitere Ergebnisseite geladen wird.

Lesen loadingMoreText()Schreiben setLoadingMoreText()Benachrichtigung loadingMoreTextChanged()
QString moreResultsText

Begleittext zur Aktion für eine weitere Ergebnisseite.

Lesen moreResultsText()Schreiben setMoreResultsText()Benachrichtigung moreResultsTextChanged()
QString retryText

Beschriftung der Aktion zum erneuten Versuch nach einer fehlgeschlagenen Anfrage.

Lesen retryText()Schreiben setRetryText()Benachrichtigung retryTextChanged()
QString loadMoreText

Beschriftung der Aktion, die eine weitere Ergebnisseite anfordert.

Lesen loadMoreText()Schreiben setLoadMoreText()Benachrichtigung loadMoreTextChanged()

Signale

void suggestionsChanged()

Im Vorschlags-Popup angezeigte Vorschlagstexte.

void headerChanged()

Optionaler Beschriftungstext über der Eingabezeile.

void queryIconGlyphChanged()

Symbolglyphe für die Abfrage-/Suchfunktion.

void queryIconVisibleChanged()

Ob das Abfragesymbol sichtbar ist.

void queryButtonPlacementChanged()

Platzierung der Abfrage-Aktionsschaltfläche.

void inputHeightChanged()

Bevorzugte Höhe des Eingabefelds.

void queryButtonSizeChanged()

Größe der Abfrageaktions-Schaltfläche.

void suggestionFontRoleChanged()

Fluent-Typography-Voreinstellung für Vorschlagszeilen.

void suggestionItemHeightChanged()

Höhe jeder Vorschlagszeile.

void suggestionListOpenChanged(bool open)

Ob das Vorschlags-Popup geöffnet ist.

void loadingMoreTextChanged()

Text, der angezeigt wird, während eine weitere Ergebnisseite geladen wird.

void moreResultsTextChanged()

Begleittext zur Aktion für eine weitere Ergebnisseite.

void retryTextChanged()

Beschriftung der Aktion zum erneuten Versuch nach einer fehlgeschlagenen Anfrage.

void loadMoreTextChanged()

Beschriftung der Aktion, die eine weitere Ergebnisseite anfordert.

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

Wird zum Anfordern von Vorschlagsdaten gesendet; append ist true, wenn die nächste Seite geladen oder erneut versucht wird.

void suggestionRequestCanceled(quint64 requestId)

Wird gesendet, wenn eine laufende requestId abgebrochen oder durch eine neue Anfrage abgelöst wird.

Geschützte Elemente

Methoden

void setQueryIconDecorative(bool decorative)

Zeigt das Abfragesymbol als nicht-interaktive Dekoration für zusammengesetzte Auswahlfelder an.

Geerbt von fluent::textfields::LineEdit

Methoden

QMargins contentMargins() const

Inhaltsränder um den Text (horizontale Werte schließen den internen Texteinzug von Qt ein).

void setContentMargins(const QMargins& margins)

Inhaltsränder um den Text (horizontale Werte schließen den internen Texteinzug von Qt ein).

Typography::FontRole fontRole() const

Fluent-Typography-Voreinstellung für Text.

void setFontRole(Typography::FontRole role)

Fluent-Typography-Voreinstellung für Text.

bool isClearButtonEnabled() const

Ob die nachgestellte Löschen-Schaltfläche aktiviert ist.

void setClearButtonEnabled(bool enabled)

Ob die nachgestellte Löschen-Schaltfläche aktiviert ist.

int clearButtonSize() const

Größe der Löschen-Schaltfläche, standardmäßig 24 logische Pixel.

void setClearButtonSize(int size)

Größe der Löschen-Schaltfläche, standardmäßig 24 logische Pixel.

QPoint clearButtonOffset() const

Pixelversatz für die Löschen-Schaltfläche.

void setClearButtonOffset(const QPoint& offset)

Pixelversatz für die Löschen-Schaltfläche.

int focusedBorderWidth() const

Untere Rahmenbreite im fokussierten Zustand.

void setFocusedBorderWidth(int width)

Untere Rahmenbreite im fokussierten Zustand.

int unfocusedBorderWidth() const

Untere Rahmenbreite im nicht fokussierten Zustand; standardmäßig null (keine Unterstreichung).

void setUnfocusedBorderWidth(int width)

Untere Rahmenbreite im nicht fokussierten Zustand; standardmäßig null (keine Unterstreichung).

bool isFrameVisible() const

Ob LineEdit seinen Eingaberahmen und die Fokus-Unterstreichung zeichnet.

void setFrameVisible(bool visible)

Ob LineEdit seinen Eingaberahmen und die Fokus-Unterstreichung zeichnet.

void setTrailingText(const QString& text)

Zeigt ein Klartext-Suffix am hinteren Rand an und ersetzt ein vorhandenes nachgestelltes Widget.

bool setTrailingWidget(QWidget* widget, WidgetOwnership ownership)

Setzt ein benutzerdefiniertes nachgestelltes Widget und legt die Bereinigung über WidgetOwnership fest (lehnt sich selbst oder Vorfahren ab). Vor dem Wechsel des Eigentumsmodus takeTrailingWidget() aufrufen.

QWidget* takeTrailingWidget()

Entfernt das nachgestellte Widget und gibt es zur Verwaltung oder Löschung durch den Aufrufer zurück.

void releaseTrailingWidget()

Entfernt das nachgestellte Widget und bereinigt es gemäß seinem WidgetOwnership-Modus.

Eigenschaften

QMargins contentMargins

Inhaltsränder um den Text (horizontale Werte schließen den internen Texteinzug von Qt ein).

Lesen contentMargins()Schreiben setContentMargins()Benachrichtigung contentMarginsChanged()
Typography::FontRole fontRole

Fluent-Typography-Voreinstellung für Text.

Lesen fontRole()Schreiben setFontRole()Benachrichtigung fontRoleChanged()
bool clearButtonEnabled

Ob die nachgestellte Löschen-Schaltfläche aktiviert ist.

Lesen isClearButtonEnabled()Schreiben setClearButtonEnabled()Benachrichtigung clearButtonEnabledChanged()
int clearButtonSize

Größe der Löschen-Schaltfläche, standardmäßig 24 logische Pixel.

Lesen clearButtonSize()Schreiben setClearButtonSize()Benachrichtigung clearButtonSizeChanged()
QPoint clearButtonOffset

Pixelversatz für die Löschen-Schaltfläche.

Lesen clearButtonOffset()Schreiben setClearButtonOffset()Benachrichtigung clearButtonOffsetChanged()
int focusedBorderWidth

Untere Rahmenbreite im fokussierten Zustand.

Lesen focusedBorderWidth()Schreiben setFocusedBorderWidth()Benachrichtigung focusedBorderWidthChanged()
int unfocusedBorderWidth

Untere Rahmenbreite im nicht fokussierten Zustand; standardmäßig null (keine Unterstreichung).

Lesen unfocusedBorderWidth()Schreiben setUnfocusedBorderWidth()Benachrichtigung unfocusedBorderWidthChanged()
bool frameVisible

Ob LineEdit seinen Eingaberahmen und die Fokus-Unterstreichung zeichnet.

Lesen isFrameVisible()Schreiben setFrameVisible()Benachrichtigung frameVisibleChanged()
QString trailingText
Lesen trailingText()Schreiben setTrailingText()Benachrichtigung trailingTextChanged()
QWidget* trailingWidget
Lesen trailingWidget()Benachrichtigung trailingWidgetChanged()
fluent::WidgetOwnership trailingWidgetOwnership
Lesen trailingWidgetOwnership()Benachrichtigung trailingWidgetOwnershipChanged()
QString clearButtonAccessibleName
Lesen clearButtonAccessibleName()Schreiben setClearButtonAccessibleName()Benachrichtigung clearButtonAccessibleNameChanged()
Qt::FocusPolicy clearButtonFocusPolicy
Lesen clearButtonFocusPolicy()Schreiben setClearButtonFocusPolicy()Benachrichtigung clearButtonFocusPolicyChanged()

Signale

void contentMarginsChanged()

Inhaltsränder um den Text (horizontale Werte schließen den internen Texteinzug von Qt ein).

void fontRoleChanged()

Fluent-Typography-Voreinstellung für Text.

void clearButtonEnabledChanged()

Ob die nachgestellte Löschen-Schaltfläche aktiviert ist.

void clearButtonSizeChanged()

Größe der Löschen-Schaltfläche, standardmäßig 24 logische Pixel.

void clearButtonOffsetChanged()

Pixelversatz für die Löschen-Schaltfläche.

void focusedBorderWidthChanged()

Untere Rahmenbreite im fokussierten Zustand.

void unfocusedBorderWidthChanged()

Untere Rahmenbreite im nicht fokussierten Zustand; standardmäßig null (keine Unterstreichung).

void frameVisibleChanged()

Ob LineEdit seinen Eingaberahmen und die Fokus-Unterstreichung zeichnet.

Geerbt von fluent::FluentElement

Enumerationen

enum Theme

Globales visuelles Theme zum Auflösen von Design-Tokens.

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

Methoden

static void setTheme(Theme theme)

Aktualisiert das globale Theme und benachrichtigt aktive FluentElement-Instanzen.

static void setThemeDeferred(Theme theme)

Plant eine gebündelte Theme-Aktualisierung mit Priorität für sichtbare Elemente, ohne die aktuelle Interaktion zu blockieren.

static Theme currentTheme()

Gibt das aktuell aktive globale Design zurück.

static bool themeUsesDarkAppearance(Theme theme)

Gibt zurück, ob ein Theme Chrome und Material-Tokens auf dunklem Hintergrund verwendet.

static void refreshTheme()

Sendet das aktuelle Theme nach einer Änderung von Design-Tokens erneut, um ein Neuzeichnen auszulösen.

static int themeGeneration()

Monotoner Zähler zur Veraltungsprüfung, der bei jedem Designwechsel erhöht wird.

Theme effectiveTheme() const

Löst das von diesem Element verwendete Theme auf und berücksichtigt dabei eine geerbte QWidget-Überschreibung.

bool effectiveThemeUsesDarkAppearance() const

Gibt zurück, ob das effektive Theme dieses Elements Chrome auf dunklem Hintergrund verwendet.

bool setThemeOverrides(const QJsonObject& overrides)

Ersetzt die selektiven Farb-, Radius- und Schrift-Token-Überschreibungen dieses Elements.

QJsonObject themeOverrides() const

Gibt die festgelegten Überschreibungen dieses Elements zurück.

void clearThemeOverrides()

Setzt alle Token-Felder auf die Standardwerte des globalen Designs zurück.

const Colors& themeColorsRef() const

Kopiefreier Zugriff auf das aktive Farbset für kritische Zeichenpfade.

Material::AcrylicToken themeAcrylic() const

Material-, Höhenstufen- und adaptive Layout-Tokens.

QColor themeBackdrop(bool active) const

Backdrop-Farbe des Fenster-Chrome für den angegebenen Aktivierungszustand.

virtual void onThemeUpdated()

Wird nach einer Änderung des globalen Themes aufgerufen.

Typen und Aliase

struct Colors

An Komponenten zurückgegebene Design-Token-Snapshots.

Geerbt von fluent::QMLPlus

Methoden

AnchorLayout::Anchors* anchors()

Gibt veränderbare Anker für den QWidget-Host zurück.

void setState(const QString& name)

Wendet einen registrierten Zustand anhand seines Namens an oder stellt den Standardzustand wieder her, wenn @p name leer ist. Unbekannte Namen werden ignoriert, und bestehende Bindungen werden beim Verlassen des Zustands wieder aufgenommen.

void addState(const QMLState& state)

Registriert oder ersetzt eine benannte Zustandsdefinition; das Ersetzen des aktiven Zustands wendet diesen sofort an.

void evaluateStates()

Wertet Zustandsbedingungen in Registrierungsreihenfolge neu aus und aktiviert den ersten Treffer oder den Standardzustand, wenn keiner zutrifft. Wird auch automatisch bei Benachrichtigungen abhängiger Eigenschaften ausgeführt; abgeleitete Zustände mit extend erben Änderungen der Vorgänger, sofern keine Zyklen vorliegen oder Vorgänger fehlen.

QMLPlusRuntime* runtime()

Gibt den bei Bedarf erstellten Zustandsbeobachter im Besitz dieses Hosts zurück.

void setAnchors(const AnchorLayout::Anchors& anchors)

Ersetzt alle Host-Anker und macht das übergeordnete Layout ungültig.

void resetAnchors()

Löscht alle Host-Anker und invalidiert das übergeordnete Layout.

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

Bindet @p sourceProp von @p source über PropertyBinder::bind() an @p targetProp dieses QWidget-Hosts.

void addTransition(const StateTransition& transition)

Registriert einen Zustandsübergang in Prioritätsreihenfolge.

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

Setzt die Standardanimation, die beim Schreiben von @p propertyName über writeProperty() oder eine Bindung verwendet wird. Explizite StateTransition-Regeln haben Vorrang; direkte C++-Setter-Aufrufe werden nicht animiert.

void clearBehavior(const char* propertyName)

Entfernt die Standardanimation für zukünftige verwaltete Schreibvorgänge.

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

Schreibt eine Host-Eigenschaft über Behavior, ohne deren Bindung zu entfernen.

Qt-Basisklassendokumentation: QLineEdit