CDockablePane::GetDockingStatus

[アーティクル]
09/17/2008

更新 : 2007 年 11 月

指定されたポインタ位置に基づいてドッキングされるペインの機能を判断します。

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 Word 2007 のドッキング動作をエミュレートします。

ドッキングが遅延状態の場合 (CS_DELAY_DOCK および CS_DELAY_DOCK_TO_TAB)、フレームワークはユーザーがマウスボタンを離すまでドッキングを実行しません。ペインが DT_STANDARD ドッキングモードを使用している場合、フレームワークは予定されているドッキング場所に四角形を表示します。ペインが DT_SMART ドッキングモードを使用している場合、フレームワークは予定されているドッキング場所にスマートドッキングマーカーと半透明の四角形を表示します。ペインのドッキングモードを指定するには、CBasePane::SetDockingMode メソッドを呼び出します。スマートドッキングの詳細については、「CDockingManager::GetSmartDockingParams」を参照してください。