Classe CMFCCaptionButton

  • Artigo

A classe CMFCCaptionButton implementa um botão exibido na barra de título para um painel de encaixe ou uma janela com minimoldura. Normalmente, a estrutura cria botões de legenda automaticamente.

Sintaxe

class CMFCCaptionButton : public CObject

Membros

Construtores

Nome Descrição
CMFCCaptionButton::CMFCCaptionButton Constrói um objeto CMFCCaptionButton.

Métodos públicos

Nome Descrição
CMFCCaptionButton::GetHit Retorna o comando representado pelo botão.
CMFCCaptionButton::GetIconID Retorna a ID de imagem associada ao botão.
CMFCCaptionButton::GetRect Retorna o retângulo ocupado pelo botão.
CMFCCaptionButton::GetSize Retorna a largura e a altura do botão.
CMFCCaptionButton::IsMiniFrameButton Indica se a altura da barra de título está definida como tamanho mínimo.
CMFCCaptionButton::Move Define o local de desenho do botão e o estado de exibição da janela.
CMFCCaptionButton::OnDraw Desenha o botão de título.
CMFCCaptionButton::SetMiniFrameButton Define o tamanho mini da barra de título.

Comentários

Você pode derivar uma classe da Classe CPaneFrameWnd e usar o método protegido, AddButton, para adicionar botões de legenda a uma mini janela de quadro.

CPaneFrameWnd.h define IDs de comando para dois tipos de botões de título:

  • AFX_CAPTION_BTN_PIN, que exibe um botão de fixação quando o painel de encaixe dá suporte ao modo de ocultação automática.

  • AFX_CAPTION_BTN_CLOSE, que exibe um botão Fechar quando o painel pode ser fechado ou oculto.

Exemplo

O exemplo a seguir demonstra como construir um objeto CMFCCaptionButton e definir o tamanho mini da barra de título.

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

Hierarquia de herança

CObject

CMFCCaptionButton

Requisitos

Cabeçalho: afxcaptionbutton.h

CMFCCaptionButton::CMFCCaptionButton

Constrói um objeto CMFCCaptionButton.

CMFCCaptionButton();

CMFCCaptionButton(
    UINT nHit,
    BOOL bLeftAlign = FALSE);

Parâmetros

nHit
[in] O comando associado ao botão.

bLeftAlign
[in] Especifica se o botão está alinhado à esquerda.

A tabela a seguir lista os possíveis valores do parâmetro nHit.

Valor Comando
AFX_HTCLOSE Botão Fechar.
HTMINBUTTON Botão Minimizar.
HTMAXBUTTON Botão Maximizar.
AFX_HTLEFTBUTTON Botão de seta para a esquerda.
AFX_HTRIGHTBUTTON Botão de seta para a direita.
AFX_HTMENU Botão de menu de seta para baixo.
HTNOWHERE O valor padrão; não representa nenhum comando.

Comentários

Por padrão, os botões de título não estão associados a um comando.

Os botões de título estão alinhados à direita ou à esquerda.

CMFCCaptionButton::GetHit

Retorna o comando representado pelo botão.

UINT GetHit() const;

Valor de retorno

O comando representado pelo botão.

A seguinte tabela lista os possíveis valores retornados.

Valor Comando
AFX_HTCLOSE Botão Fechar.
HTMINBUTTON Botão Minimizar.
HTMAXBUTTON Botão Maximizar.
AFX_HTLEFTBUTTON Botão de seta para a esquerda.
AFX_HTRIGHTBUTTON Botão de seta para a direita.
AFX_HTMENU Botão de menu de seta para baixo.
HTNOWHERE O valor padrão; não representa nenhum comando.

CMFCCaptionButton::GetIconID

Retorna a ID de imagem associada ao botão.

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

Parâmetros

bHorz
[in] TRUE para IDs de imagem de seta para a esquerda ou para a direita; FALSE para IDs de imagem de seta para cima ou para baixo.

bMaximized
[in] TRUE para uma ID de imagem de maximizar; FALSE para uma ID de imagem de minimizar.

Valor de retorno

A ID da imagem.

Comentários

Os parâmetros especificam IDs de imagem para minimizar ou maximizar botões de título.

CMFCCaptionButton::GetRect

Retorna o retângulo ocupado pelo botão.

virtual CRect GetRect() const;

Valor de retorno

O retângulo que representa o local do botão.

Comentários

Se você não conseguir ver o botão, o tamanho retornado será 0.

CMFCCaptionButton::GetSize

Retorna a largura e a altura do botão.

static CSize GetSize();

Valor de retorno

As dimensões externas do botão.

Comentários

O tamanho retornado inclui margem e borda de botão.

CMFCCaptionButton::IsMiniFrameButton

Indica se a altura da barra de título está definida como tamanho mínimo.

BOOL IsMiniFrameButton() const;

Valor de retorno

TRUE se a legenda estiver definida como tamanho mini; caso contrário, FALSE.

Comentários

CMFCCaptionButton::Move

Define o local de desenho do botão e o estado de exibição da janela.

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

Parâmetros

ptTo
[in] O novo local.

bHide
[in] Se deve mostrar o botão.

CMFCCaptionButton::OnDraw

Desenha o botão de título.

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

Parâmetros

pDC
[in] Ponteiro para um contexto de dispositivo para o botão.

bActive
[in] Se deseja desenhar uma imagem de botão ativo.

bHorz
[in] Reservado para uso em uma classe derivada.

bMaximized
[in] Se deseja desenhar uma imagem de botão maximizado.

bDisabled
[in] Se deseja desenhar uma imagem de botão habilitado.

Comentários

O parâmetro bMaximized é usado quando o botão é um botão maximizar ou minimizar.

CMFCCaptionButton::SetMiniFrameButton

Define o tamanho mini da barra de título.

void SetMiniFramebutton(BOOL bSet = TRUE);

Parâmetros

bSet
[in] TRUE para a altura da barra de título mini; FALSE para a altura da barra de título padrão.

Confira também

Gráfico da hierarquia
Classes
Classe CPaneFrameWnd
Classe CDockablePane