CDockSite クラス
詳細については、Visual Studio のインストールの VC\atlmfc\src\mfc フォルダーにあるソース コードを参照してください。
CPane Class から派生したペインを一連の行に配置する機能を提供します。
構文
class CDockSite: public CBasePane
メンバー
パブリック メソッド
解説
CFrameWndEx::EnableDocking を呼び出すと、フレームワークによって CDockSite オブジェクトが自動的に作成されます。 ドッキング サイト ウィンドウは、メイン フレーム ウィンドウ上のクライアント領域の端に配置されます。
CFrameWndEx クラスはこれらのサービスを処理するため、通常、ドック サイトによって提供されるサービスを呼び出す必要はありません。
例
次の例では、CDockSite クラスのオブジェクトを作成する方法を示します。
AFX_DOCKSITE_INFO info;
CDockSite *pDockBar = (CDockSite*)info.pDockBarRTC->CreateObject();
継承階層
CObject
└ CCmdTarget
└ CWnd
└ CBasePane
└ CDockSite
要件
Header: afxDockSite.h
CDockSite::AddRow
CDockingPanesRow* AddRow(
POSITION pos,
int nHeight);
パラメーター
[入力] pos
[入力] nHeight
戻り値
解説
CDockSite::AdjustDockingLayout
virtual void AdjustDockingLayout();
解説
CDockSite::AdjustLayout
virtual void AdjustLayout();
解説
CDockSite::AlignDockSite
void AlignDockSite(
const CRect& rectToAlignBy,
CRect& rectResult,
BOOL bMoveImmediately);
パラメーター
[入力] rectToAlignBy
[入力] rectResult
[入力] bMoveImmediately
解説
CDockSite::CalcFixedLayout
virtual CSize CalcFixedLayout(
BOOL bStretch,
BOOL bHorz);
パラメーター
[入力] 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);
パラメーター
[入力] dwStyleEx
[入力] dwStyle
[in] rect
[入力] pParentWnd
[入力] dwControlBarStyle
[入力] pContext
戻り値
解説
CDockSite::CreateRow
virtual CDockingPanesRow* CreateRow(
CDockSite* pParentDockBar,
int nOffset,
int nRowHeight);
パラメーター
[入力] pParentDockBar
[in] nOffset
[入力] nRowHeight
戻り値
解説
CDockSite::D ockPane
virtual void DockPane(
CPane* pWnd,
AFX_DOCK_METHOD dockMethod,
LPCRECT lpRect = NULL);
パラメーター
[入力] pWnd
[入力] dockMethod
[入力] lpRect
解説
CDockSite::D ockPaneLeftOf
ペインを別のペインの左側にドッキングします。
virtual BOOL DockPaneLeftOf(
CPane* pBarToDock,
CPane* pTargetBar);
パラメーター
pBarToDock
[入力、出力] pTargetBar の左側にドッキングするペインへのポインター。
pTargetBar
[入力、出力]ターゲット ウィンドウへのポインター。
戻り値
ペインが正常にドッキングされた場合は TRUE。それ以外の場合は FALSE。
解説
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);
パラメーター
[入力] 船首
戻り値
解説
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;
パラメーター
[入力] 船首
戻り値
解説
CDockSite::IsRectWithinDockSite
BOOL IsRectWithinDockSite(
CRect rect,
CPoint& ptDelta);
パラメーター
[in] rect
[入力] ptDelta
戻り値
解説
CDockSite::IsResizable
virtual BOOL IsResizable() const;
戻り値
解説
CDockSite::MovePane
virtual BOOL MovePane(
CPane* pWnd,
UINT nFlags,
CPoint ptOffset);
パラメーター
[入力] pWnd
[入力] nFlags
[入力] ptOffset
戻り値
解説
CDockSite::OnInsertRow
virtual void OnInsertRow(POSITION pos);
パラメーター
[入力] pos
解説
CDockSite::OnRemoveRow
virtual void OnRemoveRow(
POSITION pos,
BOOL bByShow = FALSE);
パラメーター
[入力] pos
[入力] bByShow
解説
CDockSite::OnResizeRow
virtual int OnResizeRow(
CDockingPanesRow* pRowToResize,
int nOffset);
パラメーター
[入力] pRowToResize
[in] nOffset
戻り値
解説
CDockSite::OnSizeParent
virtual void OnSizeParent(
CRect& rectAvailable,
UINT nSide,
BOOL bExpand,
int nOffset);
パラメーター
[入力] rectAvailable
[入力] nSide
[入力] bExpand
[in] nOffset
解説
CDockSite::OnSetWindowPos
virtual BOOL OnSetWindowPos(
const CWnd* pWndInsertAfter,
const CRect& rectWnd,
UINT nFlags);
パラメーター
[入力] pWndInsertAfter
[入力] rectWnd
[入力] nFlags
戻り値
解説
CDockSite::OnShowRow
virtual void OnShowRow(
POSITION pos,
BOOL bShow);
パラメーター
[入力] 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
[入力] dockMethod
解説
CDockSite::RemoveRow
void RemoveRow(CDockingPanesRow* pRow);
パラメーター
[入力] 船首
解説
CDockSite::ReplacePane
BOOL ReplacePane(
CPane* pOldBar,
CPane* pNewBar);
パラメーター
[入力] pOldBar
[入力] pNewBar
戻り値
解説
CDockSite::RepositionPanes
virtual void RepositionPanes(CRect& rectNewClientArea);
パラメーター
[入力] rectNewClientArea
解説
CDockSite::ResizeDockSite
void ResizeDockSite(
int nNewWidth,
int nNewHeight);
パラメーター
[入力] nNewWidth
[入力] nNewHeight
解説
CDockSite::ResizeRow
int ResizeRow(
CDockingPanesRow* pRow,
int nNewSize,
BOOL bAdjustLayout = TRUE);
パラメーター
[入力] 船首
[入力] nNewSize
[入力] bAdjustLayout
戻り値
解説
CDockSite::ShowPane
ペインを表示します。
virtual BOOL ShowPane(
CBasePane* pBar,
BOOL bShow,
BOOL bDelay,
BOOL bActivate);
パラメーター
pBar
[入力、出力]表示または非表示にするペインへのポインター。
bShow
[in]ペインを表示することを指定する場合は TRUE。ペインを非表示にすることを指定する場合は FALSE。
bDelay
[in]TRUE ウィンドウが表示されるまで、ウィンドウのレイアウトを遅らせる必要があることを指定します。それ以外の場合は FALSE。
bActivate
[入力] このパラメーターは使用しません。
戻り値
ペインが正常に表示または非表示にされた場合は TRUE。 指定したペインがこのドッキング サイトに属していない場合は FALSE。
解説
ドッキングされたペインを表示または非表示にするには、このメソッドを呼び出します。 通常、親フレーム ウィンドウまたは基本ウィンドウによって呼び出されるため、 CDockSite::ShowPane を直接呼び出す必要はありません。
CDockSite::ShowRow
void ShowRow(
CDockingPanesRow* pRow,
BOOL bShow,
BOOL bAdjustLayout);
パラメーター
[入力] 船首
[入力] bShow
[入力] bAdjustLayout
解説
CDockSite::SwapRows
void SwapRows(
CDockingPanesRow* pFirstRow,
CDockingPanesRow* pSecondRow);
パラメーター
[入力] pFirstRow
[入力] pSecondRow