CDockingManager クラス

[アーティクル]
08/09/2011

メインフレームウィンドウのドッキングレイアウトを制御するコア機能を実装します。

class CDockingManager : public CObject

メンバー

パブリックメソッド

[名前]	説明
CDockingManager::AddDockSite	ドッキングペインを作成し、それをコントロールバーのリストに追加します。
CDockingManager::AddHiddenMDITabbedBar	バーペインへのハンドルを非表示の MDI タブ付きバーペインのリストに追加します。
CDockingManager::AddMiniFrame	ミニフレームの一覧にフレームを追加します。
CDockingManager::AddPane	ペインをドッキングマネージャーに登録します。
CDockingManager::AdjustDockingLayout	フレームウィンドウ内のすべてのペインのレイアウトを再計算して調整します。
CDockingManager::AdjustPaneFrames	すべてのペインおよび CPaneFrameWnd ウィンドウに WM_NCCALCSIZE メッセージを送信します。
CDockingManager::AdjustRectToClientArea	四角形の配置を調整します。
CDockingManager::AlignAutoHidePane	自動非表示モードのドッキングペインのサイズを、ドッキングサイトで囲まれたフレームのクライアント領域いっぱいの幅または高さになるように変更します。
CDockingManager::AutoHidePane	自動非表示ツールバーを作成します。
CDockingManager::BringBarsToTop	指定された配置を持つドッキングバーを一番上に置きます。
CDockingManager::BuildPanesMenu	ドッキングペインおよびツールバーの名前をメニューに追加します。
CDockingManager::CalcExpectedDockedRect	ドッキングウィンドウの予想される四角形を計算します。
CDockingManager::Create	ドッキングマネージャーを作成します。
CDockingManager::DeterminePaneAndStatus	指定した点とドッキングステータスを含むペインを判断します。
CDockingManager::DisableRestoreDockState	レジストリからのドッキングレイアウトの読み込みを有効または無効にします。
CDockingManager::DockPane	ペインを別のペインまたはフレームウィンドウにドッキングします。
CDockingManager::DockPaneLeftOf	ペインを別のペインの左側にドッキングします。
CDockingManager::HideAutoHidePanes	ペインのメインフレームへのドッキングを有効にし、ドッキングペインを作成し、それをコントロールバーのリストに追加します。
CDockingManager::EnableDocking	ドッキングペインを作成し、メインフレームへのペインのドッキングを有効にします。
CDockingManager::EnableDockSiteMenu	すべてのドッキングペインのキャプションにポップアップメニューを開く、追加のボタンを表示します。
CDockingManager::EnablePaneContextMenu	ユーザーが右マウスボタンをクリックし、ライブラリが WM_CONTEXTMENU メッセージを処理している場合に、ライブラリに対して、アプリケーションのツールバーとドッキングペインがリストされる特別なコンテキストメニューを表示するよう指示します。
CDockingManager::FindDockSite	指定された位置にあり、指定された配置を持つバーペインを取得します。
CDockingManager::FindDockSiteByPane	対象のバーペインの ID を持つバーペインを返します。
CDockingManager::FindPaneByID	指定したコントロール ID でペインを検索します。
CDockingManager::FixupVirtualRects	現在のすべてのツールバーの位置を仮想四角形にコミットします。
CDockingManager::FrameFromPoint	指定した点を含むフレームを返します。
CDockingManager::GetClientAreaBounds	クライアント領域の境界を含む四角形を取得します。
CDockingManager::GetDockingMode	現在のドッキングモードを返します。
CDockingManager::GetDockSiteFrameWnd	親ウィンドウフレームへのポインターを取得します。
CDockingManager::GetEnabledAutoHideAlignment	ペインの有効な配置を返します。
CDockingManager::GetMiniFrames	ミニフレームの一覧を取得します。
CDockingManager::GetOuterEdgeBounds	フレームの外縁を含む四角形を取得します。
CDockingManager::GetPaneList	ドッキングマネージャーに属するペインの一覧を返します。これには、すべての浮動ペインが含まれます。
CDockingManager::GetSmartDockingManager	スマートドッキングマネージャーへのポインターを取得します。
CDockingManager::GetSmartDockingManagerPermanent	スマートドッキングマネージャーへのポインターを取得します。
CDockingManager::GetSmartDockingParams	ドッキングマネージャーのスマートドッキングのパラメーターを返します。
CDockingManager::GetSmartDockingTheme	スマートドッキングマーカーの表示に使用されるテーマを返す静的メソッド。
CDockingManager::HideAutoHidePanes	自動非表示モードのペインを非表示にします。
CDockingManager::InsertDockSite	ドッキングペインを作成し、それをコントロールバーのリストに挿入します。
CDockingManager::InsertPane	コントロールペインをコントロールバーのリストに挿入します。
CDockingManager::IsDockSiteMenu	すべてのペインのキャプションにポップアップメニューが表示されるかどうかを指定します。
CDockingManager::IsInAdjustLayout	すべてのペインのレイアウトが調整されているかどうかを確認します。
CDockingManager::IsOLEContainerMode	ドッキングマネージャーが OLE コンテナーモードであるかどうかを示します。
CDockingManager::IsPointNearDockSite	指定された点がドッキングサイトの近くにあるかどうかを判定します。
CDockingManager::IsPrintPreviewValid	印刷プレビューモードが設定されているかどうかを判定します。
CDockingManager::LoadState	レジストリからドッキングマネージャーの状態を読み込みます。
CDockingManager::LockUpdate	指定されたウィンドウをロックします。
CDockingManager::OnActivateFrame	フレームウィンドウがアクティブまたは非アクティブになるときに、フレームワークによって呼び出されます。
CDockingManager::OnClosePopupMenu	アクティブなポップアップメニューが WM_DESTROY メッセージを処理するときに、フレームワークによって呼び出されます。
CDockingManager::OnMoveMiniFrame	ミニフレームウィンドウを移動するために、フレームワークによって呼び出されます。
CDockingManager::OnPaneContextMenu	ペインのリストを持つメニューをビルドするときに、フレームワークによって呼び出されます。
CDockingManager::PaneFromPoint	指定した点を含むペインを返します。
CDockingManager::ProcessPaneContextMenuCommand	指定されたコマンドのチェックボックスをオンまたはオフにし、表示されるペインのレイアウトを再計算するために、フレームワークによって呼び出されます。
CDockingManager::RecalcLayout	コントロールのリストに掲載されるコントロールの内部レイアウトを再計算します。
CDockingManager::ReleaseEmptyPaneContainers	空のペインコンテナーを解放します。
CDockingManager::RemoveHiddenMDITabbedBar	指定された非表示のバーペインを削除します。
CDockingManager::RemoveMiniFrame	指定したフレームをミニフレームの一覧から削除します。
CDockingManager::RemovePaneFromDockManager	ペインの登録を解除し、ドッキングマネージャーの一覧から削除します。
CDockingManager::ReplacePane	ペインを別のペインに置き換えます。
CDockingManager::ResortMiniFramesForZOrder	ミニフレームの一覧でフレームを再度並べ替えます。
CDockingManager::SaveState	レジストリにドッキングマネージャーの状態を保存します。
CDockingManager::SendMessageToMiniFrames	指定されたメッセージをすべてのミニフレームに送信します。
CDockingManager::Serialize	ドッキングマネージャーをアーカイブに書き込みます (CObject::Serialize をオーバーライドします)。
CDockingManager::SetAutohideZOrder	コントロールバーと指定されたペインのサイズ、幅、および高さを設定します。
CDockingManager::SetDockingMode	ドッキングモードを設定します。
CDockingManager::SetDockState	コントロールバー、ミニフレーム、および自動非表示バーのドッキング状態を設定します。
CDockingManager::SetPrintPreviewMode	印刷プレビューに表示されるバーの印刷プレビューモードを設定します。
CDockingManager::SetSmartDockingParams	スマートドッキングの動作を定義するパラメーターを設定します。
CDockingManager::ShowDelayShowMiniFrames	ミニフレームウィンドウの表示と非表示を切り替えます。
CDockingManager::ShowPanes	コントロールと自動非表示のバーのペインの表示と非表示を切り替えます。
CDockingManager::StartSDocking	スマートドッキングマネージャーの配置に従って指定されたウィンドウのスマートドッキングを開始します。
CDockingManager::StopSDocking	スマートドッキングを停止します。

データメンバー

[名前]	説明
CDockingManager::m_bHideDockingBarsInContainerMode	OLE コンテナーモードの場合にドッキングマネージャーがペインを非表示にするかどうかを指定します。
CDockingManager::m_dockModeGlobal	グローバルドッキングモードを指定します。
CDockingManager::m_nDockSensitivity	ドッキング感度を指定します。
CDockingManager::m_nTimeOutBeforeDockingBarDock	即時ドッキングモードでドッキングペインがドッキングするまでの待機時間をミリ秒単位で指定します。
CDockingManager::m_nTimeOutBeforeToolBarDock	ツールバーがメインフレームウィンドウにドッキングされるまでの時間をミリ秒単位で指定します。

解説

メインフレームウィンドウは、このクラスを自動的に作成および初期化します。

ドッキングマネージャーオブジェクトは、ドッキングレイアウト内にあるすべてのペインのリスト、およびメインフレームウィンドウに属するすべての CPaneFrameWnd ウィンドウのリストも保持します。

CDockingManager クラスは、ペインまたは CPaneFrameWnd ウィンドウを検索するために使用できるサービスを実装します。これらのサービスはメインフレームウィンドウのオブジェクトにラップされるので、通常は直接呼び出しません。詳細については、「CPaneFrameWnd クラス」を参照してください。

カスタマイズのヒント

次のヒントは CDockingManager オブジェクトに適用されます。

CDockingManager クラスは、次のドッキングモードをサポートします。
- AFX_DOCK_TYPE::DT_IMMEDIATE
- AFX_DOCK_TYPE::DT_STANDARD
- AFX_DOCK_TYPE::DT_SMART
これらのドッキングモードは CDockingManager::m_dockModeGlobal により定義され、CDockingManager::SetDockingMode を呼び出すことにより設定されます。
非フローティングのサイズ変更できないペインを作成するには、CDockingManager::AddPane メソッドを呼び出します。このメソッドは、ペインのレイアウトを制御するドッキングマネージャーにペインを登録します。

使用例

CDockingManager クラスのさまざまなメソッドを使用して CDockingManager オブジェクトを構成する方法を次の例に示します。例では、すべてのドッキングペインのキャプションでポップアップメニューを開く追加のボタンを表示する方法、およびオブジェクトのドッキングモードを設定する方法を示しています。このコードスニペットは、「VisualStudioDemo サンプル:MFC Visual Studio アプリケーション」の一部です。

    CDockingManager* pDockManager = GetDockingManager();
    ASSERT_VALID(pDockManager);
    pDockManager->AdjustPaneFrames();
    pDockManager->EnableDockSiteMenu();
    pDockManager->SetDockingMode(DT_STANDARD);