CDockablePane クラス

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

class CDockablePane : public CPane

メンバー

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

[名前]

説明

CDockablePane::CDockablePane

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

パブリック メソッド

[名前]

説明

CDockablePane::AttachToTabWnd

ペインを別のペインにアタッチします。 これによって、タブ付きペインが作成されます。

CDockablePane::CalcFixedLayout

  (CBasePane::CalcFixedLayout をオーバーライドします。)

CDockablePane::CanAcceptMiniFrame

 

CDockablePane::CanAcceptPane

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

CDockablePane::CanAdjustLayout

 

CDockablePane::CanAutoHide

ペインが自動非表示モードをサポートするかどうかを判定します。 (CBasePane::CanAutoHide をオーバーライドします。)

CDockablePane::CanBeAttached

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

CDockablePane::ConvertToTabbedDocument

  (CPane::ConvertToTabbedDocument をオーバーライドします。)

CDockablePane::CopyState

  (CPane::CopyState をオーバーライドします。)

CDockablePane::Create

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

CDockablePane::CreateDefaultPaneDivider

 

CDockablePane::CreateEx

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

CDockablePane::CreateTabbedPane

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

CDockablePane::DockPaneContainer

 

CDockablePane::DockPaneStandard

  (CPane::DockPaneStandard をオーバーライドします。)

CDockablePane::DockToFrameWindow

  (CPane::DockToFrameWindow をオーバーライドします。)

CDockablePane::DockToRecentPos

 

CDockablePane::DockToWindow

ドッキング ペインを別のドッキング ペインにドッキングします。

CDockablePane::EnableAutohideAll

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

CDockablePane::EnableGripper

キャプション (グリップ) を表示または非表示にします。

CDockablePane::GetAHRestoredRect

 

CDockablePane::GetAHSlideMode

 

CDockablePane::GetAutoHideButton

 

CDockablePane::GetAutoHideToolBar

 

CDockablePane::GetCaptionHeight

現在のキャプションの高さを返します。

CDockablePane::GetDefaultPaneDivider

ペインのコンテナーの既定のペイン区分線を返します。

CDockablePane::GetDockingStatus

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

CDockablePane::GetDragSensitivity

ドッキング ペインのドラッグ感度を返します。

CDockablePane::GetLastPercentInPaneContainer

 

CDockablePane::GetRecentSiblingPaneInfo

 

CDockablePane::GetTabArea

 

CDockablePane::GetTabbedPaneRTC

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

CDockablePane::HasAutoHideMode

ドッキング ペインを自動非表示モードに切り替えられるかどうかを指定します。

CDockablePane::HitTest

ペイン内でユーザーがマウスをクリックした特定の位置を指定します。

CDockSite::IsAccessibilityCompatible

  (CBasePane::IsAccessibilityCompatible をオーバーライドします。)

CDockablePane::IsAutoHideMode

ペインが自動的に隠すモードかどうかを判断します。

CDockablePane::IsAutohideAllEnabled

ドッキング ペインとコンテナー内の他のすべてのペインを、自動非表示モードで配置できるかどうかを示します。

CDockablePane::IsChangeState

  (CPane::IsChangeState をオーバーライドします。)

CDockablePane::IsDocked

現在のペインがドッキングされているかどうかを判定します。

CDockablePane::IsDrawCaption

 

CDockablePane::IsHideDisabledButtons

 

CDockablePane::IsHideInAutoHideMode

ShowPane を呼び出してペインの表示と非表示を切り替える場合、自動非表示モードのペインの動作を決定します。

CDockablePane::IsInFloatingMultiPaneFrameWnd

  (CPane::IsInFloatingMultiPaneFrameWnd をオーバーライドします。)

CDockablePane::IsResizable

  (CPane::IsResizable をオーバーライドします。)

CDockablePane::IsTabLocationBottom

 

CDockablePane::IsTracked

 

CDockablePane::IsVisible

現在のペインの表示状態を判定します。

CDockablePane::LoadState

  (CPane::LoadState をオーバーライドします。)

CDockablePane::OnAfterChangeParent

ペインの親が変更されたときに、フレームワークによって呼び出されます。 (CPane::OnAfterChangeParent をオーバーライドします。)

CDockablePane::OnAfterDockFromMiniFrame

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

CDockablePane::OnBeforeChangeParent

ペインの親が変更される直前に、フレームワークによって呼び出されます。 (CPane::OnBeforeChangeParent をオーバーライドします。)

CDockablePane::OnBeforeFloat

ペインがフローティング状態になる直前に、フレームワークによって呼び出されます (CPane::OnBeforeFloat をオーバーライドします)。

CDockablePane::OnUpdateCmdUI

  (CBasePane::OnUpdateCmdUI をオーバーライドします。)

CDockablePane::PreTranslateMessage

  (CBasePane::PreTranslateMessage をオーバーライドします。)

CDockablePane::RemoveFromDefaultPaneDividier

 

CDockablePane::ReplacePane

 

CDockablePane::RestoreDefaultPaneDivider

 

CDockablePane::SaveState

  (CPane::SaveState をオーバーライドします。)

CDockablePane::Serialize

  (CBasePane::Serialize をオーバーライドします。)

CDockablePane::SetAutoHideMode

ドッキング ペインの表示モードと自動非表示モードを切り替えます。

CDockablePane::SetAutoHideParents

 

CDockablePane::SetCaptionStyle

 

CDockablePane::SetDefaultPaneDivider

 

CDockablePane::SetLastPercentInPaneContainer

 

CDockablePane::SetResizeMode

 

CDockablePane::SetRestoredDefaultPaneDivider

 

CDockablePane::SetTabbedPaneRTC

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

CDockablePane::ShowPane

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

CDockablePane::Slide

ペインが自動非表示モードの場合にのみ表示するスライド アニメーションを備えたペインを表示または非表示にします。

CDockablePane::ToggleAutoHide

自動非表示モードに切り替えます。  (CPane::ToggleAutoHide をオーバーライドします。)

CDockablePane::UndockPane

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

CDockablePane::UnSetAutoHideMode

 

プロテクト メソッド

[名前]

説明

CDockablePane::CheckAutoHideCondition

ドッキング ペインが非表示 (自動非表示モード) かどうかを判断します。

CDockablePane::CheckStopSlideCondition

自動的に隠すドッキング ペインがスライドをいつ停止するかを判断します。

CDockablePane::DrawCaption

ドッキング ペイン キャプション (グリップ) を描画します。

CDockablePane::OnPressButtons

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

CDockablePane::OnSlide

ペインが表示または非表示にされているときに自動非表示スライド効果を表示するために、フレームワークによって呼び出されます。

データ メンバー

[名前]

説明

CDockablePane::m_bDisableAnimation

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

CDockablePane::m_bHideInAutoHideMode

ペインが自動的に隠すモードのときに、ペインの動作を決定します。

CDockablePane::m_nSlideSteps

自動非表示モードでペインが表示または非表示にされているときのペインのアニメーション速度を指定します。

解説

CDockablePane は次の機能を実装します。

  • メイン フレーム ウィンドウへのペインのドッキング。

  • 自動非表示モードへのペインの切り替え。

  • タブ付きウィンドウへのペインのアタッチ。

  • ミニフレームウィンドウでのペインの切り離し。

  • ミニフレーム ウィンドウにおける浮動ペインの、別のペインへのドッキング。

  • ペインのサイズ変更。

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

    注意

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

  • キャプション付きまたはキャプションなしのペインの作成。 キャプションには、テキスト ラベルを設定できます。また、キャプションをグラデーションの色で塗りつぶすことができます。

  • ペインのコンテンツ表示中のペインのドラッグ。

  • ドラッグ四角形の表示中のペインのドラッグ。

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

カスタマイズのヒント

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

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

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

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

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

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

使用例

CDockablePane クラスのさまざまなメソッドを使用して CDockablePane オブジェクトを構成する方法を次の例に示します。 この例では、ドッキング可能ペインのすべての機能の自動非表示を有効にする方法、キャプションまたはグリッパーを有効にする方法、自動非表示モードを有効にする方法、ペインを表示する方法、および自動非表示モードのペインをアニメーション化する方法を示しています。 このコード スニペットは、「VisualStudioDemo サンプル:MFC 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

参照

参照

階層図

CPane クラス

その他の技術情報

MFC クラス