Share via


CBasePane クラス

MFC のすべてのペインの基本クラス。

構文

class CBasePane : public CWnd

メンバー

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

名前 説明
CBasePane::CBasePane 既定のコンストラクターです。
CBasePane::~CBasePane デストラクターです。

パブリック メソッド

名前 説明
CBasePane::accHitTest 画面上の指定された位置にある子要素または子オブジェクトを取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::accHitTest.)
CBasePane::accLocation 指定したオブジェクトの現在の画面の場所を取得するためにフレームワークによって呼び出されます。 (オーバーライド CWnd::accLocation.)
CBasePane::AccNotifyObjectFocusEvent CBasePane は、このメソッドを使用しません。
CBasePane::accSelect 選択を変更するため、または指定されたオブジェクトのキーボード フォーカスを移動するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::accSelect.)
CBasePane::AddPane ドッキング マネージャーにウィンドウを追加します。
CBasePane::AdjustDockingLayout ドッキング マネージャーに呼び出しをリダイレクトして、ドッキング レイアウトを調整します。
CBasePane::AdjustLayout ウィンドウが内部レイアウトを調整する必要があるときに、フレームワークによって呼び出されます。
CBasePane::CalcFixedLayout コントロール バーの水平サイズを計算します。
CBasePane::CanAcceptPane 別のペインをペインにドッキングできるかどうかを決定します。
CBasePane::CanAutoHide ペインが自動非表示モードをサポートするかどうかを指定します。
CBasePane::CanBeAttached ペインを別のペインにドッキングできるかどうかを決定します。
CBasePane::CanBeClosed ウィンドウを閉じることができるかどうかを指定します。
CBasePane::CanBeDocked ペインを別のペインにドッキングできるかどうかを決定します。
CBasePane::CanBeResized ウィンドウのサイズを変更できるかどうかを決定します。
CBasePane::CanBeTabbedDocument ウィンドウを MDI タブ付きドキュメントに変換できるかどうかを指定します。
CBasePane::CanFloat ペインを浮動可能にするかどうかを指定します。
CBasePane::CanFocus ウィンドウがフォーカスを受け取ることができるかどうかを指定します。
CBasePane::CopyState 特定のペインの状態をコピーします。
CBasePane::CreateDefaultMiniframe ウィンドウが浮動できる場合は、ミニフレーム ウィンドウを作成します。
CBasePane::CreateEx ペイン コントロールを作成します。
CBasePane::D ockPane ペインを別のペインまたはフレーム ウィンドウにドッキングします。
CBasePane::D ockPaneUsingRTTI 実行時の型情報を使用してペインをドッキングします。
CBasePane::D ockToFrameWindow ドッキング可能なウィンドウをフレームにドッキングします。
CBasePane::D oesAllowDynInsertBefore このペインと親フレームの間に別のペインを動的に挿入できるかどうかを決定します。
CBasePane::EnableDocking ウィンドウのメイン フレームへのドッキングを有効にします。
CBasePane::EnableGripper グリッパーを有効または無効にします。 グリッパーが有効になっている場合、ユーザーはそれをドラッグしてペインの位置を変更できます。
CBasePane::FillWindowRect 内部使用。
CBasePane::FloatPane ウィンドウを浮動表示します。
CBasePane::get_accChild 指定された子の IDispatch インターフェイスのアドレスを取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accChild.)
CBasePane::get_accChildCount このオブジェクトに属する子の数を取得するためにフレームワークによって呼び出されます。 (オーバーライド CWnd::get_accChildCount.)
CBasePane::get_accDefaultAction オブジェクトの既定のアクションを記述する文字列を取得するためにフレームワークによって呼び出されます。 (オーバーライド CWnd::get_accDefaultAction.)
CBasePane::get_accDescription 指定されたオブジェクトの外観を記述する文字列を取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accDescription.)
CBasePane::get_accFocus キーボード フォーカスを保持するオブジェクトを取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accFocus.)
CBasePane::get_accHelp オブジェクトのヘルプ プロパティ文字列を取得するためにフレームワークによって呼び出されます。 (オーバーライド CWnd::get_accHelp.)
CBasePane::get_accHelpTopic 指定したオブジェクトに関連付けられている WinHelp ファイルの完全なパスと、そのファイル内の適切なトピックの識別子を取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accHelpTopic.)
CBasePane::get_accKeyboardShortcut オブジェクトの指定したショートカット キーを取得するためにフレームワークによって呼び出されます。 (オーバーライド CWnd::get_accKeyboardShortcut.)
CBasePane::get_accName 指定されたオブジェクトの名前を取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accName.)
CBasePane::get_accParent オブジェクトの親のインターフェイスを IDispatch 取得するためにフレームワークによって呼び出されます。 (オーバーライド CWnd::get_accParent.)
CBasePane::get_accRole 指定されたオブジェクトの役割を記述する情報を取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accRole.)
CBasePane::get_accSelection このオブジェクトの選択されている子を取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accSelection.)
CBasePane::get_accState 指定されたオブジェクトの現在の状態を取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accState.)
CBasePane::get_accValue 指定されたオブジェクトの値を取得するために、フレームワークによって呼び出されます。 (オーバーライド CWnd::get_accValue.)
CBasePane::GetCaptionHeight キャプションの高さを返します。
CBasePane::GetControlBarStyle コントロール バーのスタイルを返します。
CBasePane::GetCurrentAlignment 現在のペインの配置を返します。
CBasePane::GetDockingMode ペインの現在のドッキング モードを返します。
CBasePane::GetDockSiteFrameWnd ウィンドウのドッキング サイトであるウィンドウへのポインターを返します。
CBasePane::GetEnabledAlignment ウィンドウに適用されるCBRS_ALIGN_スタイルを返します。
CBasePane::GetMFCStyle MFC に固有のウィンドウ スタイルを返します。
CBasePane::GetPaneIcon ウィンドウ アイコンへのハンドルを返します。
CBasePane::GetPaneRect 内部使用。
CBasePane::GetPaneRow ウィンドウがドッキングされている CDockingPanesRowオブジェクトへのポインターを返します。
CBasePane::GetPaneStyle ペイン スタイルを返します。
CBasePane::GetParentDockSite 親ドッキング サイトへのポインターを返します。
CBasePane::GetParentMiniFrame 親ミニフレーム ウィンドウへのポインターを返します。
CBasePane::GetParentTabbedPane 親タブ付きペインへのポインターを返します。
CBasePane::GetParentTabWnd タブ内にある親ウィンドウへのポインターを返します。
CBasePane::GetRecentVisibleState フレームワークは、ウィンドウがアーカイブから復元されるときに、このメソッドを呼び出します。
CBasePane::HideInPrintPreviewMode 印刷プレビューでペインを非表示にするかどうかを指定します。
CBasePane::InsertPane 指定されたペインがドッキング マネージャーに登録されます。
CBasePane::IsAccessibilityCompatible ウィンドウがアクティブなアクセシビリティをサポートするかどうかを指定します。
CBasePane::IsAutoHideMode ペインが自動非表示モードかどうかを指定します。
CBasePane::IsDialogControl ウィンドウがダイアログ コントロールかどうかを指定します。
CBasePane::IsDocked ペインをドッキングするかどうかを指定します。
CBasePane::IsFloating ペインが浮動かどうかを判断します。
CBasePane::IsHorizontal ウィンドウを水平方向にドッキングするかどうかを決定します。
CBasePane::IsInFloatingMultiPaneFrameWnd ペインが複数ウィンドウ フレーム ウィンドウ内にあるかどうかを指定します。
CBasePane::IsMDITabbed ウィンドウがタブ付きドキュメントとして MDI 子ウィンドウに追加されているかどうかを確認します。
CBasePane::IsPaneVisible ウィンドウにWS_VISIBLE フラグを設定するかどうかを指定します。
CBasePane::IsPointNearDockSite 指定されたポイントがドッキング サイトに近いかどうかを決定します。
CBasePane::IsResizable ウィンドウのサイズを変更できるかどうかを決定します。
CBasePane::IsRestoredFromRegistry ウィンドウがレジストリから復元されるかどうかを判断します。
CBasePane::IsTabbed タブ付きウィンドウのタブ コントロールにペインが挿入されているかどうかを確認します。
CBasePane::IsTooltipTopmost 内部使用。
CBasePane::IsVisible ウィンドウが表示されるかどうかを決定します。
CBasePane::LoadState レジストリからペインの状態を読み込みます。
CBasePane::MoveWindow ウィンドウを移動します。
CBasePane::OnAfterChangeParent ウィンドウの親が変更されたときにフレームワークによって呼び出されます。
CBasePane::OnBeforeChangeParent ウィンドウが親ウィンドウを変更する直前に、フレームワークによって呼び出されます。
CBasePane::OnDrawCaption フレームワークは、キャプションが描画されるときにこのメソッドを呼び出します。
CBasePane::OnMovePaneDivider このメソッドは現在使用されていません。
CBasePane::OnPaneContextMenu ペインの一覧を含むメニューを構築するときにフレームワークによって呼び出されます。
CBasePane::OnRemoveFromMiniFrame ウィンドウが親ミニ フレーム ウィンドウから削除されたときにフレームワークによって呼び出されます。
CBasePane::OnSetAccData CBasePane は、このメソッドを使用しません。
CBasePane::OnUpdateCmdUI 内部使用。
CBasePane::P aneFromPoint 特定のポイントを含むペインが返されます。
CBasePane::PreTranslateMessage TranslateMessage および DispatchMessage の各 Windows 関数にディスパッチされる前に、ウィンドウ メッセージを変換するためにクラス CWinApp で使用されます。 ( CWnd::PreTranslateMessageをオーバーライドします)。
CBasePane::RecalcLayout CBasePane は、このメソッドを使用しません。
CBasePane::RemovePaneFromDockManager ペインを登録解除して、ドッキング マネージャーの一覧から削除します。
CBasePane::SaveState レジストリにペインの状態を保存します。
CBasePane::SelectDefaultFont 特定のデバイス コンテキストの既定のフォントを選択します。
CBasePane::Serialize アーカイブに対して、このオブジェクトの読み取りまたは書き込みを行います。 ( CObject::Serializeをオーバーライドします)。
CBasePane::SetControlBarStyle コントロール バーのスタイルを設定します。
CBasePane::SetDockingMode ウィンドウのドッキング モードを設定します。
CBasePane::SetMDITabbed 内部使用。
CBasePane::SetPaneAlignment ペインの配置を設定します。
CBasePane::SetPaneRect 内部使用。
CBasePane::SetPaneStyle ウィンドウのスタイルを設定します。
CBasePane::SetRestoredFromRegistry 内部使用。
CBasePane::SetWindowPos ウィンドウのサイズ、位置、Z オーダーを変更します。
CBasePane::ShowPane ペインの表示と非表示を切り替えます。
CBasePane::StretchPane 垂直または水平方向にウィンドウを拡大します。
CBasePane::UndockPane ドッキング サイト、既定のスライダー、または現在ドッキングされているミニフレーム ウィンドウからウィンドウを削除します。

保護メソッド

名前 説明
CBasePane::D oペイント ウィンドウの背景を塗りつぶします。

解説

MFC で使用できる拡張ドッキング機能をサポートするペイン クラスを作成する場合は、CPane クラスからCBasePane派生させる必要があります。

カスタマイズのヒント

次のカスタマイズのヒントは、 CBasePane Class そのクラスとそのクラスを継承するクラスに関連しています。

  • ペインを作成するときに、いくつかの新しいスタイルを適用できます。

    • AFX_CBRS_FLOATウィンドウが浮動します。

    • AFX_CBRS_AUTOHIDEは自動非表示モードを有効にします。

    • AFX_CBRS_CLOStandard Editionウィンドウを閉じる (非表示) できるようにします。

    これらは、ビットごとの OR 演算と組み合わせることができるフラグです。

CBasePane は、次のフラグ を反映する仮想ブール型メソッドを実装します。CBasePane::CanBeClosedCBasePane::CanAutoHideCBasePane::CanFloat。 派生クラスでオーバーライドして、動作をカスタマイズできます。

  • CBasePane::CanAcceptPaneオーバーライドすることで、ドッキング動作をカスタマイズできます。 このメソッドからウィンドウに FAL Standard Edition を返して、別のウィンドウがドッキングされないようにします。

  • 浮動できない静的ウィンドウを作成し、その前に他のウィンドウをドッキングできないようにする場合 (OutlookDemo の例の Outlook バーと同様)、非フローティングとして作成し、CBasePane::D oesAllowDynInsertBefore をオーバーライドして FAL Standard Edition を返します。 既定の実装では、ウィンドウがAFX_CBRS_FLOATスタイルなしで作成された場合Standard Edition FAL が返されます。

  • -1 以外の ID を持つすべてのペインを作成します。

  • ウィンドウの表示を決定するには、CBasePane::IsVisible を使用します。 タブモードと自動非表示モードで表示状態を正しく処理します。

  • 浮動サイズ変更できないウィンドウを作成する場合は、AFX_CBRS_FLOAT スタイルなしで作成し、CFrameWnd::D ockControlBar を呼び出 します

  • ドッキング レイアウトからペインを除外したり、ドッキング バーからツールバーを削除したりするには、CBasePane::UndockPane を呼び出します。 このメソッドは、自動非表示モードのペインや、タブ付きウィンドウのタブにあるペインには呼び出さないでください。

  • 自動非表示モードのペインを浮動またはドッキング解除する場合は、CBasePane::FloatPane または CBasePane::UndockPane を呼び出す前に、最初の引数として FAL Standard Edition で CDockablePane::SetAutoHideMode を呼び出す必要があります。

CBasePane クラスのさまざまなメソッドの使用方法を次の例に示します。 この例では、クラスから CFrameWndEx ペインを取得する方法と、ドッキング モード、ペインの配置、およびペイン スタイルを設定する方法を示します。 このコードは、Word Pad サンプルの コードです

// This CMainFrame class extends the CFrameWndEx class.
// GetPane is a method in the CFrameWndEx class which
// Returns a pointer to the pane that has the specified ID.
CBasePane *pBar = GetPane(ID_VIEW_FORMATBAR);
if (pBar != NULL)
{
    // Set the docking mode, the pane alignment, and the pane style.
    pBar->SetDockingMode(DT_STANDARD);
    pBar->SetPaneAlignment(CBRS_ALIGN_LEFT);
    pBar->SetPaneStyle(pBar->GetCurrentAlignment() | CBRS_TOOLTIPS);
    pBar->ShowPane(TRUE, FALSE, FALSE);
}

継承階層

CObject

CCmdTarget

CWnd

CBasePane

必要条件

ヘッダー: afxbasepane.h

CBasePane::AccNotifyObjectFocusEvent

CBasePane は、このメソッドを使用しません。

virtual void AccNotifyObjectFocusEvent(int);

パラメーター

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

CBasePane::AddPane

ドッキング マネージャーにウィンドウを追加します。

void AddPane(CBasePane* pBar);

パラメーター

pBar
[in]追加するペインへのポインター。

解説

これは、ドッキング マネージャーにウィンドウを追加する便利なメソッドです。 このメソッドを使用すると、親フレームの型を分析するコードを記述する必要はありません。

詳細については、「CDockingManager クラスと CMDIFrameWndEx::AddPane」を参照してください

CBasePane::AdjustDockingLayout

ドッキング マネージャーに呼び出しをリダイレクトして、ドッキング レイアウトを調整します。

virtual void AdjustDockingLayout(HDWP hdwp=NULL);

パラメーター

hdwp
[out]複数のウィンドウ位置を含む構造体へのハンドル。

解説

これは、ドッキング レイアウトを調整する便利な方法です。 このメソッドを使用すると、親フレームの型を分析するコードを記述する必要はありません。

詳細については、「 CDockingManager::AdjustDockingLayout」を参照してください。

CBasePane::AdjustLayout

ウィンドウの内部レイアウトを調整するためにフレームワークによって呼び出されます。

virtual void AdjustLayout();

解説

フレームワークは、ウィンドウが内部レイアウトを調整する必要がある場合に、このメソッドを呼び出します。 基本実装では何も行われません。

CBasePane::CalcFixedLayout

コントロール バーの水平サイズを計算します。

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

パラメーター

bStretch
[in]バーをフレームのサイズまで引き伸ばす必要があるかどうかを示します。 bStretch パラメーターは、バーがドッキング バーでない場合は 0 以外で (ドッキングには使用できません)、ドッキングまたはフローティング (ドッキングに使用できる) 場合は 0 です。

bHorz
[in]バーが水平方向または垂直方向であることを示します。 バーが水平方向の場合は bHorz パラメーターは 0 以外で、垂直方向の場合は 0 です。

戻り値

オブジェクトのコントロール バーの CSize サイズ (ピクセル単位)。

解説

CControlBar::CalcFixedLayout の 「解説」セクションを参照してください

CBasePane::CanAcceptPane

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

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

パラメーター

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

戻り値

別のウィンドウを受け入れ可能な場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

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

このメソッドと CBasePane::CanBeDocked メソッドを使用して、ウィンドウをアプリケーション内の他のペインにドッキングする方法を制御します。

既定の実装では FALSE が返されます。

CBasePane::CanAutoHide

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

virtual BOOL CanAutoHide() const;

戻り値

このウィンドウで自動非表示モードがサポートされている場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

フレームワークは、この関数を呼び出して、ペインが自動非表示モードをサポートしているかどうかを判断します。

構築中に、AFX_CBRS_AUTOHIDE フラグを CBasePane::CreateEx渡すことで、この機能を設定できます。

AFX_CBRS_AUTOHIDE フラグの既定の実装チェック。 この動作をカスタマイズするには、派生クラスでこのメソッドをオーバーライドします。

CBasePane::CanBeAttached

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

virtual BOOL CanBeAttached() const;

戻り値

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

解説

既定の実装では FALSE が返されます。 CBasePane::EnableDocking を呼び出 さずにドッキングする機能を有効または無効にするには、派生クラスでこのメソッドをオーバーライドします。

CBasePane::CanBeClosed

ウィンドウを閉じることができるかどうかを指定します。

virtual BOOL CanBeClosed() const;

戻り値

ウィンドウを閉じることができる場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

フレームワークは、このメソッドを呼び出して、ウィンドウを閉じることができるかどうかを判断します。 メソッドが TRUE を返す場合は、[ 閉じる ] ボタンがウィンドウのタイトル バーに追加されるか、ウィンドウが浮動している場合は、ウィンドウのミニフレーム ウィンドウのタイトル バーに追加されます。

構築中に、AFX_CBRS_CLOStandard Edition フラグを CBasePane::CreateEx渡すことで、この機能を設定できます。

AFX_CBRS_CLOStandard Edition フラグの既定の実装チェック。

CBasePane::CanBeDocked

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

virtual BOOL CanBeDocked(CBasePane* pDockBar) const;

パラメーター

pDockBar
[in]別のペインへのポインター。

戻り値

このペインを別のペインにドッキングできる場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

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

このメソッドと CBasePane::CanAcceptPane メソッドを使用して、アプリケーション内の他のペインにペインをドッキングする方法を制御します。

既定の実装では FALSE が返されます。

CBasePane::CanBeResized

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

virtual BOOL CanBeResized() const;

戻り値

ウィンドウのサイズを変更できる場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

このメソッドは、既定で指定されているAFX_CBRS_RESIZE フラグをチェックしますCBasePane::OnCreate。 このフラグが指定されていない場合、ドッキング マネージャーは、ウィンドウをドッキングするのではなく、移動不可として内部的にフラグを設定します。

CBasePane::CanBeTabbedDocument

ウィンドウを MDI タブ付きドキュメントに変換できるかどうかを指定します。

virtual BOOL CanBeTabbedDocument() const;

戻り値

ウィンドウをタブ付きドキュメントに変換できる場合は TRUE。それ以外の場合は FAL Standard Edition。 CBasePane::CanBeTabbedDocumentは常に FAL Standard Edition を返します。

解説

特定CBasePaneの派生型のオブジェクト (CDockablePane クラスなど) のみをタブ付きドキュメントに変換できます。

CBasePane::CanFloat

ペインを浮動可能にするかどうかを指定します。

virtual BOOL CanFloat() const;

戻り値

ペインが浮動可能な場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

フレームワークはこのメソッドを呼び出して、ペインが浮動できるかどうかを判断します。

構築中に、AFX_CBRS_FLOAT フラグを CBasePane::CreateEx渡すことで、この機能を設定できます。

Note

このフレームワークでは、非フローティング ペインは静的であり、ドッキング状態は変更できないことを前提としています。 したがって、フレームワークでは、非フローティング ペインのドッキング状態は保存されません。

AFX_CBRS_FLOAT スタイルの既定の実装チェック。

CBasePane::CanFocus

ウィンドウがフォーカスを受け取ることができるかどうかを指定します。

virtual BOOL CanFocus() const;

戻り値

ウィンドウがフォーカスを受け取ることができる場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

フォーカスを制御するには、派生クラスでこのメソッドをオーバーライドします。 たとえば、ツール バーがフォーカスを受け取ることができないため、このメソッドは、ツール バー オブジェクトで呼び出されたときにSTANDARD EDITION FAL を返します。

フレームワークは、ペインがドッキングまたは浮動したときに、入力フォーカスの設定を試みます。

CBasePane::CopyState

特定のペインの状態をコピーします。

virtual void CopyState(CBasePane* pOrgBar);

パラメーター

pOrgBar
[in]別のペインへのポインター。

解説

このメソッドは、pOrgBar からこのウィンドウに状態をコピーします。

CBasePane::CreateDefaultMiniframe

ウィンドウが浮動できる場合、このメソッドはそれに対してミニフレーム ウィンドウを作成します。

virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);

パラメーター

rectInitial
[in]ミニフレーム ウィンドウの初期座標を指定します。

戻り値

新しいミニフレーム ウィンドウへのポインター。作成に失敗した場合は NULL。

解説

ウィンドウがフローティング状態に切り替わると、フレームワークはこのメソッドを呼び出します。 このメソッドは、ミニフレーム ウィンドウを作成し、ウィンドウをこのウィンドウにアタッチします。

既定の実装では、NULL が返されます。

CBasePane::CreateEx

ペイン コントロールを作成します。

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

パラメーター

dwStyleEx
[in]拡張スタイル (詳細については CWnd ::CreateEx を参照)。

lpszClassName
[in]ウィンドウ クラス名。

lpszWindowName
[in]ウィンドウ名。

dwStyle
[in]ウィンドウ スタイル (CWnd::CreateEx を参照)。

rect
[in]最初の四角形。

pParentWnd
[in]親ウィンドウへのポインター。

nID
[in]ペイン ID を指定します。 一意である必要があります。

dwControlBarStyle
[in]ペインのスタイル フラグ。

pContext
[in]へのポインター CcreateContext

戻り値

ペインが正常に作成された場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

クラスのウィンドウを作成します lpszClassName。 WS_CAPTIONを指定した場合、ライブラリはキャプションのペインをサポートしていないため、このメソッドはWS_CAPTION スタイル ビットをクリアし、TRUE に設定CBasePane::m_bHasCaptionします。

子ウィンドウ スタイルと MFC コントロール バー (CBRS_) スタイルの任意の組み合わせを使用できます。

このライブラリでは、ペインにいくつかの新しいスタイルが追加されます。 次の表では、新しいスタイルについて説明します。

スタイル 説明
AFX_CBRS_FLOAT ウィンドウは浮動できます。
AFX_CBRS_AUTOHIDE このウィンドウでは、自動非表示モードがサポートされます
AFX_CBRS_RESIZE ウィンドウのサイズを変更できます。 重要: このスタイルは実装されていません。
AFX_CBRS_CLOStandard Edition ウィンドウは閉じることができます。
AFX_CBRS_AUTO_ROLLUP ペインは、浮動時にロールアップできます。
AFX_CBRS_REGULAR_TABS 1 つのペインがこのスタイルの別のペインにドッキングすると、通常のタブ付きウィンドウが作成されます。 (詳細については、 CTabbedPane クラス。)
AFX_CBRS_OUTLOOK_TABS 1 つのウィンドウがこのスタイルの別のウィンドウにドッキングすると、Outlook スタイルのタブ付きウィンドウが作成されます。 (詳細については、 CMFCOutlookBar クラス。)

新しいスタイルを使用するには、dwControlBarStyle でそれらを 指定します

CBasePane::D ockPane

ペインを別のペインまたはフレーム ウィンドウにドッキングします。

virtual BOOL DockPane(
    CBasePane* pDockBar,
    LPCRECT lpRect,
    AFX_DOCK_METHOD dockMethod);

パラメーター

pDockBar
[in]別のペインへのポインター。

lpRect
[in]変換先の四角形を指定します。

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

戻り値

コントロール バーが正常にドッキングされた場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

この関数を呼び出して、pDockBar で指定された別のペインまたはドック バー (CDockSite クラス) に、または pDockBar が NULL の場合はメイン フレームにペインをドッキングします。

dockMethod は、ペインのドッキング方法を指定します。 使用可能な値の一覧については、CPane::D ockPane を参照してください。

CBasePane::D ockPaneUsingRTTI

実行時の型情報を使用してペインをドッキングします。

void DockPaneUsingRTTI(BOOL bUseDockSite);

パラメーター

bUseDockSite
[in]TRUE の場合は、ドッキング サイトにドッキングします。 FAL Standard Edition の場合は、親フレームにドッキングします。

CBasePane::D ockToFrameWindow

ドッキング可能なウィンドウをフレームにドッキングします。

virtual BOOL DockToFrameWindow(
    DWORD dwAlignment,
    LPCRECT lpRect = NULL,
    DWORD dwDockFlags = DT_DOCK_LAST,
    CBasePane* pRelativeBar = NULL,
    int nRelativeIndex = -1,
    BOOL bOuterEdge = FALSE);

パラメーター

dwAlignment
[in]ペインをドッキングする親フレームの側面。

lpRect
[in]目的のサイズ。

dwDockFlags
[in] 無視されます。

pRelativeBar
[in] 無視されます。

nRelativeIndex
[in] 無視されます。

bOuterEdge
[in]TRUE の場合、dwAlignment指定された側に他のドッキング可能なペインがある場合、ペインは、親フレームの端に近い他のペインの外側にドッキングされます。 FAL Standard Edition の場合、ペインはクライアント領域の中央に近い場所にドッキングされます。

戻り値

メソッドが成功した場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

ウィンドウ分割線 ( CPaneDivider クラス) を作成できない場合、このメソッドは失敗します。 それ以外の場合は常に TRUE を返します。

CBasePane::D oesAllowDynInsertBefore

このペインと親フレームの間に別のペインを動的に挿入できるかどうかを決定します。

virtual BOOL DoesAllowDynInsertBefore() const;

戻り値

ユーザーが別のウィンドウを挿入できる場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

フレームワークは、このメソッドを呼び出して、ユーザーがこのウィンドウの前にウィンドウを動的に挿入できるかどうかを判断します。

たとえば、アプリケーションがフレームの左側にドッキングされたウィンドウ (Outlook バーなど) を作成するとします。 ユーザーが最初のウィンドウの左側に別のウィンドウをドッキングできないようにするには、このメソッドをオーバーライドして FAL Standard Edition を返します。

このメソッドをオーバーライドし、CDockablePane クラスから派生した非フローティング ウィンドウに対して FAL Standard Edition を返することをお勧めします。

既定の実装では、TRUE が返されます。

CBasePane::D oペイント

ウィンドウの背景を塗りつぶします。

virtual void DoPaint(CDC* pDC);

パラメーター

pDC
[入力] デバイス コンテキストへのポインター。

解説

既定の実装では、現在のビジュアル マネージャーを呼び出して背景を塗りつぶします ( CMFCVisualManager::OnFillBarBackground)。

CBasePane::EnableDocking

ウィンドウのメイン フレームへのドッキングを有効にします。

virtual void EnableDocking(DWORD dwAlignment);

パラメーター

dwAlignment
[入力] 有効にするドッキング配置が指定されます。

解説

メイン フレームへのドッキング配置を有効にするには、このメソッドを呼び出します。 CBRS_ALIGN_ フラグの組み合わせを渡すことができます (詳細については、「CControlBar::EnableDocking」を参照してください)。

EnableDockingは内部フラグCBasePane::m_dwEnabledAlignmentを設定し、ウィンドウがドッキングされたときにフレームワークがこのフラグをチェックします。

CBasePane::GetEnabledAlignment を呼び出して、ペインのドッキング配置を決定します。

CBasePane::EnableGripper

グリッパーを有効または無効にします。 グリッパーが有効になっている場合、ユーザーはそれをドラッグしてペインの位置を変更できます。

virtual void EnableGripper(BOOL bEnable);

パラメーター

bEnable
[in]グリッパーを有効にするには TRUE。FAL Standard Editionを無効にします。

解説

フレームワークでは、このメソッドを使用して、WS_CAPTION スタイルを使用する代わりにグリッパーを有効にします。

CBasePane::FloatPane

ウィンドウを浮動表示します。

virtual BOOL FloatPane(
    CRect rectFloat,
    AFX_DOCK_METHOD dockMethod=DM_UNKNOWN,
    bool bShow=true);

パラメーター

rectFloat
[in]フローティング ペインが表示される画面座標を指定します。

dockMethod
[in]ウィンドウを浮動させるために使用する dock メソッドを指定します。

bShow
[in]フローティング ウィンドウを表示 (TRUE) または非表示 (FAL Standard Edition) のどちらにするかを指定します。

戻り値

ペインが正常に浮動した場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

rectFloat指定された画面位置にペインを浮動させる場合は、このメソッドを呼び出します。

CBasePane::get_accHelpTopic

フレームワークは、このメソッドを呼び出して、指定したオブジェクトに関連付けられている WinHelp ファイルの完全なパスと、そのファイル内の適切なトピックの識別子を取得します。

virtual HRESULT get_accHelpTopic(
    BSTR* pszHelpFile,
    VARIANT varChild,
    long* pidTopic);

パラメーター

pszHelpFile
[in]指定したオブジェクトに関連付けられている WinHelp ファイルの完全パスを受け取る BSTR のアドレス (存在する場合)。

varChild
[in]取得するヘルプ トピックがオブジェクトのヘルプ トピックか、オブジェクトの子要素の 1 つであるかを指定します。 このパラメーターには、CHILDID_Standard Edition LF (オブジェクトのヘルプ トピックを取得する場合) または子 ID (オブジェクトのいずれかの子要素のヘルプ トピックを取得する) のいずれかを指定できます。

pidTopic
[in]指定したオブジェクトに 関連付けられているヘルプ ファイル トピックを識別します。

戻り値

CBasePane では、このメソッドは実装されません。 したがって、CBasePane::get_accHelpTopic常にS_FALStandard Editionを返します。

解説

この関数は、MFC の Active Accessibility サポートの一部です。 オブジェクトに関するヘルプ情報を提供するには、派生クラスでこの関数をオーバーライドします。

CBasePane::get_accSelection

フレームワークはこのメソッドを呼び出して、このオブジェクトの選択した子を取得します。

virtual HRESULT get_accSelection(VARIANT* pvarChildren);

パラメーター

pvarChildren
[in]選択した子を識別する情報を受け取ります。

戻り値

CBasePane では、このメソッドは実装されません。 pvarChildren が NULL の場合、このメソッドはE_INVALIDARGを返します。 それ以外の場合、このメソッドは DISP_E_MEMB (メガバイト)ERNOTFOUND を返します。

解説

この関数は、MFC の Active Accessibility サポートの一部です。 ウィンドウなしの ActiveX コントロール以外のウィンドウ化されていないユーザー インターフェイス要素がある場合は、派生クラスでこの関数をオーバーライドします。

CBasePane::GetCaptionHeight

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

virtual int GetCaptionHeight() const;

戻り値

キャプションの高さ。

CBasePane::GetControlBarStyle

コントロール バーのスタイルを返します。

virtual DWORD GetControlBarStyle() const

戻り値

AFX_CBRS_ フラグのビットごとの OR の組み合わせ。

解説

戻り値は、次の可能な値の組み合わせです。

スタイル 説明
AFX_CBRS_FLOAT コントロール バーを浮動にします。
AFX_CBRS_AUTOHIDE 自動非表示モードを有効にします。
AFX_CBRS_RESIZE コントロール バーのサイズ変更を有効にします。 このフラグを設定すると、コントロール バーをドッキング可能なウィンドウに配置できます。
AFX_CBRS_CLOStandard Edition コントロール バーの非表示を有効にします。

CBasePane::GetCurrentAlignment

現在のペインの配置を返します。

virtual DWORD GetCurrentAlignment() const;

戻り値

コントロール バーの現在の配置。 指定可能な値を次の表に示します。

Value 配置
CBRS_ALIGN_LEFT 左揃え。
CBRS_ALIGN_RIGHT 右揃え。
CBRS_ALIGN_TOP 上揃え。
CBRS_ALIGN_BOTTOM 下部の配置。

CBasePane::GetDockingMode

ペインの現在のドッキング モードを返します。

virtual AFX_DOCK_TYPE GetDockingMode() const;

戻り値

DT_STANDARDウィンドウをドラッグすると、ドラッグ四角形によって画面に表示されます。 ウィンドウの内容がドラッグされた場合にDT_IMMEDIATEします。

解説

フレームワークはこのメソッドを呼び出して、ペインの現在のドッキング モードを決定します。

未定義 (DT_UNDEFINED) の場合 CBasePane::m_dockMode 、ドッキング モードはグローバル ドッキング モード (AFX_GLOBAL_DATA::m_dockModeGlobal) から取得されます。

m_dockMode設定またはオーバーライドGetDockingModeすることで、各ペインのドッキング モードを制御できます。

CBasePane::GetDockSiteFrameWnd

ウィンドウがドッキングされている CDockingPanesRowオブジェクトへのポインターを返します。

virtual CWnd* GetDockSiteFrameWnd() const;

戻り値

ウィンドウのドッキング サイトへのポインター。

解説

ウィンドウのドッキング サイトへのポインターを取得するには、このメソッドを呼び出します。 ドッキング サイトは、ウィンドウが メイン フレームにドッキングされている場合は メイン フレーム ウィンドウ、ウィンドウが浮動している場合はミニフレーム ウィンドウのいずれかになります。

CBasePane::GetEnabledAlignment

ウィンドウに適用されるCBRS_ALIGN_スタイルを返します。

virtual DWORD GetEnabledAlignment() const;

戻り値

CBRS_ALIGN_ スタイルの組み合わせ。 次の表に、使用可能なスタイルを示します。

フラグ アラインメントを有効にしました
CBRS_ALIGN_LEFT 左。
CBRS_ALIGN_RIGHT その通りです
CBRS_ALIGN_TOP Top。
CBRS_ALIGN_BOTTOM 下部。
CBRS_ALIGN_ANY すべてのフラグの組み合わせ。

解説

このメソッドを呼び出して、ペインの有効な配置を確認します。 配置が有効になっているとは、ペインをドッキングできるメインフレーム ウィンドウの側面を意味します。

CBasePane::EnableDocking を使用 してドッキング配置を有効にします。

CBasePane::GetMFCStyle

MFC に固有のペイン スタイルを返します。

virtual DWORD GetMFCStyle() const;

戻り値

ライブラリ固有の (AFX_CBRS_) ウィンドウ スタイルの組み合わせ。

CBasePane::GetPaneIcon

ウィンドウ アイコンへのハンドルを返します。

virtual HICON GetPaneIcon(BOOL bBigIcon);

パラメーター

bBigIcon
[in]TRUE の場合、32 ピクセル x 32 ピクセルのアイコンを指定します。は、FAL Standard Edition の場合、16 ピクセル x 16 ピクセルのアイコンを指定します。

戻り値

ウィンドウ アイコンへのハンドル。 失敗した場合は NULL を返します。

解説

既定の実装では CWnd::GetIcon が呼び出 されます

CBasePane::GetPaneRow

ウィンドウがドッキングされている CDockingPanesRowオブジェクトへのポインターを返します。

CDockingPanesRow* GetPaneRow();

戻り値

ペインがドッキングされている場合はポインター CDockingPanesRow 、浮動の場合は NULL。

解説

ペインがドッキングされている行にアクセスするには、このメソッドを呼び出します。 たとえば、ペインを特定の行に配置するには、CDockingPanesRow::ArrangePanes を呼び出して呼び出GetPaneRowします。

CBasePane::GetPaneStyle

ペイン スタイルを返します。

virtual DWORD GetPaneStyle() const;

戻り値

作成時に CBasePane::SetPaneStyle メソッドによって 設定されたコントロール バー スタイル (CBRS_ スタイル を含む) の組み合わせ。

CBasePane::GetParentDockSite

親ドッキング サイトへのポインターを返します。

virtual CDockSite* GetParentDockSite() const;

戻り値

親ドック サイト。

CBasePane::GetParentMiniFrame

親ミニフレーム ウィンドウへのポインターを返します。

virtual CPaneFrameWnd* GetParentMiniFrame(BOOL bNoAssert=FALSE) const;

パラメーター

bNoAssert
[in]TRUE の場合、このメソッドは無効なポインターをチェックしません。 アプリケーションの終了時にこのメソッドを呼び出す場合は、このパラメーターを TRUE に設定します。

戻り値

ウィンドウが浮動している場合は、親ミニフレーム ウィンドウへの有効なポインター。それ以外の場合は NULL。

解説

この関数を呼び出して、親ミニフレーム ウィンドウへのポインターを取得します。 このメソッドは、CPaneFrameWnd クラスから派生したオブジェクトのすべての親とチェックを反復処理します。

ウィンドウが浮動かどうかを判断するために使用 GetParentMiniFrame します。

CBasePane::GetParentTabbedPane

親タブ付きペインへのポインターを返します。

CBaseTabbedPane* GetParentTabbedPane() const;

戻り値

親タブ付きペイン (存在する場合) へのポインター。それ以外の場合は NULL。

CBasePane::GetParentTabWnd

タブ内にある親ウィンドウへのポインターを返します。

CMFCBaseTabCtrl* GetParentTabWnd(HWND& hWndTab) const;

パラメーター

hWndTab
[out]戻り値が NULL でない場合、このパラメーターには親タブ付きウィンドウへのハンドルが含まれます。

戻り値

親タブ付きウィンドウまたは NULL への有効なポインター。

解説

この関数を使用して、親タブ付きウィンドウへのポインターを取得します。 ペインがドッキング ラッパー (CDockablePaneAdapter クラス) 内またはペイン アダプター (CDockablePaneAdapter クラス) 内にある可能性があるため、呼び出すにはGetParent不十分な場合があります。 使用 GetParentTabWnd すると、そのような場合に有効なポインターを取得できます (親がタブ付きウィンドウであると仮定)。

CBasePane::GetRecentVisibleState

フレームワークは、ウィンドウがアーカイブから復元されるときに、このメソッドを呼び出します。

virtual BOOL GetRecentVisibleState() const;

戻り値

最近表示された状態を指定する BOOL。 TRUE の場合、ペインはシリアル化されたときに表示され、復元時に表示されます。 FAL Standard Edition の場合、シリアル化時にペインは非表示になり、復元時には非表示にする必要があります。

CBasePane::HideInPrintPreviewMode

印刷プレビューでペインを非表示にするかどうかを指定します。

virtual BOOL HideInPrintPreviewMode() const;

戻り値

印刷プレビューでペインが表示されない場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

基本ペインは印刷プレビューには表示されません。 したがって、このメソッドは常に TRUE を返します。

CBasePane::InsertPane

指定されたペインがドッキング マネージャーに登録されます。

BOOL InsertPane(
    CBasePane* pControlBar,
    CBasePane* pTarget,
    BOOL bAfter = TRUE);

パラメーター

pControlBar
[入力] 挿入するペインへのポインター。

pTarget
[入力] 隣接するペインへのポインター。

bAfter
[入力] TRUE の場合、pControlBarpTarget の後に挿入されます。 [入力] FALSE の場合、pControlBarpTarget の前に挿入されます。

戻り値

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

CBasePane::IsAccessibilityCompatible

ウィンドウがアクティブなアクセシビリティをサポートするかどうかを指定します。

virtual BOOL IsAccessibilityCompatible();

戻り値

ウィンドウでアクティブなアクセシビリティがサポートされている場合は TRUE。それ以外の場合は FAL Standard Edition。

CBasePane::IsAutoHideMode

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

virtual BOOL IsAutoHideMode() const;

戻り値

ペインが自動非表示モードの場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

ベース ペインは自動的に非表示にできません。 このメソッドは常に FAL Standard Edition を返します。

CBasePane::IsDialogControl

ウィンドウがダイアログ ボックス コントロールかどうかを指定します。

BOOL IsDialogControl() const;

戻り値

ウィンドウがダイアログ ボックス コントロールの場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

フレームワークでは、このメソッドを使用して、すべてのペインのレイアウトの一貫性を確保します。

CBasePane::IsDocked

ペインをドッキングするかどうかを指定します。

virtual BOOL IsDocked() const;

戻り値

ペインの親がミニフレームでない場合、またはペインが別のペインを持つミニフレームに浮動している場合は TRUE。それ以外の場合は FAL Standard Edition。

CBasePane::IsFloating

ペインが浮動かどうかを判断します。

virtual BOOL IsFloating() const;

戻り値

ペインが浮動の場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

このメソッドは、CBasePane::IsDocked の反対の 値を返します

CBasePane::IsHorizontal

ウィンドウを水平方向にドッキングするかどうかを決定します。

virtual BOOL IsHorizontal() const;

戻り値

ウィンドウが水平方向にドッキングされている場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

既定の実装では、CBRS_ORIENT_HORZの現在のドッキング配置がチェックされます。

CBasePane::IsInFloatingMultiPaneFrameWnd

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

virtual BOOL IsInFloatingMultiPaneFrameWnd() const;

戻り値

TRUE の場合、ウィンドウが複数ウィンドウ フレーム ウィンドウ内にあります。それ以外の場合は FAL Standard Edition。

解説

ドッキング可能なペインのみが、複数ペインのフレーム ウィンドウに浮動できます。 したがって、CBasePane::IsInFloatingMultiPaneFrameWnd常に FAL Standard Edition を返します。

CBasePane::IsMDITabbed

ウィンドウがタブ付きドキュメントとして MDI 子ウィンドウに追加されているかどうかを確認します。

virtual BOOL IsMDITabbed() const;

戻り値

ウィンドウがタブ付きドキュメントとして MDI 子ウィンドウに追加された場合は TRUE。それ以外の場合は FAL Standard Edition。

CBasePane::IsPaneVisible

ウィンドウにWS_VISIBLE フラグを設定するかどうかを指定します。

BOOL IsPaneVisible() const;

戻り値

WS_VISIBLEが設定されている場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

CBasePane::IsVisible を使用して、ペインの表示を決定します。

CBasePane::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。

解説

ドッキング マネージャーで設定された感度内にある場合、ポイントはドッキング サイトの近くにあります。 既定の感度は 15 ピクセルです。

CBasePane::IsResizable

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

virtual BOOL IsResizable() const;

戻り値

ユーザーがウィンドウのサイズを変更できる場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

CDockablePane クラスペインのサイズを変更できます。

ステータス バー ( CMFCStatusBar クラス) とドック バー ( CDockSite クラス) のサイズを変更できません。

CBasePane::IsRestoredFromRegistry

ウィンドウがレジストリから復元されるかどうかを判断します。

virtual BOOL IsRestoredFromRegistry() const;

戻り値

レジストリからペインが復元される場合は TRUE。それ以外の場合は FAL Standard Edition。

CBasePane::IsTabbed

タブ付きウィンドウのタブ コントロールにペインが挿入されているかどうかを確認します。

virtual BOOL IsTabbed() const;

戻り値

コントロール バーがタブ付きウィンドウのタブに挿入される場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

このメソッドは、直接の親へのポインターを取得し、親のランタイム クラスが CMFCBaseTabCtrl クラスかどうかを判断します。

CBasePane::IsVisible

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

virtual BOOL IsVisible() const;

戻り値

ペインが表示されている場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

このメソッドを使用して、ペインの表示を決定します。 ::IsWindowVisibleは使用しないでください。

ペインがタブ付けされていない場合 (CBasePane::IsTabbed を参照)、このメソッドはWS_VISIBLEスタイルをチェックします。 ペインがタブ付きである場合、このメソッドは親タブ付きウィンドウの表示をチェックします。 親ウィンドウが表示されている場合、この関数は CMFCBaseTabCtrl::IsTabVisible を使用してペイン タブの可視性をチェックします。

CBasePane::LoadState

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

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

パラメーター

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

Nindex
[in]プロファイル インデックス。

uiID
[in]ウィンドウ ID。

戻り値

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

解説

フレームワークは、レジストリからウィンドウの状態を読み込むには、このメソッドを呼び出します。 派生クラスでオーバーライドして、CBasePane::SaveState によって保存された 追加情報を読み込みます

CBasePane::MoveWindow

ウィンドウを移動します。

virtual HDWP MoveWindow(
    CRect& rect,
    BOOL bRepaint = TRUE,
    HDWP hdwp = NULL);

パラメーター

rect
[in]ウィンドウの新しい場所とサイズを指定する四角形。

bRepaint
[in]TRUE の場合、ペインは再描画されます。 FAL Standard Edition の場合、ペインは再描画されません。

hdwp
[入力] 遅延ウィンドウ位置の構造体へのハンドル。

戻り値

遅延ウィンドウ位置構造体 (NULL) のハンドル。

解説

hdwp パラメーターとして NULL を渡すと、このメソッドはウィンドウを正常に移動します。 ハンドルを渡すと、このメソッドは遅延ウィンドウ移動を実行します。 ハンドルを取得するには、BeginDeferWindowPos を呼び出すか、このメソッドの以前の呼び出しの戻り値を格納します。

CBasePane::OnAfterChangeParent

ウィンドウの親が変更された後、フレームワークによって呼び出されます。

virtual void OnAfterChangeParent(CWnd* pWndOldParent);

パラメーター

pWndOldParent
[in]前の親へのポインター。

解説

フレームワークは、ペインの親が変更された後にこのメソッドを呼び出します。通常は、ドッキング操作またはフローティング操作が原因です。

既定の実装では、何も行われません。

CBasePane::OnBeforeChangeParent

ウィンドウが親ウィンドウを変更する直前に、フレームワークによって呼び出されます。

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

パラメーター

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

bDelay
[in]レイアウト調整を遅延する必要があるかどうかを指定します。

解説

フレームワークは、ペインの親が変更される直前にこのメソッドを呼び出します。通常は、ドッキング、フローティング、または自動非表示の操作が原因です。

既定の実装では、何も行われません。

CBasePane::OnDrawCaption

フレームワークは、キャプションが描画されるときにこのメソッドを呼び出します。

virtual void OnDrawCaption();

解説

このメソッドには、クラスの CBasePane 機能はありません。

CBasePane::OnMovePaneDivider

このメソッドは現在使用されていません。

virtual void OnMovePaneDivider(CPaneDivider* /* unused */);

パラメーター

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

CBasePane::OnPaneContextMenu

ペインの一覧を含むメニューを構築するときにフレームワークによって呼び出されます。

virtual void OnPaneContextMenu(
    CWnd* pParentFrame,
    CPoint point);

パラメーター

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

point
[in]ショートカット メニューの場所を指定します。

解説

OnPaneContextMenuはドッキング マネージャーを呼び出します。メイン現在のフレーム ウィンドウに属するペインの一覧が含まれます。 このメソッドは、ウィンドウの名前をショートカット メニューに追加して表示します。 メニューのコマンドは、個々のペインを表示または非表示にします。

この動作をカスタマイズするには、このメソッドをオーバーライドします。

CBasePane::OnRemoveFromMiniFrame

ウィンドウが親ミニ フレーム ウィンドウから削除されたときにフレームワークによって呼び出されます。

virtual void OnRemoveFromMiniFrame(CPaneFrameWnd* pMiniFrame);

パラメーター

pMiniFrame
[in]ウィンドウが削除されるミニフレーム ウィンドウへのポインター。

解説

フレームワークは、ペインが親ミニフレーム ウィンドウから削除されるときに (たとえば、ドッキングの結果として) このメソッドを呼び出します。

既定の実装では、何も行われません。

CBasePane::OnSetAccData

CBasePane は、このメソッドを使用しません。

virtual BOOL OnSetAccData(long lVal);

パラメーター

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

戻り値

このメソッドは常に TRUE を返します。

解説

CBasePane::P aneFromPoint

特定のポイントを含むペインが返されます。

CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    bool bExactBar = false,
    CRuntimeClass* pRTCBarType = NULL) const;

パラメーター

point
[入力] 確認するポイントが画面座標で指定されます。

nSensitivity
[入力] 検索領域をこの量だけ増やします。 指定されたポイントが増加領域にある場合、ペインは検索条件を満たします。

bExactBar
[入力] "nSensitivity パラメーターを無視する場合は " TRUE、それ以外の場合は FALSE。

pRTCBarType
[入力] NULL 以外の場合、メソッドで指定された型のペインのみが検索されます。

戻り値

CBasePane指定されたポイントを含む -derived オブジェクト。ペインが見つからなかった場合は NULL。

CBasePane::RecalcLayout

CBasePane は、このメソッドを使用しません。

virtual void RecalcLayout();

CBasePane::RemovePaneFromDockManager

ペインを登録解除して、ドッキング マネージャーの一覧から削除します。

void RemovePaneFromDockManager(
    CBasePane* pBar,
    BOOL bDestroy = TRUE,
    BOOL bAdjustLayout = FALSE,
    BOOL bAutoHide = FALSE,
    CBasePane* pBarReplacement = NULL);

パラメーター

pBar
[入力] 削除されるペインへのポインター。

bDestroy
[入力] TRUE の場合、削除されたペインが破棄されます。

bAdjustLayout
[入力] TRUE の場合は、ドッキング レイアウトをすぐに調整します。

bAutoHide
[入力] TRUE の場合、ドッキング レイアウトは自動非表示バーの一覧に関連します。 FALSE の場合、ドッキング レイアウトは通常のペインの一覧に関連します。

pBarReplacement
[入力] 削除されたペインを置き換えるペインへのポインター。

CBasePane::SaveState

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

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

パラメーター

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

Nindex
[in]プロファイル インデックス。

uiID
[in]ウィンドウ ID。

戻り値

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

解説

フレームワークは、ウィンドウの状態をレジストリに保存するときに、このメソッドを呼び出します。 追加情報を格納するには、派生クラスでオーバーライド SaveState します。

CBasePane::SelectDefaultFont

特定のデバイス コンテキストの既定のフォントを選択します。

CFont* SelectDefaultFont(CDC* pDC);

パラメーター

pDC
[in]デバイス コンテキスト。

戻り値

既定 の CFont クラス オブジェクトへのポインター。

CBasePane::SetControlBarStyle

コントロール バーのスタイルを設定します。

virtual void SetControlBarStyle(DWORD dwNewStyle);

パラメーター

dwNewStyle
[in]次の使用可能な値のビットごとの OR の組み合わせ。

スタイル 説明
AFX_CBRS_FLOAT コントロール バーを浮動にします。
AFX_CBRS_AUTOHIDE 自動非表示モードを有効にします。
AFX_CBRS_RESIZE コントロール バーのサイズ変更を有効にします。 このフラグを設定すると、コントロール バーをドッキング可能なウィンドウに配置できます。
AFX_CBRS_CLOStandard Edition コントロール バーの非表示を有効にします。

CBasePane::SetDockingMode

ウィンドウのドッキング モードを設定します。

void SetDockingMode(AFX_DOCK_TYPE dockModeNew);

パラメーター

dockModeNew
[in]ペインの新しいドッキング モードを指定します。

解説

フレームワークでは、標準と即時の 2 つのドッキング モードがサポートされています。

標準ドッキング モードでは、ウィンドウとミニフレーム ウィンドウはドラッグ四角形を使用して移動します。 即時ドッキング モードでは、コントロール バーとミニフレーム ウィンドウはコンテキストと共にすぐに移動されます。

最初は、ドッキング モードは CDockingManager::m_dockModeGlobal によって グローバルに定義されます。 メソッドを使用して、各ペインのドッキング モードを SetDockingMode 個別に設定できます。

CBasePane::SetPaneAlignment

ペインの配置を設定します。

virtual void SetPaneAlignment(DWORD dwAlignment);

パラメーター

dwAlignment
[in]新しい配置を指定します。

解説

通常、フレームワークは、ウィンドウがメイン フレームの一方の側から別の側にドッキングされるときに、このメソッドを呼び出します。

次の表に、dwAlignment で使用できる値を示します。

Value 配置
CBRS_ALIGN_LEFT 左揃え。
CBRS_ALIGN_RIGHT 右揃え。
CBRS_ALIGN_TOP 上揃え。
CBRS_ALIGN_BOTTOM 下部の配置。

CBasePane::SetPaneStyle

ウィンドウのスタイルを設定します。

virtual void SetPaneStyle(DWORD dwNewStyle);

パラメーター

dwNewStyle
[in]設定する新しいスタイルを指定します。

解説

このメソッドを使用して、afxres.h で定義されている任意のCBRS_ スタイルを設定できます。 ペイン スタイルとペインの配置は一緒に保存されるため、次のように、新しいスタイルを現在の配置と組み合わせて設定します。

pPane->SetPaneStyle (pPane->GetCurrentAlignment() | CBRS_TOOLTIPS);

CBasePane::SetWindowPos

ウィンドウのサイズ、位置、Z オーダーを変更します。

virtual HDWP SetWindowPos(
    const CWnd* pWndInsertAfter,
    int x,
    int y,
    int cx,
    int cy,
    UINT nFlags,
    HDWP hdwp = NULL);

パラメーター

pWndInsertAfter
[in]このCWndオブジェクトのCWnd前にあるオブジェクトを Z オーダーで識別します。 詳細については、「CWnd::SetWindowPos」を参照してください

x
[in]ウィンドウの左側の位置を指定します。

y
[in]ウィンドウの上部の位置を指定します。

cx
[in]ウィンドウの幅を指定します。

cy
[in]ウィンドウの高さを指定します。

nFlags
[in]サイズと位置のオプションを指定します。 詳細については、「CWnd::SetWindowPos」を参照してください

hdwp
[in]1 つ以上のウィンドウのサイズと位置情報を含む構造体を処理します。

戻り値

更新された遅延ウィンドウ位置構造体 (NULL) のハンドル。

解説

pWndInsertAfter が NULL の場合、このメソッドは CWnd::SetWindowPos を呼び出します。 pWndInsertAfter が NULL 以外の場合、このメソッドDeferWindowPosは .

CBasePane::ShowPane

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

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

パラメーター

bShow
[in]ペインを表示 (TRUE) または非表示 (FAL Standard Edition) するかどうかを指定します。

bDelay
[in]TRUE の場合、ドッキング レイアウトの再計算が遅れます。

bActivate
[in]TRUE の場合、ペインは表示されるときにアクティブになります。

解説

このメソッドは、ウィンドウを表示または非表示にします。 このメソッドは、ペインの可視性の ShowWindow 変更について関連するドッキング マネージャーに通知するためではなく、このメソッドを使用します。

CBasePane::IsVisible を使用して、ペインの現在の可視性を確認します。

CBasePane::StretchPane

垂直または水平方向にウィンドウを拡大します。

virtual CSize StretchPane(
    int nLength,
    BOOL bVert);

パラメーター

nLength
[in]ウィンドウを拡大する長さ。

bVert
[in]TRUE の場合は、ウィンドウを垂直方向に拡大します。 FAL Standard Edition の場合は、ウィンドウを水平方向に引き伸ばします。

戻り値

ストレッチ ウィンドウのサイズ。

CBasePane::UndockPane

ドッキング サイト、既定のスライダー、または現在ドッキングされているミニフレーム ウィンドウからウィンドウを削除します。

virtual void UndockPane(BOOL bDelay=FALSE);

パラメーター

bDelay
TRUE の場合、ドッキング レイアウトはすぐに再計算されません。

解説

このメソッドを呼び出してペインの状態を操作するか、ドッキング レイアウトからペインを除外します。

このウィンドウを引き続き使用する場合は、このメソッドを呼び出す前に CBasePane::D ockPane または CBasePane::FloatPane を呼び出します。

関連項目

階層図
クラス
Cpane
CWnd クラス