CDockingManager クラス
メイン フレーム ウィンドウのドッキング レイアウトを制御するコア機能を実装します。
構文
class CDockingManager : public CObject
メンバー
パブリック メソッド
| 名前 | 説明 |
|---|---|
| CDockingManager::AddDockSite | ドッキング ペインを作成し、コントロール バーの一覧に追加します。 |
| CDockingManager::AddHiddenMDITabbedBar | バー ペインへのハンドルを、非表示の MDI タブ付きバー ペインの一覧に追加します。 |
| CDockingManager::AddMiniFrame | フレームをミニ フレームの一覧に追加します。 |
| CDockingManager::AddPane | ペインをドッキング マネージャーに登録します。 |
| CDockingManager::AdjustDockingLayout | フレーム ウィンドウ内のすべてのペインのレイアウトを再計算して調整します。 |
| CDockingManager::AdjustPaneFrames | WM_NCCALCSIZE メッセージがすべてのペインと CPaneFrameWnd ウィンドウに送信されます。 |
| CDockingManager::AdjustRectToClientArea | 四角形の配置を調整します。 |
| CDockingManager::AlignAutoHidePane | ドッキング サイトで囲まれたフレームのクライアント領域の全幅または高さを取得するように、自動非表示モードでドッキング ウィンドウのサイズを変更します。 |
| CDockingManager::AutoHidePane | 自動的に隠すツール バーを作成します。 |
| CDockingManager::BringBarsToTop | 指定された配置のドッキング バーを上に移動します。 |
| CDockingManager::BuildPanesMenu | ドッキング ペインとツール バーの名前をメニューに追加します。 |
| CDockingManager::CalcExpectedDockedRect | ドッキング ウィンドウの想定される四角形を計算します。 |
| CDockingManager::Create | ドッキング マネージャーを作成します。 |
| CDockingManager::DeterminePaneAndStatus | 指定されたポイントとそのドッキング状態を含むペインを決定します。 |
| CDockingManager::DisableRestoreDockState | レジストリからのドッキング レイアウトの読み込みを有効または無効にします。 |
| CDockingManager::DockPane | ペインを別のペインまたはフレーム ウィンドウにドッキングします。 |
| CDockingManager::DockPaneLeftOf | ペインを別のペインの左側にドッキングします。 |
| CDockingManager::EnableAutoHidePanes | メイン フレームへのペインのドッキングを有効にして、ドッキング ペインを作成し、コントロール バーの一覧に追加します。 |
| 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_IMMEDIATEAFX_DOCK_TYPE::DT_STANDARDAFX_DOCK_TYPE::DT_SMART
これらのドッキング モードは、CDockingManager::m_dockModeGlobal によって定義され、CDockingManager::SetDockingMode を呼び出すことによって設定されます。
非フローティングで、サイズ変更できないペインを作成する場合は、CDockingManager::AddPane メソッドを呼び出します。 このメソッドを呼び出すと、ペインが、ペインのレイアウトを担当するドッキング マネージャーに登録されます。
例
次の例は、CDockingManager オブジェクトを構成するための CDockingManager クラスのさまざまなメソッドの使用方法を示しています。 この例は、すべてのドッキング ペインのキャプションにポップアップ メニューを開く追加ボタンを表示する方法と、オブジェクトのドッキング モードを設定する方法を示しています。 このコード スニペットは、Visual Studio デモ サンプルの一部です。
CDockingManager *pDockManager = GetDockingManager();
ASSERT_VALID(pDockManager);
pDockManager->AdjustPaneFrames();
pDockManager->EnableDockSiteMenu();
pDockManager->SetDockingMode(DT_STANDARD);
継承階層
必要条件
ヘッダー: afxDockingManager.h
CDockingManager::AddDockSite
ドッキング ペインを作成し、コントロール バーの一覧に追加します。
BOOL AddDockSite(
const AFX_DOCKSITE_INFO& info,
CDockSite** ppDockBar = NULL);
パラメーター
info
[入力] ドッキング ペインの配置を含む情報構造体への参照。
ppDockBar
[出力] 新しいドッキング ペインへのポインターを指すポインター。
戻り値
ドッキング ペインが正常に作成された場合は TRUE、それ以外の場合は FALSE。
CDockingManager::AddHiddenMDITabbedBar
バー ペインへのハンドルを、非表示の MDI タブ付きバー ペインの一覧に追加します。
void AddHiddenMDITabbedBar(CDockablePane* pBar);
パラメーター
pBar
[入力] バー ペインへのポインター
CDockingManager::AddPane
ペインをドッキング マネージャーに登録します。
BOOL AddPane(
CBasePane* pWnd,
BOOL bTail = TRUE,
BOOL bAutoHide = FALSE,
BOOL bInsertForOuterEdge = FALSE);
パラメーター
pWnd
[入力、出力] ドッキング マネージャーに追加するペインを指定します。
bTail
[入力] ドッキング マネージャーのペインの一覧の末尾にペインを追加する場合は、TRUE。それ以外の場合は、FALSE。
bAutoHide
[入力] 内部使用のみ。 常に既定値 FALSE を使用します。
bInsertForOuterEdge
[入力] 内部使用のみ。 常に既定値 FALSE を使用します。
戻り値
ペインがドッキング マネージャーに正常に登録された場合は TRUE、それ以外の場合は FALSE。
解説
このメソッドを呼び出して、非フローティングで、サイズ変更できないペインをドッキング マネージャーに登録します。 ペインを登録しない場合、ドッキング マネージャーがレイアウトされてもペインは表示されません。
CDockingManager::AdjustDockingLayout
フレーム ウィンドウ内のすべてのペインのレイアウトを再計算して調整します。
virtual void AdjustDockingLayout(HDWP hdwp = NULL);
パラメーター
hdwp
[入力] 遅延ウィンドウ位置構造体を指定します。 詳細については、「 Windows のデータ型」を参照してください。
解説
CDockingManager::AddMiniFrame
フレームをミニ フレームの一覧に追加します。
virtual BOOL AddMiniFrame(CPaneFrameWnd* pWnd);
パラメーター
pWnd
[入力] フレームへのポインター。
戻り値
フレームがミニ フレームの一覧に含まれておらず、正常に追加された場合は TRUE、それ以外の場合は FALSE。
CDockingManager::AdjustPaneFrames
WM_NCCALCSIZE メッセージがすべてのペインと CPaneFrameWnd ウィンドウに送信されます。
virtual void AdjustPaneFrames();
解説
CDockingManager::AdjustRectToClientArea
四角形の配置を調整します。
virtual BOOL AdjustRectToClientArea(
CRect& rectResult,
DWORD dwAlignment);
パラメーター
rectResult
[入力] CRect オブジェクトへの参照
dwAlignment
[入力] CRect オブジェクトの配置
戻り値
CRect オブジェクトの配置が調整された場合は TRUE、それ以外の場合は FALSE。
解説
dwAlignment パラメーターには、次のいずれかの値を指定できます。
CBRS_ALIGN_TOP
CBRS_ALIGN_BOTTOM
CBRS_ALIGN_LEFT
CBRS_ALIGN_RIGHT
CDockingManager::AlignAutoHidePane
ドッキング サイトで囲まれたフレームのクライアント領域の全幅または高さを取得するように、自動非表示モードでドッキング ウィンドウのサイズを変更します。
void AlignAutoHidePane(
CPaneDivider* pDefaultSlider,
BOOL bIsVisible = TRUE);
パラメーター
pDefaultSlider
[入力] ドッキング スライダー ペイン。
bIsVisible
[入力] ドッキング ペインが表示されている場合は TRUE、それ以外の場合は FALSE。
CDockingManager::AutoHidePane
自動的に隠すツール バーを作成します。
CMFCAutoHideToolBar* AutoHidePane(
CDockablePane* pBar,
CMFCAutoHideToolBar* pCurrAutoHideToolBar = NULL);
パラメーター
pBar
[入力] バー ペインへのポインター。
pCurrAutoHideToolBar
[入力] 自動的に隠すツール バーへのポインター。
戻り値
自動的に隠すツール バーが作成されなかった場合は NULL、それ以外の場合は新しいツール バーへのポインター。
CDockingManager::BringBarsToTop
指定された配置のドッキング バーを上に移動します。
void BringBarsToTop(
DWORD dwAlignment = 0,
BOOL bExcludeDockedBars = TRUE);
パラメーター
dwAlignment
[入力] 他のウィンドウの上部に移動するドッキング バーの配置。
bExcludeDockedBars
[入力] ドッキング バーを上部から除外する場合は TRUE、それ以外の場合は FALSE。
CDockingManager::BuildPanesMenu
ドッキング ペインとツール バーの名前をメニューに追加します。
void BuildPanesMenu(
CMenu& menu,
BOOL bToolbarsOnly);
パラメーター
メニュー
[入力] ドッキング ペインとツール バーの名前を追加するメニュー。
bToolbarsOnly
[入力] ツール バーの名前のみをメニューに追加する場合は TRUE、それ以外の場合は FALSE。
CDockingManager::CalcExpectedDockedRect
ドッキング ウィンドウの想定される四角形を計算します。
void CalcExpectedDockedRect(
CWnd* pWnd,
CPoint ptMouse,
CRect& rectResult,
BOOL& bDrawTab,
CDockablePane** ppTargetBar);
パラメーター
pWnd
[入力] ドッキングするウィンドウへのポインター。
ptMouse
[入力] マウスの位置。
rectResult
[出力] 計算される四角形。
bDrawTab
[入力] タブを描画する場合は TRUE、それ以外の場合は FALSE。
ppTargetBar
[出力] ターゲット ペインへのポインターを指すポインター。
解説
このメソッドでは、ユーザーがウィンドウを、ptMouse で指定されたポイントにドラッグし、そこにドッキングした場合にウィンドウが占有する四角形を計算します。
CDockingManager::Create
ドッキング マネージャーを作成します。
BOOL Create(CFrameWnd* pParentWnd);
パラメーター
pParentWnd
[入力] ドッキング マネージャーの親フレームへのポインター。 この値を NULL にすることはできません。
戻り値
常に TRUE。
CDockingManager::DeterminePaneAndStatus
指定されたポイントとそのドッキング状態を含むペインを決定します。
virtual AFX_CS_STATUS DeterminePaneAndStatus(
CPoint pt,
int nSensitivity,
DWORD dwEnabledAlignment,
CBasePane** ppTargetBar,
const CBasePane* pBarToIgnore,
const CBasePane* pBarToDock);
パラメーター
pt
[入力] 確認するペインの位置。
nSensitivity
[入力] 確認された各ペインのウィンドウの四角形を増やす値。 特定のポイントがこの増加領域内にある場合、ペインは検索条件を満たします。
dwEnabledAlignment
[入力] ドッキング ペインの配置。
ppTargetBar
[出力] ターゲット ペインへのポインターを指すポインター。
pBarToIgnore
[入力] メソッドで無視されるペイン。
pBarToDock
[入力] ドッキングされるペイン。
戻り値
ドッキングの状態。
解説
ドッキングの状態には、次のいずれかの値を指定できます。
| AFX_CS_STATUS 値 | 意味 |
|---|---|
| CS_NOTHING | ポインターは、ドッキング サイト上にありません。 このため、ペインはフローティング状態のままです。 |
| CS_DOCK_IMMEDIATELY | ポインターは即時モード (DT_IMMEDIATE スタイルが有効) のドッキング サイト上にあるため、ペインを即座にドッキングする必要があります。 |
| CS_DELAY_DOCK | ポインターは、別のドッキング ペインであるか、メイン フレームのエッジであるドッキング サイト上にあります。 |
| CS_DELAY_DOCK_TO_TAB | ポインターがドッキング サイト上にあるため、ペインはタブ付きウィンドウにドッキングされます。 これは、マウスが別のドッキング ペインのキャプション上、またはタブ付きペインのタブ領域上にある場合に発生します。 |
CDockingManager::DisableRestoreDockState
レジストリからのドッキング レイアウトの読み込みを有効または無効にします。
void DisableRestoreDockState(BOOL bDisable = TRUE);
パラメーター
bDisable
[入力] レジストリからのドッキング レイアウトの読み込みを無効にする場合は TRUE、それ以外の場合は FALSE。
解説
アプリケーションの状態が読み込まれているときにドッキング ペインとツール バーの現在のレイアウトを保持する必要がある場合は、このメソッドを呼び出します。
CDockingManager::DockPane
ペインを別のペインまたはフレーム ウィンドウにドッキングします。
void DockPane(
CBasePane* pBar,
UINT nDockBarID = 0,
LPCRECT lpRect = NULL);
パラメーター
pBar
[入力] ドッキング先のバー ペインへのポインター。
nDockBarID
[入力] ドッキングするバーの ID。
lpRect
[入力] ドッキング先の四角形。
CDockingManager::DockPaneLeftOf
ペインを別のペインの左側にドッキングします。
BOOL DockPaneLeftOf(
CPane* pBarToDock,
CPane* pTargetBar);
パラメーター
pBarToDock
[入力] pTargetBar の左側にドッキングするペインへのポインター。
pTargetBar
[入力] ターゲット ペインへのポインター。
戻り値
ペインが正常にドッキングされた場合は TRUE、それ以外の場合は FALSE。
CDockingManager::EnableAutoHidePanes
メイン フレームへのペインのドッキングを有効にして、ドッキング ペインを作成し、コントロール バーの一覧に追加します。
BOOL EnableAutoHidePanes(DWORD dwStyle);
パラメーター
dwStyle
[入力] ドッキングの配置。
戻り値
ドッキング ペインが正常に作成された場合は TRUE、それ以外の場合は FALSE。
CDockingManager::EnableDocking
ドッキング ペインを作成し、メイン フレームへのペインのドッキングを有効にします。
BOOL EnableDocking(DWORD dwStyle);
パラメーター
dwStyle
[入力] ドッキングの配置。
戻り値
ドッキング ペインが正常に作成された場合は TRUE、それ以外の場合は FALSE。
CDockingManager::EnableDockSiteMenu
すべてのドッキング ペインのキャプションでポップアップ メニューを開く追加のボタンを表示します。
static void EnableDockSiteMenu(BOOL bEnable = TRUE);
パラメーター
bEnable
[入力] ドッキング サイト メニューを有効にする場合は TRUE、それ以外の場合は FALSE。
解説
ドッキング サイト メニューには、ペインのドッキング状態を変更するための次のオプションが表示されます。
Floating- ペインをフローティングさせますDocking- ペインが最後にドッキングされた場所にあるメイン フレームでペインをドッキングしますAutoHide- ペインを、自動的に隠すモードに切り替えますHide- ペインを非表示にします
既定では、このメニューは表示されません。
CDockingManager::EnablePaneContextMenu
ユーザーがマウスの右ボタンをクリックし、ライブラリが WM_CONTEXTMENU メッセージを処理しているときに、アプリケーション ツール バーとドッキング ペインの一覧を含む特別なコンテキスト メニューを表示するようにライブラリに指示します。
void EnablePaneContextMenu(
BOOL bEnable,
UINT uiCustomizeCmd,
const CString& strCustomizeText,
BOOL bToolbarsOnly = FALSE);
パラメーター
bEnable
[入力] TRUE の場合、ライブラリにより、自動コンテキスト メニューのサポートがオンになります。FALSE の場合、自動コンテキスト メニューのサポートはオフになります。
uiCustomizeCmd
[入力] メニュー内の Customize 項目のコマンド ID。
strCustomizeText
[入力] Customize 項目のテキスト。
bToolbarsOnly
[入力] TRUE の場合は、メニューにアプリケーションのツール バーの一覧のみが表示されます。FALSE の場合、ライブラリにより、アプリケーションのドッキング ペインがこの一覧に追加されます。
CDockingManager::FindDockSite
指定された位置にあり、指定された配置のバー ペインを取得します。
virtual CDockSite* FindDockSite(
DWORD dwAlignment,
BOOL bOuter);
パラメーター
dwAlignment
[入力] バー ペインの配置。
bOuter
[入力] TRUE の場合、コントロール バーの一覧の先頭位置にあるバーを取得します。 それ以外の場合は、コントロール バーの一覧の末尾位置にあるバーを取得します。
戻り値
指定された配置のドッキング ペイン、それ以外の場合は NULL。
CDockingManager::FindPaneByID
指定されたコントロール ID でペインが検索されます。
virtual CBasePane* FindPaneByID(
UINT uBarID,
BOOL bSearchMiniFrames = FALSE);
パラメーター
uBarID
[入力] 検索するペインのコントロール ID を指定します。
bSearchMiniFrames
[入力] 検索にすべてのフローティング ペインを含める場合は TRUE。 ドッキング ペインのみを含める場合は FALSE。
戻り値
指定されたコントロール ID を持つ CBasePane オブジェクト。指定されたペインが見つからない場合は NULL。
解説
CDockingManager::FindDockSiteByPane
ターゲットのバー ペインの ID を持つバー ペインを返します。
virtual CDockSite* FindDockSiteByPane(CPane* pTargetBar);
パラメーター
pTargetBar
[入力] ターゲット バー ペインへのポインター。
戻り値
ターゲット バー ペインの ID を持つバー ペイン。このようなペインが存在しない場合は NULL。
CDockingManager::FixupVirtualRects
現在のすべてのツール バーの位置を仮想四角形にコミットします。
virtual void FixupVirtualRects();
解説
ユーザーがツール バーのドラッグを開始すると、アプリケーションでは、"仮想四角形" 内のその元の位置を記憶します。 ユーザーがドッキング サイト全体でツール バーを移動すると、そのツール バーによって他のツール バーがシフトされる場合があります。 他のツール バーの元の位置は、対応する仮想四角形に格納されます。
CDockingManager::FrameFromPoint
特定のポイントを含むフレームを返します。
virtual CPaneFrameWnd* FrameFromPoint(
CPoint pt,
CPaneFrameWnd* pFrameToExclude,
BOOL bFloatMultiOnly) const;
パラメーター
pt
[入力] 確認するポイントが画面座標で指定されます。
pFrameToExclude
[入力] 除外するフレームへのポインター。
bFloatMultiOnly
[入力] CMultiPaneFrameWnd のインスタンスではないフレームを除外する場合は TRUE、それ以外の場合は FALSE。
戻り値
特定のポイントを含むフレーム、それ以外の場合は NULL。
CDockingManager::GetClientAreaBounds
クライアント領域の境界を含む四角形を取得します。
CRect GetClientAreaBounds() const;
void GetClientAreaBounds(CRect& rcClient);
パラメーター
rcClient
[出力] クライアント領域の境界を含む四角形への参照。
戻り値
クライアント領域の境界を含む四角形。
CDockingManager::GetDockingMode
現在のドッキング モードを返します。
static AFX_DOCK_TYPE GetDockingMode();
戻り値
現在のドッキング モードを表す列挙子の値。 次のいずれかの値を指定できます。
DT_STANDARD
DT_IMMEDIATE
DT_SMART
解説
ドッキング モードを設定するには、CDockingManager::SetDockingMode を呼び出します。
CDockingManager::GetDockSiteFrameWnd
親ウィンドウ フレームへのポインターを取得します。
CFrameWnd* GetDockSiteFrameWnd() const;
戻り値
親ウィンドウ フレームへのポインター。
CDockingManager::GetEnabledAutoHideAlignment
ペインの有効化された配置を返します。
DWORD GetEnabledAutoHideAlignment() const;
戻り値
CBRS_ALIGN_ フラグのビット演算の組み合わせ。自動的に隠すペインが有効ではない場合は 0。 詳細については、「CFrameWnd::EnableDocking」を参照してください。
解説
このメソッドにより、自動的に隠すコントロール バーに対して有効な配置が返されます。 自動的に隠すバーを有効にするには、CFrameWndEx::EnableAutoHidePanes を呼び出します。
CDockingManager::GetMiniFrames
ミニ フレームの一覧を取得します。
const CObList& GetMiniFrames() const;
戻り値
ドッキング マネージャーに属するコントロール バーを含むミニ フレームの一覧。
CDockingManager::GetOuterEdgeBounds
フレームの外側のエッジを含む四角形を取得します。
CRect GetOuterEdgeBounds() const;
戻り値
フレームの外側のエッジを含む四角形。
CDockingManager::GetPaneList
ドッキング マネージャーに属するペインの一覧を返します。 これには、すべてのフローティング ペインが含まれます。
void GetPaneList(
CObList& lstBars,
BOOL bIncludeAutohide = FALSE,
CRuntimeClass* pRTCFilter = NULL,
BOOL bIncludeTabs = FALSE);
パラメーター
lstBars
[入力、出力] 現在のドッキング マネージャーのすべてのペインが含まれます。
bIncludeAutohide
[入力] 自動的に隠すモードのペインを含める場合は TRUE、それ以外の場合は FALSE。
pRTCFilter
[入力] NULL ではない場合、返される一覧には、指定されたランタイム クラスのペインのみが含まれます。
bIncludeTabs
[入力] タブを含める場合は TRUE、それ以外の場合は FALSE。
解説
ドッキング マネージャーにタブ付きペインがある場合、このメソッドによって、CBaseTabbedPane クラスへのポインターが返され、ユーザーはタブを明示的に列挙する必要があります。
ペインの特定のクラスを取得するには、pRTCFilter を使用します。 たとえば、この値を適切に設定することにより、ツール バーのみを取得できます。
CDockingManager::GetSmartDockingManager
スマート ドッキング マネージャーへのポインターを取得します。
CSmartDockingManager* GetSmartDockingManager();
戻り値
スマート ドッキング マネージャーへのポインター。
CDockingManager::GetSmartDockingManagerPermanent
スマート ドッキング マネージャーへのポインターを取得します。
CSmartDockingManager* GetSmartDockingManagerPermanent() const;
戻り値
スマート ドッキング マネージャーへのポインター。
CDockingManager::GetSmartDockingParams
ドッキング マネージャーのスマート ドッキング パラメーターを返します。
static CSmartDockingInfo& GetSmartDockingParams();
戻り値
現在のドッキング マネージャーのスマート ドッキング パラメーターを含むクラス。 詳細については、「CSmartDockingInfo クラス」を参照してください。
解説
CDockingManager::HideAutoHidePanes
自動的に隠すモードのペインを非表示にします。
void HideAutoHidePanes(
CDockablePane* pBarToExclude = NULL,
BOOL bImmediately = FALSE);
パラメーター
pBarToExclude
[入力] 非表示から除外されるバーへのポインター。
bImmediately
[入力] ペインを即座に非表示にする場合は TRUE。自動的に隠す効果を使用してペインを非表示にする場合は FALSE。
CDockingManager::InsertDockSite
ドッキング ペインを作成し、コントロール バーの一覧に挿入します。
BOOL InsertDockSite(
const AFX_DOCKSITE_INFO& info,
DWORD dwAlignToInsertAfter,
CDockSite** ppDockBar = NULL);
パラメーター
info
[入力] ドッキング ペインに関する配置情報を含む構造体。
dwAlignToInsertAfter
[入力] ドッキング ペインの配置。
ppDockBar
[出力] ドッキング ペインへのポインターを指すポインター。
戻り値
ドッキング ペインが正常に作成された場合は TRUE、それ以外の場合は FALSE。
CDockingManager::InsertPane
コントロール ペインをコントロール バーの一覧に挿入します。
BOOL InsertPane(
CBasePane* pControlBar,
CBasePane* pTarget,
BOOL bAfter = TRUE);
パラメーター
pControlBar
[入力] コントロール ペインへのポインター。
pTarget
[入力] ターゲット ペインへのポインター。
bAfter
[入力] ターゲット ペインの位置の後にペインを挿入する場合は TRUE、それ以外の場合は FALSE。
戻り値
コントロール ペインがコントロール バーの一覧に正常に追加された場合は TRUE、それ以外の場合は FALSE。
解説
このメソッドでは、コントロール ペインがコントロール バーの一覧に既に含まれている場合、またはターゲット ペインがコントロール バーの一覧にない場合、FALSE が返されます。
CDockingManager::IsDockSiteMenu
すべてのペインのキャプションにポップアップ メニューを表示するかどうかを指定します。
static BOOL IsDockSiteMenu();
戻り値
すべてのドッキング ペインのキャプションでドッキング サイト メニューが表示される場合は TRUE、それ以外の場合は FALSE。
解説
CDockingManager::EnableDockSiteMenu を呼び出すことにより、ドッキング サイト メニューを有効にすることができます。
CDockingManager::IsInAdjustLayout
すべてのペインのレイアウトを調整するかどうかを決定します。
BOOL IsInAdjustLayout() const;
戻り値
すべてのペインのレイアウトが調整される場合は TRUE、それ以外の場合は FALSE。
CDockingManager::IsOLEContainerMode
ドッキング マネージャーが OLE コンテナー モードであるかどうかを指定します。
BOOL IsOLEContainerMode() const;
戻り値
ドッキング マネージャーが OLE コンテナー モードである場合は TRUE、それ以外の場合は FALSE。
解説
OLE コンテナー モードでは、すべてのドッキング ペインおよびアプリケーション ツール バーは非表示になります。 CDockingManager::m_bHideDockingBarsInContainerMode を TRUE に設定している場合、このモードでは、ペインも非表示になります。
CDockingManager::IsPointNearDockSite
指定されたポイントがドッキング サイトに近いかどうかを決定します。
BOOL IsPointNearDockSite(
CPoint point,
DWORD& dwBarAlignment,
BOOL& bOuterEdge) const;
パラメーター
point
[入力] 指定されたポイント。
dwBarAlignment
[出力] ポイントの近くにあるエッジを指定します。 使用可能な値は、CBRS_ALIGN_LEFT、CBRS_ALIGN_RIGHT、CBRS_ALIGN_TOP、CBRS_ALIGN_BOTTOM です。
bOuterEdge
[出力] ポイントがドッキング サイトの外側の境界の近くにある場合は TRUE、それ以外の場合は FALSE。
戻り値
ポイントがドッキング サイトの近くにある場合は TRUE。それ以外の場合は FALSE。
CDockingManager::IsPrintPreviewValid
印刷プレビュー モードを設定するかどうかを決定します。
BOOL IsPrintPreviewValid() const;
戻り値
印刷プレビュー モードが設定されている場合は TRUE、それ以外の場合は FALSE。
CDockingManager::LoadState
レジストリからドッキング マネージャーの状態を読み込みます。
virtual BOOL LoadState(
LPCTSTR lpszProfileName = NULL,
UINT uiID = (UINT) -1);
パラメーター
lpszProfileName
[入力] プロファイル名。
uiID
[入力] ドッキング マネージャーの ID。
戻り値
ドッキング マネージャーの状態が正常に読み込まれた場合は TRUE、それ以外の場合は FALSE。
CDockingManager::LockUpdate
特定のウィンドウをロックします。
void LockUpdate(BOOL bLock);
パラメーター
bLock
[入力] ウィンドウをロックする場合は TRUE、それ以外の場合は FALSE。
解説
ウィンドウをロックすると、移動することも再描画することもできません。
CDockingManager::m_bHideDockingBarsInContainerMode
ドッキング マネージャーによって OLE コンテナー モードでペインを非表示にするかどうかを指定します。
AFX_IMPORT_DATA static BOOL m_bHideDockingBarsInContainerMode;
解説
アプリケーションが OLE コンテナー モードのときに、メインフレームにドッキングされているすべてのペインを表示したままにする場合は、この値を FALSE に設定します。 既定では、この値は TRUE です。
CDockingManager::m_dockModeGlobal
グローバル ドッキング モードを指定します。
AFX_IMPORT_DATA static AFX_DOCK_TYPE m_dockModeGlobal;
解説
各ドッキング ペインでは、既定により、このドッキング モードが使用されます。 このフィールドに設定できる値の詳細については、「CBasePane::GetDockingMode」を参照してください。
CDockingManager::m_nDockSensitivity
ドッキング感度を指定します。
AFX_IMPORT_DATA static int m_nDockSensitivity;
解説
ドッキング感度では、フレームワークの状態がドッキングに変更される前に、フローティング ペインをドッキング ペイン、ドッキング サイト、または別のペインにどれだけ近づけることができるかを定義します。
CDockingManager::m_nTimeOutBeforeDockingBarDock
ドッキング ペインが即時ドッキング モードでドッキングされるまでの時間をミリ秒単位で指定します。
static UINT m_nTimeOutBeforeDockingBarDock;
解説
ペインがドッキングされる前に、フレームワークは指定された時間待機します。 これにより、ユーザーがまだドラッグしているときに、ペインが誤った場所にドッキングされるのを防ぐことができます。
CDockingManager::m_nTimeOutBeforeToolBarDock
ツール バーがメイン フレーム ウィンドウにドッキングされるまでの時間をミリ秒単位で指定します。
static UINT m_nTimeOutBeforeToolBarDock;
解説
ツール バーがドッキングされる前に、フレームワークは指定された時間待機します。 これにより、ユーザーがまだドラッグしているときに、ツール バーが誤った場所にドッキングされるのを防ぐことができます。
CDockingManager::OnActivateFrame
フレーム ウィンドウがアクティブまたは非アクティブになったときにフレームワークによって呼び出されます。
virtual void OnActivateFrame(BOOL bActivate);
パラメーター
bActivate
[入力] TRUE の場合、フレーム ウィンドウはアクティブになります。FALSE の場合、フレーム ウィンドウは非アクティブです。
CDockingManager::OnClosePopupMenu
アクティブなポップアップ メニューが WM_DESTROY メッセージを処理するときに、フレームワークによって呼び出されます。
void OnClosePopupMenu();
解説
現在のメイン ウィンドウを閉じようとしているときに、フレームワークにより、WM_DESTROY メッセージが送信されます。 CMFCPopupMenu オブジェクトで WM_DESTROY メッセージが処理されるときに、フレーム ウィンドウに属する CMFCPopupMenu オブジェクトからの通知を処理するには、このメソッドをオーバーライドします。
CDockingManager::OnMoveMiniFrame
ミニフレーム ウィンドウを移動するためにフレームワークによって呼び出されます。
virtual BOOL OnMoveMiniFrame(CWnd* pFrame);
パラメーター
pFrame
[入力] ミニフレーム ウィンドウへのポインター。
戻り値
メソッドが成功した場合は TRUE、それ以外の場合は FALSE。
CDockingManager::OnPaneContextMenu
ペインの一覧を含むメニューを構築するときにフレームワークによって呼び出されます。
void OnPaneContextMenu(CPoint point);
パラメーター
point
[入力] メニューの場所を指定します。
CDockingManager::PaneFromPoint
特定のポイントを含むペインが返されます。
virtual CBasePane* PaneFromPoint(
CPoint point,
int nSensitivity,
bool bExactBar = false,
CRuntimeClass* pRTCBarType = NULL,
BOOL bCheckVisibility = FALSE,
const CBasePane* pBarToIgnore = NULL) const;
virtual CBasePane* PaneFromPoint(
CPoint point,
int nSensitivity,
DWORD& dwAlignment,
CRuntimeClass* pRTCBarType = NULL,
const CBasePane* pBarToIgnore = NULL) const;
パラメーター
point
[入力] 確認するポイントが画面座標で指定されます。
nSensitivity
[入力] 確認された各ペインのウィンドウの四角形を拡張する値。 特定のポイントがこの拡張領域内にある場合、ペインは検索条件を満たします。
bExactBar
[入力] "nSensitivity パラメーターを無視する場合は " TRUE、それ以外の場合は FALSE。
pRTCBarType
[入力] NULL ではない場合、メソッドでは、指定された型のペインのみが検索されます。
bCheckVisibility
[入力] 表示されるペインのみを確認する場合は TRUE、それ以外の場合は FALSE。
dwAlignment
[出力] 指定されたポイントでペインが見つかった場合、このパラメーターには、その指定されたポイントに最も近かったペインの辺が含まれます。 詳細については、「解説」を参照してください。
pBarToIgnore
[入力] NULL ではない場合、メソッドでは、このパラメーターで指定されたペインは無視されます。
戻り値
特定のポイントを含む CBasePane 派生オブジェクト、ペインが見つからなかった場合は NULL。
解説
関数が戻り、ペインが見つかった場合、dwAlignment には指定されたポイントの配置が含まれます。 たとえば、ポイントがペインの上側に最も近い場合、dwAlignment は CBRS_ALIGN_TOP に設定されます。
CDockingManager::ProcessPaneContextMenuCommand
指定されたコマンドのチェック ボックスをオンまたはオフにし、表示されたペインのレイアウトを再計算するためにフレームワークによって呼び出されます。
BOOL ProcessPaneContextMenuCommand(
UINT nID,
int nCode,
void* pExtra,
AFX_CMDHANDLERINFO* pHandlerInfo);
パラメーター
nID
[入力] メニュー内のコントロール バーの ID。
nCode
[入力] コマンド通知コード。
pExtra
[入力] nCode が CN_UPDATE_COMMAND_UI である場合に CCmdUI へのポインターにキャストされる void へのポインター。
pHandlerInfo
[入力] 情報構造体へのポインター。 このパラメーターは使用されません。
戻り値
pEXtra が NULL ではなく、nCode が CN_UPDATE_COMMAND_UI と等しい場合、または指定された nID を持つコントロール バーがある場合は TRUE。
CDockingManager::RecalcLayout
コントロールの一覧にあるコントロールの内部レイアウトを再計算します。
virtual void RecalcLayout(BOOL bNotify = TRUE);
パラメーター
bNotify
[入力] このパラメーターは使用しません。
CDockingManager::ReleaseEmptyPaneContainers
空のペイン コンテナーを解放します。
void ReleaseEmptyPaneContainers();
CDockingManager::RemoveHiddenMDITabbedBar
指定された非表示のバー ペインを削除します。
void RemoveHiddenMDITabbedBar(CDockablePane* pBar);
パラメーター
pBar
[入力] 削除するバー ペインへのポインター。
CDockingManager::RemoveMiniFrame
指定されたフレームをミニ フレームの一覧から削除します。
virtual BOOL RemoveMiniFrame(CPaneFrameWnd* pWnd);
パラメーター
pWnd
[入力] 削除するフレームへのポインター。
戻り値
指定されたフレームが削除された場合は TRUE、それ以外の場合は FALSE。
CDockingManager::RemovePaneFromDockManager
ペインを登録解除して、ドッキング マネージャーの一覧から削除します。
void RemovePaneFromDockManager(
CBasePane* pWnd,
BOOL bDestroy,
BOOL bAdjustLayout,
BOOL bAutoHide = FALSE,
CBasePane* pBarReplacement = NULL);
パラメーター
pWnd
[入力] 削除されるペインへのポインター。
bDestroy
[入力] TRUE の場合、削除されたペインが破棄されます。
bAdjustLayout
[入力] TRUE の場合は、ドッキング レイアウトをすぐに調整します。
bAutoHide
[入力] TRUE の場合、ペインは、自動的に隠すバーの一覧から削除されます。 FALSE の場合、ペインは、通常のペインの一覧から削除されます。
pBarReplacement
[入力] 削除されたペインを置き換えるペインへのポインター。
CDockingManager::ReplacePane
ペインを別のペインに置き換えます。
BOOL ReplacePane(
CDockablePane* pOriginalBar,
CDockablePane* pNewBar);
パラメーター
pOriginalBar
[入力] 元のペインへのポインター。
pNewBar
[入力] 元のペインに置き換わるペインへのポインター。
戻り値
ペインが正常に置き換えられた場合は TRUE、それ以外の場合は FALSE。
CDockingManager::ResortMiniFramesForZOrder
ミニ フレームの一覧内のフレームを再度並べ替えます。
void ResortMiniFramesForZOrder();
CDockingManager::SaveState
ドッキング マネージャーの状態をレジストリに保存します。
virtual BOOL SaveState(
LPCTSTR lpszProfileName = NULL,
UINT uiID = (UINT) -1);
パラメーター
lpszProfileName
[入力] レジストリ キーへのパス。
uiID
[入力] ドッキング マネージャーの ID。
戻り値
状態が正常に保存された場合は TRUE、それ以外の場合は FALSE。
解説
ドッキング マネージャーの状態をレジストリに保存するには、コントロール バーの状態、自動的に隠すバーの状態、ドッキング マネージャー内にあるミニ フレームの状態を保存する必要があります。
CDockingManager::SendMessageToMiniFrames
指定されたメッセージをすべてのミニ フレームに送信します。
BOOL SendMessageToMiniFrames(
UINT uMessage,
WPARAM wParam = 0,
LPARAM lParam = 0);
パラメーター
uMessage
[入力] 送信されるメッセージ。
wParam
[入力] 追加のメッセージ依存情報。
lParam
[入力] 追加のメッセージ依存情報。
戻り値
常に TRUE。
CDockingManager::Serialize
ドッキング マネージャーをアーカイブに書き込みます。
void Serialize(CArchive& ar);
パラメーター
ar
[入力] アーカイブ オブジェクトへの参照。
解説
ドッキング マネージャーをアーカイブに書き込むには、ドッキング コントロール バーとスライダーの数を決定し、コントロール バー、ミニ フレーム、自動的に隠すバー、MDI タブ付きバーをアーカイブに書き込む必要があります。
CDockingManager::SetAutohideZOrder
コントロール バーと指定されたペインのサイズ、幅、高さを設定します。
void SetAutohideZOrder(CDockablePane* pAHDockingBar);
パラメーター
pAHDockingBar
[入力] ドッキング可能なペインへのポインター。
CDockingManager::SetDockingMode
ドッキング モードを設定します。
static void SetDockingMode(
AFX_DOCK_TYPE dockMode,
AFX_SMARTDOCK_THEME theme = AFX_SDT_DEFAULT);
パラメーター
dockMode
新しいドッキング モードを指定します。 詳細については、「解説」を参照してください。
theme
スマート ドッキング マーカーに使用されるテーマを指定します。 これには、列挙値 AFX_SDT_DEFAULT、AFX_SDT_VS2005、AFX_SDT_VS2008 のいずれかを指定できます。
解説
この静的メソッドを呼び出してドッキング モードを設定します。
dockMode には、次のいずれかの値を指定できます。
DT_STANDARD - Visual Studio .NET 2003 で実装されている標準ドッキング モード。 ペインは、ドラッグ コンテキストなしでドラッグされます。
DT_IMMEDIATE - Microsoft Visio に実装されている即時ドッキング モード。 ペインは、ドラッグ コンテキスト付きでドラッグされますが、マーカーは表示されません。
DT_SMART - Visual Studio 2005 で実装されているスマート ドッキング モード。 ペインは、ドラッグ コンテキスト付きでドラッグされ、ペインをドッキングできる場所を示すスマート マーカーが表示されます。
CDockingManager::SetDockState
コントロール バー、ミニ フレーム、自動的に隠すバーのドッキングの状態を設定します。
virtual void SetDockState();
CDockingManager::SetPrintPreviewMode
印刷プレビューに表示されるバーの印刷プレビュー モードを設定します。
void SetPrintPreviewMode(
BOOL bPreview,
CPrintPreviewState* pState);
パラメーター
bPreview
印刷プレビュー モードが設定されている場合は TRUE、それ以外の場合は FALSE。
pState
[入力] プレビュー状態へのポインター。 このパラメーターは使用されません。
CDockingManager::SetSmartDockingParams
スマート ドッキングの動作を定義するパラメーターを設定します。
static void SetSmartDockingParams(CSmartDockingInfo& params);
パラメーター
params
[入力、出力] スマート ドッキングのパラメーターを定義します。
解説
スマート ドッキング マーカーの外観、色、または形状をカスタマイズする場合は、このメソッドを呼び出します。
スマート ドッキング マーカーの既定の外観を使用するには、CSmartDockingInfo Class の初期化されていないインスタンスを params に渡します。
CDockingManager::ShowDelayShowMiniFrames
ミニ フレームのウィンドウを表示と非表示を切り替えます。
void ShowDelayShowMiniFrames(BOOL bshow);
パラメーター
bShow
[入力] 表示されているフレームのウィンドウをアクティブにする場合は TRUE、フレームのウィンドウを非表示にする場合は FALSE。
CDockingManager::ShowPanes
コントロールと自動的に隠すバーのペインの表示と非表示を切り替えます。
virtual BOOL ShowPanes(BOOL bShow);
パラメーター
bShow
[入力] ペインを表示する場合は TRUE、ペインを非表示にする場合は FALSE。
戻り値
常に FALSE です。
CDockingManager::StartSDocking
スマート ドッキング マネージャーの配置に従って、指定されたウィンドウのスマート ドッキングを開始します。
void StartSDocking(CWnd* pDockingWnd);
パラメーター
pDockingWnd
[入力] ドッキングするウィンドウへのポインター。
CDockingManager::StopSDocking
スマート ドッキングを停止します。
void StopSDocking();
CDockingManager::GetSmartDockingTheme
スマート ドッキング マーカーの表示に使用されるテーマを返す静的メソッド。
static AFX_SMARTDOCK_THEME __stdcall GetSmartDockingTheme();
戻り値
列挙値 AFX_SDT_DEFAULT、AFX_SDT_VS2005、AFX_SDT_VS2008 のいずれかを返します。
解説
関連項目
階層図
クラス
CObject クラス
CFrameWndEx クラス
CDockablePane クラス
CPaneFrameWnd クラス
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示