CMFCCaptionButton (clase)

La clase CMFCCaptionButton implementa un botón que se muestra en la barra de título de un panel acoplable o una ventana minimarco. Normalmente, el marco de trabajo crea botones de título automáticamente.

Sintaxis

class CMFCCaptionButton : public CObject

Miembros

Constructores

Nombre	Descripción
CMFCCaptionButton::CMFCCaptionButton	Construye un objeto CMFCCaptionButton.

Métodos públicos

Nombre	Descripción
CMFCCaptionButton::GetHit	Devuelve el comando representado por el botón.
CMFCCaptionButton::GetIconID	Devuelve el identificador de la imagen asociado al botón.
CMFCCaptionButton::GetRect	Devuelve el rectángulo ocupado por el botón.
CMFCCaptionButton::GetSize	Devuelve el ancho y alto del botón.
CMFCCaptionButton::IsMiniFrameButton	Indica si el alto de la barra de título está establecido en tamaño mini.
CMFCCaptionButton::Move	Establece la ubicación de dibujo del botón y el estado de presentación de la ventana.
CMFCCaptionButton::OnDraw	Dibuja el botón de título.
CMFCCaptionButton::SetMiniFrameButton	Establece el tamaño mini de la barra de título.

Comentarios

Puede derivar una clase de CPaneFrameWnd (clase) y usar el método protegido, AddButton, para agregar botones de título a una ventana de marco mini.

CPaneFrameWnd.h define los identificadores de comando para dos tipos de botones de título:

• AFX_CAPTION_BTN_PIN, que muestra un botón de anclaje cuando el panel de acoplamiento admite el modo de ocultación automática.

• AFX_CAPTION_BTN_CLOSE, que muestra un botón Cerrar cuando el panel se puede cerrar u ocultar.

Ejemplo

En el ejemplo siguiente se muestra cómo construir un objeto CMFCCaptionButton y establecer el tamaño mini de la barra de título.

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

Jerarquía de herencia

CObject

CMFCCaptionButton

Requisitos

Encabezado: afxcaptionbutton.h

CMFCCaptionButton::CMFCCaptionButton

Construye un objeto CMFCCaptionButton.

CMFCCaptionButton();

CMFCCaptionButton(
    UINT nHit,
    BOOL bLeftAlign = FALSE);

Parámetros

nHit
[in] Comando asociado al botón.

bLeftAlign
[in] Especifica si el botón está alineado a la izquierda.

En la siguiente tabla se muestran los posibles valores del parámetro nHit.

Valor	Get-Help
AFX_HTCLOSE	Botón Cerrar
HTMINBUTTON	Botón Minimizar
HTMAXBUTTON	Botón Maximizar
AFX_HTLEFTBUTTON	Botón de flecha izquierda.
AFX_HTRIGHTBUTTON	Botón de flecha derecha.
AFX_HTMENU	Botón de menú de flecha abajo
HTNOWHERE	Valor predeterminado; no representa ningún comando.

Comentarios

De forma predeterminada, los botones de título no están asociados a ningún comando.

Los botones de título se alinean a la derecha o a la izquierda.

CMFCCaptionButton::GetHit

Devuelve el comando representado por el botón.

UINT GetHit() const;

Valor devuelto

Comando representado por el botón.

En la tabla siguiente se muestran los valores devueltos posibles.

Valor	Get-Help
AFX_HTCLOSE	Botón Cerrar
HTMINBUTTON	Botón Minimizar
HTMAXBUTTON	Botón Maximizar
AFX_HTLEFTBUTTON	Botón de flecha izquierda.
AFX_HTRIGHTBUTTON	Botón de flecha derecha.
AFX_HTMENU	Botón de menú de flecha abajo
HTNOWHERE	Valor predeterminado; no representa ningún comando.

CMFCCaptionButton::GetIconID

Devuelve el identificador de la imagen asociado al botón.

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

Parámetros

bHorz
[in] TRUE para los identificadores de imagen de flecha izquierda o derecha; FALSE para los identificadores de imagen de flecha arriba o abajo.

bMaximized
[in] TRUE para un identificador de imagen para maximizar; FALSE para un identificador de imagen para minimizar.

Valor devuelto

El identificador de la imagen.

Comentarios

Los parámetros especifican identificadores de imagen para minimizar o maximizar botones de título.

CMFCCaptionButton::GetRect

Devuelve el rectángulo ocupado por el botón.

virtual CRect GetRect() const;

Valor devuelto

Rectángulo que representa la ubicación del botón.

Comentarios

Si no puede ver el botón, el tamaño devuelto es 0.

CMFCCaptionButton::GetSize

Devuelve el ancho y alto del botón.

static CSize GetSize();

Valor devuelto

Dimensiones externas del botón.

Comentarios

El tamaño devuelto incluye el margen del botón y el borde.

CMFCCaptionButton::IsMiniFrameButton

Indica si el alto de la barra de título está establecido en tamaño mini.

BOOL IsMiniFrameButton() const;

Valor devuelto

TRUE si el título está establecido en tamaño mini; en caso contrario, FALSE.

Comentarios

CMFCCaptionButton::Move

Establece la ubicación de dibujo del botón y el estado de presentación de la ventana.

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

Parámetros

ptTo
[in] La nueva ubicación.

bHide
[in] Indica si se va a mostrar el botón.

CMFCCaptionButton::OnDraw

Dibuja el botón de título.

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

Parámetros

pDC
[in] Puntero a un contexto de dispositivo para el botón.

bActive
[in] Si se va a dibujar una imagen de botón activo.

bHorz
[in] Reservado para su uso en una clase derivada.

bMaximized
[in] Si se va a dibujar una imagen de botón maximizado.

bDisabled
[in] Si se va a dibujar una imagen de botón habilitado.

Comentarios

El parámetro bMaximized se usa cuando el botón es un botón Maximizar o Minimizar.

CMFCCaptionButton::SetMiniFrameButton

Establece el tamaño mini de la barra de título.

void SetMiniFramebutton(BOOL bSet = TRUE);

Parámetros

bSet
[in] TRUE para el alto de la barra de título mini; FALSE para el alto predeterminado de la barra de título.

Consulte también

Gráfico de jerarquías
Clases
CPaneFrameWnd (clase)
CDockablePane (clase)