Fluent-Qt

Layout

Field Formularfeld

Fügt jedem Eingabesteuerelement eine Beschriftung, eine Pflichtfeldmarkierung, Hilfetext und Validierungsfeedback hinzu.

Beispiel

Field Formularfeld: Verbindungseinstellungen

Verwendung

Verbindungseinstellungen

Koordinieren Sie Änderungen, asynchrone Validierung und das Speichern mit FormController. Die Demo nutzt eine lokale Simulation; es verlassen keine Zugangsdaten diese Seite.

#include <FluentQt/Layout.h>
using namespace fluent::layout;

#ifndef GALLERY_CONNECTIONFORM_H
#define GALLERY_CONNECTIONFORM_H

#include <FluentQt/FluentQt.h>

#include <QBoxLayout>
#include <QMap>
#include <QResizeEvent>
#include <QTimer>
#include <QUrl>

namespace fluent::gallery {

// A deterministic connection demo: the application owns values and async work.
// zh_CN: 可重复的连接演示;应用负责字段值与异步操作。
class ConnectionForm final : public layout::Card {
public:
    explicit ConnectionForm(QWidget* parent = nullptr) : Card(parent)
    {
        setObjectName(QStringLiteral("connectionForm"));
        setMaximumWidth(560);
        setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Maximum);
        m_layout = new QVBoxLayout(this);
        m_layout->setContentsMargins(32, 32, 32, 32);
        m_layout->setSpacing(24);
        m_layout->setAlignment(Qt::AlignTop);

        auto* heading = new QWidget(this);
        auto* headerLayout = new QVBoxLayout(heading);
        headerLayout->setContentsMargins(0, 0, 0, 0);
        headerLayout->setSpacing(8);
        headerLayout->addWidget(label(QStringLiteral("Connection settings"), Typography::FontRole::Subtitle));
        headerLayout->addWidget(
            label(QStringLiteral("Configure the endpoint used by this workspace."), Typography::FontRole::Body, true));
        m_layout->addWidget(heading);

        m_form = new FormController(this);
        m_form->setObjectName(QStringLiteral("connectionFormController"));
        addField(QStringLiteral("name"), QStringLiteral("Connection name"),
            QStringLiteral("A name to identify this connection."), QStringLiteral("Production API"));
        addField(QStringLiteral("address"), QStringLiteral("Server address"),
            QStringLiteral("Use HTTPS. Try offline.example to see a connection error."),
            QStringLiteral("https://api.example.com/v1"));
        addField(QStringLiteral("token"), QStringLiteral("API token"),
            QStringLiteral("Use any 8 characters in this demo."), QString(), true);

        m_status = label(QStringLiteral("No unsaved changes"), Typography::FontRole::Caption, true);
        m_status->setObjectName(QStringLiteral("connectionStatus"));
        m_status->setMinimumHeight(Typography::LineHeight::Caption);
        m_layout->addWidget(m_status);

        auto* actions = new QWidget(this);
        m_actions = new QBoxLayout(QBoxLayout::LeftToRight, actions);
        m_actions->setContentsMargins(0, 0, 0, 0);
        m_actions->setSpacing(8);
        m_test = new basicinput::Button(QStringLiteral("Test connection"), actions);
        m_test->setObjectName(QStringLiteral("connectionTest"));
        m_save = new basicinput::Button(QStringLiteral("Save connection"), actions);
        m_save->setObjectName(QStringLiteral("connectionSave"));
        m_save->setFluentStyle(basicinput::Button::Accent);
        m_actions->addWidget(m_test);
        m_actions->addWidget(m_save);
        m_layout->addWidget(actions);
        m_layout->addWidget(label(QStringLiteral("Local demo · no credentials are sent or stored."),
            Typography::FontRole::Caption, true));

        connect(m_form, &FormController::validationRequested, this, [this](const QString& key, quint64 token) {
            validate(key, token);
        });
        connect(m_form, &FormController::submitRequested, this, [this](quint64 token) {
            QTimer::singleShot(450, m_form, [form = m_form, token]() { form->completeSubmit(token, true); });
        });
        connect(m_form, &FormController::stateChanged, this, [this]() { updateStatus(); });
        connect(m_form, &FormController::submissionFinished, this, [this](bool success) {
            if (success)
                status_info::Toast::showOrUpdateToast(this, QStringLiteral("gallery.action-feedback"),
                    QStringLiteral("Connection saved for this demo"), status_info::Toast::Success, 2200,
                    status_info::Toast::Top, QMargins(16, 50, 16, 16));
        });
        connect(m_test, &basicinput::Button::clicked, m_form, &FormController::validate);
        connect(m_save, &basicinput::Button::clicked, m_form, &FormController::submit);
    }

protected:
    void resizeEvent(QResizeEvent* event) override
    {
        Card::resizeEvent(event);
        const bool narrow = width() < 400;
        const int padding = narrow ? 16 : 32;
        m_layout->setContentsMargins(padding, padding, padding, padding);
        m_actions->setDirection(narrow ? QBoxLayout::TopToBottom : QBoxLayout::LeftToRight);
    }

private:
    textfields::Label* label(const QString& text, Typography::FontRole role, bool secondary = false)
    {
        auto* result = new textfields::Label(text, this);
        result->setFluentTypography(role);
        result->setTextColorRole(
            secondary ? textfields::Label::TextColorRole::Secondary : textfields::Label::TextColorRole::Primary);
        result->setWordWrap(true);
        return result;
    }

    void
    addField(const QString& key, const QString& title, const QString& helper, const QString& value, bool secret = false)
    {
        auto* field = new layout::Field(this);
        field->setObjectName(QStringLiteral("connectionField_") + key);
        field->setLabelText(title);
        field->setHelperText(helper);
        textfields::LineEdit* editor = secret ? new textfields::PasswordBox : new textfields::LineEdit;
        editor->setObjectName(QStringLiteral("connectionInput_") + key);
        editor->setText(value);
        editor->setMinimumHeight(::Spacing::ControlHeight::Standard);
        if (secret)
            editor->setPlaceholderText(QStringLiteral("Enter a demo token"));
        field->setEditor(editor, WidgetOwnership::Owned);
        m_layout->addWidget(field);
        m_editors.insert(key, editor);
        m_form->addField(key, field);
        connect(editor, &textfields::LineEdit::textChanged, m_form, [form = m_form, key]() {
            form->markFieldChanged(key);
        });
        connect(editor, &textfields::LineEdit::editingFinished, m_form, [form = m_form, key]() {
            form->setFieldTouched(key);
        });
    }

    void validate(const QString& key, quint64 token)
    {
        const QString value = m_editors.value(key)->text().trimmed();
        if (key == QStringLiteral("name")) {
            m_form->completeValidation(key, token, !value.isEmpty(),
                value.isEmpty() ? QStringLiteral("Enter a connection name.") : QString());
        } else if (key == QStringLiteral("token")) {
            m_form->completeValidation(key, token, value.size() >= 8,
                value.size() < 8 ? QStringLiteral("Enter at least 8 characters.") : QString());
        } else {
            const QUrl url(value, QUrl::StrictMode);
            if (!url.isValid() || url.scheme() != QStringLiteral("https") || url.host().isEmpty()) {
                m_form->completeValidation(key, token, false, QStringLiteral("Enter a valid HTTPS address."));
                return;
            }
            // Context-owned timer is cancelled on teardown; the token rejects stale results.
            // zh_CN: 上下文计时器随对象销毁取消,token 拒绝过期结果。
            QTimer::singleShot(650, m_form, [form = m_form, key, token, value]() {
                const bool reachable = !value.contains(QStringLiteral("offline"), Qt::CaseInsensitive);
                form->completeValidation(key, token, reachable,
                    reachable ? QStringLiteral("Connection verified.")
                              : QStringLiteral("Server unavailable. Try another address."));
            });
        }
    }

    void updateStatus()
    {
        const bool busy = m_form->isValidating() || m_form->isSubmitting();
        m_test->setEnabled(!busy);
        m_save->setEnabled(!busy);
        m_save->setText(m_form->isSubmitting() ? QStringLiteral("Saving…") : QStringLiteral("Save connection"));
        if (m_form->isValidating())
            m_status->setText(QStringLiteral("Checking connection…"));
        else if (m_form->isSubmitting())
            m_status->setText(QStringLiteral("Saving connection…"));
        else if (!m_form->errorMessages().isEmpty())
            m_status->setText(m_form->errorMessages().join(QLatin1Char('\n')));
        else if (!m_form->submissionError().isEmpty())
            m_status->setText(m_form->submissionError());
        else if (m_form->isValid())
            m_status->setText(m_form->isDirty()
                    ? QStringLiteral("Ready to save · unsaved changes")
                    : QStringLiteral("Connection verified."));
        else
            m_status->setText(
                m_form->isDirty() ? QStringLiteral("Unsaved changes") : QStringLiteral("No unsaved changes"));
    }

    FormController* m_form = nullptr;
    QMap<QString, textfields::LineEdit*> m_editors;
    QVBoxLayout* m_layout = nullptr;
    QBoxLayout* m_actions = nullptr;
    textfields::Label* m_status = nullptr;
    basicinput::Button* m_test = nullptr;
    basicinput::Button* m_save = nullptr;
};

} // namespace fluent::gallery

#endif // GALLERY_CONNECTIONFORM_H

fluent::layout::Field

Erbt von QWidget · FluentElement · QMLPlus

Formularfeld-Wrapper, der einem Editor eine Beschriftung, eine Pflichtfeldmarkierung, einen Hilfetext und einen Validierungsstatus hinzufügt.

Konstruktoren

Destruktoren

Enumerationen

enum class LabelPosition

Platziert die Beschriftung über oder neben dem Editor.

  • Top
  • Leading
enum class ValidationState

Visueller Status der Validierungsmeldung (nur zur Anzeige; die Validierungslogik verbleibt in der Anwendung).

  • None
  • Error
  • Warning
  • Success
  • Validating

Methoden

int labelWidth() const

Gemeinsame Beschriftungsbreite im Modus Leading; lange Beschriftungen werden umgebrochen.

void setLabelWidth(int width)

Gemeinsame Beschriftungsbreite im Modus Leading; lange Beschriftungen werden umgebrochen.

Eigenschaften

QString labelText
Lesen labelText()Schreiben setLabelText()Benachrichtigung labelTextChanged()
LabelPosition labelPosition
Lesen labelPosition()Schreiben setLabelPosition()Benachrichtigung labelPositionChanged()
int labelWidth

Gemeinsame Beschriftungsbreite im Modus Leading; lange Beschriftungen werden umgebrochen.

Lesen labelWidth()Schreiben setLabelWidth()Benachrichtigung labelWidthChanged()
bool required
Lesen isRequired()Schreiben setRequired()Benachrichtigung requiredChanged()
QString helperText
Lesen helperText()Schreiben setHelperText()Benachrichtigung helperTextChanged()
QString validationMessage
Lesen validationMessage()Schreiben setValidationMessage()Benachrichtigung validationMessageChanged()
ValidationState validationState
Lesen validationState()Schreiben setValidationState()Benachrichtigung validationStateChanged()
QWidget* editor
Lesen editor()Schreiben setEditor()Benachrichtigung editorChanged()

Signale

void labelWidthChanged(int width)

Gemeinsame Beschriftungsbreite im Modus Leading; lange Beschriftungen werden umgebrochen.

PySide6-Erweiterungen

setOwnedEditor(widget)

Setzt einen Editor, der beim Entfernen aus dem Field gelöscht wird.

setBorrowedEditor(widget)

Setzt einen geliehenen Editor, der bei der Freigabe kein Elternwidget mehr hat.

setReparentedEditor(widget)

Setzt einen Editor, der bei der Freigabe zu seinem bisherigen übergeordneten QWidget zurückkehrt.

Geschützte Elemente

Methoden

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: QWidget