Share via

CDockSite クラス

  • [アーティクル]

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

CPane Class から派生したペインを一連の行に配置する機能を提供します。

構文

class CDockSite: public CBasePane

メンバー

パブリック メソッド

名前 説明
CDockSite::AddRow
CDockSite::AdjustDockingLayout (オーバーライド CBasePane::AdjustDockingLayout.)
CDockSite::AdjustLayout (オーバーライド CBasePane::AdjustLayout.)
CDockSite::AlignDockSite
CDockSite::CalcFixedLayout (オーバーライド CBasePane::CalcFixedLayout.)
CDockSite::CanAcceptPane (オーバーライド CBasePane::CanAcceptPane.)
CDockSite::CreateEx (オーバーライド CBasePane::CreateEx.)
CDockSite::CreateRow
CDockSite::D ockPane (オーバーライド CBasePane::D ockPane.)
CDockSite::D oesAllowDynInsertBefore (オーバーライド CBasePane::D oesAllowDynInsertBefore.)
CDockSite::FindRowIndex
CDockSite::FixupVirtualRects
CDockSite::GetDockSiteID
CDockSite::GetDockSiteRowsList
CDockSite::IsAccessibilityCompatible ( CBasePane::IsAccessibilityCompatibleをオーバーライドします)。
CDockSite::IsDragMode
CDockSite::IsLastRow
CDockSite::IsRectWithinDockSite
CDockSite::IsResizable (オーバーライド CBasePane::IsResizable.)
CDockSite::MovePane
CDockSite::OnInsertRow
CDockSite::OnRemoveRow
CDockSite::OnResizeRow
CDockSite::OnSetWindowPos
CDockSite::OnShowRow
CDockSite::OnSizeParent
CDockSite::P aneFromPoint パラメーターによって指定された点にあるドッキング サイトにドッキングされているペインを返します。
CDockSite::D ockPaneLeftOf ペインを別のペインの左側にドッキングします。
CDockSite::FindPaneByID 指定された ID によって識別されるペインを返します。
CDockSite::GetPaneList ドッキング サイトにドッキングされているペインの一覧を返します。
CDockSite::RectSideFromPoint
CDockSite::RemovePane
CDockSite::RemoveRow
CDockSite::ReplacePane
CDockSite::RepositionPanes
CDockSite::ResizeDockSite
CDockSite::ResizeRow
CDockSite::ShowPane ペインを表示します。
CDockSite::ShowRow
CDockSite::SwapRows

解説

CFrameWndEx::EnableDocking を呼び出すと、フレームワークによってオブジェクトが自動的に作成CDockSiteされます。 ドッキング サイト ウィンドウは、メイン フレーム ウィンドウ上のクライアント領域の端に配置されます。

CFrameWndEx クラスはこれらのサービスを処理するため、通常、ドック サイトによって提供されるサービスを呼び出す必要はありません。

例

次の例では、CDockSite クラスのオブジェクトを作成する方法を示します。

AFX_DOCKSITE_INFO info;
CDockSite *pDockBar = (CDockSite*)info.pDockBarRTC->CreateObject();

継承階層

CObject
└ CCmdTarget
 └ CWnd
  └ CBasePane
   └ CDockSite

必要条件

ヘッダー: afxDockSite.h

CDockSite::AddRow

CDockingPanesRow* AddRow(
    POSITION pos,
    int nHeight);

パラメーター

[in] Pos

[in] nHeight

戻り値

解説

CDockSite::AdjustDockingLayout

virtual void AdjustDockingLayout();

解説

CDockSite::AdjustLayout

virtual void AdjustLayout();

解説

CDockSite::AlignDockSite

void AlignDockSite(
    const CRect& rectToAlignBy,
    CRect& rectResult,
    BOOL bMoveImmediately);

パラメーター

[in] rectToAlignBy

[in] rectResult

[in] bMoveImmediately

解説

CDockSite::CalcFixedLayout

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

パラメーター

[in] bStretch

[in] bHorz

戻り値

解説

CDockSite::CanAcceptPane

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

パラメーター

[入力] pBar

戻り値

解説

CDockSite::CreateEx

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

パラメーター

[in] dwStyleEx

[in] Dwstyle

[in] Rect

[入力] pParentWnd

[in] dwControlBarStyle

[入力] pContext

戻り値

解説

CDockSite::CreateRow

virtual CDockingPanesRow* CreateRow(
    CDockSite* pParentDockBar,
    int nOffset,
    int nRowHeight);

パラメーター

[in] pParentDockBar

[in] nOffset

[in] nRowHeight

戻り値

解説

CDockSite::D ockPane

virtual void DockPane(
    CPane* pWnd,
    AFX_DOCK_METHOD dockMethod,
    LPCRECT lpRect = NULL);

パラメーター

[入力] pWnd

[in] dockMethod

[入力] lpRect

解説

CDockSite::D ockPaneLeftOf

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

virtual BOOL DockPaneLeftOf(
    CPane* pBarToDock,
    CPane* pTargetBar);

パラメーター

pBarToDock
[入力、出力]pTargetBar の左側にドッキングするペインへのポインター。

pTargetBar
[入力、出力]ターゲット ウィンドウへのポインター。

戻り値

ペインが正常にドッキングされた場合は TRUE。それ以外の場合は FAL Standard Edition。

解説

CDockSite::D oesAllowDynInsertBefore

virtual BOOL DoesAllowDynInsertBefore() const;

戻り値

解説

CDockSite::FindPaneByID

指定した ID のペインを返します。

CPane* FindPaneByID(UINT nID);

パラメーター

nID
[in]見つかるペインのコマンド ID。

戻り値

指定したコマンド ID を持つペインへのポインター。ペインが見つからない場合は NULL。

解説

CDockSite::FindRowIndex

int FindRowIndex(CDockingPanesRow* pRow);

パラメーター

[in] 船首

戻り値

解説

CDockSite::FixupVirtualRects

virtual void FixupVirtualRects();

解説

CDockSite::GetDockSiteID

virtual UINT GetDockSiteID() const;

戻り値

解説

CDockSite::GetDockSiteRowsList

const CObList& GetDockSiteRowsList() const;

戻り値

解説

CDockSite::GetPaneList

ドッキング サイトにドッキングされているペインの一覧を返します。

const CObList& GetPaneList() const;

戻り値

ドッキング バーに現在ドッキングされているペインの一覧への読み取り専用参照。

CDockSite::IsAccessibilityCompatible

virtual BOOL IsAccessibilityCompatible();

戻り値

解説

CDockSite::IsDragMode

virtual BOOL IsDragMode() const;

戻り値

解説

CDockSite::IsLastRow

bool IsLastRow(CDockingPanesRow* pRow) const;

パラメーター

[in] 船首

戻り値

解説

CDockSite::IsRectWithinDockSite

BOOL IsRectWithinDockSite(
    CRect rect,
    CPoint& ptDelta);

パラメーター

[in] Rect

[in] ptDelta

戻り値

解説

CDockSite::IsResizable

virtual BOOL IsResizable() const;

戻り値

解説

CDockSite::MovePane

virtual BOOL MovePane(
    CPane* pWnd,
    UINT nFlags,
    CPoint ptOffset);

パラメーター

[入力] pWnd

[in] Nflags

[in] ptOffset

戻り値

解説

CDockSite::OnInsertRow

virtual void OnInsertRow(POSITION pos);

パラメーター

[in] Pos

解説

CDockSite::OnRemoveRow

virtual void OnRemoveRow(
    POSITION pos,
    BOOL bByShow = FALSE);

パラメーター

[in] Pos

[in] bByShow

解説

CDockSite::OnResizeRow

virtual int OnResizeRow(
    CDockingPanesRow* pRowToResize,
    int nOffset);

パラメーター

[in] pRowToResize

[in] nOffset

戻り値

解説

CDockSite::OnSizeParent

virtual void OnSizeParent(
    CRect& rectAvailable,
    UINT nSide,
    BOOL bExpand,
    int nOffset);

パラメーター

[in] rectAvailable

[in] nSide

[in] bExpand

[in] nOffset

解説

CDockSite::OnSetWindowPos

virtual BOOL OnSetWindowPos(
    const CWnd* pWndInsertAfter,
    const CRect& rectWnd,
    UINT nFlags);

パラメーター

[in] pWndInsertAfter

[in] rectWnd

[in] Nflags

戻り値

解説

CDockSite::OnShowRow

virtual void OnShowRow(
    POSITION pos,
    BOOL bShow);

パラメーター

[in] Pos

[入力] bShow

解説

CDockSite::P aneFromPoint

パラメーターによって指定された点にあるドッキング サイトにドッキングされているペインを返します。

virtual CPane* PaneFromPoint(CPoint pt);

パラメーター

pt
[in]取得するペインのポイント (画面座標)。

戻り値

指定したポイントにあるペインへのポインター。指定したポイントにペインが存在しない場合は NULL。

解説

CDockSite::RectSideFromPoint

static int __stdcall RectSideFromPoint(
    const CRect& rect,
    const CPoint& point);

パラメーター

[in] Rect

[入力] point

戻り値

解説

CDockSite::RemovePane

virtual void RemovePane(
    CPane* pWnd,
    AFX_DOCK_METHOD dockMethod);

パラメーター

[入力] pWnd

[in] dockMethod

解説

CDockSite::RemoveRow

void RemoveRow(CDockingPanesRow* pRow);

パラメーター

[in] 船首

解説

CDockSite::ReplacePane

BOOL ReplacePane(
    CPane* pOldBar,
    CPane* pNewBar);

パラメーター

[in] pOldBar

[in] pNewBar

戻り値

解説

CDockSite::RepositionPanes

virtual void RepositionPanes(CRect& rectNewClientArea);

パラメーター

[in] rectNewClientArea

解説

CDockSite::ResizeDockSite

void ResizeDockSite(
    int nNewWidth,
    int nNewHeight);

パラメーター

[in] nNewWidth

[in] nNewHeight

解説

CDockSite::ResizeRow

int ResizeRow(
    CDockingPanesRow* pRow,
    int nNewSize,
    BOOL bAdjustLayout = TRUE);

パラメーター

[in] 船首

[in] nNewSize

[入力] bAdjustLayout

戻り値

解説

CDockSite::ShowPane

ペインを表示します。

virtual BOOL ShowPane(
    CBasePane* pBar,
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

パラメーター

pBar
[入力、出力]表示または非表示にするペインへのポインター。

bShow
[in]ペインを表示することを指定する場合は TRUE。FAL Standard Edition ペインを非表示にすることを指定します。

bDelay
[in]TRUE ウィンドウが表示されるまで、ウィンドウのレイアウトを遅らせる必要があることを指定します。それ以外の場合は FAL Standard Edition。

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

戻り値

ペインが正常に表示または非表示にされた場合は TRUE。 FAL Standard Edition指定したウィンドウがこのドッキング サイトに属していない場合。

解説

ドッキングされたペインを表示または非表示にするには、このメソッドを呼び出します。 通常、親フレーム ウィンドウまたは基本ウィンドウによって呼び出されるため、直接呼び出 CDockSite::ShowPane す必要はありません。

CDockSite::ShowRow

void ShowRow(
    CDockingPanesRow* pRow,
    BOOL bShow,
    BOOL bAdjustLayout);

パラメーター

[in] 船首

[入力] bShow

[入力] bAdjustLayout

解説

CDockSite::SwapRows

void SwapRows(
    CDockingPanesRow* pFirstRow,
    CDockingPanesRow* pSecondRow);

パラメーター

[in] pFirstRow

[in] pSecondRow

解説

関連項目

階層図
クラス
CBasePane クラス