Classe CMFCAutoHideButton
Um botão que exibe ou oculta uma Classe CDockablePane configurada para ocultar.
Para obter mais detalhes, confira o código-fonte localizado na pasta VC\atlmfc\src\mfc de sua instalação do Visual Studio.
Sintaxe
class CMFCAutoHideButton : public CObject
Membros
Métodos públicos
| Nome | Descrição |
|---|---|
| CMFCAutoHideButton::BringToTop | |
| CMFCAutoHideButton::Create | Cria e inicializa o botão de ocultamento automático. |
| CMFCAutoHideButton::GetAlignment | Recupera o alinhamento do botão de ocultamento automático. |
| CMFCAutoHideButton::GetAutoHideWindow | Retorna o objeto CDockablePane associado ao botão de ocultamento automático. |
| CMFCAutoHideButton::GetParentToolBar | |
| CMFCAutoHideButton::GetRect | |
| CMFCAutoHideButton::GetSize | Determina o tamanho do botão de ocultamento automático. |
| CMFCAutoHideButton::GetTextSize | Retorna o tamanho do rótulo de texto do botão de ocultamento automático. |
| CMFCAutoHideButton::HighlightButton | Realça o botão de ocultamento automático. |
| CMFCAutoHideButton::IsActive | Indica se o botão de ocultamento automático está ativo. |
| CMFCAutoHideButton::IsHighlighted | Retorna o estado de realce do botão de ocultamento automático. |
| CMFCAutoHideButton::IsHorizontal | Determina se o botão de ocultamento automático é horizontal ou vertical. |
| CMFCAutoHideButton::IsTop | |
| CMFCAutoHideButton::IsVisible | Indica se o botão está visível. |
| CMFCAutoHideButton::Move | |
| CMFCAutoHideButton::OnDraw | A estrutura chama esse método quando desenha o botão de ocultamento automático. |
| CMFCAutoHideButton::OnDrawBorder | A estrutura chama esse método quando desenha a borda de um botão de ocultamento automático. |
| CMFCAutoHideButton::OnFillBackground | A estrutura chama esse método quando preenche a tela de fundo de um botão de ocultamento automático. |
| CMFCAutoHideButton::ReplacePane | |
| CMFCAutoHideButton::ShowAttachedWindow | Mostra ou oculta a Classe CDockablePane associada. |
| CMFCAutoHideButton::ShowButton | Mostra ou oculta o botão de ocultamento automático. |
| CMFCAutoHideButton::UnSetAutoHideMode |
Comentários
Na criação, o objeto CMFCAutoHideButton é anexado a uma classe CDockablePane. O objeto CDockablePane será oculto ou exibido à medida que o usuário interage com o objeto CMFCAutoHideButton.
Por padrão, a estrutura cria automaticamente um CMFCAutoHideButton quando o usuário ativa o ocultamento automático. A estrutura pode criar um elemento de uma classe de interface do usuário personalizada em vez da classe CMFCAutoHideButton. Para especificar qual classe de interface do usuário personalizada a estrutura deve usar, defina a variável de membro estático CMFCAutoHideBar::m_pAutoHideButtonRTS igual à classe de interface do usuário personalizada. Por padrão, essa variável é definida como CMFCAutoHideButton.
Exemplo
O exemplo a seguir demonstra como construir um objeto CMFCAutoHideButton e usar vários métodos na classe CMFCAutoHideButton. O exemplo mostra como inicializar um objeto CMFCAutoHideButton usando seu método Create, mostrar a classe CDockablePane associada e mostrar o botão de ocultamento automático.
CMFCAutoHideButton *autoHideButton = new CMFCAutoHideButton();
CDockablePane cPane;
// CMFCAutoHideBar* pParentBar
if (!autoHideButton->Create(pParentBar, &cPane, CBRS_ALIGN_LEFT))
{
return 0;
}
autoHideButton->ShowAttachedWindow(true);
autoHideButton->ShowButton(true);
Hierarquia de herança
CMFCAutoHideButton
Requisitos
Cabeçalho: afxautohidebutton.h
CMFCAutoHideButton::BringToTop
void BringToTop();
Comentários
CMFCAutoHideButton::Create
Cria e inicializa um botão de ocultamento automático.
virtual BOOL Create(
CMFCAutoHideBar* pParentBar,
CDockablePane* pAutoHideWnd,
DWORD dwAlignment);
Parâmetros
pParentBar
[in] Um ponteiro para a barra de ferramentas pai.
pAutoHideWnd
[in] Um ponteiro para um objeto CDockablePane. Esse botão de ocultamento automático oculta e mostra esse CDockablePane.
dwAlignment
[in] Um valor que especifica o alinhamento do botão com a janela de quadro principal.
Valor de retorno
Diferente de zero se tiver êxito; caso contrário, 0.
Comentários
Ao criar um objeto CMFCAutoHideButton, você deve associar o botão de ocultamento automático a um CDockablePane específico. O usuário pode usar o botão de ocultamento automático para ocultar e mostrar o CDockablePane associado.
O parâmetro dwAlignment indica onde o botão de ocultamento automático reside no aplicativo. O parâmetro pode usar um dos valores a seguir:
CBRS_ALIGN_LEFT
CBRS_ALIGN_RIGHT
CBRS_ALIGN_TOP
CBRS_ALIGN_BOTTOM
CMFCAutoHideButton::GetAlignment
Recupera o alinhamento do botão de ocultamento automático.
DWORD GetAlignment() const;
Valor de retorno
Um valor DWORD que contém o alinhamento atual do botão de ocultamento automático.
Comentários
O alinhamento do botão de ocultamento automático indica onde o botão reside no aplicativo. Pode ser qualquer um dos seguintes valores:
CBRS_ALIGN_LEFT
CBRS_ALIGN_RIGHT
CRBS_ALIGN_TOP
CBRS_ALIGN_BOTTOM
CMFCAutoHideButton::GetAutoHideWindow
Retorna o objeto CDockablePane associado ao botão de ocultamento automático.
CDockablePane* GetAutoHideWindow() const;
Valor de retorno
Um ponteiro para o objeto CDockablePane associado.
Comentários
Para associar um botão de ocultamento automático a um CDockablePane, passe o CDockablePane como um parâmetro para o método CMFCAutoHideButton::Create.
CMFCAutoHideButton::GetParentToolBar
CMFCAutoHideBar* GetParentToolBar();
Valor de retorno
Comentários
CMFCAutoHideButton::GetRect
CRect GetRect() const;
Valor de retorno
Comentários
CMFCAutoHideButton::GetSize
Determina o tamanho do botão de ocultamento automático.
CSize GetSize() const;
Valor de retorno
Um objeto CSize que contém o tamanho do botão.
Comentários
O tamanho calculado inclui o tamanho da borda do botão de ocultamento automático.
CMFCAutoHideButton::GetTextSize
Retorna o tamanho do rótulo de texto do botão de ocultamento automático.
virtual CSize GetTextSize() const;
Valor de retorno
Um objeto CSize que contém o tamanho do texto para o botão de ocultamento automático.
CMFCAutoHideButton::IsActive
Indica se o botão de ocultamento automático está ativo.
BOOL IsActive() const;
Valor de retorno
TRUE se o botão de ocultamento automático estiver ativo; caso contrário, FALSE.
Comentários
Um botão de ocultamento automático está ativo quando a janela da Classe CDockablePane associada é exibida.
CMFCAutoHideButton::IsHorizontal
Determina se o botão de ocultamento automático é horizontal ou vertical.
BOOL IsHorizontal() const;
Valor de retorno
Diferente de zero se o botão for horizontal; caso contrário, zero.
Comentários
A estrutura define a orientação de um objeto CMFCAutoHideButton quando você o cria. Você pode controlar a orientação usando o parâmetro dwAlignment no método CMFCAutoHideButton::Create.
CMFCAutoHideButton::IsTop
BOOL IsTop() const;
Valor de retorno
Comentários
CMFCAutoHideButton::IsVisible
Indica se o botão de ocultamento automático está visível.
virtual BOOL IsVisible() const;
Valor de retorno
TRUE se o botão estiver visível; caso contrário, FALSE.
CMFCAutoHideButton::OnDraw
A estrutura chama esse método quando desenha o botão de ocultamento automático.
virtual void OnDraw(CDC* pDC);
Parâmetros
pDC
[in] Um ponteiro para um contexto de dispositivo.
Comentários
Se você quiser personalizar a aparência de botões de ocultamento automático em seu aplicativo, crie uma nova classe derivada de CMFCAutoHideButton. Em sua classe derivada, substitua esse método.
CMFCAutoHideButton::OnDrawBorder
A estrutura chama esse método quando desenha a borda de um botão de ocultamento automático.
virtual void OnDrawBorder(
CDC* pDC,
CRect rectBounds,
CRect rectBorderSize);
Parâmetros
pDC
[in] Um ponteiro para um contexto de dispositivo.
rectBounds
[in] O retângulo delimitador do botão de ocultamento automático.
rectBorderSize
[in] A espessura da borda para cada lado do botão de ocultamento automático.
Comentários
Se você quiser personalizar a borda de cada botão de ocultamento automático em seu aplicativo, crie uma nova classe derivada do CMFCAutoHideButton. Em sua classe derivada, substitua esse método.
CMFCAutoHideButton::OnFillBackground
A estrutura chama esse método quando preenche a tela de fundo de um botão de ocultamento automático.
virtual void OnFillBackground(
CDC* pDC,
CRect rect);
Parâmetros
pDC
[in] Um ponteiro para um contexto de dispositivo.
rect
[in] O retângulo delimitador do botão de ocultamento automático.
Comentários
Se você quiser personalizar o segundo plano dos botões de ocultamento automático em seu aplicativo, crie uma nova classe derivada do CMFCAutoHideButton. Em sua classe derivada, substitua esse método.
CMFCAutoHideButton::ShowAttachedWindow
Mostra ou oculta a Classe CDockablePane associada.
void ShowAttachedWindow(BOOL bShow);
Parâmetros
bShow
[in] Um booliano que especifica se esse método mostra o CDockablePane anexado.
CMFCAutoHideButton::ShowButton
Mostra ou oculta o botão de ocultamento automático.
virtual void ShowButton(BOOL bShow);
Parâmetros
bShow
[in] Um booliano que especifica se o botão de ocultamento automático deve ser mostrado.
CMFCAutoHideButton::Move
void Move(int nOffset);
Parâmetros
[in] nOffset
Comentários
CMFCAutoHideButton::ReplacePane
void ReplacePane(CDockablePane* pNewBar);
Parâmetros
[in] pNewBar
Comentários
CMFCAutoHideButton::UnSetAutoHideMode
Desabilita o modo de ocultamento automático.
virtual void UnSetAutoHideMode(CDockablePane* pFirstBarInGroup);
Parâmetros
pFirstBarInGroup
[in] Um ponteiro para a primeira barra do grupo.
Comentários
CMFCAutoHideButton::HighlightButton
Realça o botão de ocultamento automático.
virtual void HighlightButton(BOOL bHighlight);
Parâmetros
bHighlight
Especifica o novo estado do botão de ocultamento automático. TRUE indica que o botão está realçado, FALSE indica que o botão não está realçado.
Comentários
CMFCAutoHideButton::IsHighlighted
Retorna o estado de realce do botão de ocultamento automático.
virtual BOOL IsHighlighted() const;
Valor de retorno
Retorna TRUE se o botão de ocultamento automático estiver realçado; caso contrário, FALSE.
Comentários
Confira também
Gráfico da hierarquia
Classes
Classe CMFCAutoHideBar
Classe CAutoHideDockSite