Класс CMFCAutoHideButton
Кнопка, отображающая или скрывающая CDockablePane Class , настроенный на скрытие.
Дополнительные сведения см. в исходном коде, расположенном в папке VC\atlmfc\src\mfc установки Visual Studio.
Синтаксис
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 платформа может создавать элемент настраиваемого класса пользовательского интерфейса. Чтобы указать, какой настраиваемый класс пользовательского интерфейса должна использовать платформа, задайте для статической переменной-члена CMFCAutoHideBar::m_pAutoHideButtonRTS значение, равное необходимому настраиваемому классу. Значение этой переменной по умолчанию — 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);
Иерархия наследования
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.
Замечания
При создании 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 при его создании. Вы можете управлять ориентацией с помощью параметра dwAlignment в методе CMFCAutoHideButton::Create .
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.
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