CDockablePane クラス

ドッキング サイトにドッキングできる、またはタブ付きペインに含めることができるペインを実装します。

構文

class CDockablePane : public CPane

メンバー

パブリック コンストラクター

名前	説明
CDockablePane::CDockablePane	CDockablePane オブジェクトを構築して初期化します。

パブリック メソッド

名前	説明
CDockablePane::AttachToTabWnd	別のペインにペインをアタッチします。 これにより、タブ付きペインが作成されます。
CDockablePane::CalcFixedLayout	ウィンドウの四角形のサイズを返します。
CDockablePane::CanAcceptMiniFrame	指定したミニ フレームをウィンドウにドッキングできるかどうかを決定します。
CDockablePane::CanAcceptPane	別のペインを現在のペインにドッキングできるかどうかを決定します。
CDockablePane::CanAutoHide	ペインが自動非表示モードをサポートするかどうかを指定します。 ( CBasePane::CanAutoHideをオーバーライドします)。
CDockablePane::CanBeAttached	現在のペインを別のペインにドッキングできるかどうかを決定します。
CDockablePane::ConvertToTabbedDocument	1 つ以上のドッキング可能なペインを MDI タブ付きドキュメントに変換します。
CDockablePane::CopyState	ドッキング可能ウィンドウの状態をコピーします。
CDockablePane::Create	Windows コントロールを作成し、オブジェクトに CDockablePane アタッチします。
CDockablePane::CreateDefaultPaneDivider	フレーム ウィンドウにドッキングされているウィンドウの既定の分割線を作成します。
CDockablePane::CreateEx	Windows コントロールを作成し、オブジェクトに CDockablePane アタッチします。
CDockablePane::CreateTabbedPane	現在のペインからタブ付きペインを作成します。
CDockablePane::DockPaneContainer	コンテナーをペインにドッキングします。
CDockablePane::DockPaneStandard	アウトライン (標準) ドッキングを使用してペインをドッキングします。
CDockablePane::DockToFrameWindow	内部使用。 ウィンドウをドッキングするには、次を使用するか、 を使用 CPane::DockPane します CDockablePane::DockToWindow。
CDockablePane::DockToRecentPos	ペインを、保存されている最近のドッキング位置にドッキングします。
CDockablePane::DockToWindow	1 つのドッキング ウィンドウを別のドッキング ウィンドウにドッキングします。
CDockablePane::EnableAutohideAll	コンテナー内の他のペインと共に、このペインの自動非表示モードを有効または無効にします。
CDockablePane::EnableGripper	キャプション (グリッパー) を表示または非表示にします。
CDockablePane::GetAHRestoredRect	自動非表示モードで表示される場合のペインの位置を指定します。
CDockablePane::GetAHSlideMode	ウィンドウのスライド の自動非表示モードを取得します。
CDockablePane::GetAutoHideButton	内部使用。
CDockablePane::GetAutoHideToolBar	内部使用。
CDockablePane::GetCaptionHeight	現在のキャプションの高さを返します。
CDockablePane::GetDefaultPaneDivider	ペインのコンテナーの既定のウィンドウ分割線を返します。
CDockablePane::GetDockingStatus	指定されたポインター位置に基づいてペインをドッキングする機能を決定します。
CDockablePane::GetDragSensitivity	ドッキング ウィンドウのドラッグ感度を返します。
CDockablePane::GetLastPercentInPaneContainer	コンテナー内でペインが占める領域の割合を取得します。
CDockablePane::GetTabArea	ウィンドウのタブ領域を取得します。
CDockablePane::GetTabbedPaneRTC	別のペインが現在のペインにドッキングされるときに作成されるタブ付きウィンドウに関するランタイム クラス情報を返します。
CDockablePane::HasAutoHideMode	ドッキング ウィンドウを自動非表示モードに切り替えることができるかどうかを指定します。
CDockablePane::HitTest	ユーザーがマウスをクリックするペイン内の特定の場所を指定します。
CDockablePane::IsAccessibilityCompatible	内部使用。
CDockablePane::IsAutohideAllEnabled	ドッキング ウィンドウとコンテナー内の他のすべてのペインを自動非表示モードで配置できるかどうかを示します。
CDockablePane::IsAutoHideMode	ペインが自動非表示モードかどうかを指定します。
CDockablePane::IsChangeState	内部使用。
CDockablePane::IsDocked	現在のウィンドウがドッキングされているかどうかを判断します。
CDockablePane::IsHideInAutoHideMode	呼び出 ShowPaneしによって表示 (または非表示) されている場合に、自動非表示モードのペインの動作を決定します。
CDockablePane::IsInFloatingMultiPaneFrameWnd	ペインが複数ウィンドウ フレーム ウィンドウ内にあるかどうかを指定します。
CDockablePane::IsResizable	ウィンドウのサイズを変更できるかどうかを指定します。
CDockablePane::IsTabLocationBottom	タブをウィンドウの上部または下部に配置するかどうかを指定します。
CDockablePane::IsTracked	ユーザーがウィンドウをドラッグするかどうかを指定します。
CDockablePane::IsVisible	現在のウィンドウが表示されるかどうかを決定します。
CDockablePane::LoadState	内部使用。
CDockablePane::OnAfterChangeParent	ウィンドウの親が変更されたときにフレームワークによって呼び出されます。 ( CPane::OnAfterChangeParentをオーバーライドします)。
CDockablePane::OnAfterDockFromMiniFrame	フローティング ドッキング バーがフレーム ウィンドウにドッキングされるときにフレームワークによって呼び出されます。
CDockablePane::OnBeforeChangeParent	ウィンドウの親が変更されようとしているときにフレームワークによって呼び出されます。 ( CPane::OnBeforeChangeParentをオーバーライドします)。
CDockablePane::OnBeforeFloat	ウィンドウが浮動しようとしているときにフレームワークによって呼び出されます。 ( CPane::OnBeforeFloatをオーバーライドします)。
CDockablePane::RemoveFromDefaultPaneDividier	ウィンドウがドッキング解除されている場合、フレームワークはこのメソッドを呼び出します。
CDockablePane::ReplacePane	ペインを指定したペインに置き換えます。
CDockablePane::RestoreDefaultPaneDivider	フレームワークは、ウィンドウが逆シリアル化され、既定のウィンドウ分割線を復元するために、このメソッドを呼び出します。
CDockablePane::SaveState	内部使用。
CDockablePane::Serialize	ペインをシリアル化します。 ( CBasePane::Serializeをオーバーライドします)。
CDockablePane::SetAutoHideMode	ドッキング ウィンドウを表示モードと自動非表示モードの間で切り替えます。
CDockablePane::SetAutoHideParents	ペインの自動非表示ボタンと自動非表示ツールバーを設定します。
CDockablePane::SetDefaultPaneDivider	内部使用。
CDockablePane::SetLastPercentInPaneContainer	コンテナー内でペインが占める領域の割合を設定します。
CDockablePane::SetResizeMode	内部使用。
CDockablePane::SetRestoredDefaultPaneDivider	復元された既定のウィンドウ分割線を設定します。
CDockablePane::SetTabbedPaneRTC	2 つのペインが一緒にドッキングされるときに作成されるタブ付きウィンドウのランタイム クラス情報を設定します。
CDockablePane::ShowPane	ペインの表示と非表示を切り替えます。
CDockablePane::Slide	ペインが自動非表示モードの場合にのみ表示されるスライド アニメーションを含むペインの表示と非表示を切り替えます。
CDockablePane::ToggleAutoHide	自動非表示モードを切り替えます。 (オーバーライド. CPane::ToggleAutoHide )
CDockablePane::UndockPane	メイン フレーム ウィンドウまたはミニフレーム ウィンドウ コンテナーからペインをドッキング解除します。
CDockablePane::UnSetAutoHideMode	内部使用。 自動非表示モードを設定するには、 CDockablePane::SetAutoHideMode

保護メソッド

名前	説明
CDockablePane::CheckAutoHideCondition	ドッキング ウィンドウを非表示にするかどうかを指定します (自動非表示モード)。
CDockablePane::CheckStopSlideCondition	ドッキング ウィンドウの自動非表示がスライドを停止するタイミングを指定します。
CDockablePane::DrawCaption	ドッキング ウィンドウキャプション (グリッパー) を描画します。
CDockablePane::OnPressButtons	ユーザーがボタン以外のキャプション ボタンをAFX_HTCLOSE押すと呼びAFX_HTMAXBUTTON出されます。
CDockablePane::OnSlide	ウィンドウが表示または非表示のときに、スライドの自動非表示効果をレンダリングするためにフレームワークによって呼び出されます。

データ メンバー

名前	説明
CDockablePane::m_bDisableAnimation	ドッキング可能ウィンドウの自動非表示アニメーションを無効にするかどうかを指定します。
CDockablePane::m_bHideInAutoHideMode	ペインが自動非表示モードの場合のペインの動作を決定します。
CDockablePane::m_nSlideSteps	自動非表示モードでペインを表示または非表示にする場合の、ペインのアニメーション速度を指定します。

解説

CDockablePane には、次の機能が実装されています。

• ウィンドウをメインフレーム ウィンドウにドッキングする。

• ウィンドウを自動非表示モードに切り替える。

• タブ付きウィンドウにウィンドウをアタッチする。

• ミニフレーム ウィンドウ内のウィンドウの浮動。

• ミニフレーム ウィンドウに浮動している別のペインにペインをドッキングする。

• ウィンドウのサイズを変更する。

• ドッキング ウィンドウの読み込みと保存の状態。

  Note

  状態情報は Windows レジストリに保存されます。

• キャプションの有無に関係なくペインを作成する。 キャプションにはテキスト ラベルを付けることができ、グラデーションの色で塗りつぶすことができます。

• ウィンドウの内容を表示しながらウィンドウをドラッグする

• ドラッグ四角形を表示しながらペインをドラッグする。

アプリケーションでドッキング ウィンドウを使用するには、クラスからペイン クラスを CDockablePane 派生させます。 派生オブジェクトをメインフレーム ウィンドウ オブジェクトに埋め込むか、ウィンドウのインスタンスを制御するウィンドウ オブジェクトに埋め込みます。 次に、CDockablePane::Createメイン フレーム ウィンドウでメッセージをWM_CREATE処理するときに、メソッドまたはCDockablePane::CreateExメソッドを呼び出します。 最後に、ウィンドウ オブジェクトを呼び出CBasePane::EnableDockingして設定しますCDockablePane::AttachToTabWnd。 CBasePane::DockPane

カスタマイズのヒント

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

• タブ付きでないドッキング可能なペインを 2 つ呼び出 CDockablePane::AttachToTabWnd すと、パラメーターに ppTabbedControlBar タブ付きウィンドウへのポインターが返されます。 このパラメーターを使用すると、引き続きタブ付きウィンドウにタブを追加できます。

• 作成されるCDockablePane::AttachToTabWndタブ付きペインの種類は、パラメーター内pTabControlBarAttachToのCDockablePaneオブジェクトによって決まります。 呼び出 CDockablePane::SetTabbedPaneRTC して、作成するタブ付きペインの種類を CDockablePane 設定できます。 既定の型は、最初に dwTabbedStyleCDockablePane::Create .CDockablePane 既定の型が Class の場合dwTabbedStyleはCMFCOutlookBarClass です。既定の型の場合dwTabbedStyleは AFX_CBRS_REGULAR_TABS Class ですCTabbedPane。AFX_CBRS_OUTLOOK_TABS

• ドッキング可能なペインを別のウィンドウにドッキングする場合は、メソッドを CDockablePane::DockToWindow 呼び出します。 このメソッドを呼び出す前に、元のウィンドウをどこかにドッキングする必要があります。

• メンバー変数 CDockablePane::m_bHideInAutoHideMode は、呼び出 CDockablePane::ShowPaneし時の自動非表示モードでのドッキング可能ペインの動作を制御します。 このメンバー変数が設定 TRUEされている場合、ドッキング可能ペインとその自動非表示ボタンは非表示になります。 それ以外の場合は、スライドインとスライドアウトが行われます。

• メンバー変数を > にTRUE設定すると、アニメーションの自動非表示をCDockablePane::m_bDisableAnimation無効にできます。

例

次の例では、クラスのさまざまなメソッドを CDockablePane 使用してオブジェクトを構成する方法を CDockablePane 示します。 この例では、ドッキング可能ペインのすべての自動非表示機能を有効にする方法、キャプションまたはグリッパーを有効にする方法、自動非表示モードを有効にする方法、ペインを表示する方法、自動非表示モードのペインをアニメーション化する方法を示します。 このコード スニペットは、Visual Studio デモ サンプルの一部です。

// GetOwner is an inherited method.
CDockablePane *pParentBar = DYNAMIC_DOWNCAST(CDockablePane, GetOwner());

pParentBar->EnableAutohideAll();
pParentBar->EnableGripper(true);
pParentBar->SetAutoHideMode(true, CBRS_ALIGN_LEFT);
pParentBar->ShowPane(true, false, true);
pParentBar->Slide(true);

継承階層

CObject

CCmdTarget

CWnd

CBasePane

CPane

CDockablePane

必要条件

ヘッダー:afxDockablePane.h

CDockablePane::AttachToTabWnd

現在のペインをターゲット ペインにアタッチし、タブ付きペインを作成します。

virtual CDockablePane* AttachToTabWnd(
    CDockablePane* pTabControlBarAttachTo,
    AFX_DOCK_METHOD dockMethod,
    BOOL bSetActive= TRUE,
    CDockablePane** ppTabbedControlBar = NULL);

パラメーター

pTabControlBarAttachTo
[入力、出力]現在のペインがアタッチされているターゲット ペインを指定します。 ターゲット ペインはドッキング可能なペインである必要があります。

dockMethod
[in]ドッキング メソッドを指定します。

bSetActive
[in] TRUEアタッチ操作後にタブ付きペインをアクティブにする場合。それ以外の場合は . FALSE

ppTabbedControlBar
[out]アタッチ操作の結果として表示されるタブ付きペインが含まれます。

戻り値

タブ付きペインでない場合は、現在のペインへのポインター。それ以外の場合は、アタッチ操作の結果としてタブ付きペインへのポインター。 戻り値は、 NULL 現在のウィンドウをアタッチできない場合、またはエラーが発生した場合です。

解説

このメソッドを使用してドッキング可能なペインが別のペインにアタッチされると、次の処理が行われます。

1. フレームワークは、ターゲット ウィンドウが通常のドッキング ウィンドウpTabControlBarAttachToであるか、またはそこから派生CBaseTabbedPaneしているかをチェックします。

2. ターゲット ペインがタブ付きペインの場合、フレームワークは現在のペインをタブとして追加します。

3. ターゲット ペインが通常のドッキング ウィンドウの場合、フレームワークによってタブ付きペインが作成されます。

   • フレームワークが呼び出します pTabControlBarAttachTo->CreateTabbedPane。 新しいタブ付きペインのスタイルは、メンバーによって m_pTabbedControlBarRTC 異なります。 既定では、このメンバーはランタイム クラス CTabbedPaneに設定されます。 スタイルをAFX_CBRS_OUTLOOK_TABSパラメーターとしてメソッドにdwTabbedStyleCDockablePane::Create渡すと、ランタイム クラス オブジェクトは次のCMFCOutlookBarランタイム クラスに設定されます。 このメンバーはいつでも変更して、新しいウィンドウのスタイルを変更できます。

   • このメソッドがタブ付きペインを作成すると、フレームワークはポインターを pTabControlBarAttachTo (ウィンドウが複数のミニフレーム ウィンドウにドッキングまたは浮動している場合)、新しいタブ付きペインへのポインターに置き換えます。

   • フレームワークは、最初の pTabControlBarAttachTo タブとしてタブ付きペインにペインを追加します。その後、フレームワークは現在のウィンドウを 2 番目のタブとして追加します。

4. 現在のペインが派生 CBaseTabbedPaneしている場合、そのすべてのタブが移動 pTabControlBarAttachTo され、現在のペインが破棄されます。 したがって、このメソッドを呼び出すときは、メソッドが戻るときに現在のウィンドウへのポインターが無効になる可能性があるため、注意してください。

ドッキング レイアウトの作成時にペインを別のペインにアタッチする場合は、次の値に設定 dockMethod します DM_SHOW。

別のペインをアタッチする前に、最初のペインをドッキングする必要があります。

CDockablePane::CalcFixedLayout

ウィンドウの四角形のサイズを返します。

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

パラメーター

bStretch
[in] 使用されません。

bHorz
[in] 使用されません。

戻り値

CSizeウィンドウの四角形のサイズを含むオブジェクト。

CDockablePane::CanAcceptMiniFrame

指定したミニフレームをペインにドッキングできるかどうかを決定します。

virtual BOOL CanAcceptMiniFrame(CPaneFrameWnd* pMiniFrame) const;

パラメーター

pMiniFrame
[in]オブジェクトへの CPaneFrameWnd ポインター。

戻り値

TRUE ウィンドウにドッキングできる場合は 〗。それ以外の場合 pMiniFrame は 〗 FALSE。

CDockablePane::CanAcceptPane

別のペインを現在のペインにドッキングできるかどうかを決定します。

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

パラメーター

pBar
[in]現在のペインにドッキングするペインを指定します。

戻り値

TRUE指定したペインをこのペインにドッキングできる場合は 〘。それ以外の場合は . FALSE

解説

フレームワークは、ペインが現在のペインにドッキングされる前に、このメソッドを呼び出します。

特定のペインへのドッキングを有効または無効にするには、派生クラスでこの関数をオーバーライドします。

既定では、このメソッドは、いずれかのpBar場合、またはその親が型CDockablePaneである場合に返しますTRUE。

CDockablePane::CanAutoHide

ペインを自動的に非表示にできるかどうかを指定します。

virtual BOOL CanAutoHide() const;

戻り値

TRUEペインが自動的に非表示にできる場合。それ以外の場合は . FALSE

解説

CDockablePane::CanAutoHide は、 FALSE 次のいずれかの状況で返されます。

• ペインには親がありません。

• ドッキング マネージャーでは、ペインの自動非表示は許可されません。

• ペインはドッキングされていません。

CDockablePane::CanBeAttached

現在のペインを別のペインにドッキングできるかどうかを決定します。

virtual BOOL CanBeAttached() const;

戻り値

TRUEドッキング可能ウィンドウを別のウィンドウまたはメインフレーム ウィンドウにドッキングできる場合は a0/&メイン。FALSEそれ以外の場合は 。

解説

既定では、このメソッドは常に .TRUE 呼び出 CBasePane::EnableDockingさずにドッキングを有効または無効にするには、派生クラスでこのメソッドをオーバーライドします。

CDockablePane::CDockablePane

CDockablePane オブジェクトを構築して初期化します。

CDockablePane();

解説

ドッキング可能なウィンドウ オブジェクトを作成したら、それを呼び出 CDockablePane::Create すか、作成 CDockablePane::CreateEx します。

CDockablePane::ConvertToTabbedDocument

1 つ以上のドッキング可能なペインを MDI タブ付きドキュメントに変換します。

virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);

パラメーター

bActiveTabOnly
[in]変換 CTabbedPaneする場合は、アクティブなタブのみを変換するように指定 TRUE します。ペイン内のすべてのタブを変換するように指定 FALSE します。

CDockablePane::CheckAutoHideCondition

ドッキング ウィンドウを非表示にするかどうかを指定します (自動非表示モードとも呼ばれます)。

virtual BOOL CheckAutoHideCondition();

戻り値

TRUE非表示の条件が満たされている場合。それ以外の場合は . FALSE

解説

フレームワークでは、タイマーを使用して、自動非表示のドッキング可能ウィンドウを非表示にするかどうかを定期的にチェックします。 このメソッドは、ペインがアクティブでない場合、ペインのサイズが変更されていない場合、およびマウス ポインターがウィンドウの上にない場合に返 TRUE されます。

上記のすべての条件が満たされている場合、フレームワークはウィンドウを非表示にする呼び出しを行 CDockablePane::Slide います。

CDockablePane::CheckStopSlideCondition

自動非表示ドッキング ウィンドウがスライドを停止するタイミングを指定します。

virtual BOOL CheckStopSlideCondition(BOOL bDirection);

パラメーター

bDirection
[in] TRUE ウィンドウが表示されている場合は〘。 FALSE ペインが非表示の場合は 。

戻り値

TRUE停止条件が満たされた場合。それ以外の場合は . FALSE

解説

ドッキング可能なペインが自動非表示モードに設定されている場合、フレームワークはスライド効果を使用してペインを表示または非表示にします。 フレームワークは、ウィンドウがスライドしているときにこの関数を呼び出します。 CheckStopSlideCondition は、 TRUE ウィンドウが完全に表示されている場合、または完全に非表示になっている場合に返されます。

カスタム自動非表示効果を実装するには、派生クラスでこのメソッドをオーバーライドします。

CDockablePane::CopyState

ドッキング可能ウィンドウの状態をコピーします。

virtual void CopyState(CDockablePane* pOrgBar);

パラメーター

pOrgBar
[入力] ドッキング可能なペインへのポインター。

解説

CDockablePane::CopyState は、次のメソッドを呼び出して、現在の pOrgBar ウィンドウに状態をコピーします。

• CPane::CopyState

• CDockablePane::GetAHRestoredRect

• CDockablePane::GetAHSlideMode

• CDockablePane::GetLastPercentInPaneContainer

• CDockablePane::IsAutohideAllEnabled

CDockablePane::Create

Windows コントロールを作成し、オブジェクトに CDockablePane アタッチします。

virtual BOOL Create(
    LPCTSTR lpszCaption,
    CWnd* pParentWnd,
    const RECT& rect,
    BOOL bHasGripper,
    UINT nID,
    DWORD dwStyle,
    DWORD dwTabbedStyle = AFX_CBRS_REGULAR_TABS,
    DWORD dwControlBarStyle = AFX_DEFAULT_DOCKING_PANE_STYLE,
    CCreateContext* pContext = NULL);

virtual BOOL Create(
    LPCTSTR lpszWindowName,
    CWnd* pParentWnd,
    CSize sizeDefault,
    BOOL bHasGripper,
    UINT nID,
    DWORD dwStyle = WS_CHILD|WS_VISIBLE|CBRS_TOP|CBRS_HIDE_INPLACE,
    DWORD dwTabbedStyle = AFX_CBRS_REGULAR_TABS,
    DWORD dwControlBarStyle = AFX_DEFAULT_DOCKING_PANE_STYLE);

パラメーター

lpszCaption
[in]ウィンドウ名を指定します。

pParentWnd
[入力、出力]親ウィンドウを指定します。

rect
[in]ウィンドウのサイズと位置をクライアント座標で指定します pParentWnd。

bHasGripper
[in] TRUEキャプションを含むペインを作成する場合は。それ以外の場合は a0/&FALSEキャプション。

nID
[in]子ウィンドウの ID を指定します。 このドッキング ウィンドウのドッキング状態を保存する場合、この値は一意である必要があります。

dwStyle
[in]ウィンドウ スタイル属性を指定します。

dwTabbedStyle
[in]ユーザーがこのウィンドウのキャプション上のウィンドウをドラッグしたときに作成されるタブ付きウィンドウのタブ付きスタイルを指定します。

dwControlBarStyle
[in]追加のスタイル属性を指定します。

pContext
[入力、出力]ウィンドウの作成コンテキストを指定します。

lpszWindowName
[in]ウィンドウ名を指定します。

sizeDefault
[in]ウィンドウのサイズを指定します。

戻り値

TRUEドッキング可能なウィンドウが正常に作成された場合。それ以外の場合は . FALSE

解説

Windows ウィンドウを作成し、オブジェクトに CDockablePane アタッチします。

ウィンドウ スタイルに dwStyle フラグがある CBRS_FLOAT_MULTI 場合、ミニフレーム ウィンドウはミニフレーム ウィンドウ内の他のペインと共に浮動できます。 既定では、ドッキング ウィンドウは個別にのみ浮動できます。

パラメーターに dwTabbedStyle フラグが AFX_CBRS_OUTLOOK_TABS 指定されている場合、別のウィンドウがメソッドを使用してこのウィンドウにアタッチされている場合、ウィンドウは Outlook スタイルのタブ付きペインを CDockablePane::AttachToTabWnd 作成します。 既定では、ドッキング可能なペインでは、通常のタブ付きペインが CTabbedPane作成されます。

CDockablePane::CreateDefaultPaneDivider

フレーム ウィンドウにドッキングされているウィンドウの既定の分割線を作成します。

static CPaneDivider* __stdcall CreateDefaultPaneDivider(
    DWORD dwAlignment,
    CWnd* pParent,
    CRuntimeClass* pSliderRTC = NULL);

パラメーター

dwAlignment
[in]ペインをドッキングするメイン フレームの側面を指定します。 or CBRS_ALIGN_RIGHT フラグがCBRS_ALIGN_LEFT含まれている場合、このメソッドは垂直 (CPaneDivider::SS_VERT) 分割線を作成します。それ以外の場合dwAlignment、このメソッドは水平 (CPaneDivider::SS_HORZ) 分割線を作成します。

pParent
[in]親フレームへのポインター。

pSliderRTC
[in] 使用されません。

戻り値

このメソッドは、新しく作成された分割線へのポインターを返します。または NULL 、分割器の作成が失敗した場合に返されます。

解説

dwAlignment には、次のいずれかの値を指定できます。

Value	説明
CBRS_ALIGN_TOP	ウィンドウは、フレーム ウィンドウのクライアント領域の上部にドッキングされています。
CBRS_ALIGN_BOTTOM	ウィンドウは、フレーム ウィンドウのクライアント領域の下部にドッキングされています。
CBRS_ALIGN_LEFT	ウィンドウは、フレーム ウィンドウのクライアント領域の左側にドッキングされています。
CBRS_ALIGN_RIGHT	ウィンドウは、フレーム ウィンドウのクライアント領域の右側にドッキングされています。

CDockablePane::CreateEx

Windows コントロールを作成し、オブジェクトに CDockablePane アタッチします。

virtual BOOL CreateEx(
    DWORD dwStyleEx,
    LPCTSTR lpszCaption,
    CWnd* pParentWnd,
    const RECT& rect,
    BOOL bHasGripper,
    UINT nID,
    DWORD dwStyle,
    DWORD dwTabbedStyle = AFX_CBRS_REGULAR_TABS,
    DWORD dwControlBarStyle = AFX_DEFAULT_DOCKING_PANE_STYLE,
    CCreateContext* pContext = NULL);

パラメーター

dwStyleEx
[in]新しいウィンドウの拡張スタイル属性を指定します。

lpszCaption
[in]ウィンドウ名を指定します。

pParentWnd
[入力、出力]親ウィンドウを指定します。

rect
[in]ウィンドウのサイズと位置をクライアント座標で指定します pParentWnd。

bHasGripper
[in] TRUEキャプションを含むペインを作成する場合は。それ以外の場合は a0/&FALSEキャプション。

nID
[in]子ウィンドウの ID を指定します。 このドッキング ウィンドウのドッキング状態を保存する場合、この値は一意である必要があります。

dwStyle
[in]ウィンドウ スタイル属性を指定します。

dwTabbedStyle
[in]ユーザーがこのウィンドウのキャプション上のウィンドウをドラッグしたときに作成されるタブ付きウィンドウのタブ付きスタイルを指定します。

dwControlBarStyle
[in]追加のスタイル属性を指定します。

pContext
[入力、出力]ウィンドウの作成コンテキストを指定します。

戻り値

TRUEドッキング可能なウィンドウが正常に作成された場合。それ以外の場合は . FALSE

解説

Windows ウィンドウを作成し、オブジェクトに CDockablePane アタッチします。

ウィンドウ スタイルに dwStyle フラグがある CBRS_FLOAT_MULTI 場合、ミニフレーム ウィンドウはミニフレーム ウィンドウ内の他のペインと共に浮動できます。 既定では、ドッキング ウィンドウは個別にのみ浮動できます。

パラメーターに dwTabbedStyle フラグが AFX_CBRS_OUTLOOK_TABS 指定されている場合、別のウィンドウがメソッドを使用してこのウィンドウにアタッチされている場合、ウィンドウは Outlook スタイルのタブ付きペインを CDockablePane::AttachToTabWnd 作成します。 既定では、ドッキング可能なペインでは、通常のタブ付きペインが CTabbedPane作成されます。

CDockablePane::CreateTabbedPane

現在のペインからタブ付きペインを作成します。

virtual CTabbedPane* CreateTabbedPane();

戻り値

新しいタブ付きペイン、または NULL 作成操作が失敗した場合。

解説

フレームワークは、このウィンドウを置き換えるタブ付きペインを作成するときに、このメソッドを呼び出します。 詳細については、CDockablePane::AttachToTabWndを参照してください。

タブ付きペインの作成と初期化方法をカスタマイズするには、派生クラスでこのメソッドをオーバーライドします。

タブ付きペインは、メソッドによってCDockablePane::CreateEx初期化されるメンバーにm_pTabbedControlBarRTC格納されているランタイム クラス情報に従って作成されます。

CDockablePane::DockPaneContainer

コンテナーをペインにドッキングします。

virtual BOOL DockPaneContainer(
    CPaneContainerManager& barContainerManager,
    DWORD dwAlignment,
    AFX_DOCK_METHOD dockMethod);

パラメーター

barContainerManager
[in]ドッキングされているコンテナーのコンテナー マネージャーへの参照。

dwAlignment
[in] DWORD コンテナーをドッキングするペインの側面を指定する 〗。

dockMethod
[in] 使用されません。

戻り値

TRUEコンテナーがウィンドウに正常にドッキングされた場合。それ以外の場合は . FALSE

解説

dwAlignment には、次のいずれかの値を指定できます。

Value	説明
CBRS_ALIGN_TOP	コンテナーがペインの上部にドッキングされています。
CBRS_ALIGN_BOTTOM	コンテナーはペインの下部にドッキングされています。
CBRS_ALIGN_LEFT	コンテナーはペインの左側にドッキングされています。
CBRS_ALIGN_RIGHT	コンテナーがペインの右側にドッキングされています。

CDockablePane::DockPaneStandard

アウトライン (標準) ドッキングを使用してペインをドッキングします。

virtual CPane* DockPaneStandard(BOOL& bWasDocked);

パラメーター

bWasDocked
[in]メソッドから制御が戻るときに、ウィンドウが正常にドッキングされた場合は、この値に含まれます TRUE 。それ以外の場合は FALSE、

戻り値

ウィンドウがタブ付きウィンドウにドッキングされた場合、またはドッキングの結果としてタブ付きウィンドウが作成された場合、このメソッドはタブ付きウィンドウへのポインターを返します。 ペインが正常にドッキングされた場合、このメソッドはポインターを this 返します。 ドッキングに失敗した場合、このメソッド NULLは .

CDockablePane::DockToRecentPos

保存されているドッキング位置にペインをドッキングします。

BOOL CDockablePane::DockToRecentPos();

戻り値

TRUEペインが正常にドッキングされた場合は〘。それ以外の場合は . FALSE

解説

ドッキング可能ウィンドウには、最近のドッキング情報がオブジェクトに CRecentDockSiteInfo 格納されます。

CDockablePane::DockToWindow

1 つのドッキング ウィンドウを別のドッキング ウィンドウにドッキングします。

virtual BOOL DockToWindow(
    CDockablePane* pTargetWindow,
    DWORD dwAlignment,
    LPCRECT lpRect = NULL);

パラメーター

pTargetWindow
[入力、出力]このペインをドッキングするドッキング可能なペインを指定します。

dwAlignment
[in]ペインのドッキング配置を指定します。 、またはのいずれかをCBRS_ALIGN_LEFTCBRS_ALIGN_BOTTOMCBRS_ALIGN_TOPCBRS_ALIGN_RIGHT指定できます。CBRS_ALIGN_ANY (.で afxres.h定義)

lpRect
[in]ペインのドッキング四角形を指定します。

戻り値

TRUEウィンドウが正常にドッキングされた場合。それ以外の場合は . FALSE

解説

このメソッドを呼び出して、1 つのペインを別のペインにドッキングし、次で指定した配置を指定します dwAlignment。

CDockablePane::DrawCaption

ドッキング ウィンドウのキャプション (グリッパーとも呼ばれます) を描画します。

virtual void DrawCaption(
    CDC* pDC,
    CRect rectCaption);

パラメーター

pDC
[in]描画に使用されるデバイス コンテキストを表します。

rectCaption
[in]ウィンドウのキャプションの外接する四角形を指定します。

解説

フレームワークはこのメソッドを呼び出して、ドッキング可能なウィンドウのキャプションを描画します。

派生クラスでこのメソッドをオーバーライドして、キャプションの外観をカスタマイズします。

CDockablePane::EnableAutohideAll

このペインとコンテナー内の他のペインの自動非表示モードを有効または無効にします。

void EnableAutohideAll(BOOL bEnable = TRUE);

パラメーター

bEnable
[in] TRUEドッキング可能ウィンドウのすべての機能の自動非表示を有効にする場合は、次の操作を行います。それ以外の場合は . FALSE

解説

ユーザーが Ctrl キーを押しながらピン ボタンをクリックしてペインを自動非表示モードに切り替えると、同じコンテナー内の他のすべてのペインも自動非表示モードに切り替わります。

特定のウィンドウに bEnable 対してこの機能を FALSE 無効にするように設定して、このメソッドを呼び出します。

CDockablePane::EnableGripper

キャプション (グリッパーとも呼ばれます) を表示または非表示にします。

virtual void EnableGripper(BOOL bEnable);

パラメーター

bEnable
[in] TRUEキャプションを有効にする場合は a0/&キャプション。それ以外のFALSE場合は 。

解説

フレームワークがドッキング可能なペインを作成する場合、指定されている場合でも、ウィンドウ スタイルはありません WS_STYLE 。 つまり、ウィンドウのキャプションは、フレームワークによって制御されるクライアント以外の領域ですが、この領域は標準ウィンドウのキャプションとは異なります。

キャプションはいつでも表示または非表示にすることができます。 ウィンドウがタブ付きウィンドウにタブとして追加されたとき、またはウィンドウがミニフレーム ウィンドウに浮動している場合、フレームワークはキャプションを非表示にします。

CDockablePane::GetAHRestoredRect

自動非表示モードの場合のペインの位置を指定します。

CRect GetAHRestoredRect() const;

戻り値

CRectウィンドウが自動非表示モードのときのペインの位置を含むオブジェクト。

解説

CDockablePane::GetAHSlideMode

ウィンドウのスライド の自動非表示モードを取得します。

virtual UINT GetAHSlideMode() const;

戻り値

UINTウィンドウのスライドの自動非表示モードを指定する A。 戻り値には、いずれか AFX_AHSM_MOVE を AFX_AHSM_STRETCH指定できますが、実装で使用 AFX_AHSM_MOVEされるのは .

解説

CDockablePane::GetCaptionHeight

現在のキャプションの高さをピクセル単位で返します。

virtual int GetCaptionHeight() const;

戻り値

キャプションの高さ (ピクセル単位)。

解説

キャプションがメソッドによってCDockablePane::EnableGripper非表示にされた場合、またはペインにキャプションがない場合、キャプションの高さは 0 です。

CDockablePane::GetDefaultPaneDivider

ペインのコンテナーの既定のウィンドウ分割線を返します。

CPaneDivider* GetDefaultPaneDivider() const;

戻り値

ドッキング可能ウィンドウがメインフレーム ウィンドウにドッキングされている場合、またはNULLドッキング可能ウィンドウがドッキングされていない場合、またはドッキング可能なウィンドウが浮動している場合は、有効CPaneDividerなオブジェクト。

解説

ウィンドウ分割線の詳細については、「クラス」を参照してください。CPaneDivider

CDockablePane::GetDockingStatus

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

virtual AFX_CS_STATUS GetDockingStatus(
    CPoint pt,
    int nSensitivity);

パラメーター

pt
[入力] ポインターの画面座標位置。

nSensitivity
[in]四角形の端から離れた距離 (ピクセル単位) は、ドッキングを有効にするためにポインターが必要です。

戻り値

次のいずれかの状態値。

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。

CDockablePane::GetDragSensitivity

ドッキング ウィンドウのドラッグ感度を返します。

static const CSize& GetDragSensitivity();

戻り値

CSizeドラッグ ポイントを中心とする四角形の幅と高さをピクセル単位で格納するオブジェクト。 ドラッグ操作は、マウス ポインターがこの四角形の外側に移動するまで開始されません。

CDockablePane::GetLastPercentInPaneContainer

ペインがコンテナー ( CPaneContainer クラス) 内で占める領域の割合を取得します。

int GetLastPercentInPaneContainer() const;

戻り値

intペインがコンテナー内で占める領域の割合を指定する値。

解説

このメソッドは、コンテナーがそのレイアウトを調整するときに使用されます。

CDockablePane::GetTabArea

ウィンドウのタブ領域を取得します。

virtual void GetTabArea(
    CRect& rectTabAreaTop,
    CRect& rectTabAreaBottom) const;

パラメーター

rectTabAreaTop
[in] GetTabArea タブがペインの上部にある場合は、この変数にタブ領域が入力されます。 タブがペインの下部にある場合、この変数は空の四角形で塗りつぶされます。

rectTabAreaBottom
[in] GetTabArea ペインの下部にタブがある場合は、この変数にタブ領域が表示されます。 タブがウィンドウの上部にある場合、この変数は空の四角形で塗りつぶされます。

解説

このメソッドは、タブから CDockablePane 派生し、タブを持つクラスでのみ使用されます。 詳細については、次のトピックを参照してください。 CTabbedPane::GetTabArea および CMFCOutlookBar::GetTabArea

CDockablePane::GetTabbedPaneRTC

別のペインが現在のペインにドッキングされるときに作成されるタブ付きウィンドウに関するランタイム クラス情報を返します。

CRuntimeClass* GetTabbedPaneRTC() const;

戻り値

ドッキング可能ウィンドウのランタイム クラス情報。

解説

動的に作成されるタブ付きペインのランタイム クラス情報を取得するには、このメソッドを呼び出します。 これは、ユーザーが 1 つのペインを別のペインのキャプションにドラッグした場合、またはメソッドを呼び出CDockablePane::AttachToTabWndして、2 つのドッキング可能なペインからタブ付きペインをプログラムで作成する場合に発生する可能性があります。

ランタイム クラス情報は、メソッドを呼び出 CDockablePane::SetTabbedPaneRTC すことによって設定できます。

CDockablePane::HasAutoHideMode

ドッキング ウィンドウを自動非表示モードに切り替えることができるかどうかを指定します。

virtual BOOL HasAutoHideMode() const;

戻り値

TRUEドッキング可能なウィンドウを自動非表示モードに切り替えることができる場合。それ以外の場合は . FALSE

解説

特定のドッキング可能ウィンドウの自動非表示モードを無効にするには、派生クラスでこのメソッドをオーバーライドします。

CDockablePane::HitTest

ユーザーがマウスをクリックするペイン内の場所を指定します。

virtual int HitTest(
    CPoint point,
    BOOL bDetectCaption = FALSE);

パラメーター

point
[in]テストするポイントを指定します。

bDetectCaption
[in] TRUEポイントがHTCAPTIONペインのキャプションにある場合は返す必要があります。それ以外の場合FALSEは .

戻り値

次のいずれかの値:

• HTNOWHERE ドッキング可能ウィンドウに表示されない場合 point は 。

• HTCLIENT がドッキング可能ペインのクライアント領域にある場合 point は〘。

• HTCAPTIONがドッキング可能ウィンドウのキャプション領域にある場合pointはϑ。

• AFX_HTCLOSE 閉じるボタンに表示されている場合 point は 。

• HTMAXBUTTON ピン ボタンに表示されている場合 point は〘。

CDockablePane::IsAutohideAllEnabled

ドッキング ウィンドウとコンテナー内の他のすべてのペインを自動非表示モードに切り替えることができるかどうかを示します。

virtual BOOL IsAutohideAllEnabled() const;

戻り値

TRUEドッキング可能なペインとコンテナー内の他のすべてのペインを自動非表示モードに切り替えることができる場合。それ以外の場合は . FALSE

解説

Ctrl キーを押しながらドッキング ピン ボタンをクリックして、ユーザーが自動非表示モードを有効にする

この動作を有効または無効にするには、メソッドを CDockablePane::EnableAutohideAll 呼び出します。

CDockablePane::IsAutoHideMode

ペインが自動非表示モードかどうかを指定します。

virtual BOOL IsAutoHideMode() const;

戻り値

TRUEドッキング可能ウィンドウが自動非表示モードの場合は 〗。それ以外の場合は . FALSE

CDockablePane::IsDocked

現在のウィンドウがドッキングされているかどうかを判断します。

virtual BOOL IsDocked() const;

戻り値

TRUE ドッキング可能なウィンドウがミニフレーム ウィンドウに属していない場合、または別のウィンドウがあるミニフレーム ウィンドウに浮動している場合。 FALSE ペインがミニフレーム ウィンドウの子であり、ミニフレーム ウィンドウに属する他のペインがない場合。

解説

ウィンドウが メイン フレーム ウィンドウにドッキングされているかどうかを確認するには、次を呼び出しますCDockablePane::GetDefaultPaneDivider。 メソッドが非NULLポインターを返す場合、ウィンドウはメインフレーム ウィンドウにドッキングされます。

CDockablePane::IsHideInAutoHideMode

呼び出 CDockablePane::ShowPaneしによって表示 (または非表示) されている場合に、自動非表示モードのペインの動作を決定します。

virtual BOOL IsHideInAutoHideMode() const;

戻り値

TRUE自動非表示モードのときにドッキング可能なペインを非表示にする必要がある場合。それ以外の場合は . FALSE

解説

ドッキング可能なペインが自動非表示モードの場合、ペインを非表示または表示するために呼び出 ShowPane すと動作が異なります。 この動作は静的メンバー CDockablePane::m_bHideInAutoHideModeによって制御されます。 このメンバーが存在する場合、 TRUEドッキング可能ウィンドウとそれに関連する自動非表示ツール バーまたは自動非表示ボタンは、呼び出 ShowPaneし時に非表示または表示されます。 それ以外の場合、ドッキング可能ウィンドウはアクティブ化または非アクティブ化され、関連する自動非表示ツール バーまたは自動非表示ボタンが常に表示されます。

派生クラスでこのメソッドをオーバーライドして、個々のペインの既定の動作を変更します。

m_bHideInAutoHideMode の既定値は FALSE です。

CDockablePane::IsInFloatingMultiPaneFrameWnd

ペインが複数ウィンドウ フレーム ウィンドウ ( CMultiPaneFrameWnd Class) 内にあるかどうかを指定します。

virtual BOOL IsInFloatingMultiPaneFrameWnd() const;

戻り値

TRUEペインがマルチペイン フレーム ウィンドウ内にある場合は 〘。それ以外の場合は . FALSE

解説

CDockablePane::IsResizable

ウィンドウのサイズを変更できるかどうかを指定します。

virtual BOOL IsResizable() const;

戻り値

TRUEウィンドウのサイズが変更可能な場合は〘。それ以外の場合は . FALSE

解説

既定では、ドッキング可能なウィンドウはサイズ変更可能です。 サイズ変更を防ぐには、派生クラスでこのメソッドをオーバーライドして返します FALSE。 値がFALSE失敗ASSERTCPane::DockPaneする可能性があることに注意してください。 代わりに、親フレーム内にペインをドッキングするために使用 CDockingManager::AddPane します。

サイズを変更できないペインは、浮動モードでも自動非表示モードにもならず、常に親フレームの外側の端に配置されます。

CDockablePane::IsTabLocationBottom

タブをウィンドウの上部または下部に配置するかどうかを指定します。

virtual BOOL IsTabLocationBottom() const;

戻り値

TRUE タブがウィンドウの下部に配置されている場合。 FALSE タブがウィンドウの上部にある場合は 。

解説

詳細については、CTabbedPane::IsTabLocationBottomを参照してください。

CDockablePane::IsTracked

ユーザーがウィンドウを移動するかどうかを指定します。

BOOL IsTracked() const;

戻り値

TRUEペインを移動する場合は〘。それ以外の場合は . FALSE

CDockablePane::IsVisible

現在のウィンドウが表示されるかどうかを決定します。

virtual BOOL IsVisible() const;

戻り値

TRUEドッキング可能ウィンドウが表示されている場合は 〗。それ以外の場合は . FALSE

解説

このメソッドを呼び出して、ドッキング可能ウィンドウが表示されているかどうかを確認します。 スタイルの呼び出し CWnd::IsWindowVisible やテストの代わりに、このメソッドを WS_VISIBLE 使用できます。 返される可視性の状態は、自動非表示モードが有効か無効か、およびプロパティの CDockablePane::IsHideInAutoHideMode 値によって異なります。

ドッキング可能ウィンドウが自動非表示モードIsHideInAutoHideModeで、表示状態が常FALSEに返FALSEされる場合。

ドッキング可能ウィンドウが自動非表示モード IsHideInAutoHideMode で表示状態を返す TRUE 場合は、関連する自動非表示ツール バーの表示状態によって異なります。

ドッキング可能ウィンドウが自動非表示モードでない場合、表示状態はメソッドによって CBasePane::IsVisible 決定されます。

## CDockablePane::LoadState

社外秘。 詳細については、Visual Studio インストールのフォルダーにある mfc ソース コードを参照してください。 たとえば、「 %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc 」のように入力します。

virtual BOOL LoadState(
   LPCTSTR lpszProfileName = NULL,
   int nIndex = -1,
   UINT uiID = (UINT) -1
);

CDockablePane::m_bDisableAnimation

ドッキング可能ペインの自動非表示アニメーションを無効にするかどうかを指定します。

AFX_IMPORT_DATA static BOOL m_bDisableAnimation;

CDockablePane::m_bHideInAutoHideMode

ペインが自動非表示モードの場合のペインの動作を決定します。

AFX_IMPORT_DATA static BOOL m_bHideInAutoHideMode;

解説

この値は、アプリケーション内のすべてのドッキング ウィンドウに影響します。

このメンバーを TRUE設定すると、ドッキング可能なペインは、呼び出 CDockablePane::ShowPaneし時に、関連する自動非表示ツール バーとボタンと共に非表示または表示されます。

このメンバーを FALSE設定すると、呼び出 CDockablePane::ShowPaneし時にドッキング可能ペインがアクティブ化または非アクティブ化されます。

CDockablePane::m_nSlideSteps

ペインが自動非表示モードの場合のアニメーション速度を指定します。

AFX_IMPORT_DATA static int m_nSlideSteps;

解説

アニメーション効果を速くするには、この値を小さくします。 アニメーション効果を遅くするには、この値を大きくします。

CDockablePane::OnAfterChangeParent

詳細については、Visual Studio インストールのフォルダーにある mfc ソース コードを参照してください。 たとえば、「 %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc 」のように入力します。

virtual void OnAfterChangeParent(CWnd* pWndOldParent);

パラメーター

[入力] pWndOldParent\

解説

CDockablePane::OnAfterDockFromMiniFrame

フローティング ドッキング バーがフレーム ウィンドウにドッキングされるときにフレームワークによって呼び出されます。

virtual void OnAfterDockFromMiniFrame();

解説

既定では、このメソッドは何も実行しません。

CDockablePane::OnBeforeChangeParent

フレームワークは、ウィンドウの親を変更する前に、このメソッドを呼び出します。

virtual void OnBeforeChangeParent(
    CWnd* pWndNewParent,
    BOOL bDelay = FALSE);

パラメーター

pWndNewParent
[in]新しい親ウィンドウへのポインター。

bDelay
[in]ペインがドッキング解除されている場合にドッキング レイアウトの再計算を遅延するかどうかを指定する BOOL。 詳細については、CDockablePane::UndockPaneを参照してください。

解説

ペインがドッキングされていて、新しい親がドッキングを許可していない場合、このメソッドはペインのドッキングを解除します。

ウィンドウをタブ付きドキュメントに変換する場合、このメソッドは最近のドッキング位置を格納します。 フレームワークは、最近のドッキング位置を使用して、ペインがドッキング状態に戻されたときにペインの位置を復元します。

CDockablePane::OnBeforeFloat

ウィンドウがフローティング状態に遷移する前に、フレームワークはこのメソッドを呼び出します。

virtual BOOL OnBeforeFloat(
    CRect& rectFloat,
    AFX_DOCK_METHOD dockMethod);

パラメーター

rectFloat
[in]ウィンドウが浮動状態の場合の位置とサイズを指定します。

dockMethod
[in]ドッキング メソッドを指定します。 使用可能な値の一覧を参照してください CPane::DockPane 。

戻り値

TRUEペインを浮動可能な場合は〘。それ以外の場合は . FALSE

解説

このメソッドは、ペインが浮動しようとしているときにフレームワークによって呼び出されます。 ペインが浮動する前に処理を実行する場合は、派生クラスでこのメソッドをオーバーライドできます。

CDockablePane::OnPressButtons

ユーザーがボタン以外のキャプション ボタンをAFX_HTCLOSE押すと呼びAFX_HTMAXBUTTON出されます。

virtual void OnPressButtons(UINT nHit);

パラメーター

nHit
[in]このパラメーターは使用されません。

解説

ドッキング可能ウィンドウのキャプションにカスタム ボタンを追加する場合は、ユーザーがボタンを押したときに通知を受け取るためにこのメソッドをオーバーライドします。

CDockablePane::OnSlide

ウィンドウが自動非表示モードのときにペインをアニメーション化するためにフレームワークによって呼び出されます。

virtual void OnSlide(BOOL bSlideOut);

パラメーター

bSlideOut
[in] TRUE ウィンドウを表示するには、 FALSE をクリックしてペインを非表示にします。

解説

カスタム自動非表示効果を実装するには、派生クラスでこのメソッドをオーバーライドします。

CDockablePane::RemoveFromDefaultPaneDividier

ウィンドウがドッキング解除されている場合、フレームワークはこのメソッドを呼び出します。

void RemoveFromDefaultPaneDividier();

解説

このメソッドは、既定のウィンドウ分割線を NULL 設定し、そのコンテナーからペインを削除します。

CDockablePane::ReplacePane

ペインを指定したペインに置き換えます。

BOOL ReplacePane(
    CDockablePane* pBarToReplaceWith,
    AFX_DOCK_METHOD dockMethod,
    BOOL bRegisterWithFrame = FALSE);

パラメーター

pBarToReplaceWith
[入力] ドッキング可能なペインへのポインター。

dockMethod
[in] 使用されません。

bRegisterWithFrame
[in]場合 TRUEは、新しいペインが古いペインの親のドッキング マネージャーに登録されます。 新しいペインは、ドッキング マネージャーによってメインされたペインの一覧の古いペインのインデックスに挿入されます。

戻り値

TRUE置換が成功した場合。それ以外の場合は . FALSE

CDockablePane::RestoreDefaultPaneDivider

ウィンドウが逆シリアル化されると、フレームワークはこのメソッドを呼び出して、既定のウィンドウ分割線を復元します。

void RestoreDefaultPaneDivider();

解説

復元された既定のウィンドウ分割線は、現在の既定のウィンドウ分割線 (存在する場合) に置き換えられます。

CDockablePane::SetAutoHideMode

ドッキング ウィンドウを表示モードと自動非表示モードの間で切り替えます。

virtual CMFCAutoHideBar* SetAutoHideMode(
    BOOL bMode,
    DWORD dwAlignment,
    CMFCAutoHideBar* pCurrAutoHideBar = NULL,
    BOOL bUseTimer = TRUE);

パラメーター

bMode
[in] TRUE 自動非表示モードを有効にするには、 FALSE 通常のドッキング モードを有効にします。

dwAlignment
[in]作成する自動非表示ペインの配置を指定します。

pCurrAutoHideBar
[入力、出力]現在の自動非表示ツール バーへのポインター。 NULL の可能性があります。

bUseTimer
[in]ユーザーがウィンドウを自動非表示モードに切り替えたときに自動非表示効果を使用するか、ペインをすぐに非表示にするかを指定します。

戻り値

自動非表示モードに切り替えた結果として作成された自動非表示ツール バー。NULL

解説

フレームワークは、ユーザーがピン ボタンをクリックしてドッキング可能ウィンドウを自動非表示モードまたは通常のドッキング モードに切り替えるときに、このメソッドを呼び出します。

このメソッドを呼び出して、ドッキング可能なウィンドウをプログラムで自動非表示モードに切り替えます。 ウィンドウは、メイン フレーム ウィンドウにドッキングする必要があります (CDockablePane::GetDefaultPaneDivider有効なポインターをCPaneDivider返す必要があります)。

CDockablePane::SetAutoHideParents

ペインの自動非表示ボタンと自動非表示ツールバーを設定します。

void SetAutoHideParents(
    CMFCAutoHideBar* pToolBar,
    CMFCAutoHideButton* pBtn);

パラメーター

pToolBar
[in]自動非表示ツール バーへのポインター。

pBtn
[in]自動非表示ボタンへのポインター。

CDockablePane::SetLastPercentInPaneContainer

コンテナー内のペインが占める領域の割合を設定します。

void SetLastPercentInPaneContainer(int n);

パラメーター

n
[in] int ペインがコンテナー内で占める領域の割合を指定する値。

解説

フレームワークは、レイアウトの再計算時に新しい値を使用するようにウィンドウを調整します。

CDockablePane::SetRestoredDefaultPaneDivider

復元された既定のウィンドウ分割線を設定します。

void SetRestoredDefaultPaneDivider(HWND hRestoredSlider);

パラメーター

hRestoredSlider
[in]ウィンドウ分割線 (スライダー) へのハンドル。

解説

復元された既定のウィンドウ分割線は、ペインが逆シリアル化されるときに取得されます。 詳細については、CDockablePane::RestoreDefaultPaneDividerを参照してください。

CDockablePane::SetTabbedPaneRTC

2 つのペインが一緒にドッキングされるときに作成されるタブ付きウィンドウのランタイム クラス情報を設定します。

void SetTabbedPaneRTC(CRuntimeClass* pRTC);

パラメーター

pRTC
[in]タブ付きペインのランタイム クラス情報。

解説

動的に作成されるタブ付きペインのランタイム クラス情報を設定するには、このメソッドを呼び出します。 これは、ユーザーが 1 つのペインを別のペインのキャプションにドラッグした場合、またはメソッドを呼び出CDockablePane::AttachToTabWndして、2 つのドッキング可能なペインからタブ付きペインをプログラムで作成する場合に発生する可能性があります。

既定のランタイム クラスは、次のパラメーターにdwTabbedStyle従って設定されますCDockablePane::CreateEx。CDockablePane::Create 新しいタブ付きペインをカスタマイズするには、次のいずれかのクラスからクラスを派生させます。

• CBaseTabbedPane クラス

• CTabbedPane クラス

• CMFCOutlookBar クラス。

次に、ランタイム クラス情報へのポインターを使用してこのメソッドを呼び出します。

CDockablePane::ShowPane

ペインの表示と非表示を切り替えます。

virtual void ShowPane(
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

パラメーター

bShow
[in] TRUE ウィンドウを表示するには、 FALSE をクリックしてペインを非表示にします。

bDelay
[in] TRUE ドッキングレイアウトの調整を遅らせる; FALSE をクリックすると、ドッキング レイアウトがすぐに調整されます。

bActivate
[in] TRUE表示されたらペインをアクティブにします。それ以外の場合は . FALSE

解説

ドッキング可能なペインを CWnd::ShowWindow 表示または非表示にする代わりに、このメソッドを呼び出します。

CDockablePane::Slide

自動非表示モードのペインをアニメーション化します。

virtual void Slide(
    BOOL bSlideOut,
    BOOL bUseTimer = TRUE);

パラメーター

bSlideOut
[in] TRUE ウィンドウを表示するには、 FALSE をクリックしてペインを非表示にします。

bUseTimer
[in] TRUE 自動非表示効果を持つペインを表示または非表示にする場合は、次の操作を行います。 FALSE ウィンドウをすぐに表示または非表示にします。

解説

フレームワークは、このメソッドを呼び出して、自動非表示モードのペインをアニメーション化します。

このメソッドは、値を CDockablePane::m_nSlideDefaultTimeOut 使用して、スライド効果のタイムアウトを決定します。 タイムアウトの既定値は 1 です。 自動非表示アルゴリズムをカスタマイズする場合は、このメンバーを変更してタイムアウトを変更します。

CDockablePane::ToggleAutoHide

ウィンドウを常に表示モードと自動非表示モードの間で切り替えます。

virtual void ToggleAutoHide();

解説

このメソッドは、呼び出 CDockablePane::SetAutoHideModeすことによってペインの自動非表示モードを切り替えます。

CDockablePane::UndockPane

メイン フレーム ウィンドウまたはミニフレーム ウィンドウ コンテナーからペインをドッキング解除します。

virtual void UndockPane(BOOL bDelay = FALSE);

パラメーター

bDelay
[in] TRUE ドッキングレイアウトの計算を遅らせる場合。 FALSE をクリックすると、ドッキング レイアウトが直ちに再計算されます。

解説

このメソッドを呼び出して、メイン フレーム ウィンドウまたはマルチミニフレーム ウィンドウ コンテナー (他のウィンドウを含む 1 つのミニフレーム ウィンドウに浮動するペイン) からウィンドウをドッキング解除します。

によって実行されない外部操作を実行する前に、ペインのドッキングを解除する CDockingManager必要があります。 たとえば、プログラムによってある場所から別の場所に移動するには、ウィンドウのドッキングを解除する必要があります。

フレームワークは、ペインが破棄される前に自動的にドッキングを解除します。

関連項目

階層図
クラス
CPane クラス