Partilhar via


Classe CMFCCaptionButton

Observação

A biblioteca Microsoft Foundation Classes (MFC) continua a ser suportada. No entanto, já não estamos a adicionar funcionalidades nem a atualizar a documentação.

A CMFCCaptionButton classe implementa um botão que é exibido na barra de legendas para um painel de acoplamento ou uma janela de mini-moldura. Normalmente, o framework cria automaticamente botões de legenda.

Sintaxe

class CMFCCaptionButton : public CObject

Membros

Construtores

Nome Description
CMFCCaptionButton::CMFCCaptionButton Constrói um objeto CMFCCaptionButton.

Métodos Públicos

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

Observações

Pode derivar uma classe a partir da CPaneFrameWnd Class e usar o método protegido, AddButton, para adicionar botões de legenda a uma janela de mini moldura.

CPaneFrameWnd.h define IDs de comandos para dois tipos de botões de legenda:

  • AFX_CAPTION_BTN_PIN, que mostra um botão de alfinete quando o painel de acoplamento suporta o modo de ocultação automática.

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

Example

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

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

Hierarquia de herança

CObject

CMFCCaptionButton

Requerimentos

Cabeçalho: afxcaptionbutton.h

CMFCCaptionButton::CMFCCaptionButton

Constrói um CMFCCaptionButton objeto.

CMFCCaptionButton();

CMFCCaptionButton(
    UINT nHit,
    BOOL bLeftAlign = FALSE);

Parâmetros

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

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

A tabela seguinte lista os valores possíveis para o parâmetro nHit .

Valor Comando
AFX_HTCLOSE Fecha o botão.
HTMINBUTTON Botão de minimizar.
HTMAXBUTTON Botão de maximizar.
AFX_HTLEFTBUTTON Botão de seta para a esquerda.
AFX_HTRIGHTBUTTON Botão de seta para a direita.
AFX_HTMENU Botão do menu da seta para baixo.
Em lado nenhum O valor padrão; não representa nenhuma ordem.

Observações

Por defeito, os botões de legenda não estão associados a um comando.

Os botões de legenda estão alinhados à direita ou à esquerda.

CMFCCaptionButton::GetHit

Devolve o comando representado pelo botão.

UINT GetHit() const;

Valor de retorno

O comando representado pelo botão.

A tabela seguinte lista possíveis valores de retorno.

Valor Comando
AFX_HTCLOSE Fecha o botão.
HTMINBUTTON Botão de minimizar.
HTMAXBUTTON Botão de maximizar.
AFX_HTLEFTBUTTON Botão de seta para a esquerda.
AFX_HTRIGHTBUTTON Botão de seta para a direita.
AFX_HTMENU Botão do menu da seta para baixo.
Em lado nenhum O valor padrão; não representa nenhuma ordem.

CMFCCaptionButton::GetIconID

Devolve o ID da imagem associado ao botão.

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

Parâmetros

bHorz
[dentro] TRUE para identificações de imagem com seta esquerda ou direita; FALSE para identificações de imagem com seta para cima ou para baixo.

bMaximizado
[dentro] TRUE para maximizar o ID da imagem; FALSE para minimizar ID de imagem.

Valor de retorno

O ID com imagem.

Observações

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

CMFCCaptionButton::GetRect

Devolve o retângulo ocupado pelo botão.

virtual CRect GetRect() const;

Valor de retorno

O retângulo que representa a localização do botão.

Observações

Se não conseguir ver o botão, o tamanho devolvido é 0.

CMFCCaptionButton::GetSize

Devolve a largura e altura do botão.

static CSize GetSize();

Valor de retorno

As dimensões exteriores do botão.

Observações

O tamanho devolvido inclui a margem e a borda dos botões.

CMFCCaptionButton::IsMiniFrameButton

Indica se a altura da barra de título está definida para tamanho mini.

BOOL IsMiniFrameButton() const;

Valor de retorno

TRUE se a legenda estiver definida para tamanho mini; caso contrário, FALSO.

Observações

CMFCCaptionButton::Move

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

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

Parâmetros

ptTo
[dentro] A nova localização.

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

CMFCCaptionButton::OnDraw

Desenha o botão da legenda.

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

Parâmetros

pDC
[dentro] Apontar para o contexto do dispositivo para o botão.

bActive
[dentro] Se deve desenhar uma imagem de botão ativo.

bHorz
[dentro] Reservado para uso numa classe derivada.

bMaximizado
[dentro] Se deve desenhar uma imagem de botão maximizada.

bDeficiente
[dentro] Se deve desenhar uma imagem de botão ativada.

Observações

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

CMFCCaptionButton::SetMiniFrameButton

Define o mini tamanho da barra de título.

void SetMiniFramebutton(BOOL bSet = TRUE);

Parâmetros

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

Consulte também

Gráfico de Hierarquia
Classes
Classe CPaneFrameWnd
CDockablePane Classe