Share via


CMFCAutoHideButton クラス

非表示になるように構成されている CDockablePane Class を表示または非表示にするボタンです。

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

構文

class CMFCAutoHideButton : public CObject

メンバー

パブリック メソッド

名前 説明
CMFCAutoHideButton::BringToTop
CMFCAutoHideButton::Create 自動的に隠すボタンを作成して初期化します。
CMFCAutoHideButton::GetAlignment 自動的に隠すボタンの配置を取得します。
CMFCAutoHideButton::GetAutoHideWindow 自動非表示ボタンに 関連付けられている CDockablePane オブジェクトを返します。
CMFCAutoHideButton::GetParentToolBar
CMFCAutoHideButton::GetRect
CMFCAutoHideButton::GetSize 自動的に隠すボタンのサイズを調べます。
CMFCAutoHideButton::GetTextSize 自動的に隠すボタンのテキスト ラベルのサイズを返します。
CMFCAutoHideButton::HighlightButton 自動的に隠すボタンを強調表示します。
CMFCAutoHideButton::IsActive 自動的に隠すボタンがアクティブかどうかを示します。
CMFCAutoHideButton::IsHighlighted 自動的に隠すボタンの強調表示状態を返します。
CMFCAutoHideButton::IsHorizontal 自動的に隠すボタンの表示方向が水平と垂直のどちらであるかを判断します。
CMFCAutoHideButton::IsTop
CMFCAutoHideButton::IsVisible ボタンが表示されるかどうかを示します。
CMFCAutoHideButton::Move
CMFCAutoHideButton::OnDraw フレームワークは、自動的に隠すボタンを描画するときにこのメソッドを呼び出します。
CMFCAutoHideButton::OnDrawBorder フレームワークは、自動的に隠すボタンの境界線を描画するときにこのメソッドを呼び出します。
CMFCAutoHideButton::OnFillBackground フレームワークは、自動的に隠すボタンの背景を塗りつぶすときにこのメソッドを呼び出します。
CMFCAutoHideButton::ReplacePane
CMFCAutoHideButton::ShowAttachedWindow 関連付けられている CDockablePane クラスを表示または非表示にします。
CMFCAutoHideButton::ShowButton 自動的に隠すボタンの表示と非表示を切り替えます。
CMFCAutoHideButton::UnSetAutoHideMode

解説

作成時にCMFCAutoHideButton、オブジェクトは CDockablePane クラスアタッチされます。 ユーザーが CMFCAutoHideButton オブジェクトと対話操作を行うと、CDockablePane オブジェクトの非表示と表示が切り替えられます。

既定では、ユーザーが自動非表示をオンにすると、フレームワークが自動的に CMFCAutoHideButton を作成します。 フレームワークは、CMFCAutoHideButton クラスではなく、カスタム UI クラスの要素を作成できます。 フレームワークが使用するカスタム UI クラスを指定するには、静的メンバー変数 CMFCAutoHideBar::m_pAutoHideButtonRTS をカスタム UI クラスと等しくなるように設定します。 既定では、この変数は CMFCAutoHideButton に設定されます。

CMFCAutoHideButton オブジェクトを構築して CMFCAutoHideButton クラスのさまざまなメソッドを使用する方法を次の例に示します。 この例では、Create メソッドを使用して CMFCAutoHideButton オブジェクトを初期化する方法、関連付けられている CDockablePane クラスを表示する方法、および自動非表示ボタンを表示する方法を示しています。

CMFCAutoHideButton *autoHideButton = new CMFCAutoHideButton();
CDockablePane cPane;
// CMFCAutoHideBar* pParentBar
if (!autoHideButton->Create(pParentBar, &cPane, CBRS_ALIGN_LEFT))
{
   return 0;
}
autoHideButton->ShowAttachedWindow(true);
autoHideButton->ShowButton(true);

継承階層

CObject

CMFCAutoHideButton

必要条件

ヘッダー: afxautohidebutton.h

CMFCAutoHideButton::BringToTop

void BringToTop();

解説

CMFCAutoHideButton::Create

自動非表示ボタンを作成して初期化します。

virtual BOOL Create(
    CMFCAutoHideBar* pParentBar,
    CDockablePane* pAutoHideWnd,
    DWORD dwAlignment);

パラメーター

pParentBar
[in]親ツール バーへのポインター。

pAutoHideWnd
[in]CDockablePane オブジェクトへのポインター。 この自動非表示ボタンは非表示になり、表示されます CDockablePane

dwAlignment
[in]メイン フレーム ウィンドウでのボタンの配置を指定する値。

戻り値

正常終了した場合は 0 以外を返します。それ以外の場合は 0 を返します。

解説

オブジェクトを CMFCAutoHideButton 作成するときは、自動非表示ボタンを特定 CDockablePaneのボタンに関連付ける必要があります。 ユーザーは、自動非表示ボタンを使用して、関連付けられている CDockablePaneを非表示にして表示できます。

dwAlignment パラメーターは、自動非表示ボタンがアプリケーション内のどこに存在するかを示します。 このパラメーターは次のいずれかの値に設定できます。

  • CBRS_ALIGN_LEFT

  • CBRS_ALIGN_RIGHT

  • CBRS_ALIGN_TOP

  • CBRS_ALIGN_BOTTOM

CMFCAutoHideButton::GetAlignment

自動的に隠すボタンの配置を取得します。

DWORD GetAlignment() const;

戻り値

自動非表示ボタンの現在の配置を含む DWORD 値。

解説

自動非表示ボタンの配置は、ボタンがアプリケーション上のどこにあるかを示します。 次のいずれかの値を指定できます。

  • CBRS_ALIGN_LEFT

  • CBRS_ALIGN_RIGHT

  • CRBS_ALIGN_TOP

  • CBRS_ALIGN_BOTTOM

CMFCAutoHideButton::GetAutoHideWindow

自動非表示ボタンに 関連付けられている CDockablePane オブジェクトを返します。

CDockablePane* GetAutoHideWindow() const;

戻り値

関連付けられている CDockablePane オブジェクトへのポインター。

解説

自動非表示ボタンを a に関連付CDockablePaneけるには、パラメーターとして CMFCAutoHideButton::Create メソッドにCDockablePaneします。

CMFCAutoHideButton::GetParentToolBar

CMFCAutoHideBar* GetParentToolBar();

戻り値

解説

CMFCAutoHideButton::GetRect

CRect GetRect() const;

戻り値

解説

CMFCAutoHideButton::GetSize

自動的に隠すボタンのサイズを調べます。

CSize GetSize() const;

戻り値

ボタン の CSize サイズを含むオブジェクト。

解説

計算されたサイズには、自動非表示ボタンの境界線のサイズが含まれます。

CMFCAutoHideButton::GetTextSize

自動的に隠すボタンのテキスト ラベルのサイズを返します。

virtual CSize GetTextSize() const;

戻り値

自動非表示ボタンのテキストのサイズを格納している CSize オブジェクト。

CMFCAutoHideButton::IsActive

自動的に隠すボタンがアクティブかどうかを示します。

BOOL IsActive() const;

戻り値

自動非表示ボタンがアクティブな場合は TRUE。FAL Standard Editionそれ以外の場合。

解説

関連付けられている CDockablePane クラス ウィンドウが表示されると、自動非表示ボタンがアクティブになります。

CMFCAutoHideButton::IsHorizontal

自動的に隠すボタンの表示方向が水平と垂直のどちらであるかを判断します。

BOOL IsHorizontal() const;

戻り値

ボタンが水平の場合は 0 以外。それ以外の場合は 0。

解説

フレームワークは、作成時に CMFCAutoHideButton オブジェクトの向きを設定します。 CMFCAutoHideButton::Create メソッドの dwAlignment パラメーターを 使用して方向を 制御できます。

CMFCAutoHideButton::IsTop

BOOL IsTop() const;

戻り値

解説

CMFCAutoHideButton::IsVisible

自動非表示ボタンが表示されているかどうかを示します。

virtual BOOL IsVisible() const;

戻り値

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

CMFCAutoHideButton::OnDraw

フレームワークは、自動的に隠すボタンを描画するときにこのメソッドを呼び出します。

virtual void OnDraw(CDC* pDC);

パラメーター

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

解説

アプリケーションの自動非表示ボタンの外観をカスタマイズする場合は、派生 CMFCAutoHideButtonした新しいクラスを作成します。 派生クラスで、このメソッドをオーバーライドします。

CMFCAutoHideButton::OnDrawBorder

フレームワークは、自動的に隠すボタンの境界線を描画するときにこのメソッドを呼び出します。

virtual void OnDrawBorder(
    CDC* pDC,
    CRect rectBounds,
    CRect rectBorderSize);

パラメーター

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

rectBounds
[in]自動非表示ボタンの外接する四角形。

rectBorderSize
[in]自動非表示ボタンの各辺の境界線の太さ。

解説

アプリケーションの各自動非表示ボタンの境界線をカスタマイズする場合は、CMFCAutoHideButton 派生クラスで、このメソッドをオーバーライドします。

CMFCAutoHideButton::OnFillBackground

フレームワークは、自動的に隠すボタンの背景を塗りつぶすときにこのメソッドを呼び出します。

virtual void OnFillBackground(
    CDC* pDC,
    CRect rect);

パラメーター

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

rect
[in]自動非表示ボタンの外接する四角形。

解説

アプリケーションの自動非表示ボタンの背景をカスタマイズする場合は、CMFCAutoHideButton 派生クラスで、このメソッドをオーバーライドします。

CMFCAutoHideButton::ShowAttachedWindow

関連付けられている CDockablePane クラスを表示または非表示にします。

void ShowAttachedWindow(BOOL bShow);

パラメーター

bShow
[in]このメソッドが添付 CDockablePaneを表示するかどうかを指定するブール値です。

CMFCAutoHideButton::ShowButton

自動的に隠すボタンの表示と非表示を切り替えます。

virtual void ShowButton(BOOL bShow);

パラメーター

bShow
[in]自動非表示ボタンを表示するかどうかを指定するブール値。

CMFCAutoHideButton::Move

void Move(int nOffset);

パラメーター

[in] nOffset

解説

CMFCAutoHideButton::ReplacePane

void ReplacePane(CDockablePane* pNewBar);

パラメーター

[in] pNewBar

解説

CMFCAutoHideButton::UnSetAutoHideMode

自動的に隠すモードを無効にします。

virtual void UnSetAutoHideMode(CDockablePane* pFirstBarInGroup);

パラメーター

pFirstBarInGroup
[in]グループ内の最初のバーへのポインター。

解説

CMFCAutoHideButton::HighlightButton

自動非表示ボタンを強調表示します。

virtual void HighlightButton(BOOL bHighlight);

パラメーター

bHighlight
新しい自動非表示ボタンの状態を指定します。 TRUE はボタンが強調表示されていることを示し、FAL Standard Edition はボタンが強調表示されていないことを示します。

解説

CMFCAutoHideButton::IsHighlighted

自動非表示ボタンの強調表示状態を返します。

virtual BOOL IsHighlighted() const;

戻り値

自動非表示ボタンが強調表示されている場合は TRUE を返します。それ以外の場合は FAL Standard Edition。

解説

関連項目

階層図
クラス
CMFCAutoHideBar クラス
CAutoHideDockSite クラス