Classe CBasePane

Classe base para todos os painéis na MFC.

Sintaxe

class CBasePane : public CWnd

Membros

Construtores públicos

Nome	Descrição
CBasePane::CBasePane	Construtor padrão.
CBasePane::~CBasePane	Destruidor.

Métodos públicos

Nome	Descrição
CBasePane::accHitTest	Chamado pela estrutura para recuperar o elemento filho ou o objeto filho em um determinado ponto na tela. (Substitui CWnd::accHitTest.)
CBasePane::accLocation	Chamado pela estrutura para recuperar a localização da tela atual do objeto especificado. (Substitui CWnd::accLocation.)
CBasePane::AccNotifyObjectFocusEvent	CBasePane não usa esse método.
CBasePane::accSelect	Chamado pela estrutura para modificar a seleção ou mover o foco do teclado do objeto especificado. (Substitui CWnd::accSelect.)
CBasePane::AddPane	Adiciona um painel ao gerenciador de encaixe.
CBasePane::AdjustDockingLayout	Redireciona uma chamada ao gerenciador de encaixe para ajustar o layout de encaixe.
CBasePane::AdjustLayout	Chamado pela estrutura quando o painel deve ajustar o layout interno.
CBasePane::CalcFixedLayout	Calcula o tamanho horizontal de uma barra de controle.
CBasePane::CanAcceptPane	Determina se outro painel pode ser encaixado ao painel.
CBasePane::CanAutoHide	Determina se o painel dá suporte ao modo de ocultação automática.
CBasePane::CanBeAttached	Determina se o painel pode ser encaixado a outro painel.
CBasePane::CanBeClosed	Determina se o painel pode ser fechado.
CBasePane::CanBeDocked	Determina se o painel pode ser encaixado a outro painel.
CBasePane::CanBeResized	Determina se o painel pode ser redimensionado.
CBasePane::CanBeTabbedDocument	Especifica se o painel pode ser convertido em um documento com guias MDI.
CBasePane::CanFloat	Determina se o painel pode flutuar.
CBasePane::CanFocus	Especifica se o painel pode receber foco.
CBasePane::CopyState	Copia o estado de um determinado painel.
CBasePane::CreateDefaultMiniframe	Se o painel puder flutuar, criará uma janela com minimoldura.
CBasePane::CreateEx	Cria o controle do painel.
CBasePane::DockPane	Encaixa um painel em outro painel ou em uma janela de quadro.
CBasePane::DockPaneUsingRTTI	Encaixa o painel usando informações de tipo de tempo de execução.
CBasePane::DockToFrameWindow	Encaixa um painel encaixável em um quadro.
CBasePane::DoesAllowDynInsertBefore	Determina se outro painel pode ser inserido dinamicamente entre esse painel e o quadro pai.
CBasePane::EnableDocking	Habilita o encaixe do painel ao quadro principal.
CBasePane::EnableGripper	Habilita ou desabilita a garra. Se a garra estiver habilitada, o usuário poderá arrastá-la para reposicionar o painel.
CBasePane::FillWindowRect	Usado internamente.
CBasePane::FloatPane	Faz o painel flutuar.
CBasePane::get_accChild	Chamado pela estrutura para recuperar o endereço de uma interface IDispatch para o filho especificado. (Substitui CWnd::get_accChild.)
CBasePane::get_accChildCount	Chamado pela estrutura para recuperar o número de filhos que pertencem a esse objeto. (Substitui CWnd::get_accChildCount.)
CBasePane::get_accDefaultAction	Chamado pela estrutura para recuperar uma cadeia de caracteres que descreve a ação padrão do objeto. (Substitui CWnd::get_accDefaultAction.)
CBasePane::get_accDescription	Chamado pela estrutura para recuperar uma cadeia de caracteres que descreve a aparência visual do objeto especificado. (Substitui CWnd::get_accDescription.)
CBasePane::get_accFocus	Chamado pela estrutura para recuperar o objeto que tem o foco do teclado. (Substitui CWnd::get_accFocus.)
CBasePane::get_accHelp	Chamado pela estrutura para recuperar uma cadeia de caracteres da propriedade Help para o objeto. (Substitui CWnd::get_accHelp.)
CBasePane::get_accHelpTopic	Chamado pela estrutura para recuperar o caminho completo do arquivo WinHelp associado ao objeto especificado e ao identificador do tópico apropriado nesse arquivo. (Substitui CWnd::get_accHelpTopic.)
CBasePane::get_accKeyboardShortcut	Chamado pela estrutura para recuperar a tecla de atalho especificada para o objeto. (Substitui CWnd::get_accKeyboardShortcut.)
CBasePane::get_accName	Chamado pela estrutura para recuperar o nome do objeto especificado. (Substitui CWnd::get_accName.)
CBasePane::get_accParent	Chamado pela estrutura para recuperar a interface IDispatch do pai do objeto. (Substitui CWnd::get_accParent.)
CBasePane::get_accRole	Chamado pela estrutura para recuperar informações que descrevem a função do objeto especificado. (Substitui CWnd::get_accRole.)
CBasePane::get_accSelection	Chamado pela estrutura para recuperar os filhos selecionados desse objeto. (Substitui CWnd::get_accSelection.)
CBasePane::get_accState	Chamado pela estrutura para recuperar o estado atual do objeto especificado. (Substitui CWnd::get_accState.)
CBasePane::get_accValue	Chamado pela estrutura para recuperar o valor do objeto especificado. (Substitui CWnd::get_accValue.)
CBasePane::GetCaptionHeight	Retorna a altura da legenda.
CBasePane::GetControlBarStyle	Retorna o estilo da barra de controle.
CBasePane::GetCurrentAlignment	Retorna o alinhamento do painel atual.
CBasePane::GetDockingMode	Retorna o modo de encaixe atual do painel.
CBasePane::GetDockSiteFrameWnd	Retorna um ponteiro para a janela que é o local de encaixe do painel.
CBasePane::GetEnabledAlignment	Retorna os estilos de CBRS_ALIGN_ aplicados ao painel.
CBasePane::GetMFCStyle	Retorna os estilos de painel específicos do MFC.
CBasePane::GetPaneIcon	Retorna um identificador para o ícone do painel.
CBasePane::GetPaneRect	Usado internamente.
CBasePane::GetPaneRow	Retorna um ponteiro para o objeto CDockingPanesRow em que o painel está encaixado.
CBasePane::GetPaneStyle	Retorna o estilo do painel.
CBasePane::GetParentDockSite	Retorna um ponteiro para o local de encaixe pai.
CBasePane::GetParentMiniFrame	Retorna um ponteiro para a janela com minimoldura pai.
CBasePane::GetParentTabbedPane	Retorna um ponteiro para o painel com guias pai.
CBasePane::GetParentTabWnd	Retorna um ponteiro para a janela pai que está dentro de uma guia.
CBasePane::GetRecentVisibleState	A estrutura chama esse método quando um painel é restaurado com base em um arquivo.
CBasePane::HideInPrintPreviewMode	Especifica se o painel fica oculto na visualização de impressão.
CBasePane::InsertPane	Registra o painel especificado no gerenciador de encaixe.
CBasePane::IsAccessibilityCompatible	Especifica se o painel dá suporte à Acessibilidade Ativa.
CBasePane::IsAutoHideMode	Determina se um painel está no modo de ocultação automática.
CBasePane::IsDialogControl	Especifica se o painel é um controle de caixa de diálogo.
CBasePane::IsDocked	Determina se o painel está encaixado.
CBasePane::IsFloating	Determina se o painel está flutuando.
CBasePane::IsHorizontal	Determina se o painel está encaixado horizontalmente.
CBasePane::IsInFloatingMultiPaneFrameWnd	Especifica se o painel está em uma janela de quadro com vários painéis.
CBasePane::IsMDITabbed	Determina se o painel foi adicionado a uma janela filho do MDI como um documento com guias.
CBasePane::IsPaneVisible	Especifica se o sinalizador WS_VISIBLE está definido para o painel.
CBasePane::IsPointNearDockSite	Determina se um ponto especificado está próximo ao local de encaixe.
CBasePane::IsResizable	Determina se o painel pode ser redimensionado.
CBasePane::IsRestoredFromRegistry	Determina se o painel é restaurado com base no registro.
CBasePane::IsTabbed	Determina se o painel foi inserido no controle guia de uma janela com guias.
CBasePane::IsTooltipTopmost	Usado internamente.
CBasePane::IsVisible	Determina se o painel está visível.
CBasePane::LoadState	Carrega o estado do painel com base no registro.
CBasePane::MoveWindow	Move o painel.
CBasePane::OnAfterChangeParent	Chamado pela estrutura quando o pai do painel foi alterado.
CBasePane::OnBeforeChangeParent	Chamado pela estrutura logo antes do painel alterar a respectiva janela pai.
CBasePane::OnDrawCaption	A estrutura chama esse método quando a legenda é desenhada.
CBasePane::OnMovePaneDivider	Esse método não é usado atualmente.
CBasePane::OnPaneContextMenu	Chamado pela estrutura quando compila um menu que tem uma lista de painéis.
CBasePane::OnRemoveFromMiniFrame	Chamado pela estrutura quando um painel é removido da janela com minimoldura pai.
CBasePane::OnSetAccData	CBasePane não usa esse método.
CBasePane::OnUpdateCmdUI	Usado internamente.
CBasePane::PaneFromPoint	Retorna o painel que contém o determinado ponto.
CBasePane::PreTranslateMessage	Usado pela classe CWinApp para converter mensagens de janela antes que elas sejam expedidas para as funções TranslateMessage e DispatchMessage do Windows. (Substitui CWnd::PreTranslateMessage.)
CBasePane::RecalcLayout	CBasePane não usa esse método.
CBasePane::RemovePaneFromDockManager	Cancela o registro de um painel e o remove da lista no gerenciador de encaixe.
CBasePane::SaveState	Salva o estado do painel no registro.
CBasePane::SelectDefaultFont	Seleciona a fonte padrão para um determinado contexto de dispositivo.
CBasePane::Serialize	Lê ou grava esse objeto de ou em uma camada de arquivos. (Substitui CObject::Serialize.)
CBasePane::SetControlBarStyle	Define o estilo da barra de controle.
CBasePane::SetDockingMode	Define o modo de encaixe para o painel.
CBasePane::SetMDITabbed	Usado internamente.
CBasePane::SetPaneAlignment	Define o alinhamento do painel.
CBasePane::SetPaneRect	Usado internamente.
CBasePane::SetPaneStyle	Define o estilo do painel.
CBasePane::SetRestoredFromRegistry	Usado internamente.
CBasePane::SetWindowPos	Altera o tamanho, a posição e a ordem em Z de um painel.
CBasePane::ShowPane	Mostra ou oculta o painel.
CBasePane::StretchPane	Alonga um painel vertical ou horizontalmente.
CBasePane::UndockPane	Remove o painel do local de encaixe, do controle deslizante padrão ou da janela com minimoldura em que ele está encaixado.

Métodos protegidos

Nome	Descrição
CBasePane::DoPaint	Preenche o segundo plano do painel.

Comentários

Se você quiser criar uma classe de painel com suporte para os recursos de encaixe estendidos disponíveis no MFC, precisará derivá-la de CBasePane ou da Classe CPane.

Dias de personalização

As seguintes dicas de personalização dizem respeito a CBasePane Class e a todas as classes que herdam dela:

• Ao criar um painel, você pode aplicar vários novos estilos:

  • AFX_CBRS_FLOAT faz o painel flutuar.

  • AFX_CBRS_AUTOHIDE habilita o modo de ocultação automática.

  • AFX_CBRS_CLOSE permite que o painel seja fechado (ocultado).

  Esses são sinalizadores que você pode combinar com uma operação OR bit a bit.

CBasePane implementa os seguintes métodos boolianos virtuais para refletir esses sinalizadores: CBasePane::CanBeClosed, CBasePane::CanAutoHide, CBasePane::CanFloat. Você pode substituí-los em classes derivadas para personalizar seu comportamento.

• Você pode personalizar o comportamento de encaixe substituindo CBasePane::CanAcceptPane. Faça com que o painel retorne FALSE desse método para impedir que outro painel se encaixe a ele.

• Se você quiser criar um painel estático que não flutue e que impeça qualquer outro painel de encaixar-se antes dele (semelhante à barra do Outlook no exemplo OutlookDemo), crie-o como não flutuante e substitua CBasePane::DoesAllowDynInsertBefore para retornar FALSE. A implementação padrão retornará FALSE se o painel for criado sem o estilo AFX_CBRS_FLOAT.

• Crie todos os painéis com IDs diferentes de -1.

• Para determinar a visibilidade do painel, use CBasePane::IsVisible. Ele lida corretamente com o estado de visibilidade nos modos de ocultação automática e com guias.

• Se quiser criar um painel redimensionável não flutuante, crie-o sem o estilo AFX_CBRS_FLOAT e chame CFrameWnd::DockControlBar.

• Para excluir um painel de um layout de encaixe ou remover uma barra de ferramentas da barra de encaixe, chame CBasePane::UndockPane. Não chame esse método para painéis no modo de ocultação automática nem para painéis que residem em guias de janelas com guias.

• Se quiser fazer flutuar ou desencaixar um painel no modo de ocultação automática, chame CDockablePane::SetAutoHideMode com FALSE como o primeiro argumento antes de chamar CBasePane::FloatPane ou CBasePane::UndockPane.

Exemplo

O exemplo a seguir demonstra como usar vários métodos na classe CBasePane. O exemplo demonstra como recuperar um painel da classe CFrameWndEx e como definir o modo de encaixe, o alinhamento do painel e o estilo do painel. O código é do exemplo do Word Pad.

// This CMainFrame class extends the CFrameWndEx class.
// GetPane is a method in the CFrameWndEx class which
// Returns a pointer to the pane that has the specified ID.
CBasePane *pBar = GetPane(ID_VIEW_FORMATBAR);
if (pBar != NULL)
{
    // Set the docking mode, the pane alignment, and the pane style.
    pBar->SetDockingMode(DT_STANDARD);
    pBar->SetPaneAlignment(CBRS_ALIGN_LEFT);
    pBar->SetPaneStyle(pBar->GetCurrentAlignment() | CBRS_TOOLTIPS);
    pBar->ShowPane(TRUE, FALSE, FALSE);
}

Hierarquia de herança

CObject

CCmdTarget

CWnd

CBasePane

Requisitos

Cabeçalho: afxbasepane.h

CBasePane::AccNotifyObjectFocusEvent

CBasePane não usa esse método.

virtual void AccNotifyObjectFocusEvent(int);

Parâmetros

int
[in] Não é usado.

CBasePane::AddPane

Adiciona um painel ao gerenciador de encaixe.

void AddPane(CBasePane* pBar);

Parâmetros

pBar
[in] Um ponteiro para um painel a ser adicionado.

Comentários

Esse é um método de conveniência que adiciona um painel a um gerenciador de encaixe. Usando esse método, você não precisa escrever um código que analisa o tipo do quadro pai.

Para obter mais informações, consulte Classe CDockingManager e CMDIFrameWndEx::AddPane.

CBasePane::AdjustDockingLayout

Redireciona uma chamada ao gerenciador de encaixe para ajustar o layout de encaixe.

virtual void AdjustDockingLayout(HDWP hdwp=NULL);

Parâmetros

hdwp
[out] Um identificador para uma estrutura que contém várias posições de janela.

Comentários

Esse é um método de conveniência que ajusta o layout de encaixe. Usando esse método, você não precisa escrever um código que analisa o tipo do quadro pai.

Para obter mais informações, consulte CDockingManager::AdjustDockingLayout

CBasePane::AdjustLayout

Chamado pela estrutura para ajustar o layout interno de um painel.

virtual void AdjustLayout();

Comentários

A estrutura chama esse método quando um painel precisa ajustar o layout interno. A implementação base não faz nada.

CBasePane::CalcFixedLayout

Calcula o tamanho horizontal de uma barra de controle.

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

Parâmetros

bStretch
[in] Indica se a barra deve ser alongada até atingir o tamanho do quadro. O parâmetro bStretch é diferente de zero quando a barra não é de encaixe (não disponível para encaixe) e é igual a 0 quando está encaixada ou flutuando (disponível para encaixe).

bHorz
[in] Indica que a barra está orientada horizontal ou verticalmente. O parâmetro bHorz é diferente de zero quando a barra está orientada horizontalmente e é igual a 0 quando ela está orientada verticalmente.

Valor de Devolução

O tamanho da barra de controle, em pixels, de um objeto CSize.

Comentários

Consulte a seção de comentários em CControlBar::CalcFixedLayout

CBasePane::CanAcceptPane

Determina se outro painel pode ser encaixado ao painel.

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

Parâmetros

pBar
[in] Um ponteiro para o painel a ser encaixado.

Valor de Devolução

TRUE se outro painel puder ser aceito; caso contrário, FALSE.

Comentários

A estrutura chama esse método antes de encaixar o painel especificado por pBar ao painel atual.

Use esse método e o método CBasePane::CanBeDocked para controlar como os painéis se encaixam a outros painéis no aplicativo.

A implementação padrão retorna FALSE.

CBasePane::CanAutoHide

Determina se o painel dá suporte ao modo de ocultação automática.

virtual BOOL CanAutoHide() const;

Valor de Devolução

TRUE se esse painel der suporte ao modo de ocultação automática; caso contrário, FALSE.

Comentários

A estrutura chama essa função para determinar se o painel dá suporte ao modo de ocultação automática.

Durante a construção, você pode definir essa capacidade passando o sinalizador AFX_CBRS_AUTOHIDE para CBasePane::CreateEx.

A implementação padrão verifica o sinalizador AFX_CBRS_AUTOHIDE. Substitua esse método em uma classe derivada para personalizar esse comportamento.

CBasePane::CanBeAttached

Determina se o painel pode ser encaixado a outro painel ou janela de quadro.

virtual BOOL CanBeAttached() const;

Valor de Devolução

TRUE se o painel puder ser encaixado em outro painel ou janela de quadro; caso contrário, FALSE.

Comentários

A implementação padrão retorna FALSE. Substitua esse método em uma classe derivada para habilitar ou desabilitar a capacidade de encaixar sem chamar CBasePane::EnableDocking.

CBasePane::CanBeClosed

Determina se o painel pode ser fechado.

virtual BOOL CanBeClosed() const;

Valor de Devolução

TRUE se o painel puder ser fechado; caso contrário, FALSE.

Comentários

A estrutura chama esse método para determinar se o painel pode ser fechado. Se o método retornar TRUE, um botão Fechar será adicionado à barra de título do painel ou, se o painel estiver flutuando, à barra de título da janela com minimoldura do painel.

Durante a construção, você pode definir essa capacidade passando o sinalizador AFX_CBRS_CLOSE para CBasePane::CreateEx.

A implementação padrão verifica o sinalizador AFX_CBRS_CLOSE.

CBasePane::CanBeDocked

Determina se o painel pode ser encaixado a outro painel.

virtual BOOL CanBeDocked(CBasePane* pDockBar) const;

Parâmetros

pDockBar
[in] Um ponteiro para outro painel.

Valor de Devolução

TRUE se o painel puder ser encaixado a outro painel; caso contrário, FALSE.

Comentários

A estrutura chama esse método antes de encaixar o painel especificado por pBar ao painel atual.

Use esse método e o método CBasePane::CanAcceptPane para controlar como os painéis se encaixam a outros painéis no aplicativo.

A implementação padrão retorna FALSE.

CBasePane::CanBeResized

Determina se o painel pode ser redimensionado.

virtual BOOL CanBeResized() const;

Valor de Devolução

TRUE se o painel puder ser redimensionado; caso contrário, FALSE.

Comentários

Esse método detecta o sinalizador AFX_CBRS_RESIZE, que é especificado por padrão em CBasePane::OnCreate. Se o sinalizador não for especificado, o gerenciador de encaixe sinalizará o painel internamente como não movimentável em vez de encaixá-lo.

CBasePane::CanBeTabbedDocument

Especifica se o painel pode ser convertido em um documento com guias MDI.

virtual BOOL CanBeTabbedDocument() const;

Valor de Devolução

TRUE se o painel puder ser convertido em um documento com guias; caso contrário, FALSE. CBasePane::CanBeTabbedDocument sempre retorna FALSE.

Comentários

Somente objetos de determinados tipos derivados de CBasePane, como a Classe CDockablePane, podem ser convertidos em documentos com guias.

CBasePane::CanFloat

Determina se o painel pode flutuar.

virtual BOOL CanFloat() const;

Valor de Devolução

TRUE se o painel puder flutuar; caso contrário, FALSE.

Comentários

A estrutura chama esse método para determinar se o painel pode flutuar.

Durante a construção, você pode definir essa capacidade passando o sinalizador AFX_CBRS_FLOAT para CBasePane::CreateEx.

Observação

A estrutura pressupõe que os painéis não flutuantes sejam estáticos e que seu estado de encaixe não possa ser alterado. Portanto, a estrutura não salva o estado de encaixe de painéis não flutuantes.

A implementação padrão verifica o sinalizador AFX_CBRS_FLOAT.

CBasePane::CanFocus

Especifica se o painel pode receber foco.

virtual BOOL CanFocus() const;

Valor de Devolução

TRUE se o painel puder receber o foco; caso contrário, FALSE.

Comentários

Substitua esse método em uma classe derivada para controlar o foco. Por exemplo, como as barras de ferramentas não podem receber foco, esse método retorna FALSE quando é chamado em objetos de barra de ferramentas.

A estrutura tenta definir o foco de entrada quando um painel está encaixado ou flutuando.

CBasePane::CopyState

Copia o estado de um determinado painel.

virtual void CopyState(CBasePane* pOrgBar);

Parâmetros

pOrgBar
[in] Um ponteiro para outro painel.

Comentários

Esse método copia o estado de pOrgBar para o painel.

CBasePane::CreateDefaultMiniframe

Se o painel puder flutuar, o método criará uma janela com minimoldura para ele.

virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);

Parâmetros

rectInitial
[in] Especifica as coordenadas iniciais da janela com minimoldura.

Valor de Devolução

Um ponteiro para a nova janela com minimoldura ou NULL se a criação falhou.

Comentários

A estrutura chama esse método quando um painel muda para o estado flutuante. O método cria uma janela com minimoldura e anexa o painel a essa janela.

A implementação padrão retorna NULL.

CBasePane::CreateEx

Cria o controle do painel.

virtual BOOL CreateEx(
    DWORD dwStyleEx,
    LPCTSTR lpszClassName,
    LPCTSTR lpszWindowName,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID,
    DWORD dwControlBarStyle=0,
    CCreateContext* pContext=NULL);

Parâmetros

dwStyleEx
[in] Os estilos estendidos (consulte CWnd::CreateEx para obter mais informações).

lpszClassName
[in] O nome de classe da janela.

lpszWindowName
[in] O nome da janela.

dwStyle
[in] O estilo da janela (consulte CWnd::CreateEx).

rect
[in] O retângulo inicial.

pParentWnd
[in] Um ponteiro para a janela pai.

Nid
[in] Especifica a ID do painel. Deve ser exclusivo.

dwControlBarStyle
[in] Sinalizadores de estilo para painéis.

pContext
[in] Um ponteiro para CcreateContext

Valor de Devolução

TRUE se o painel foi criado com êxito; caso contrário, FALSE.

Comentários

Cria uma janela da classe lpszClassName. Se você especificar WS_CAPTION, o método limpará o bit de estilo WS_CAPTION e definirá CBasePane::m_bHasCaption como TRUE, pois a biblioteca não dará suporte a painéis com legendas.

Você pode usar qualquer combinação de estilos de janela filho e estilos da barra de controle do MFC (CBRS_).

A biblioteca adiciona vários novos estilos para painéis. A seguinte tabela descreve os novos estilos:

Estilo	Descrição
AFX_CBRS_FLOAT	O painel pode flutuar.
AFX_CBRS_AUTOHIDE	O painel dá suporte ao modo de ocultação automática
AFX_CBRS_RESIZE	O painel pode ser redimensionado. Importante: esse estilo não é implementado.
AFX_CBRS_CLOSE	O painel pode ser fechado.
AFX_CBRS_AUTO_ROLLUP	O painel pode ser rolado para cima enquanto flutua.
AFX_CBRS_REGULAR_TABS	Quando um painel é encaixado a outro painel que tem esse estilo, uma janela com guias regular é criada. (Para obter mais informações, consulte Classe CTabbedPane.)
AFX_CBRS_OUTLOOK_TABS	Quando um painel é encaixado a outro painel que tem esse estilo, uma janela com guias com estilo do Outlook é criada. (Para obter mais informações, consulte Classe CMFCOutlookBar.)

Para usar os novos estilos, especifique-os em dwControlBarStyle.

CBasePane::DockPane

Encaixa um painel em outro painel ou em uma janela de quadro.

virtual BOOL DockPane(
    CBasePane* pDockBar,
    LPCRECT lpRect,
    AFX_DOCK_METHOD dockMethod);

Parâmetros

pDockBar
[in] Um ponteiro para outro painel.

lpRect
[in] Especifica o retângulo de destino.

dockMethod
[in] Especifica o método de encaixe.

Valor de Devolução

TRUE se a barra de controle tiver sido encaixada com êxito; caso contrário, FALSE.

Comentários

Chame essa função para encaixar um painel a outro painel ou a uma barra de encaixe (Classe CDockSite) especificada por pDockBar ou a um quadro principal se pDockBar for NULL.

dockMethod especifica como o painel está encaixado. Consulte CPane::DockPane para obter uma lista de valores possíveis.

CBasePane::DockPaneUsingRTTI

Encaixa o painel usando informações de tipo de tempo de execução.

void DockPaneUsingRTTI(BOOL bUseDockSite);

Parâmetros

bUseDockSite
[in] Se TRUE, encaixar ao local de encaixe. Se FALSE, encaixar ao quadro pai.

CBasePane::DockToFrameWindow

Encaixa um painel encaixável em um quadro.

virtual BOOL DockToFrameWindow(
    DWORD dwAlignment,
    LPCRECT lpRect = NULL,
    DWORD dwDockFlags = DT_DOCK_LAST,
    CBasePane* pRelativeBar = NULL,
    int nRelativeIndex = -1,
    BOOL bOuterEdge = FALSE);

Parâmetros

dwAlignment
[in] O lado do quadro pai ao qual você deseja encaixar o painel.

lpRect
[in] O tamanho desejado.

dwDockFlags
[in] Ignorado.

pRelativeBar
[in] Ignorado.

nRelativeIndex
[in] Ignorado.

bOuterEdge
[in] Se for TRUE e houver outros painéis encaixáveis no lado especificado por dwAlignment, o painel será encaixado fora dos outros painéis, mais perto da borda do quadro pai. Se for FALSE, o painel será encaixado mais perto do centro da área de cliente.

Valor de Devolução

TRUE se o método foi bem-sucedido; caso contrário, FALSE.

Comentários

Esse método falhará se um divisor de painel ( Classe CPaneDivider) não puder ser criado. Caso contrário, ele sempre retornará TRUE.

CBasePane::DoesAllowDynInsertBefore

Determina se outro painel pode ser inserido dinamicamente entre esse painel e o quadro pai.

virtual BOOL DoesAllowDynInsertBefore() const;

Valor de Devolução

TRUE se um usuário puder inserir outro painel; caso contrário, FALSE.

Comentários

A estrutura chama esse método para determinar se um usuário pode inserir dinamicamente um painel antes desse painel.

Por exemplo, suponha que o aplicativo crie um painel encaixado no lado esquerdo do quadro (como a barra do Outlook). Para impedir que o usuário encaixe outro painel à esquerda do primeiro, substitua esse método e retorne FALSE.

Recomendamos que você substitua esse método e retorne FALSE para painéis não flutuantes derivados da Classe CDockablePane.

A implementação padrão retorna TRUE.

CBasePane::DoPaint

Preenche o segundo plano do painel.

virtual void DoPaint(CDC* pDC);

Parâmetros

pDC
[in] Um ponteiro para um contexto de dispositivo.

Comentários

A implementação padrão chama o gerenciador visual atual para preencher o segundo plano (CMFCVisualManager::OnFillBarBackground).

CBasePane::EnableDocking

Habilita o encaixe do painel ao quadro principal.

virtual void EnableDocking(DWORD dwAlignment);

Parâmetros

dwAlignment
[in] Especifica o alinhamento de encaixe a ser habilitado.

Comentários

Chame esse método para habilitar o alinhamento de encaixe ao quadro principal. Você pode passar uma combinação de sinalizadores CBRS_ALIGN_ (para obter mais informações, consulte CControlBar::EnableDocking).

EnableDocking define o sinalizador interno CBasePane::m_dwEnabledAlignment e a estrutura verifica esse sinalizador quando um painel é encaixado.

Chame CBasePane::GetEnabledAlignment para determinar o alinhamento de encaixe de um painel.

CBasePane::EnableGripper

Habilita ou desabilita a garra. Se a garra estiver habilitada, o usuário poderá arrastá-la para reposicionar o painel.

virtual void EnableGripper(BOOL bEnable);

Parâmetros

bEnable
[in] TRUE para habilitar a garra; FALSE para desabilitá-la.

Comentários

A estrutura usa esse método para habilitar uma garra em vez de usar o estilo WS_CAPTION.

CBasePane::FloatPane

Faz o painel flutuar.

virtual BOOL FloatPane(
    CRect rectFloat,
    AFX_DOCK_METHOD dockMethod=DM_UNKNOWN,
    bool bShow=true);

Parâmetros

rectFloat
[in] Especifica as coordenadas de tela em que o painel flutuante aparece.

dockMethod
[in] Especifica o método de encaixe a ser usado para que o painel flutue.

bShow
[in] Especifica se o painel flutuante fica visível (TRUE) ou oculto (FALSE).

Valor de Devolução

TRUE se o painel flutuou com êxito; caso contrário, FALSE.

Comentários

Chame esse método para fazer flutuar um painel na posição da tela especificada por rectFloat.

CBasePane::get_accHelpTopic

A estrutura chama esse método para recuperar o caminho completo do arquivo WinHelp associado ao objeto especificado e ao identificador do tópico apropriado nesse arquivo.

virtual HRESULT get_accHelpTopic(
    BSTR* pszHelpFile,
    VARIANT varChild,
    long* pidTopic);

Parâmetros

pszHelpFile
[in] Endereço de um BSTR que recebe o caminho completo do arquivo WinHelp associado ao objeto especificado, se houver.

varChild
[in] Especifica se o tópico de Ajuda a ser recuperado é aquele do objeto ou um dos elementos filho do objeto. Esse parâmetro pode ser CHILDID_SELF (para obter um tópico de Ajuda para o objeto) ou uma ID filho (para obter um tópico de Ajuda para um dos elementos filho do objeto).

pidTopic
[in] Identifica o tópico do arquivo de Ajuda associado ao objeto especificado.

Valor de Devolução

CBasePane não implementa esse método. Portanto, CBasePane::get_accHelpTopic sempre retorna S_FALSE.

Comentários

Essa função faz parte do suporte à Acessibilidade Ativa no MFC. Substitua essa função em uma classe derivada para fornecer informações de ajuda sobre o objeto.

CBasePane::get_accSelection

A estrutura chama esse método para recuperar os filhos selecionados desse objeto.

virtual HRESULT get_accSelection(VARIANT* pvarChildren);

Parâmetros

pvarChildren
[in] Recebe informações que identificam os filhos selecionados.

Valor de Devolução

CBasePane não implementa esse método. Se pvarChildren for NULL, o método retornará E_INVALIDARG. Caso contrário, o método retornará DISP_E_MEMBERNOTFOUND.

Comentários

Essa função faz parte do suporte à Acessibilidade Ativa no MFC. Substitua essa função em uma classe derivada se você tiver elementos de interface do usuário sem janelas, exceto por controles ActiveX sem janelas.

CBasePane::GetCaptionHeight

Retorna a altura da legenda.

virtual int GetCaptionHeight() const;

Valor de Devolução

A altura da legenda.

CBasePane::GetControlBarStyle

Retorna o estilo da barra de controle.

virtual DWORD GetControlBarStyle() const

Valor de Devolução

Uma combinação de OR bit a bit de sinalizadores AFX_CBRS_.

Comentários

O valor retornado é uma combinação dos possíveis valores a seguir.

Estilo	Descrição
AFX_CBRS_FLOAT	Faz a barra de controle flutuar.
AFX_CBRS_AUTOHIDE	Habilita o modo de ocultação automática.
AFX_CBRS_RESIZE	Habilita o redimensionamento da barra de controle. Quando esse sinalizador é definido, a barra de controle pode ser colocada em um painel encaixável.
AFX_CBRS_CLOSE	Habilita a ocultação da barra de controle.

CBasePane::GetCurrentAlignment

Retorna o alinhamento do painel atual.

virtual DWORD GetCurrentAlignment() const;

Valor de Devolução

O alinhamento atual da barra de controle. A tabela a seguir mostra os valores possíveis:

Valor	Alinhamento
CBRS_ALIGN_LEFT	Alinhamento à esquerda.
CBRS_ALIGN_RIGHT	Alinhamento à direita.
CBRS_ALIGN_TOP	Alinhamento superior.
CBRS_ALIGN_BOTTOM	Alinhamento inferior.

CBasePane::GetDockingMode

Retorna o modo de encaixe atual do painel.

virtual AFX_DOCK_TYPE GetDockingMode() const;

Valor de Devolução

DT_STANDARD se arrastar o painel for indicado na tela por um retângulo de arrasto. DT_IMMEDIATE se o conteúdo do painel for arrastado.

Comentários

A estrutura chama esse método para determinar o modo de encaixe atual do painel.

Se CBasePane::m_dockMode for indefinido (DT_UNDEFINED), o modo de encaixe será derivado do modo de encaixe global (AFX_GLOBAL_DATA::m_dockModeGlobal).

Definindo m_dockMode ou substituindo GetDockingMode, você pode controlar o modo de encaixe para cada painel.

CBasePane::GetDockSiteFrameWnd

Retorna um ponteiro para o objeto CDockingPanesRow em que o painel está encaixado.

virtual CWnd* GetDockSiteFrameWnd() const;

Valor de Devolução

Um ponteiro para o local de encaixe do painel.

Comentários

Chame esse método para recuperar um ponteiro para o local de encaixe do painel. O local de encaixe poderá ser uma janela de quadro principal se o painel estiver encaixado no quadro principal ou uma janela com minimoldura se o painel estiver flutuando.

CBasePane::GetEnabledAlignment

Retorna os estilos de CBRS_ALIGN_ aplicados ao painel.

virtual DWORD GetEnabledAlignment() const;

Valor de Devolução

Uma combinação de estilos de CBRS_ALIGN_. A seguinte tabela mostra os estilos possíveis:

Sinalizador	Alinhamento habilitado
CBRS_ALIGN_LEFT	Esquerda.
CBRS_ALIGN_RIGHT	Certo.
CBRS_ALIGN_TOP	Top.
CBRS_ALIGN_BOTTOM	Inferior.
CBRS_ALIGN_ANY	Combinação de todos os sinalizadores.

Comentários

Chame esse método para determinar o alinhamento habilitado para o painel. Alinhamento habilitado são os lados da janela do quadro principal a que um painel pode ser encaixado.

Habilite o alinhamento de encaixe usando CBasePane::EnableDocking.

CBasePane::GetMFCStyle

Retorna os estilos de painel específicos ao MFC.

virtual DWORD GetMFCStyle() const;

Valor de Devolução

Uma combinação dos estilos de painel (AFX_CBRS_) específicos da biblioteca.

CBasePane::GetPaneIcon

Retorna um identificador para o ícone do painel.

virtual HICON GetPaneIcon(BOOL bBigIcon);

Parâmetros

bBigIcon
[in] Especificará um ícone de 32 por 32 pixels se TRUE; especificará um ícone de 16 por 16 pixels se FALSE.

Valor de Devolução

Um identificador do ícone de painel. Se não for bem-sucedido, retornará NULL.

Comentários

A implementação padrão chama CWnd::GetIcon.

CBasePane::GetPaneRow

Retorna um ponteiro para o objeto CDockingPanesRow em que o painel está encaixado.

CDockingPanesRow* GetPaneRow();

Valor de Devolução

Um ponteiro para CDockingPanesRow se o painel estiver encaixado ou NULL se ele estiver flutuando.

Comentários

Chame esse método para acessar a linha a que um painel está encaixado. Por exemplo, para organizar os painéis em uma linha específica, chame GetPaneRow e chame CDockingPanesRow::ArrangePanes.

CBasePane::GetPaneStyle

Retorna o estilo do painel.

virtual DWORD GetPaneStyle() const;

Valor de Devolução

Uma combinação de estilos de barra de controle (incluindo estilos de CBRS_) definida pelo método CBasePane::SetPaneStyle no momento da criação.

CBasePane::GetParentDockSite

Retorna um ponteiro para o local de encaixe pai.

virtual CDockSite* GetParentDockSite() const;

Valor de Devolução

O local de encaixe pai.

CBasePane::GetParentMiniFrame

Retorna um ponteiro para a janela com minimoldura pai.

virtual CPaneFrameWnd* GetParentMiniFrame(BOOL bNoAssert=FALSE) const;

Parâmetros

bNoAssert
[in] Se TRUE, o método não verificará se há ponteiros inválidos. Se você chamar esse método quando o aplicativo for encerrado, defina o parâmetro como TRUE.

Valor de Devolução

Um ponteiro válido para a janela com minimoldura pai se o painel estiver flutuando; caso contrário, NULL.

Comentários

Chame essa função para recuperar um ponteiro para a janela com minimoldura pai. Esse método itera por todos os pais e verifica se há um objeto derivado da Classe CPaneFrameWnd.

Use GetParentMiniFrame para determinar se o painel está flutuando.

CBasePane::GetParentTabbedPane

Retorna um ponteiro para o painel com guias pai.

CBaseTabbedPane* GetParentTabbedPane() const;

Valor de Devolução

Um ponteiro para o painel com guias pai, se ele existir; caso contrário, NULL.

CBasePane::GetParentTabWnd

Retorna um ponteiro para a janela pai que está dentro de uma guia.

CMFCBaseTabCtrl* GetParentTabWnd(HWND& hWndTab) const;

Parâmetros

hWndTab
[out] Se o valor retornado for diferente de NULL, esse parâmetro conterá o identificador para a janela com guias pai.

Valor de Devolução

Um ponteiro válido para a janela com guias pai ou NULL.

Comentários

Use essa função para recuperar um ponteiro para a janela com guias pai. Às vezes, não é suficiente chamar GetParent, porque um painel pode estar dentro de um wrapper de encaixe (Classe CDockablePaneAdapter) ou de um adaptador de painel (Classe CDockablePaneAdapter). Usando GetParentTabWnd, você poderá recuperar um ponteiro válido nesses casos (supondo que o pai seja uma janela com guias).

CBasePane::GetRecentVisibleState

A estrutura chama esse método quando um painel é restaurado com base em um arquivo.

virtual BOOL GetRecentVisibleState() const;

Valor de Devolução

Um BOOL que especifica o estado visível recente. Se TRUE, o painel estava visível quando serializado e deverá estar visível quando restaurado. Se FALSE, o painel estava oculto quando serializado e deverá estar oculto quando restaurado.

CBasePane::HideInPrintPreviewMode

Especifica se o painel fica oculto na visualização de impressão.

virtual BOOL HideInPrintPreviewMode() const;

Valor de Devolução

TRUE se o painel não for mostrado na visualização de impressão; caso contrário, FALSE.

Comentários

Os painéis de base não são mostrados na visualização de impressão. Portanto, este método sempre retorna TRUE.

CBasePane::InsertPane

Registra o painel especificado no gerenciador de encaixe.

BOOL InsertPane(
    CBasePane* pControlBar,
    CBasePane* pTarget,
    BOOL bAfter = TRUE);

Parâmetros

pControlBar
[in] Um ponteiro para o painel a ser inserido.

pTarget
[in] Um ponteiro para o painel adjacente.

bAfter
[in] Se TRUE, pControlBar será inserido após pTarget. Se FALSE, pControlBar será inserido antes de pTarget.

Valor de Devolução

TRUE se o método for bem-sucedido; caso contrário, FALSE.

CBasePane::IsAccessibilityCompatible

Especifica se o painel dá suporte à Acessibilidade Ativa.

virtual BOOL IsAccessibilityCompatible();

Valor de Devolução

TRUE se o painel der suporte à Acessibilidade Ativa; caso contrário, FALSE.

CBasePane::IsAutoHideMode

Determina se um painel está no modo de ocultação automática.

virtual BOOL IsAutoHideMode() const;

Valor de Devolução

TRUE se o painel estiver no modo de ocultação automática; caso contrário, FALSE.

Comentários

Os painéis de base não podem ser ocultados automaticamente. Esse método sempre retorna FALSE.

CBasePane::IsDialogControl

Especifica se o painel é um controle de caixa de diálogo.

BOOL IsDialogControl() const;

Valor de Devolução

TRUE se o painel for um controle de caixa de diálogo; caso contrário, FALSE.

Comentários

A estrutura usa esse método para garantir a uniformidade de layout para todos os painéis.

CBasePane::IsDocked

Determina se o painel está encaixado.

virtual BOOL IsDocked() const;

Valor de Devolução

TRUE se o pai do painel não for uma minimoldura ou se o painel estiver flutuando em uma minimoldura com outro painel; caso contrário, FALSE.

CBasePane::IsFloating

Determina se o painel está flutuando.

virtual BOOL IsFloating() const;

Valor de Devolução

TRUE se o painel estiver flutuando; caso contrário, FALSE.

Comentários

Esse método retorna o valor oposto de CBasePane::IsDocked.

CBasePane::IsHorizontal

Determina se o painel está encaixado horizontalmente.

virtual BOOL IsHorizontal() const;

Valor de Devolução

TRUE se o painel estiver encaixado horizontalmente; caso contrário, FALSE.

Comentários

A implementação padrão verifica o alinhamento de encaixe atual de CBRS_ORIENT_HORZ.

CBasePane::IsInFloatingMultiPaneFrameWnd

Especifica se o painel está em uma janela de quadro de vários painéis (Classe CMultiPaneFrameWnd).

virtual BOOL IsInFloatingMultiPaneFrameWnd() const;

Valor de Devolução

TRUE se o painel estiver em uma janela de quadro de vários painéis; caso contrário, FALSE.

Comentários

Somente painéis encaixáveis podem flutuar em uma janela de quadro de vários painéis. Portanto, CBasePane::IsInFloatingMultiPaneFrameWnd sempre retorna FALSE.

CBasePane::IsMDITabbed

Determina se o painel foi adicionado a uma janela filho do MDI como um documento com guias.

virtual BOOL IsMDITabbed() const;

Valor de Devolução

TRUE se o painel tiver sido adicionado a uma janela filho do MDI como um documento com guias; caso contrário, FALSE.

CBasePane::IsPaneVisible

Especifica se o sinalizador WS_VISIBLE está definido para o painel.

BOOL IsPaneVisible() const;

Valor de Devolução

TRUE se WS_VISIBLE estiver definido; caso contrário, FALSE.

Comentários

Use CBasePane::IsVisible para determinar a visibilidade do painel.

CBasePane::IsPointNearDockSite

Determina se um ponto especificado está próximo ao local de encaixe.

BOOL IsPointNearDockSite(
    CPoint point,
    DWORD& dwBarAlignment,
    BOOL& bOuterEdge) const;

Parâmetros

point
[in] O ponto especificado.

dwBarAlignment
[out] Especifica de qual borda o ponto está próximo. Os valores possíveis são CBRS_ALIGN_LEFT, CBRS_ALIGN_RIGHT, CBRS_ALIGN_TOP e CBRS_ALIGN_BOTTOM

bOuterEdge
[out] TRUE se o ponto estiver próximo à borda externa do local de encaixe; caso contrário, FALSE.

Valor de Devolução

TRUE se o ponto estiver próximo ao local de encaixe; caso contrário, FALSE.

Comentários

O ponto fica próximo ao local de encaixe quando está dentro da sensibilidade definida no gerenciador de encaixe. A sensibilidade padrão é de 15 pixels.

CBasePane::IsResizable

Determina se o painel pode ser redimensionado.

virtual BOOL IsResizable() const;

Valor de Devolução

TRUE se o painel puder ser redimensionado pelo usuário; caso contrário, FALSE.

Comentários

Painéis da Classe CDockablePane podem ser redimensionados.

A barra de status (Classe CMFCStatusBar) e a barra de encaixe (Classe CDockSite) não podem ser redimensionadas.

CBasePane::IsRestoredFromRegistry

Determina se o painel é restaurado com base no registro.

virtual BOOL IsRestoredFromRegistry() const;

Valor de Devolução

TRUE se o painel for restaurado do registro; caso contrário, FALSE.

CBasePane::IsTabbed

Determina se o painel foi inserido no controle guia de uma janela com guias.

virtual BOOL IsTabbed() const;

Valor de Devolução

TRUE se a barra de controle for inserida em uma guia de uma janela com guias; caso contrário, FALSE.

Comentários

Esse método recupera um ponteiro para o pai imediato e determina se a classe de runtime do pai é a Classe CMFCBaseTabCtrl.

CBasePane::IsVisible

Determina se o painel está visível.

virtual BOOL IsVisible() const;

Valor de Devolução

TRUE se o painel estiver visível; caso contrário, FALSE.

Comentários

Use esse método para determinar a visibilidade de um painel. Não use ::IsWindowVisible.

Se o painel não tiver guias (consulte CBasePane::IsTabbed), esse método verificará o estilo WS_VISIBLE. Se o painel tiver guias, esse método verificará a visibilidade da janela com guias pai. Se a janela pai estiver visível, a função verificará a visibilidade da guia do painel usando CMFCBaseTabCtrl::IsTabVisible.

CBasePane::LoadState

Carrega o estado do painel com base no registro.

virtual BOOL LoadState(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

Parâmetros

lpszProfileName
[in] Nome do perfil.

nIndex
[in] Índice do perfil.

uiID
[in] ID do painel.

Valor de Devolução

TRUE se o estado do painel tiver sido carregado com êxito; caso contrário, FALSE.

Comentários

A estrutura chama esse método para carregar o estado do painel com base no registro. Substitua-o em uma classe derivada para carregar informações adicionais salvas por CBasePane::SaveState.

CBasePane::MoveWindow

Move o painel.

virtual HDWP MoveWindow(
    CRect& rect,
    BOOL bRepaint = TRUE,
    HDWP hdwp = NULL);

Parâmetros

rect
[in] Um retângulo que especifica o novo local e o tamanho do painel.

bRepaint
[in] Se TRUE, o painel será repintado. Se FALSE, o painel não será repintado.

hdwp
[in] Identificador de uma estrutura de posição de janela adiada.

Valor de Devolução

[in] Um identificador de uma estrutura de posição de janela adiada, ou NULL.

Comentários

Se você passar NULL como o parâmetro hdwp, o método moverá a janela normalmente. Se você passar um identificador, o método executará uma movimentação de janela adiada. Você pode obter um identificador chamando BeginDeferWindowPos ou armazenando o valor retornado de uma chamada anterior para esse método.

CBasePane::OnAfterChangeParent

Chamado pela estrutura após as alterações no pai do painel.

virtual void OnAfterChangeParent(CWnd* pWndOldParent);

Parâmetros

pWndOldParent
[in] Um ponteiro para o pai anterior.

Comentários

A estrutura chama esse método após as alterações no pai do painel, geralmente devido a uma operação de flutuação ou de encaixe.

A implementação padrão não tem ação.

CBasePane::OnBeforeChangeParent

Chamado pela estrutura logo antes do painel alterar a respectiva janela pai.

virtual void OnBeforeChangeParent(
    CWnd* pWndNewParent,
    BOOL bDelay=FALSE);

Parâmetros

pWndNewParent
[in] Um ponteiro para uma nova janela pai.

bDelay
[in] Especifica se ajustes de layout devem ser adiados.

Comentários

A estrutura chama esse método logo antes das alterações no pai do painel, geralmente devido a uma operação de flutuação, encaixe ou ocultação automática.

A implementação padrão não tem ação.

CBasePane::OnDrawCaption

A estrutura chama esse método quando a legenda é desenhada.

virtual void OnDrawCaption();

Comentários

Esse método não tem nenhuma funcionalidade para a classe CBasePane.

CBasePane::OnMovePaneDivider

Esse método não é usado atualmente.

virtual void OnMovePaneDivider(CPaneDivider* /* unused */);

Parâmetros

Utilizadas
[in] Não é usado.

CBasePane::OnPaneContextMenu

Chamado pela estrutura quando compila um menu que tem uma lista de painéis.

virtual void OnPaneContextMenu(
    CWnd* pParentFrame,
    CPoint point);

Parâmetros

pParentFrame
[in] Um ponteiro para o quadro pai.

point
[in] Especifica o local do menu de atalho.

Comentários

OnPaneContextMenu chama o gerenciador de encaixe, que mantém a lista de painéis que pertencem à janela do quadro atual. Esse método adiciona os nomes dos painéis a um menu de atalho e o exibe. Os comandos no menu mostram ou ocultam painéis individuais.

Substitua esse método para personalizar o comportamento.

CBasePane::OnRemoveFromMiniFrame

Chamado pela estrutura quando um painel é removido da janela com minimoldura pai.

virtual void OnRemoveFromMiniFrame(CPaneFrameWnd* pMiniFrame);

Parâmetros

pMiniFrame
[in] Um ponteiro para uma janela com minimoldura da qual o painel é removido.

Comentários

A estrutura chama esse método quando um painel é removido da janela com minimoldura pai (como resultado do encaixe, por exemplo).

A implementação padrão não tem ação.

CBasePane::OnSetAccData

CBasePane não usa esse método.

virtual BOOL OnSetAccData(long lVal);

Parâmetros

lVal
[in] Não é usado.

Valor de Devolução

Este método sempre retorna TRUE.

Comentários

CBasePane::PaneFromPoint

Retorna o painel que contém o determinado ponto.

CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    bool bExactBar = false,
    CRuntimeClass* pRTCBarType = NULL) const;

Parâmetros

point
[in] Especifica o ponto, em coordenadas de tela, a ser verificado.

nSensitivity
[in] Aumenta a área de pesquisa segundo esse valor. Um painel atenderá aos critérios de pesquisa se o ponto determinado estiver na área aumentada.

bExactBar
[in] TRUE para ignorar o parâmetro nSensitivity; caso contrário, FALSE.

pRTCBarType
[in] Se diferente de NULL, o método pesquisará apenas painéis do tipo especificado.

Valor de Devolução

O objeto derivado de CBasePane que contém o ponto determinado ou NULL se nenhum painel foi encontrado.

CBasePane::RecalcLayout

CBasePane não usa esse método.

virtual void RecalcLayout();

CBasePane::RemovePaneFromDockManager

Cancela o registro de um painel e o remove da lista no gerenciador de encaixe.

void RemovePaneFromDockManager(
    CBasePane* pBar,
    BOOL bDestroy = TRUE,
    BOOL bAdjustLayout = FALSE,
    BOOL bAutoHide = FALSE,
    CBasePane* pBarReplacement = NULL);

Parâmetros

pBar
[in] Um ponteiro para um painel a ser removido.

bDestroy
[in] Se TRUE, o painel removido será destruído.

bAdjustLayout
[in] Se TRUE, ajuste o layout de encaixe imediatamente.

bAutoHide
[in] Se TRUE, o layout de encaixe estará relacionado à lista de barras de ocultamento automático. Se FALSE, o layout de encaixe está relacionado à lista de painéis regulares.

pBarReplacement
[in] Um ponteiro para um painel que substitui o painel removido.

CBasePane::SaveState

Salva o estado do painel no registro.

virtual BOOL SaveState(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

Parâmetros

lpszProfileName
[in] Nome do perfil.

nIndex
[in] Índice do perfil.

uiID
[in] ID do painel.

Valor de Devolução

TRUE se o estado foi salvo com êxito; caso contrário, FALSE.

Comentários

A estrutura chama esse método quando salva o estado do painel no registro. Substitua SaveState em uma classe derivada para armazenar informações adicionais.

CBasePane::SelectDefaultFont

Seleciona a fonte padrão para um determinado contexto de dispositivo.

CFont* SelectDefaultFont(CDC* pDC);

Parâmetros

pDC
[in] O contexto de um dispositivo.

Valor de Devolução

Um ponteiro para o objeto de Classe CFont padrão.

CBasePane::SetControlBarStyle

Define o estilo da barra de controle.

virtual void SetControlBarStyle(DWORD dwNewStyle);

Parâmetros

dwNewStyle
[in] Uma combinação de OR bit a bit dos valores possíveis a seguir.

Estilo	Descrição
AFX_CBRS_FLOAT	Faz a barra de controle flutuar.
AFX_CBRS_AUTOHIDE	Habilita o modo de ocultação automática.
AFX_CBRS_RESIZE	Habilita o redimensionamento da barra de controle. Quando esse sinalizador é definido, a barra de controle pode ser colocada em um painel encaixável.
AFX_CBRS_CLOSE	Habilita a ocultação da barra de controle.

CBasePane::SetDockingMode

Define o modo de encaixe para o painel.

void SetDockingMode(AFX_DOCK_TYPE dockModeNew);

Parâmetros

dockModeNew
[in] Especifica o novo modo de encaixe do painel.

Comentários

A estrutura dá suporte a dois modos de encaixe: padrão e imediato.

No modo de encaixe padrão, painéis e janelas com minimoldura são movidos usando um retângulo de arrastar. No modo de encaixe imediato, as barras de controle e as janelas de minimoldura são movidas imediatamente com o respectivo contexto.

Inicialmente, o modo de encaixe é definido globalmente por CDockingManager::m_dockModeGlobal. Você pode definir o modo de encaixe para cada painel individualmente usando o método SetDockingMode.

CBasePane::SetPaneAlignment

Define o alinhamento do painel.

virtual void SetPaneAlignment(DWORD dwAlignment);

Parâmetros

dwAlignment
[in] Especifica o novo alinhamento.

Comentários

Normalmente, a estrutura chama esse método quando um painel é encaixado de um lado do quadro principal para outro.

A seguinte tabela mostra os valores possíveis para dwAlignment:

Valor	Alinhamento
CBRS_ALIGN_LEFT	Alinhamento à esquerda.
CBRS_ALIGN_RIGHT	Alinhamento à direita.
CBRS_ALIGN_TOP	Alinhamento superior.
CBRS_ALIGN_BOTTOM	Alinhamento inferior.

CBasePane::SetPaneStyle

Define o estilo do painel.

virtual void SetPaneStyle(DWORD dwNewStyle);

Parâmetros

dwNewStyle
[in] Especifica o novo estilo a ser definido.

Comentários

Esse método pode ser usado para definir qualquer um dos estilos de CBRS_ definidos em afxres.h. Como o estilo e o alinhamento do painel são armazenados juntos, defina o novo estilo combinando-o ao alinhamento atual, da seguinte maneira.

pPane->SetPaneStyle (pPane->GetCurrentAlignment() | CBRS_TOOLTIPS);

CBasePane::SetWindowPos

Altera o tamanho, a posição e a ordem em Z de um painel.

virtual HDWP SetWindowPos(
    const CWnd* pWndInsertAfter,
    int x,
    int y,
    int cx,
    int cy,
    UINT nFlags,
    HDWP hdwp = NULL);

Parâmetros

pWndInsertAfter
[in] Identifica o objeto CWnd que vem antes desse objeto CWnd na ordem em Z. Para obter mais informações, consulte CWnd::SetWindowPos.

x
[in] Especifica a posição do lado esquerdo da janela.

y
[in] Especifica a posição da parte superior da janela.

cx
[in] Especifica a largura da janela.

Cy
[in] Especifica a altura da janela.

nFlags
[in] Especifica opções de tamanho e posição. Para obter mais informações, consulte CWnd::SetWindowPos.

hdwp
[in] Identificador de uma estrutura que contém informações de tamanho e posição de uma ou mais janelas.

Valor de Devolução

[in] Um identificador de uma estrutura de posição de janela adiada atualizada, ou NULL.

Comentários

Se pWndInsertAfter for NULL, esse método chamará CWnd::SetWindowPos. Se pWndInsertAfter não for NULL, esse método chamará DeferWindowPos.

CBasePane::ShowPane

Mostra ou oculta o painel.

virtual void ShowPane(
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

Parâmetros

bShow
[in] Especifica se um painel deve ser mostrado (TRUE) ou ocultador (FALSE).

bDelay
[in] Se TRUE, o recálculo do layout de encaixe será adiado.

bActivate
[in] Se TRUE, o painel estará ativo quando mostrado.

Comentários

Esse método mostra ou oculta um painel. Use esse método em vez de ShowWindow, porque ele notifica os gerenciadores de encaixe relevantes sobre as alterações na visibilidade do painel.

Use CBasePane::IsVisible para determinar a visibilidade atual de um painel.

CBasePane::StretchPane

Alonga um painel vertical ou horizontalmente.

virtual CSize StretchPane(
    int nLength,
    BOOL bVert);

Parâmetros

nLength
[in] O comprimento segundo o qual alongar o painel.

bVert
[in] Se TRUE, alongar o painel verticalmente. Se FALSE, alongar o painel horizontalmente.

Valor de Devolução

O tamanho do painel alongado.

CBasePane::UndockPane

Remove o painel do local de encaixe, do controle deslizante padrão ou da janela com minimoldura em que ele está encaixado.

virtual void UndockPane(BOOL bDelay=FALSE);

Parâmetros

bDelay
Se TRUE, o layout de encaixe não será recalculado imediatamente.

Comentários

Chame esse método para manipular o estado do painel ou excluir o painel do layout de encaixe.

Se quiser continuar usando esse painel, chame CBasePane::DockPane ou CBasePane::FloatPane antes de chamar esse método.

Confira também

Gráfico da hierarquia
Classes
CPane
Classe CWnd