Класс CMFCCaptionButton

Класс CMFCCaptionButton реализует кнопку, отображаемую на панели заголовков для панели закрепления или окна мини-кадра. Как правило, платформа создает кнопки заголовка автоматически.

Синтаксис

class CMFCCaptionButton : public CObject

Участники

Конструкторы

Имя	Описание
CMFCCaptionButton::CMFCCaptionButton	Создает объект CMFCCaptionButton.

Открытые методы

Имя	Описание
CMFCCaptionButton::GetHit	Возвращает команду, представленную кнопкой.
CMFCCaptionButton::GetIconID	Возвращает идентификатор изображения, связанный с кнопкой.
CMFCCaptionButton::GetRect	Возвращает прямоугольник, занятый кнопкой.
CMFCCaptionButton::GetSize	Возвращает ширину и высоту кнопки.
CMFCCaptionButton::IsMiniFrameButton	Указывает, задана ли высота строки заголовка мини-размер.
CMFCCaptionButton::Move	Задает расположение рисования кнопки и состояние окна.
CMFCCaptionButton::OnDraw	Рисует кнопку заголовка.
CMFCCaptionButton::SetMiniFrameButton	Задает мини-размер строки заголовка.

Замечания

Класс CPaneFrameWnd можно наследовать и использовать защищенный метод, AddButtonчтобы добавить кнопки заголовка в мини-окно фрейма.

CPaneFrameWnd.h определяет идентификаторы команд для двух типов кнопок заголовка:

• AFX_CAPTION_BTN_PIN, который отображает кнопку закрепления при закреплении панели поддержки режима автоматического скрытия.

• AFX_CAPTION_BTN_CLOSE, которая отображает кнопку "Закрыть ", когда панель может быть закрыта или скрыта.

Пример

В следующем примере показано, как создать CMFCCaptionButton объект и задать мини-размер строки заголовка.

CMFCCaptionButton *captionButton = new CMFCCaptionButton(AFX_HTCLOSE);
captionButton->SetMiniFrameButton(true);

Иерархия наследования

CObject

CMFCCaptionButton

Требования

Заголовок: afxcaptionbutton.h

CMFCCaptionButton::CMFCCaptionButton

Формирует объект CMFCCaptionButton.

CMFCCaptionButton();

CMFCCaptionButton(
    UINT nHit,
    BOOL bLeftAlign = FALSE);

Параметры

nHit
[in] Команда, связанная с кнопкой.

bLeftAlign
[in] Указывает, выравнивается ли кнопка слева.

В следующей таблице перечислены возможные значения для параметра nHit .

Значение	Команда
AFX_HTCLOSE	Кнопка "Закрыть".
HTMINBUTTON	Кнопка "Свернуть".
HTMAXBUTTON	Кнопка "Развернуть".
AFX_HTLEFTBUTTON	Кнопка со стрелкой влево.
AFX_HTRIGHTBUTTON	Кнопка со стрелкой вправо.
AFX_HTMENU	Кнопка меню стрелки вниз.
HTNOWHERE	Значение по умолчанию; не представляет команды.

Замечания

По умолчанию кнопки заголовка не связаны с командой.

Кнопки заголовка выровнены вправо или влево.

CMFCCaptionButton::GetHit

Возвращает команду, представленную кнопкой.

UINT GetHit() const;

Возвращаемое значение

Команда, представленная кнопкой.

В следующей таблице перечислены возможные возвращаемые значения.

Значение	Команда
AFX_HTCLOSE	Кнопка "Закрыть".
HTMINBUTTON	Кнопка "Свернуть".
HTMAXBUTTON	Кнопка "Развернуть".
AFX_HTLEFTBUTTON	Кнопка со стрелкой влево.
AFX_HTRIGHTBUTTON	Кнопка со стрелкой вправо.
AFX_HTMENU	Кнопка меню стрелки вниз.
HTNOWHERE	Значение по умолчанию; не представляет команды.

CMFCCaptionButton::GetIconID

Возвращает идентификатор изображения, связанный с кнопкой.

virtual CMenuImages::IMAGES_IDS GetIconID(
    BOOL bHorz,
    BOOL bMaximized = FALSE) const;

Параметры

bHorz
[in] TRUE для идентификаторов изображений влево или вправо; FALSE для идентификаторов изображений стрелки вверх или вниз.

bMaximized
[in] ЗНАЧЕНИЕ TRUE для максимального идентификатора изображения; ЗНАЧЕНИЕ FALSE для идентификатора сверток изображения.

Возвращаемое значение

Идентификатор изображения.

Замечания

Параметры указывают идентификаторы изображений для кнопок сворачивания или максимального увеличения подписей.

CMFCCaptionButton::GetRect

Возвращает прямоугольник, занятый кнопкой.

virtual CRect GetRect() const;

Возвращаемое значение

Прямоугольник, представляющий расположение кнопки.

Замечания

Если кнопка не отображается, возвращается значение 0.

CMFCCaptionButton::GetSize

Возвращает ширину и высоту кнопки.

static CSize GetSize();

Возвращаемое значение

Внешние размеры кнопки.

Замечания

Возвращаемый размер включает поле кнопки и границу.

CMFCCaptionButton::IsMiniFrameButton

Указывает, задана ли высота строки заголовка мини-размер.

BOOL IsMiniFrameButton() const;

Возвращаемое значение

ЗНАЧЕНИЕ TRUE, если заголовок имеет мини-размер; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

CMFCCaptionButton::Move

Задает расположение рисования кнопки и состояние окна.

void Move(
    const CPoint& ptTo,
    BOOL bHide = FALSE);

Параметры

ptTo
[in] Новое расположение.

bHide
[in] Указывает, следует ли отображать кнопку.

CMFCCaptionButton::OnDraw

Рисует кнопку заголовка.

virtual void OnDraw(
    CDC* pDC,
    BOOL bActive,
    BOOL bHorz = TRUE,
    BOOL bMaximized = TRUE,
    BOOL bDisabled = FALSE);

Параметры

pDC
[in] Указатель на контекст устройства для кнопки.

bActive
[in] Нарисуйте активное изображение кнопки.

bHorz
[in] Зарезервировано для использования в производном классе.

bMaximized
[in] Нарисуйте развернутое изображение кнопки.

bDisabled
[in] Нарисуйте изображение кнопки с включенным параметром.

Замечания

Параметр bMaximized используется, когда кнопка является максимальной или свернутой кнопкой.

CMFCCaptionButton::SetMiniFrameButton

Задает мини-размер строки заголовка.

void SetMiniFramebutton(BOOL bSet = TRUE);

Параметры

bSet
[in] TRUE для высоты мини-заголовка; ЗНАЧЕНИЕ FALSE для высоты заголовка по умолчанию.

См. также

Диаграмма иерархии
Классы
Класс CPaneFrameWnd
Класс CDockablePane