Fluent-Qt

Dialoge & Flyouts

TeachingTip Hinweistipp

Ein verankerter Hinweis, der auf eine Funktion aufmerksam macht, ohne die Interaktion zu blockieren.

Beispiel

TeachingTip Hinweistipp: Zielgerichteter Hinweis mit Schließgründen

Verwendung

Zielgerichteter Hinweis mit Schließgründen

TeachingTip zeigt auf ein Ziel, lässt sich durch Klick außerhalb schließen und meldet, wie er geschlossen wurde.

#include <FluentQt/DialogsFlyouts.h>
using namespace fluent::dialogs_flyouts;

auto* tip = new TeachingTip(window());
tip->setPreferredPlacement(TeachingTip::Right);
tip->setLightDismissEnabled(true);
tip->setCardSize(QSize(320, 154));
connect(tip, &TeachingTip::closing, status,
        [status](TeachingTip::CloseReason reason) { updateStatus(reason); });
tip->showAt(targetButton);

fluent::dialogs_flyouts::TeachingTip

Erbt von Popup

Kontextbezogenes Lern-Flyout mit Zielverankerung, Platzierungsoptionen und optionaler Spitze.

Konstruktoren

Enumerationen

enum PreferredPlacement
  • Auto
  • Top
  • TopLeft
  • TopRight
  • Bottom
  • BottomLeft
  • BottomRight
  • Left
  • LeftTop
  • LeftBottom
  • Right
  • RightTop
  • RightBottom
enum CloseReason
  • Programmatic = Popup::Programmatic
  • ActionButton = Popup::ActionButton
  • CloseButton = Popup::CloseButton
  • LightDismiss = Popup::LightDismiss
  • TargetDestroyed = Popup::TargetDestroyed

Methoden

QWidget* target() const

Ziel-Widget für die Verankerung des Teaching-Tips.

void setTarget(QWidget* target)

Ziel-Widget für die Verankerung des Teaching-Tips.

PreferredPlacement preferredPlacement() const

Bevorzugte Platzierung des Teaching-Tips um das Ziel.

void setPreferredPlacement(PreferredPlacement placement)

Bevorzugte Platzierung des Teaching-Tips um das Ziel.

int placementMargin() const

Abstand zwischen Teaching-Tip und Ziel.

void setPlacementMargin(int margin)

Abstand zwischen Teaching-Tip und Ziel.

bool isLightDismissEnabled() const

Ob eine Interaktion außerhalb den Lerntipp schließt.

void setLightDismissEnabled(bool enabled)

Ob eine Interaktion außerhalb den Lerntipp schließt.

bool isTailVisible() const

Ob die Spitze des Lerntipps gezeichnet wird.

void setTailVisible(bool visible)

Ob die Spitze des Lerntipps gezeichnet wird.

QWidget* contentHost() const

Inhaltscontainer, dessen Geometrie automatisch mit der Platzierung und cardSize() aktualisiert wird.

void setCardSize(const QSize& size)

Setzt die Inhaltsgröße der Karte ohne Schatten und Spitze (Standard: 360x200).

Eigenschaften

QWidget* target

Ziel-Widget für die Verankerung des Teaching-Tips.

Lesen target()Schreiben setTarget()Benachrichtigung targetChanged()
PreferredPlacement preferredPlacement

Bevorzugte Platzierung des Teaching-Tips um das Ziel.

Lesen preferredPlacement()Schreiben setPreferredPlacement()Benachrichtigung preferredPlacementChanged()
int placementMargin

Abstand zwischen Teaching-Tip und Ziel.

Lesen placementMargin()Schreiben setPlacementMargin()Benachrichtigung placementMarginChanged()
bool lightDismissEnabled

Ob eine Interaktion außerhalb den Lerntipp schließt.

Lesen isLightDismissEnabled()Schreiben setLightDismissEnabled()Benachrichtigung lightDismissEnabledChanged()
bool tailVisible

Ob die Spitze des Lerntipps gezeichnet wird.

Lesen isTailVisible()Schreiben setTailVisible()Benachrichtigung tailVisibleChanged()

Signale

void targetChanged(QWidget* target)

Ziel-Widget für die Verankerung des Teaching-Tips.

void preferredPlacementChanged(PreferredPlacement placement)

Bevorzugte Platzierung des Teaching-Tips um das Ziel.

void placementMarginChanged(int margin)

Abstand zwischen Teaching-Tip und Ziel.

void lightDismissEnabledChanged(bool enabled)

Ob eine Interaktion außerhalb den Lerntipp schließt.

void tailVisibleChanged(bool visible)

Ob die Spitze des Lerntipps gezeichnet wird.

Geschützte Elemente

Methoden

Geerbt von fluent::dialogs_flyouts::Popup

Enumerationen

enum CloseFlag
  • NoAutoClose = 0
  • CloseOnPressOutside = 1 << 0
  • CloseOnEscape = 1 << 1
enum CloseReason

Grund für das Schließen eines Overlays. Die Werte 0–4 entsprechen zur Quellkompatibilität TeachingTip::CloseReason.

  • Programmatic = 0
  • ActionButton = 1
  • CloseButton = 2
  • LightDismiss = 3
  • TargetDestroyed = 4
  • Escape = 5

Methoden

bool isOpen() const

Angeforderter Öffnungszustand (unabhängig vom Animationsfortschritt oder der Widget-Sichtbarkeit).

ClosePolicy closePolicy() const

Richtlinie zur Steuerung des Schließverhaltens bei Klicks außerhalb, Esc oder programmatischem Schließen.

void setClosePolicy(ClosePolicy p)

Richtlinie zur Steuerung des Schließverhaltens bei Klicks außerhalb, Esc oder programmatischem Schließen.

bool isModal() const

Ob das Overlay Interaktionen außerhalb blockiert.

void setModal(bool m)

Ob das Overlay Interaktionen außerhalb blockiert.

bool lightDismissConsumesPress() const

Ob ein Schließen per CloseOnPressOutside den Mausklick abfängt, anstatt ihn durchzuleiten (Standard: false).

void addLightDismissPassthrough(QWidget* widget)

Nimmt ein Widget von lightDismissConsumesPress() aus, ohne den Besitz zu übernehmen.

bool isDim() const

Ob eine abgedunkelte Ebene hinter dem Overlay angezeigt wird.

void setDim(bool d)

Ob eine abgedunkelte Ebene hinter dem Overlay angezeigt wird.

double dimOpacity() const

Scrim-Deckkraft in [0, 1]; -1 verwendet das Smoke-Token des Themes. Gilt nur, wenn dim aktiviert ist.

void setDimOpacity(double opacity)

Scrim-Deckkraft in [0, 1]; -1 verwendet das Smoke-Token des Themes. Gilt nur, wenn dim aktiviert ist.

double backdropBlurRadius() const

Unschärferadius [0, 32] für den erfassten Hintergrund (0 deaktiviert; standardmäßig 4 im modalen Zustand, sonst 0).

void setBackdropBlurRadius(double radius)

Unschärferadius [0, 32] für den erfassten Hintergrund (0 deaktiviert; standardmäßig 4 im modalen Zustand, sonst 0).

bool isAnimationEnabled() const

Ob Öffnungs- und Schließübergänge des Popups animiert werden.

void setAnimationEnabled(bool e)

Ob Öffnungs- und Schließübergänge des Popups animiert werden.

bool isExitAnimationEnabled() const

Steuert, ob close() die Ausblendanimation abspielt (die Öffnungsanimation bleibt unberührt).

void setThemeSource(QWidget* source)

Setzt ein Widget als Fallback-Theme-Quelle, wenn das Popup keinen Anker hat.

double popupProgress() const

Fortschritt der Öffnungs-/Schließanimation des Popups.

void setPopupProgress(double p)

Fortschritt der Öffnungs-/Schließanimation des Popups.

void setPosition(QWidget* relativeTo, const QPoint& localPos)

Platziert die obere linke Ecke des Popups an localPos in den Koordinaten von relativeTo; ohne Angabe zentriert open().

void setIsOpen(bool open)

Angeforderter Öffnungszustand (unabhängig vom Animationsfortschritt oder der Widget-Sichtbarkeit).

void refreshBackdrop()

Aktualisiert den zwischengespeicherten Hintergrund, nachdem sich der Anwendungsinhalt hinter einem geöffneten Popup geändert hat.

void closeWithReason(CloseReason reason)

Schließt mit einem expliziten Grund; close() verwendet Programmatic, sofern kein Grund aussteht.

Eigenschaften

bool isOpen

Angeforderter Öffnungszustand (unabhängig vom Animationsfortschritt oder der Widget-Sichtbarkeit).

Lesen isOpen()Schreiben setIsOpen()Benachrichtigung isOpenChanged()
ClosePolicy closePolicy

Richtlinie zur Steuerung des Schließverhaltens bei Klicks außerhalb, Esc oder programmatischem Schließen.

Lesen closePolicy()Schreiben setClosePolicy()Benachrichtigung closePolicyChanged()
bool modal

Ob das Overlay Interaktionen außerhalb blockiert.

Lesen isModal()Schreiben setModal()Benachrichtigung modalChanged()
bool dim

Ob eine abgedunkelte Ebene hinter dem Overlay angezeigt wird.

Lesen isDim()Schreiben setDim()Benachrichtigung dimChanged()
double dimOpacity

Scrim-Deckkraft in [0, 1]; -1 verwendet das Smoke-Token des Themes. Gilt nur, wenn dim aktiviert ist.

Lesen dimOpacity()Schreiben setDimOpacity()Benachrichtigung dimOpacityChanged()
double backdropBlurRadius

Unschärferadius [0, 32] für den erfassten Hintergrund (0 deaktiviert; standardmäßig 4 im modalen Zustand, sonst 0).

Lesen backdropBlurRadius()Schreiben setBackdropBlurRadius()Benachrichtigung backdropBlurRadiusChanged()
bool animationEnabled

Ob Öffnungs- und Schließübergänge des Popups animiert werden.

Lesen isAnimationEnabled()Schreiben setAnimationEnabled()Benachrichtigung animationEnabledChanged()
double popupProgress

Fortschritt der Öffnungs-/Schließanimation des Popups.

Lesen popupProgress()Schreiben setPopupProgress()Benachrichtigung popupProgressChanged()

Signale

void isOpenChanged(bool open)

Angeforderter Öffnungszustand (unabhängig vom Animationsfortschritt oder der Widget-Sichtbarkeit).

void opening()

Öffnungsübergang gestartet. Kompatibilitätsalias: aboutToShow().

void closing(CloseReason reason)

Schließübergang gestartet. aboutToHide() ist der parameterlose Kompatibilitätsalias.

void popupProgressChanged(double progress)

Fortschritt der Öffnungs-/Schließanimation des Popups.

void closePolicyChanged(ClosePolicy policy)

Richtlinie zur Steuerung des Schließverhaltens bei Klicks außerhalb, Esc oder programmatischem Schließen.

void modalChanged(bool modal)

Ob das Overlay Interaktionen außerhalb blockiert.

void dimChanged(bool dim)

Ob eine abgedunkelte Ebene hinter dem Overlay angezeigt wird.

void dimOpacityChanged(double opacity)

Scrim-Deckkraft in [0, 1]; -1 verwendet das Smoke-Token des Themes. Gilt nur, wenn dim aktiviert ist.

void backdropBlurRadiusChanged(double radius)

Unschärferadius [0, 32] für den erfassten Hintergrund (0 deaktiviert; standardmäßig 4 im modalen Zustand, sonst 0).

void animationEnabledChanged(bool enabled)

Ob Öffnungs- und Schließübergänge des Popups animiert werden.

Typen und Aliase

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