CMFCAutoHideButton (clase)

Botón que muestra u oculta una CDockablePane Class configurada para ocultar.

Para obtener información más detallada, consulta el código fuente que se ubica en la carpeta VC\atlmfc\src\mfc de la instalación de Visual Studio.

Sintaxis

class CMFCAutoHideButton : public CObject

Miembros

Métodos públicos

Nombre	Descripción
CMFCAutoHideButton::BringToTop
CMFCAutoHideButton::Create	Crea e inicializa el botón de ocultación automática.
CMFCAutoHideButton::GetAlignment	Recupera la alineación del botón de ocultación automática.
CMFCAutoHideButton::GetAutoHideWindow	Devuelve el objeto CDockablePane asociado con el botón de ocultación automática.
CMFCAutoHideButton::GetParentToolBar
CMFCAutoHideButton::GetRect
CMFCAutoHideButton::GetSize	Determina el tamaño del botón de ocultación automática.
CMFCAutoHideButton::GetTextSize	Devuelve el tamaño de la etiqueta de texto para el botón de ocultación automática.
CMFCAutoHideButton::HighlightButton	Resalta el botón de ocultación automática.
CMFCAutoHideButton::IsActive	Indica si el botón de ocultación automática está activo.
CMFCAutoHideButton::IsHighlighted	Devuelve el estado de resaltado del botón de ocultación automática.
CMFCAutoHideButton::IsHorizontal	Determina si el botón de ocultación automática es horizontal o vertical.
CMFCAutoHideButton::IsTop
CMFCAutoHideButton::IsVisible	Indica si el botón está visible.
CMFCAutoHideButton::Move
CMFCAutoHideButton::OnDraw	El marco de trabajo llama a este método cuando dibuja el botón de ocultación automática.
CMFCAutoHideButton::OnDrawBorder	El marco de trabajo llama a este método cuando dibuja el borde de un botón de ocultación automática.
CMFCAutoHideButton::OnFillBackground	El marco de trabajo llama a este método cuando rellena el fondo de un botón de ocultación automática.
CMFCAutoHideButton::ReplacePane
CMFCAutoHideButton::ShowAttachedWindow	Muestra u oculta la Clase CDockablePane asociada.
CMFCAutoHideButton::ShowButton	Muestra u oculta el botón de ocultación automática.
CMFCAutoHideButton::UnSetAutoHideMode

Comentarios

Durante la creación, el objeto CMFCAutoHideButton se adjunta a una Clase CDockablePane. El objeto CDockablePane se oculta o se muestra cuando el usuario interactúa con el objeto CMFCAutoHideButton.

De forma predeterminada, el marco de trabajo crea automáticamente un CMFCAutoHideButton cuando el usuario activa la ocultación automática. El marco de trabajo puede crear un elemento de una clase de interfaz de usuario personalizada en lugar de la clase CMFCAutoHideButton. Para especificar qué clase de interfaz de usuario personalizada debería utilizar, establezca la variable de miembro estático CMFCAutoHideBar::m_pAutoHideButtonRTS igual que la clase de interfaz de usuario personalizada. De forma predeterminada, esta variable se establece en CMFCAutoHideButton.

Ejemplo

En el siguiente ejemplo se muestra cómo construir un objeto CMFCAutoHideButton y cómo usar varios métodos de la clase CMFCAutoHideButton. En el ejemplo se muestra cómo inicializar un objeto CMFCAutoHideButton mediante su método Create, mostrar la clase asociada CDockablePane y mostrar el botón de ocultación automática.

CMFCAutoHideButton *autoHideButton = new CMFCAutoHideButton();
CDockablePane cPane;
// CMFCAutoHideBar* pParentBar
if (!autoHideButton->Create(pParentBar, &cPane, CBRS_ALIGN_LEFT))
{
   return 0;
}
autoHideButton->ShowAttachedWindow(true);
autoHideButton->ShowButton(true);

Jerarquía de herencia

CObject

CMFCAutoHideButton

Requisitos

Encabezado: afxautohidebutton.h

CMFCAutoHideButton::BringToTop

void BringToTop();

Comentarios

CMFCAutoHideButton::Create

Crea e inicializa un botón de ocultación automática.

virtual BOOL Create(
    CMFCAutoHideBar* pParentBar,
    CDockablePane* pAutoHideWnd,
    DWORD dwAlignment);

Parámetros

pParentBar
[in] Puntero al botón primario de la barra de herramientas.

pAutoHideWnd
[in] Puntero a un objeto de CDockablePane. Este botón ocultar automáticamente oculta y muestra que CDockablePane.

dwAlignment
[in] Un valor que especifica la alineación del botón con la ventana de marco principal.

Valor devuelto

Si es correcta, su valor es distinto de cero. En caso contrario, es cero.

Comentarios

Al crear un objeto CMFCAutoHideButton, debe asociar el botón ocultar automáticamente con un específico CDockablePane. El usuario puede usar el botón ocultar automáticamente para ocultar y mostrar el asociado CDockablePane.

El parámetro dwAlignment indica dónde reside el botón Ocultar automáticamente en la aplicación. El parámetro puede establecerse en uno de los valores siguientes:

• CBRS_ALIGN_LEFT

• CBRS_ALIGN_RIGHT

• CBRS_ALIGN_TOP

• CBRS_ALIGN_BOTTOM

CMFCAutoHideButton::GetAlignment

Recupera la alineación del botón de ocultación automática.

DWORD GetAlignment() const;

Valor devuelto

Valor DWORD que contiene la alineación actual del botón ocultar automáticamente.

Comentarios

La alineación del botón ocultar automáticamente indica dónde reside el botón en la aplicación. Puede tener cualquiera de los valores siguientes:

• CBRS_ALIGN_LEFT

• CBRS_ALIGN_RIGHT

• CRBS_ALIGN_TOP

• CBRS_ALIGN_BOTTOM

CMFCAutoHideButton::GetAutoHideWindow

Devuelve el objeto CDockablePane asociado con el botón de ocultación automática.

CDockablePane* GetAutoHideWindow() const;

Valor devuelto

Puntero al objeto CDockablePane asociado.

Comentarios

Para asociar un botón de ocultación automática a CDockablePane, pase CDockablePane como un parámetro al método CMFCAutoHideButton::Create.

CMFCAutoHideButton::GetParentToolBar

CMFCAutoHideBar* GetParentToolBar();

Valor devuelto

Comentarios

CMFCAutoHideButton::GetRect

CRect GetRect() const;

Valor devuelto

Comentarios

CMFCAutoHideButton::GetSize

Determina el tamaño del botón de ocultación automática.

CSize GetSize() const;

Valor devuelto

Objeto CSize que contiene el tamaño del botón.

Comentarios

El tamaño calculado incluye el tamaño del borde del botón ocultar automáticamente.

CMFCAutoHideButton::GetTextSize

Devuelve el tamaño de la etiqueta de texto para el botón de ocultación automática.

virtual CSize GetTextSize() const;

Valor devuelto

Objeto CSize que contiene el tamaño del texto para el botón ocultar automáticamente.

CMFCAutoHideButton::IsActive

Indica si el botón de ocultación automática está activo.

BOOL IsActive() const;

Valor devuelto

TRUE si el botón ocultar automáticamente está activo; False en caso contrario.

Comentarios

Un botón ocultar automáticamente está activo cuando se muestra la ventana de clase CDockablePane asociada.

CMFCAutoHideButton::IsHorizontal

Determina si el botón de ocultación automática es horizontal o vertical.

BOOL IsHorizontal() const;

Valor devuelto

Distinto de cero si el botón es horizontal; de lo contrario, 0.

Comentarios

El marco establece la orientación de un objeto CMFCAutoHideButton al crearlo. Puede controlar la orientación mediante el parámetro dwAlignment en el método CMFCAutoHideButton::Create.

CMFCAutoHideButton::IsTop

BOOL IsTop() const;

Valor devuelto

Comentarios

CMFCAutoHideButton::IsVisible

Indica si el botón de ocultación automática es visible.

virtual BOOL IsVisible() const;

Valor devuelto

TRUE si el botón está visible; False en caso contrario.

CMFCAutoHideButton::OnDraw

El marco de trabajo llama a este método cuando dibuja el botón de ocultación automática.

virtual void OnDraw(CDC* pDC);

Parámetros

pDC
[in] Puntero a un contexto de dispositivo.

Comentarios

Si desea personalizar la apariencia de los botones de ocultación automática en la aplicación, cree una nueva clase derivada de CMFCAutoHideButton. En la clase derivada, invalide este método.

CMFCAutoHideButton::OnDrawBorder

El marco de trabajo llama a este método cuando dibuja el borde de un botón de ocultación automática.

virtual void OnDrawBorder(
    CDC* pDC,
    CRect rectBounds,
    CRect rectBorderSize);

Parámetros

pDC
[in] Puntero a un contexto de dispositivo.

rectBounds
[in] Rectángulo delimitador del botón ocultar automáticamente.

rectBorderSize
[in] Grosor del borde para cada lado del botón ocultar automáticamente.

Comentarios

Si desea personalizar el borde de cada botón ocultar automáticamente en la aplicación, cree una nueva clase derivada de CMFCAutoHideButton. En la clase derivada, invalide este método.

CMFCAutoHideButton::OnFillBackground

El marco de trabajo llama a este método cuando rellena el fondo de un botón de ocultación automática.

virtual void OnFillBackground(
    CDC* pDC,
    CRect rect);

Parámetros

pDC
[in] Puntero a un contexto de dispositivo.

rect
[in] Rectángulo delimitador del botón ocultar automáticamente.

Comentarios

Si desea personalizar el fondo de los botones de ocultación automática en la aplicación, cree una nueva clase derivada de CMFCAutoHideButton. En la clase derivada, invalide este método.

CMFCAutoHideButton::ShowAttachedWindow

Muestra u oculta la Clase CDockablePane asociada.

void ShowAttachedWindow(BOOL bShow);

Parámetros

bShow
[in] Valor booleano que especifica si este método muestra el objeto adjunto CDockablePane.

CMFCAutoHideButton::ShowButton

Muestra u oculta el botón de ocultación automática.

virtual void ShowButton(BOOL bShow);

Parámetros

bShow
[in] Valor booleano que especifica si se va a mostrar el botón ocultar automáticamente.

CMFCAutoHideButton::Move

void Move(int nOffset);

Parámetros

[in] nOffset

Comentarios

CMFCAutoHideButton::ReplacePane

void ReplacePane(CDockablePane* pNewBar);

Parámetros

[in] pNewBar

Comentarios

CMFCAutoHideButton::UnSetAutoHideMode

Permite deshabilitar el modo de ocultación automática.

virtual void UnSetAutoHideMode(CDockablePane* pFirstBarInGroup);

Parámetros

pFirstBarInGroup
[in] Puntero a la primera barra del grupo.

Comentarios

CMFCAutoHideButton::HighlightButton

Resalta el botón de ocultación automática.

virtual void HighlightButton(BOOL bHighlight);

Parámetros

bHighlight
Especifica el nuevo estado del botón ocultar automáticamente. TRUE indica que el botón está resaltado, FALSE indica que el botón no está resaltado.

Comentarios

CMFCAutoHideButton::IsHighlighted

Devuelve el estado de resaltado del botón de ocultación automática.

virtual BOOL IsHighlighted() const;

Valor devuelto

Devuelve TRUE si el botón Ocultar automáticamente está resaltado; en caso contrario, FALSE.

Comentarios

Consulte también

Gráfico de jerarquías
Clases
CMFCAutoHideBar (clase)
CAutoHideDockSite (clase)