CDockablePane::GetDockingStatus
指定されたポインター位置に基づいてドッキングされるペインの機能を判断します。
virtual AFX_CS_STATUS GetDockingStatus(
CPoint pt,
int nSensitivity
);
パラメーター
[入力] pt
ポインターの画面座標での位置。[入力] nSensitivity
ドッキングを有効にするためにポインターが存在する必要がある四角形の端からの距離 (ピクセル単位)。
戻り値
次のいずれかの状態値を使用します。
AFX_CS_STATUS の値 |
説明 |
|---|---|
CS_NOTHING |
ポインターはドッキング サイト上にありません。 フレームワークはそのペインをドッキングしません。 |
CS_DOCK_IMMEDIATELY |
ポインターはイミディエイト モード (ペインが DT_IMMEDIATE ドッキング モードを使用している) のドッキング サイトの上にあります。 フレームワークはペインを直ちにドッキングします。 |
CS_DELAY_DOCK |
ポインターは別のドッキング ペイン上、またはメイン フレームの境界上にあります。 フレームワークはある程度時間を置いてからペインをドッキングします。 この遅延の詳細については、「解説」セクションを参照してください。 |
CS_DELAY_DOCK_TO_TAB |
ポインターはドッキング サイト上にありますが、それによってペインはタブ付きウィンドウにドッキングされることになります。 これは、ポインターが別のドッキング ペインのキャプション上にあるか、タブ付きペインのタブ領域上にあるときに発生します。 |
解説
フレームワークは、このメソッドを呼び出して、フローティング ペインのドッキングを処理します。
DT_IMMEDIATE ドッキング モードを使用するフローティング ツール バーまたはドッキング ペインに対して、フレームワークはある程度時間を置いてからドッキング コマンドを処理し、ドッキングが実行される前にユーザーがウィンドウを親フレームのクライアント領域から移動できるようにします。 遅延時間の長さはミリ秒単位で、CDockingManager::m_nTimeOutBeforeToolBarDock データ メンバーによって制御されます。 CDockingManager::m_nTimeOutBeforeToolBarDock の既定値は 200 です。 この動作は、Microsoft Word2007 のドッキング動作をエミュレートします。
ドッキングが遅延状態の場合 (CS_DELAY_DOCK および CS_DELAY_DOCK_TO_TAB)、フレームワークはユーザーがマウス ボタンを離すまでドッキングを実行しません。 ペインが DT_STANDARD ドッキング モードを使用している場合、フレームワークは予定されているドッキング場所に四角形を表示します。 ペインが DT_SMART ドッキング モードを使用している場合、フレームワークは予定されているドッキング場所にスマート ドッキング マーカーと半透明の四角形を表示します。 ペインのドッキング モードを指定するには、CBasePane::SetDockingMode メソッドを呼び出します。 スマート ドッキングの詳細については、「CDockingManager::GetSmartDockingParams」を参照してください。
必要条件
**ヘッダー:**afxdockablepane.h