CAutoHideDockSite クラス
CAutoHideDockSiteは、CDockSite クラスを拡張して、ドッキング ウィンドウの自動非表示を実装します。
構文
class CAutoHideDockSite : public CDockSite
メンバー
パブリック コンストラクター
| 名前 | 内容 |
|---|---|
| 名前 | 説明 |
CAutoHideDockSite::CAutoHideDockSite |
CAutoHideDockSite オブジェクトを構築します。 |
CAutoHideDockSite::~CAutoHideDockSite |
デストラクターです。 |
パブリック メソッド
| 名前 | 内容 |
|---|---|
| 名前 | 説明 |
CAutoHideDockSite::AllowShowOnPaneMenu |
ウィンドウ メニューに CAutoHideDockSite が表示されるかどうかを示します。 |
| CAutoHideDockSite::CanAcceptPane | 基本ペイン オブジェクトが CMFCAutoHideBar クラスから派生するかどうかを決定します。 |
| CAutoHideDockSite::D ockPane | ウィンドウをこの CAuotHideDockSite オブジェクトにドッキングします。 |
| CAutoHideDockSite::GetAlignRect | 画面座標でドッキング サイトのサイズを取得します。 |
| CAutoHideDockSite::RepositionPanes | グローバル余白とボタン間隔を使用して、 CAutoHideDockSite のペインを再描画します。 |
| CAutoHideDockSite::SetOffsetLeft | ドッキング バーの左側の余白を設定します。 |
| CAutoHideDockSite::SetOffsetRight | ドッキング バーの右側の余白を設定します。 |
| CAutoHideDockSite::UnSetAutoHideMode | CAutoHideDockSite上のオブジェクトに対してCMFCAutoHideBar::UnSetAutoHideMode を呼び出します。 |
データ メンバー
| 名前 | 内容 |
|---|---|
| 名前 | 説明 |
| CAutoHideDockSite::m_nExtraSpace | ツールバーとドッキング バーの端の間のスペースのサイズを定義します。 このスペースは、ドッキングスペースの配置に応じて、左端または上端から測定されます。 |
解説
CFrameWndEx::EnableAutoHidePanes を呼び出すと、フレームワークによってCAutoHideDockSite オブジェクトが自動的に作成されます。 ほとんどの場合、このクラスを直接インスタンス化または使用する必要はありません。
ドッキング バーは、ドッキング ウィンドウの左側と、 CMFCAutoHideButton クラスの左側との間のギャップです。
継承階層
例
次の例では、CMFCAutoHideBar オブジェクトからCAutoHideDockSite オブジェクトを取得する方法と、ドッキング バーの左右の余白を設定する方法を示します。
CAutoHideDockSite *pParentDockBar = DYNAMIC_DOWNCAST(CAutoHideDockSite, pParentBar->GetParentDockSite());
pParentDockBar->SetOffsetLeft(10);
pParentDockBar->SetOffsetRight(10);
要件
Header: afxautohidedocksite.h
CAutoHideDockSite::CanAcceptPane
基本ペインが CMFCAutoHideBar オブジェクトであるか、 CMFCAutoHideBarから派生しているかを判断します。
virtual BOOL CanAcceptPane(const CBasePane* pBar) const;
パラメーター
pBar
[in]フレームワークがテストする基本ウィンドウ。
戻り値
pBarがCMFCAutoHideBarから派生している場合は TRUE。それ以外の場合は FALSE。
解説
基本ペイン オブジェクトが CMFCAutoHideBarから派生している場合は、 CAutoHideDockSiteを含めることができます。
CAutoHideDockSite::D ockPane
ウィンドウをこの CAutoHideDockSite オブジェクトにドッキングします。
virtual void DockPane(
CPane* pWnd,
AFX_DOCK_METHOD dockMethod,
LPRECT lpRect = NULL);
パラメーター
pWnd
[in]フレームワークがドッキングするウィンドウ。
dockMethod
[in]ウィンドウのドッキング オプション。
lpRect
[in]ドッキングされたペインの境界を指定する四角形。
解説
既定の実装では、将来使用するために提供されるパラメーター dockMethod は使用されません。
lpRect が NULL の場合、フレームワークはペインをドッキング サイトの既定の場所に配置します。 ドッキング サイトが水平の場合、既定の場所はドッキング サイトの左端にあります。 それ以外の場合、既定の場所はドック サイトの上部にあります。
CAutoHideDockSite::GetAlignRect
画面座標でドッキング サイトのサイズを取得します。
void GetAlignRect(CRect& rect) const;
パラメーター
rect
[in]四角形への参照。 このメソッドは、ドッキング サイトのサイズをこの四角形に格納します。
解説
四角形は、含めないようにオフセット余白に合わせて調整されます。
CAutoHideDockSite::m_nExtraSpace
CAutoHideDockSite クラスの端とCMFCAutoHideBar クラス オブジェクトの間のスペースのサイズ。
static int m_nExtraSpace;
解説
CMFCAutoHideBarがCAutoHideDockSiteにドッキングされている場合は、ドッキング サイト全体を占有しないでください。 このグローバル変数は、 CMFCAutoHideBar の左端または上端と対応する CAutoHideDockSite エッジの間の余分なスペースを制御します。 上端と左端のどちらを使用するかは、現在の配置によって異なります。
CAutoHideDockSite::SetOffsetLeft
ドッキング バーの左側の余白を設定します。
void SetOffsetLeft(int nOffset);
パラメーター
nOffset
[in]新しいオフセット。
解説
CMFCAutoHideBar オブジェクトは、 CAutoHideDockSite オブジェクトに静的に配置されます。 つまり、ユーザーはオブジェクトの場所を手動で変更 CMFCAutoHideBar 。 SetOffsetLeftメソッドは、左端のCMFCAutoHideBarの左側とCAutoHideDockSiteの左側の間隔を制御します。
CAutoHideDockSite::SetOffsetRight
ドッキング バーの右側の余白を設定します。
void SetOffsetRight(int nOffset);
パラメーター
nOffset
[in]新しいオフセット。
解説
CMFCAutoHideBar オブジェクトは、 CAutoHideDockSite オブジェクトに静的に配置されます。 つまり、ユーザーは、 CMFCAutoHideBar オブジェクトの場所を手動で変更することはできません。 SetOffsetRightメソッドは、右端のCMFCAutoHideBarとCAutoHideDockSiteの右側の間の間隔を制御します。
CAutoHideDockSite::RepositionPanes
CAutoHideDockSite のペインを再描画します。
virtual void RepositionPanes(CRect& rectNewClientArea);
パラメーター
rectNewClientArea
[in] 予約値。
解説
既定の実装では、 rectNewClientArea を使用しません。 ウィンドウは、グローバル ツールバーの余白とボタンの間隔で再描画されます。
CAutoHideDockSite::UnSetAutoHideMode
ドッキング サイト上のオブジェクト CMFCAutoHideBar::UnSetAutoHideMode を呼び出します。
void UnSetAutoHideMode(CMFCAutoHideBar* pAutoHideToolbar);
パラメーター
pAutoHideToolbar
[in]CAutoHideDockSiteにある CMFCAutoHideBar オブジェクト ペインへのポインター。
解説
このメソッドは、 pAutoHideToolbar を含む行を検索します。 その行のすべてのCMFCAutoHideBar オブジェクトに対してCMFCAutoHideBar.UnSetAutoHideModeを呼び出します。 pAutoHideToolbarが見つからないか NULL の場合、このメソッドは、CAutoHideDockSiteのすべてのCMFCAutoHideBar オブジェクトに対してCMFCAutoHideBar.UnSetAutoHideModeを呼び出します。