CMFCAutoHideButton 类

显示或隐藏配置为隐藏的 CDockablePane Class 按钮。

有关详细信息,请参阅所安装的 Visual Studio 的 C\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 Class 类。
CMFCAutoHideButton::ShowButton 显示或隐藏自动隐藏按钮。
CMFCAutoHideButton::UnSetAutoHideMode

注解

在创建过程中,CMFCAutoHideButton 对象附加到 CDockablePane 类CDockablePane 对象随着用户与 CMFCAutoHideButton 对象交互而隐藏或显示。

默认情况下,框架在用户打开“自动隐藏”时自动创建 CMFCAutoHideButton。 框架可创建自定义 UI 类的元素而不是 CMFCAutoHideButton 类。 若要指定框架应使用的自定义 UI 类,请将静态成员变量 CMFCAutoHideBar::m_pAutoHideButtonRTS 设置为自定义 UI 类。 默认情况下,此变量设置为 CMFCAutoHideButton

示例

下面的示例演示如何构造 CMFCAutoHideButton 对象和在 CMFCAutoHideButton 类中使用各种方法。 该示例演示如何使用 CMFCAutoHideButton 对象的 Create 方法来初始化该对象,并显示关联的 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 对象的指针。

备注

若要将自动隐藏按钮与 CDockablePane 关联,请将 CDockablePane 作为参数传递给 CMFCAutoHideButton::Create 方法。

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;否则为 FALSE。

备注

显示关联的 CDockablePane 类窗口时,自动隐藏按钮处于活动状态。

CMFCAutoHideButton::IsHorizontal

确定自动隐藏按钮的方向是水平还是垂直。

BOOL IsHorizontal() const;

返回值

如果按钮为水平方向,则为非零;否则为 0。

注解

框架在你创建 CMFCAutoHideButton 对象时设置其方向。 可以使用 CMFCAutoHideButton::Create 方法中的 dwAlignment 参数来控制方向

CMFCAutoHideButton::IsTop

BOOL IsTop() const;

返回值

注解

CMFCAutoHideButton::IsVisible

指示自动隐藏按钮是否可见。

virtual BOOL IsVisible() const;

返回值

如果按钮可见,则为 TRUE;否则为 FALSE。

CMFCAutoHideButton::OnDraw

框架在绘制自动隐藏按钮时调用此方法。

virtual void OnDraw(CDC* pDC);

参数

pDC
[in] 指向设备上下文的指针。

备注

如果想自定义应用程序中自动隐藏按钮的外观,请创建一个派生自 CMFCAutoHideButton 的新类。 在派生类中,重写此方法。

CMFCAutoHideButton::OnDrawBorder

框架在绘制自动隐藏按钮的边框时调用此方法。

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

参数

pDC
[in] 指向设备上下文的指针。

rectBounds
[in] 自动隐藏按钮的边框。

rectBorderSize
[in] 自动隐藏按钮每一侧的边框粗细。

备注

如果想自定义应用程序中每个自动隐藏按钮的边框,请创建一个派生自 CMFCAutoHideButton 的新类。 在派生类中,重写此方法。

CMFCAutoHideButton::OnFillBackground

框架在填充自动隐藏按钮的背景时调用此方法。

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

参数

pDC
[in] 指向设备上下文的指针。

rect
[in] 自动隐藏按钮的边框。

注解

如果想自定义应用程序中自动隐藏按钮的背景,请创建一个派生自 CMFCAutoHideButton 的新类。 在派生类中,重写此方法。

CMFCAutoHideButton::ShowAttachedWindow

显示或隐藏关联的 CDockablePane Class 类。

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 表示按钮已突出显示,FALSE 表示按钮未突出显示。

注解

CMFCAutoHideButton::IsHighlighted

返回自动隐藏按钮的突出显示状态。

virtual BOOL IsHighlighted() const;

返回值

如果自动隐藏按钮已突出显示,则返回 TRUE;否则返回 FALSE。

备注

另请参阅

层次结构图

CMFCAutoHideBar 类
CAutoHideDockSite 类