Fluent-Qt

ダイアログとポップアップ

TeachingTip ティーチングヒント

操作を妨げることなく機能に注目を集めるアンカー付きのヒントです。

サンプル

TeachingTip ティーチングヒント: 終了理由付きのターゲットヒント

使い方

終了理由付きのターゲットヒント

TeachingTip はターゲットを指し示し、ライトディスミスに対応しており、閉じられた理由を通知します。

#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

継承元 Popup

ターゲットへのアンカー固定、配置オプション、およびオプションのテールを備えたコンテキストティーチングフライアウト。

コンストラクタ

列挙型

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

メソッド

QWidget* target() const

ティーチングチップのアンカー先として使用されるターゲットウィジェットです。

void setTarget(QWidget* target)

ティーチングチップのアンカー先として使用されるターゲットウィジェットです。

PreferredPlacement preferredPlacement() const

ターゲット周囲におけるティーチングヒントの優先配置。

void setPreferredPlacement(PreferredPlacement placement)

ターゲット周囲におけるティーチングヒントの優先配置。

int placementMargin() const

ティーチングティップとターゲットの間に保たれるマージン。

void setPlacementMargin(int margin)

ティーチングティップとターゲットの間に保たれるマージン。

bool isLightDismissEnabled() const

外部での操作によってティーチングチップを閉じるかどうか。

void setLightDismissEnabled(bool enabled)

外部での操作によってティーチングチップを閉じるかどうか。

bool isTailVisible() const

ティーチングチップのテールを描画するかどうか。

void setTailVisible(bool visible)

ティーチングチップのテールを描画するかどうか。

QWidget* contentHost() const

配置位置と cardSize() に応じてジオメトリが自動更新されるコンテンツコンテナ。

void setCardSize(const QSize& size)

影とテールを除いたカードコンテンツのサイズを設定します(デフォルトは 360x200)。

プロパティ

QWidget* target

ティーチングチップのアンカー先として使用されるターゲットウィジェットです。

読み取り target()書き込み setTarget()通知シグナル targetChanged()
PreferredPlacement preferredPlacement

ターゲット周囲におけるティーチングヒントの優先配置。

読み取り preferredPlacement()書き込み setPreferredPlacement()通知シグナル preferredPlacementChanged()
int placementMargin

ティーチングティップとターゲットの間に保たれるマージン。

読み取り placementMargin()書き込み setPlacementMargin()通知シグナル placementMarginChanged()
bool lightDismissEnabled

外部での操作によってティーチングチップを閉じるかどうか。

読み取り isLightDismissEnabled()書き込み setLightDismissEnabled()通知シグナル lightDismissEnabledChanged()
bool tailVisible

ティーチングチップのテールを描画するかどうか。

読み取り isTailVisible()書き込み setTailVisible()通知シグナル tailVisibleChanged()

シグナル

void targetChanged(QWidget* target)

ティーチングチップのアンカー先として使用されるターゲットウィジェットです。

void preferredPlacementChanged(PreferredPlacement placement)

ターゲット周囲におけるティーチングヒントの優先配置。

void placementMarginChanged(int margin)

ティーチングティップとターゲットの間に保たれるマージン。

void lightDismissEnabledChanged(bool enabled)

外部での操作によってティーチングチップを閉じるかどうか。

void tailVisibleChanged(bool visible)

ティーチングチップのテールを描画するかどうか。

protected メンバー

メソッド

fluent::dialogs_flyouts::Popup から継承

列挙型

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

オーバーレイが閉じた理由。値 0–4 はソース互換性のため TeachingTip::CloseReason と一致します。

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

メソッド

bool isOpen() const

要求された展開状態です(アニメーションの進行状況やウィジェットの可視性とは独立しています)。

ClosePolicy closePolicy() const

領域外クリック、Esc キー、またはプログラムによる閉じる動作を制御するポリシー。

void setClosePolicy(ClosePolicy p)

領域外クリック、Esc キー、またはプログラムによる閉じる動作を制御するポリシー。

bool isModal() const

オーバーレイが自身の外側での操作をブロックするかどうか。

void setModal(bool m)

オーバーレイが自身の外側での操作をブロックするかどうか。

bool lightDismissConsumesPress() const

CloseOnPressOutside による閉じる動作で、マウス押下イベントを通過させずに消費するかどうかです(デフォルトは false)。

void addLightDismissPassthrough(QWidget* widget)

所有権を取得せずに、ウィジェットを lightDismissConsumesPress() の対象から除外します。

bool isDim() const

オーバーレイの背後に減光/スクリムレイヤーを表示するかどうかです。

void setDim(bool d)

オーバーレイの背後に減光/スクリムレイヤーを表示するかどうかです。

double dimOpacity() const

[0, 1] の範囲のスクリム不透明度です。-1 でテーマのスモークトークンを使用します。dim が有効な場合にのみ適用されます。

void setDimOpacity(double opacity)

[0, 1] の範囲のスクリム不透明度です。-1 でテーマのスモークトークンを使用します。dim が有効な場合にのみ適用されます。

double backdropBlurRadius() const

キャプチャされた背景のぼかし半径 [0, 32](0 で無効、モーダル時の既定値は 4、それ以外は 0)。

void setBackdropBlurRadius(double radius)

キャプチャされた背景のぼかし半径 [0, 32](0 で無効、モーダル時の既定値は 4、それ以外は 0)。

bool isAnimationEnabled() const

ポップアップの開閉トランジションをアニメーション化するかどうか。

void setAnimationEnabled(bool e)

ポップアップの開閉トランジションをアニメーション化するかどうか。

bool isExitAnimationEnabled() const

close() 時に終了フェードアニメーションを再生するかどうかを制御します(開始アニメーションには影響しません)。

void setThemeSource(QWidget* source)

ポップアップにアンカーがない場合のフォールバックテーマソースとなるウィジェットを設定します。

double popupProgress() const

ポップアップの開閉アニメーションの進行度。

void setPopupProgress(double p)

ポップアップの開閉アニメーションの進行度。

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

ポップアップの左上隅を relativeTo 座標系の localPos に配置します。未設定の場合、open() は中央に表示します。

void setIsOpen(bool open)

要求された展開状態です(アニメーションの進行状況やウィジェットの可視性とは独立しています)。

void refreshBackdrop()

開いているポップアップの背後でアプリケーションコンテンツが変更された後、キャッシュされたバックドロップを更新します。

void closeWithReason(CloseReason reason)

明示的な理由を指定して閉じます。保留中の理由がない場合、close() は Programmatic を使用します。

プロパティ

bool isOpen

要求された展開状態です(アニメーションの進行状況やウィジェットの可視性とは独立しています)。

読み取り isOpen()書き込み setIsOpen()通知シグナル isOpenChanged()
ClosePolicy closePolicy

領域外クリック、Esc キー、またはプログラムによる閉じる動作を制御するポリシー。

読み取り closePolicy()書き込み setClosePolicy()通知シグナル closePolicyChanged()
bool modal

オーバーレイが自身の外側での操作をブロックするかどうか。

読み取り isModal()書き込み setModal()通知シグナル modalChanged()
bool dim

オーバーレイの背後に減光/スクリムレイヤーを表示するかどうかです。

読み取り isDim()書き込み setDim()通知シグナル dimChanged()
double dimOpacity

[0, 1] の範囲のスクリム不透明度です。-1 でテーマのスモークトークンを使用します。dim が有効な場合にのみ適用されます。

読み取り dimOpacity()書き込み setDimOpacity()通知シグナル dimOpacityChanged()
double backdropBlurRadius

キャプチャされた背景のぼかし半径 [0, 32](0 で無効、モーダル時の既定値は 4、それ以外は 0)。

読み取り backdropBlurRadius()書き込み setBackdropBlurRadius()通知シグナル backdropBlurRadiusChanged()
bool animationEnabled

ポップアップの開閉トランジションをアニメーション化するかどうか。

読み取り isAnimationEnabled()書き込み setAnimationEnabled()通知シグナル animationEnabledChanged()
double popupProgress

ポップアップの開閉アニメーションの進行度。

読み取り popupProgress()書き込み setPopupProgress()通知シグナル popupProgressChanged()

シグナル

void isOpenChanged(bool open)

要求された展開状態です(アニメーションの進行状況やウィジェットの可視性とは独立しています)。

void opening()

開くトランジションが開始されました。互換エイリアス:aboutToShow()。

void closing(CloseReason reason)

閉じるトランジションが開始されました。aboutToHide() は引数なしの互換エイリアスです。

void popupProgressChanged(double progress)

ポップアップの開閉アニメーションの進行度。

void closePolicyChanged(ClosePolicy policy)

領域外クリック、Esc キー、またはプログラムによる閉じる動作を制御するポリシー。

void modalChanged(bool modal)

オーバーレイが自身の外側での操作をブロックするかどうか。

void dimChanged(bool dim)

オーバーレイの背後に減光/スクリムレイヤーを表示するかどうかです。

void dimOpacityChanged(double opacity)

[0, 1] の範囲のスクリム不透明度です。-1 でテーマのスモークトークンを使用します。dim が有効な場合にのみ適用されます。

void backdropBlurRadiusChanged(double radius)

キャプチャされた背景のぼかし半径 [0, 32](0 で無効、モーダル時の既定値は 4、それ以外は 0)。

void animationEnabledChanged(bool enabled)

ポップアップの開閉トランジションをアニメーション化するかどうか。

型とエイリアス

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

指定されたアクティブ状態に対するウィンドウ chrome の背景色。

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)

PropertyBinder::bind() を介して、@p source の @p sourceProp をこの QWidget ホストの @p targetProp にバインドします。

void addTransition(const StateTransition& transition)

優先順位順に状態遷移を登録します。

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

writeProperty() またはバインディング経由で @p propertyName が書き込まれた際に使用されるデフォルトアニメーションを設定します。明示的な StateTransition ルールが優先され、C++ のセッターを直接呼び出した場合はアニメーションしません。

void clearBehavior(const char* propertyName)

今後のマネージド書き込みに使用するデフォルトアニメーションを削除します。

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

バインディングを削除せずに Behavior 経由でホストプロパティに書き込みます。

Qt 基底クラスドキュメント:QWidget