CPaneFrameWnd クラス

詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。

1 つのペインを含むミニフレーム ウィンドウを実装します。 そのペインは、ウィンドウのクライアント領域になります。

構文

class CPaneFrameWnd : public CWnd

メンバー

パブリック メソッド

名前	説明
CPaneFrameWnd::AddPane	ペインを追加します。
CPaneFrameWnd::AddRemovePaneFromGlobalList	グローバル リストに対してペインを追加または削除します。
CPaneFrameWnd::AdjustLayout	ミニフレーム ウィンドウのレイアウトを調整します。
CPaneFrameWnd::AdjustPaneFrames
CPaneFrameWnd::CalcBorderSize	ミニフレーム ウィンドウの境界線のサイズを計算します。
CPaneFrameWnd::CalcExpectedDockedRect	ドッキング ウィンドウの予想される四角形を計算します。
CPaneFrameWnd::CanBeAttached	現在のペインを別のペインまたはフレーム ウィンドウにドッキングできるかどうかを判定します。
CPaneFrameWnd::CanBeDockedToPane	ミニフレーム ウィンドウをペインにドッキングできるかどうかを判定します。
CPaneFrameWnd::CheckGripperVisibility
CPaneFrameWnd::ConvertToTabbedDocument	ペインをタブ付きドキュメントに変換します。
CPaneFrameWnd::Create	ミニフレーム ウィンドウを作成し、CPaneFrameWnd オブジェクトにアタッチします。
CPaneFrameWnd::CreateEx	ミニフレーム ウィンドウを作成し、CPaneFrameWnd オブジェクトにアタッチします。
CPaneFrameWnd::D ockPane	ペインをドッキングします。
CPaneFrameWnd::FindFloatingPaneByID	フローティング ペインのグローバル リストで、指定したコントロール ID のペインを検索します。
CPaneFrameWnd::FrameFromPoint	ユーザーが指定したポイントを含むミニフレーム ウィンドウを検索します。
CPaneFrameWnd::GetCaptionHeight	ミニフレーム ウィンドウのキャプションの高さを返します。
CPaneFrameWnd::GetCaptionRect	ミニフレーム ウィンドウのキャプションに外接する四角形を計算します。
CPaneFrameWnd::GetCaptionText	キャプション テキストを返します。
CPaneFrameWnd::GetDockingManager
CPaneFrameWnd::GetDockingMode	ドッキングのモードを返します。
CPaneFrameWnd::GetFirstVisiblePane	ミニフレーム ウィンドウに含まれる最初の可視ペインを返します。
CPaneFrameWnd::GetHotPoint
CPaneFrameWnd::GetPane	ミニフレーム ウィンドウに含まれるペインを返します。
CPaneFrameWnd::GetPaneCount	ミニフレーム ウィンドウに含まれるペインの数を返します。
CPaneFrameWnd::GetParent
CPaneFrameWnd::GetPinState
CPaneFrameWnd::GetRecentFloatingRect
CPaneFrameWnd::GetVisiblePaneCount	ミニフレーム ウィンドウに含まれる可視ペインの数を返します。
CPaneFrameWnd::HitTest	特定のポイントに、ミニフレーム ウィンドウのどの部分があるか判定します。
CPaneFrameWnd::IsCaptured
CPaneFrameWnd::IsDelayShow
CPaneFrameWnd::IsRollDown	ミニフレーム ウィンドウをロール ダウンするかどうかを判断します。
CPaneFrameWnd::IsRollUp	ミニフレーム ウィンドウをロール アップするかどうかを判断します。
CPaneFrameWnd::KillDockingTimer	ドッキング タイマーを停止します。
CPaneFrameWnd::LoadState	レジストリからペインの状態を読み込みます。
CPaneFrameWnd::OnBeforeDock	ドッキングが可能かどうかを判定します。
CPaneFrameWnd::OnDockToRecentPos	ミニフレーム ウィンドウを直前の位置にドッキングします。
CPaneFrameWnd::OnKillRollUpTimer	ロールアップ タイマーを停止します。
CPaneFrameWnd::OnMovePane	ミニフレーム ウィンドウを指定したオフセットだけ移動します。
CPaneFrameWnd::OnPaneRecalcLayout	含まれているペインのレイアウトを調整します。
CPaneFrameWnd::OnSetRollUpTimer	ロールアップ タイマーを設定します。
CPaneFrameWnd::OnShowPane	ミニフレーム ウィンドウ内のペインが非表示になるとき、または表示されるときに、フレームワークによって呼び出されます。
CPaneFrameWnd::P aneFromPoint	ユーザーが指定した位置がミニフレーム ウィンドウ内のペインに含まれている場合、そのペインを返します。
CPaneFrameWnd::P in
CPaneFrameWnd::PreTranslateMessage	TranslateMessage および DispatchMessage の各 Windows 関数にディスパッチされる前に、ウィンドウ メッセージを変換するためにクラス CWinApp で使用されます。
CPaneFrameWnd::RedrawAll	すべてのミニフレーム ウィンドウを再描画します。
CPaneFrameWnd::RemoveNonValidPanes	有効でないウィンドウを削除するために、フレームワークによって呼び出されます。
CPaneFrameWnd::RemovePane	ミニフレーム ウィンドウから、ペインを削除します。
CPaneFrameWnd::ReplacePane	ペインを別のペインに置き換えます。
CPaneFrameWnd::SaveState	レジストリにペインの状態を保存します。
CPaneFrameWnd::Serialize	アーカイブに対して、このオブジェクトの読み取りまたは書き込みを行います。
CPaneFrameWnd::SetCaptionButtons	キャプションのボタンを設定します。
CPaneFrameWnd::SetDelayShow
CPaneFrameWnd::SetDockingManager
CPaneFrameWnd::SetDockingTimer	ドッキング タイマーを設定します。
CPaneFrameWnd::SetDockState	ドッキング状態を設定します。
CPaneFrameWnd::SetHotPoint
CPaneFrameWnd::SetPreDockState	ドッキング前の状態を設定するために、フレームワークによって呼び出されます。
CPaneFrameWnd::SizeToContent	含まれているペインとサイズを同じにするために、ミニフレーム ウィンドウのサイズを調整します。
CPaneFrameWnd::StartTearOff	メニューをティアオフします。
CPaneFrameWnd::StoreRecentDockSiteInfo
CPaneFrameWnd::StoreRecentTabRelatedInfo

保護メソッド

名前	説明
CPaneFrameWnd::OnCheckRollState	ミニフレーム ウィンドウをロール アップまたはロール ダウンするかどうかを判断します。
CPaneFrameWnd::OnDrawBorder	ミニフレーム ウィンドウの境界線を描画します。

データ メンバー

名前	説明
CPaneFrameWnd::m_bUseSaveBits	ウィンドウ クラスを CS_SAVEBITS クラス スタイルに登録するかどうかを指定します。

解説

ペインがドッキング状態からフローティング状態に切り替わるときに、フレームワークは自動的に CPaneFrameWnd オブジェクトを作成します。

ミニフレーム ウィンドウは内容を表示した状態でドラッグ (直接ドッキング) するか、ドラッグ四角形を使用してドラッグ (標準ドッキング) することができます。 ミニフレームのコンテナー ペインのドッキング モードにより、ミニフレームのドラッグ動作が決まります。 詳細については、「CBasePane::GetDockingMode」を参照してください。

ミニフレーム ウィンドウには、含まれているペインのスタイルに従って、キャプションのボタンが表示されます。 ペインを閉じることができる場合 (CBasePane::CanBeClosed)、[閉じる] ボタンが表示されます。 ペインのスタイルが AFX_CBRS_AUTO_ROLLUP である場合、ピンが表示されます。

CPaneFrameWnd からクラスを派生させる場合は、フレームワークで作成方法を定義する必要があります。 CPane::CreateDefaultMiniframe をオーバーライドしてクラスを作成するか、クラスのランタイム クラス情報を指すように CPane::m_pMiniFrameRTC メンバーを設定します。

継承階層

CObject

CCmdTarget

CWnd

CPaneFrameWnd

要件

ヘッダー: afxPaneFrameWnd.h

CPaneFrameWnd::AddPane

ペインを追加します。

virtual void AddPane(CBasePane* pWnd);

パラメーター

pWnd
[入力] 追加するペイン。

CPaneFrameWnd::AddRemovePaneFromGlobalList

グローバル リストに対してペインを追加または削除します。

static BOOL __stdcall AddRemovePaneFromGlobalList(
    CBasePane* pWnd,
    BOOL bAdd);

パラメーター

pWnd
[入力] 追加または削除するペイン。

bAdd
[入力] 0 以外の場合、ペインを追加します。 0 の場合、ペインを削除します。

戻り値

メソッドが成功した場合は 0 以外、それ以外の場合は 0。

CPaneFrameWnd::AdjustLayout

ミニフレーム ウィンドウのレイアウトを調整します。

virtual void AdjustLayout();

CPaneFrameWnd::AdjustPaneFrames

virtual void AdjustPaneFrames();

解説

CPaneFrameWnd::CalcBorderSize

ミニフレーム ウィンドウの境界線のサイズを計算します。

virtual void CalcBorderSize(CRect& rectBorderSize) const;

パラメーター

rectBorderSize
[出力] ミニフレーム ウィンドウの境界線のサイズ (ピクセル単位) を含みます。

解説

このメソッドは、ミニフレーム ウィンドウの境界線のサイズを計算するためにフレームワークによって呼び出されます。 返されるサイズは、ミニフレーム ウィンドウにツール バーまたは CDockablePane のどちらが含まれているかによって異なります。

CPaneFrameWnd::CalcExpectedDockedRect

ドッキング ウィンドウの予想される四角形を計算します。

virtual void CalcExpectedDockedRect(
    CWnd* pWndToDock,
    CPoint ptMouse,
    CRect& rectResult,
    BOOL& bDrawTab,
    CDockablePane** ppTargetBar);

パラメーター

pWndToDock
[入力] ドッキングするウィンドウへのポインター。

ptMouse
[入力] マウスの位置。

rectResult
[出力] 計算される四角形。

bDrawTab
[出力] TRUE の場合、タブが描画されます。FALSE の場合、タブは描画されません。

ppTargetBar
[出力] ターゲット ペインへのポインター。

解説

このメソッドでは、ユーザーがウィンドウを、ptMouse で指定されたポイントにドラッグし、そこにドッキングした場合にウィンドウが占有する四角形を計算します。

CPaneFrameWnd::CanBeAttached

現在のペインを別のペインまたはフレーム ウィンドウにドッキングできるかどうかを判定します。

virtual BOOL CanBeAttached() const;

戻り値

ペインを別のペインまたはフレーム ウィンドウにドッキングできる場合は TRUE、それ以外の場合は FALSE。

CPaneFrameWnd::CanBeDockedToPane

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

virtual BOOL CanBeDockedToPane(const CDockablePane* pDockingBar) const;

パラメーター

pDockingBar
[入力] ペイン。

戻り値

ミニフレームを pDockingBar にドッキングできる場合は 0 以外、それ以外の場合は 0。

CPaneFrameWnd::CheckGripperVisibility

virtual void CheckGripperVisibility();

解説

CPaneFrameWnd::ConvertToTabbedDocument

ペインをタブ付きドキュメントに変換します。

virtual void ConvertToTabbedDocument();

CPaneFrameWnd::Create

ミニフレーム ウィンドウを作成し、CPaneFrameWnd オブジェクトにアタッチします。

virtual BOOL Create(
    LPCTSTR lpszWindowName,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    CCreateContext* pContext = NULL);

パラメーター

lpszWindowName
[入力] ミニフレーム ウィンドウで表示するテキストを指定します。

dwStyle
[入力] ウィンドウのスタイルを指定します。 詳細については、「ウィンドウ スタイル」を参照してください。

rect
[入力] ミニフレーム ウィンドウの初期サイズと位置を指定します。

pParentWnd
[入力、出力] ミニフレーム ウィンドウの親フレームを指定します。 この値を NULL にすることはできません。

pContext
[入力、出力] ユーザー定義のコンテキストを指定します。

戻り値

ウィンドウが正常に作成された場合は TRUE、それ以外の場合は FALSE。

解説

ミニフレーム ウィンドウは、2 つのステップで作成されます。 最初に、フレームワークは CPaneFrameWnd オブジェクトを作成します。 次に、Create が呼び出され、Windows ミニフレーム ウィンドウを作成し、CPaneFrameWnd オブジェクトにアタッチします。

CPaneFrameWnd::CreateEx

ミニフレーム ウィンドウを作成し、CPaneFrameWnd オブジェクトにアタッチします。

virtual BOOL CreateEx(
    DWORD dwStyleEx,
    LPCTSTR lpszWindowName,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    CCreateContext* pContext=NULL);

パラメーター

dwStyleEx
[入力] 拡張ウィンドウ スタイルを指定します。 詳細については、「拡張ウィンドウ スタイル」を参照してください

lpszWindowName
[入力] ミニフレーム ウィンドウで表示するテキストを指定します。

dwStyle
[入力] ウィンドウのスタイルを指定します。 詳細については、「ウィンドウ スタイル」を参照してください。

rect
[入力] ミニフレーム ウィンドウの初期サイズと位置を指定します。

pParentWnd
[入力、出力] ミニフレーム ウィンドウの親フレームを指定します。 この値を NULL にすることはできません。

pContext
[入力、出力] ユーザー定義のコンテキストを指定します。

戻り値

ウィンドウが正常に作成された場合は TRUE、それ以外の場合は FALSE。

解説

ミニフレーム ウィンドウは、2 つのステップで作成されます。 最初に、フレームワークは CPaneFrameWnd オブジェクトを作成します。 次に、Create が呼び出され、Windows ミニフレーム ウィンドウを作成し、CPaneFrameWnd オブジェクトにアタッチします。

CPaneFrameWnd::D ockPane

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

virtual CDockablePane* DockPane(BOOL& bWasDocked);

パラメーター

bWasDocked
[出力] ペインが既にドッキングされている場合は TRUE、それ以外の場合は FALSE。

戻り値

操作が成功した場合は、ペインがドッキングされた CDockablePane、それ以外の場合は NULL。

CPaneFrameWnd::FindFloatingPaneByID

フローティング ペインのグローバル リストで、指定したコントロール ID のペインを検索します。

static CBasePane* FindFloatingPaneByID(UINT nID);

パラメーター

nID
[入力] 検索するペインのコントロール ID を表します。

戻り値

指定されたコントロール ID を持つペイン、指定されたコントロール ID を持つペインがない場合は NULL。

CPaneFrameWnd::FrameFromPoint

指定されたポイントを含むミニフレーム ウィンドウを検索します。

static CPaneFrameWnd* __stdcall FrameFromPoint(
    CPoint pt,
    int nSensitivity,
    CPaneFrameWnd* pFrameToExclude = NULL,
    BOOL bFloatMultiOnly = FALSE);

パラメーター

pt
[入力] ポイント (画面座標)。

nSensitivity
[入力] ミニフレーム ウィンドウの検索領域をこのサイズで増やします。 特定のポイントが増加領域に入った場合、ミニフレーム ウィンドウは検索条件を満たします。

pFrameToExclude
[入力] 検索から除外するミニフレーム ウィンドウを指定します。

bFloatMultiOnly
[入力] TRUE の場合、CBRS_FLOAT_MULTI スタイルを持つミニフレーム ウィンドウのみを検索します。 FALSE の場合、すべてのミニフレーム ウィンドウを検索します。

戻り値

pt を含むミニフレーム ウィンドウへのポインター、それ以外の場合は NULL。

CPaneFrameWnd::GetCaptionHeight

ミニフレーム ウィンドウのキャプションの高さを返します。

virtual int GetCaptionHeight() const;

戻り値

ミニフレーム ウィンドウの高さ (ピクセル単位)。

解説

このメソッドを呼び出して、ミニフレーム ウィンドウの高さを決定します。 既定では、高さは SM_CYSMCAPTION に設定されます。 詳細については、「GetSystemMetrics 関数」を参照してください。

CPaneFrameWnd::GetCaptionRect

ミニフレーム ウィンドウのキャプションに外接する四角形を計算します。

virtual void GetCaptionRect(CRect& rectCaption) const;

パラメーター

rectCaption
[出力] ミニフレーム ウィンドウのキャプションのサイズと位置 (画面座標) を含みます。

解説

このメソッドは、ミニフレーム ウィンドウのキャプションの境界ボックスを計算するためにフレームワークによって呼び出されます。

CPaneFrameWnd::GetCaptionText

キャプション テキストを返します。

virtual CString GetCaptionText();

戻り値

ミニフレーム ウィンドウのキャプション テキスト。

解説

このメソッドは、フレームワークでキャプション テキストを表示する場合にフレームワークによって呼び出されます。

CPaneFrameWnd::GetDockingManager

CDockingManager* GetDockingManager() const;

戻り値

解説

CPaneFrameWnd::GetDockingMode

ドッキングのモードを返します。

virtual AFX_DOCK_TYPE GetDockingMode() const;

戻り値

ドッキング モード。 次のいずれかの値です。

• DT_STANDARD

• DT_IMMEDIATE

• DT_SMART

CPaneFrameWnd::GetFirstVisiblePane

ミニフレーム ウィンドウに含まれる最初の可視ペインを返します。

virtual CWnd* GetFirstVisiblePane() const;

戻り値

ミニフレーム ウィンドウ内の最初のペイン。ミニフレーム ウィンドウにペインが含まれていない場合は NULL。

CPaneFrameWnd::GetHotPoint

CPoint GetHotPoint() const;

戻り値

解説

CPaneFrameWnd::GetPane

ミニフレーム ウィンドウに含まれるペインを返します。

virtual CWnd* GetPane() const;

戻り値

ミニフレームに含まれるペイン。ミニフレーム ウィンドウにペインが含まれていない場合は NULL。

解説

CPaneFrameWnd::GetPaneCount

ミニフレーム ウィンドウに含まれるペインの数を返します。

virtual int GetPaneCount() const;

戻り値

ミニフレーム ウィンドウ内のペインの数。 この値には 0 を指定できます。

解説

CPaneFrameWnd::GetParent

CWnd* GetParent();

戻り値

解説

CPaneFrameWnd::GetPinState

BOOL GetPinState() const;

戻り値

解説

CPaneFrameWnd::GetRecentFloatingRect

CRect GetRecentFloatingRect() const;

戻り値

解説

CPaneFrameWnd::GetVisiblePaneCount

ミニフレーム ウィンドウに含まれる可視ペインの数を返します。

virtual int GetVisiblePaneCount() const;

戻り値

表示されるペインの数。

解説

CPaneFrameWnd::HitTest

特定のポイントに、ミニフレーム ウィンドウのどの部分があるか判定します。

virtual LRESULT HitTest(
    CPoint point,
    BOOL bDetectCaption);

パラメーター

point
[入力] テストするポイント。

bDetectCaption
[入力] TRUE の場合、ポイントをキャプションに照らしてチェックします。 FALSE の場合、キャプションは無視されます。

戻り値

次のいずれかの値です。

Value	意味
HTNOWHERE	ポイントは、ミニフレーム ウィンドウの外側にあります。
HTCLIENT	ポイントは、クライアント領域内にあります。
HTCAPTION	ポイントは、キャプション上にあります。
HTTOP	ポイントは、上部にあります。
HTTOPLEFT	ポイントは、左上にあります。
HTTOPRIGHT	ポイントは、右上にあります。
HTLEFT	ポイントは、左側にあります。
HTRIGHT	ポイントは、右側にあります。
HTBOTTOM	ポイントは、下部にあります。
HTBOTTOMLEFT	ポイントは、左下にあります。
HTBOTTOMRIGHT	ポイントは、右下にあります。

CPaneFrameWnd::IsCaptured

BOOL IsCaptured() const;

戻り値

解説

CPaneFrameWnd::IsDelayShow

BOOL IsDelayShow() const;

戻り値

解説

CPaneFrameWnd::IsRollDown

ミニフレーム ウィンドウをロール ダウンするかどうかを判断します。

virtual BOOL IsRollDown() const;

戻り値

ミニフレーム ウィンドウをロールダウンする必要がある場合は TRUE、それ以外の場合は FALSE。

解説

このメソッドは、ミニフレーム ウィンドウをロールダウンする必要があるかどうかを決定するためにフレームワークによって呼び出されます。 ミニフレーム ウィンドウに AFX_CBRS_AUTO_ROLLUP フラグを持つペインが少なくとも 1 つ含まれている場合は、ミニフレーム ウィンドウに対してロールアップおよびロールダウン機能が有効になります。 このフラグは、ペインが作成されるときに設定されます。 詳細については、「CBasePane::CreateEx」を参照してください。

フレームワークでは、既定により、マウス ポインターがミニフレーム ウィンドウの境界ボックス内にあるかどうかをチェックして、ウィンドウをロールダウンする必要があるかどうかを決定します。 派生クラスでは、この動作をオーバーライドできます。

CPaneFrameWnd::IsRollUp

ミニフレーム ウィンドウをロール アップするかどうかを判断します。

virtual BOOL IsRollUp() const;

戻り値

ミニフレーム ウィンドウをロールアップする必要がある場合は TRUE、それ以外の場合は FALSE。

解説

このメソッドは、ミニフレーム ウィンドウをロールアップする必要があるかどうかを決定するためにフレームワークによって呼び出されます。 ミニフレーム ウィンドウに AFX_CBRS_AUTO_ROLLUP フラグを持つペインが少なくとも 1 つ含まれている場合は、ミニフレーム ウィンドウに対してロールアップおよびロールダウン機能が有効になります。 このフラグは、ペインが作成されるときに設定されます。 詳細については、「CBasePane::CreateEx」を参照してください。

フレームワークでは、既定により、マウス ポインターが、ミニフレーム ウィンドウの境界ボックス内にあるかどうかをチェックして、ウィンドウをロールアップする必要があるかどうかを決定します。 派生クラスでは、この動作をオーバーライドできます。

CPaneFrameWnd::KillDockingTimer

ドッキング タイマーを停止します。

void KillDockingTimer();

CPaneFrameWnd::LoadState

レジストリからペインの状態を読み込みます。

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

パラメーター

lpszProfileName
[入力] プロファイル名。

uiID
[入力] ペイン ID。

戻り値

ペインの状態が正常に読み込まれた場合は TRUE、それ以外の場合は FALSE。

CPaneFrameWnd::m_bUseSaveBits

CS_SAVEBITS クラス スタイルを持つウィンドウ クラスを登録するかどうかを指定します。

AFX_IMPORT_DATA static BOOL m_bUseSaveBits;

解説

CS_SAVEBITS スタイルを持つミニフレーム ウィンドウ クラスを登録するには、この静的メンバーを TRUE に設定します。 これは、ユーザーがミニフレーム ウィンドウをドラッグするときにちらつきを減らすのに役立ちます。

CPaneFrameWnd::OnBeforeDock

ドッキングが可能かどうかを判定します。

virtual BOOL OnBeforeDock();

戻り値

ドッキングが可能な場合は TRUE、それ以外の場合は FALSE。

CPaneFrameWnd::OnCheckRollState

ミニフレーム ウィンドウをロール アップまたはロール ダウンするかどうかを判断します。

virtual void OnCheckRollState();

解説

このメソッドは、ミニフレーム ウィンドウをロールアップまたはロールダウンする必要があるかどうかを決定するためにフレームワークによって呼び出されます。

フレームワークでは、既定により、CPaneFrameWnd::IsRollUp および CPaneFrameWnd::IsRollDown を呼び出して、ミニフレーム ウィンドウを拡大または復元します。 派生クラスでは、このメソッドをオーバーライドして、別のビジュアル効果を使用できます。

CPaneFrameWnd::OnDockToRecentPos

ミニフレーム ウィンドウを直前の位置にドッキングします。

virtual void OnDockToRecentPos();

CPaneFrameWnd::OnDrawBorder

ミニフレーム ウィンドウの境界線を描画します。

virtual void OnDrawBorder(CDC* pDC);

パラメーター

pDC
[入力] 境界の描画に使用されるデバイス コンテキスト。

解説

このメソッドは、ミニフレーム ウィンドウの境界を描画するためにフレームワークによって呼び出されます。

CPaneFrameWnd::OnKillRollUpTimer

ロールアップ タイマーを停止します。

virtual void OnKillRollUpTimer();

CPaneFrameWnd::OnMovePane

ミニフレーム ウィンドウを指定したオフセットだけ移動します。

virtual void OnMovePane(
    CPane* pBar,
    CPoint ptOffset);

パラメーター

pBar
[入力] ペインへのポインター (無視されます)。

ptOffset
[入力] ペインの移動に使用するオフセット。

CPaneFrameWnd::OnPaneRecalcLayout

ミニフレーム ウィンドウ内のペインのレイアウトを調整します。

virtual void OnPaneRecalcLayout();

解説

フレームワークでは、ミニフレーム ウィンドウ内のペインのレイアウトを調整する必要がある場合にこのメソッドが呼び出されます。

既定では、ペインは、ミニフレーム ウィンドウのクライアント領域全体をカバーするように位置付けられます。

CPaneFrameWnd::OnSetRollUpTimer

ロールアップ タイマーを設定します。

virtual void OnSetRollUpTimer();

CPaneFrameWnd::OnShowPane

ミニフレーム ウィンドウ内のペインが非表示になるとき、または表示されるときに、フレームワークによって呼び出されます。

virtual void OnShowPane(
    CDockablePane* pBar,
    BOOL bShow);

パラメーター

pBar
[入力] 表示する、または非表示にするペイン。

bShow
[入力] ペインを表示する場合は TRUE、ペインを非表示にする場合は FALSE。

解説

ミニフレーム ウィンドウ内のペインを表示するか、非表示にする場合にフレームワークによって呼び出されます。 既定の実装では、何も行われません。

CPaneFrameWnd::P in

void Pin(BOOL bPin = TRUE);

パラメーター

[入力] bPin

解説

CPaneFrameWnd::P aneFromPoint

ユーザーが指定した位置がミニフレーム ウィンドウ内のペインに含まれている場合、そのペインを返します。

virtual CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    BOOL bCheckVisibility);

パラメーター

point
[入力] ユーザーがクリックしたポイント (画面座標)。

nSensitivity
[入力] このパラメーターは使用しません。

bCheckVisibility
[入力] 表示されるペインのみを返す必要がある場合は TRUE、それ以外の場合は FALSE。

戻り値

ユーザーがクリックしたペイン。その位置にペインがない場合は NULL。

解説

このメソッドを呼び出して、特定のポイントを含むペインを取得します。

CPaneFrameWnd::RedrawAll

すべてのミニフレーム ウィンドウを再描画します。

static void RedrawAll();

解説

このメソッドでは、各ウィンドウに対して CWnd::RedrawWindow を呼び出すことにより、すべてのミニフレーム ウィンドウを更新します。

CPaneFrameWnd::RemoveNonValidPanes

有効でないウィンドウを削除するために、フレームワークによって呼び出されます。

virtual void RemoveNonValidPanes();

CPaneFrameWnd::RemovePane

ミニフレーム ウィンドウから、ペインを削除します。

virtual void RemovePane(
    CBasePane* pWnd,
    BOOL bDestroy = FALSE,
    BOOL bNoDelayedDestroy = FALSE);

パラメーター

pWnd
[入力] 削除するペインへのポインター。

bDestroy
[入力] ミニフレーム ウィンドウで実行される動作を指定します。 bDestroy が TRUE の場合、このメソッドにより、ミニフレーム ウィンドウが即座に破棄されます。 FALSE の場合、ミニフレーム ウィンドウは、一定の延期期間後に、このメソッドによって破棄されます。

bNoDelayedDestroy
[入力] TRUE の場合、延期された破棄は無効です。 FALSE の場合、延期された破棄は有効です。

解説

フレームワークによって、ミニフレーム ウィンドウを即座に破棄することも、一定の延期期間後に破棄することもできます。 ミニフレーム ウィンドウの破棄を延期する場合は、bNoDelayedDestroy パラメーターで FALSE を渡します。 延期された破棄は、フレームワークで AFX_WM_CHECKEMPTYMINIFRAME メッセージを処理するときに発生します。

CPaneFrameWnd::ReplacePane

ペインを別のペインに置き換えます。

virtual void ReplacePane(
    CBasePane* pBarOrg,
    CBasePane* pBarReplaceWith);

パラメーター

pBarOrg
[入力] 元のペインへのポインター。

pBarReplaceWith
[入力] 元のペインに置き換わるペインへのポインター。

CPaneFrameWnd::SaveState

レジストリにペインの状態を保存します。

virtual BOOL SaveState(
    LPCTSTR lpszProfileName = NULL,
    UINT uiID = (UINT) -1);

パラメーター

lpszProfileName
[入力] プロファイル名。

uiID
[入力] ペイン ID。

戻り値

ペインの状態が正常に保存された場合は TRUE、それ以外の場合は FALSE。

CPaneFrameWnd::SetCaptionButtons

キャプションのボタンを設定します。

virtual void SetCaptionButtons(DWORD dwButtons);

パラメーター

dwButtons
[入力] 次の値のビット演算 OR の組み合わせ。

• AFX_CAPTION_BTN_CLOSE

• AFX_CAPTION_BTN_PIN

• AFX_CAPTION_BTN_MENU

• AFX_CAPTION_BTN_CUSTOMIZE

CPaneFrameWnd::SetDelayShow

void SetDelayShow(BOOL bDelayShow);

パラメーター

[入力] bDelayShow

解説

CPaneFrameWnd::SetDockingManager

void SetDockingManager(CDockingManager* pManager);

パラメーター

[入力] pManager

解説

CPaneFrameWnd::SetDockingTimer

ドッキング タイマーを設定します。

void SetDockingTimer(UINT nTimeOut);

パラメーター

nTimeOut
[入力] タイムアウト値 (ミリ秒)。

CPaneFrameWnd::SetDockState

ドッキング状態を設定します。

virtual void SetDockState(CDockingManager* pDockManager);

パラメーター

pDockManager
[入力] ドッキング マネージャーへのポインター。

CPaneFrameWnd::SetHotPoint

void SetHotPoint(CPoint& ptNew);

パラメーター

[入力] ptNew

解説

CPaneFrameWnd::SetPreDockState

ドッキング前の状態を設定するために、フレームワークによって呼び出されます。

virtual BOOL SetPreDockState(
    AFX_PREDOCK_STATE preDockState,
    CBasePane* pBarToDock = NULL,
    AFX_DOCK_METHOD dockMethod = DM_MOUSE);

パラメーター

preDockState
[入力] 使用可能な値:

• PDS_NOTHING、

• PDS_DOCK_REGULAR、

• PDS_DOCK_TO_TAB

pBarToDock
[入力] ドッキングするペインへのポインター。

dockMethod
[入力] ドッキング メソッド (このパラメーターは無視されます)。

戻り値

ミニフレーム ウィンドウがドッキング解除されている場合は TRUE、ドッキングされている場合は FALSE。

CPaneFrameWnd::SizeToContent

含まれているペインと同じサイズになるように、ミニフレーム ウィンドウのサイズを調整します。

virtual void SizeToContent();

解説

このメソッドを呼び出して、ミニフレーム ウィンドウのサイズを、含まれているペインのサイズに調整します。

CPaneFrameWnd::StartTearOff

メニューをティアオフします。

BOOL StartTearOff(CMFCPopu* pMenu);

パラメーター

pMenu
[入力] メニューへのポインター。

戻り値

メソッドが成功した場合は TRUE、それ以外の場合は FALSE。

CPaneFrameWnd::StoreRecentDockSiteInfo

virtual void StoreRecentDockSiteInfo(CPane* pBar);

パラメーター

[入力] pBar

解説

CPaneFrameWnd::StoreRecentTabRelatedInfo

virtual void StoreRecentTabRelatedInfo(
    CDockablePane* pDockingBar,
    CDockablePane* pTabbedBar);

パラメーター

[入力] pDockingBar
[入力] pTabbedBar

解説

関連項目

階層図
クラス
CWnd クラス