Classe CBasePane

Classe base para todos os painéis no MFC.

Sintaxe

class CBasePane : public CWnd

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Observações

Se você quiser criar uma classe de painel que ofereça suporte aos recursos de encaixe estendidos disponíveis no MFC, você deve derivá-la de CBasePane ou da Classe CPane.

Dicas de personalização

As seguintes dicas de personalização pertencem à CBasePane Class e a quaisquer classes que herdam dela:

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

  • AFX_CBRS_FLOAT faz o painel flutuar.

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

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

  Estes são sinalizadores que você pode combinar com uma operação bitwise-OR.

CBasePane implementa os seguintes métodos booleanos 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 encaixe nele.

• Se você quiser criar um painel estático que não possa flutuar e que impeça qualquer outro painel de encaixar antes dele (semelhante à barra do Outlook no exemplo OutlookDemo), crie-o como não flutuante e substitua CBasePane::D oesAllowDynInsertBefore 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 com guias e ocultação automática.

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

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

• Se quiser flutuar ou desencaixar um painel que esteja no modo de ocultação automática, você deve chamar 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 CFrameWndEx classe 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

Requerimentos

Cabeçalho: afxbasepane.h

CBasePane::AccNotifyObjectFocusEvent

CBasePane não utiliza este método.

virtual void AccNotifyObjectFocusEvent(int);

Parâmetros

Int
[em] Não utilizado.

CBasePane::AddPane

Adiciona um painel ao gerenciador de encaixe.

void AddPane(CBasePane* pBar);

Parâmetros

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

Observações

Este é um método de conveniência que adiciona um painel a um gerenciador de ancoragem. Usando esse método, você não precisa escrever 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 para o gerenciador de encaixe para ajustar o layout de encaixe.

virtual void AdjustDockingLayout(HDWP hdwp=NULL);

Parâmetros

HDWP
[saídas] Uma alça para uma estrutura que contém várias posições de janela.

Observações

Este é um método de conveniência que ajusta o layout de ancoragem. Usando esse método, você não precisa escrever 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();

Observações

A estrutura chama esse método quando um painel precisa ajustar seu layout interno. A implementação de 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

bAlongamento
[em] Indica se a barra deve ser esticada até o tamanho do quadro. O parâmetro bStretch é diferente de zero quando a barra não é uma barra de ancoragem (não disponível para encaixe) e é 0 quando está ancorada ou flutuante (disponível para encaixe).

bHorz
[em] Indica que a barra está orientada horizontal ou verticalmente. O parâmetro bHorz é diferente de zero se a barra estiver orientada horizontalmente e é 0 se estiver orientada verticalmente.

Valor de retorno

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

Observações

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

CBasePane::CanAcceptPane

Determina se outro painel pode ser encaixado no painel.

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

Parâmetros

pBar
[em] Um ponteiro para o painel para encaixar.

Valor de retorno

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

Observações

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

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

A implementação padrão retorna FALSE.

CBasePane::CanAutoHide

Determina se o painel suporta o modo de ocultação automática.

virtual BOOL CanAutoHide() const;

Valor de retorno

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

Observações

A estrutura chama essa função para determinar se o painel suporta o 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 em outro painel ou janela de quadro.

virtual BOOL CanBeAttached() const;

Valor de retorno

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

Observações

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 retorno

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

Observações

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 de miniquadros 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 em outro painel.

virtual BOOL CanBeDocked(CBasePane* pDockBar) const;

Parâmetros

pDockBar
[em] Um ponteiro para outro painel.

Valor de retorno

TRUE se este painel puder ser encaixado em outro painel; caso contrário, FALSE.

Observações

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

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

A implementação padrão retorna FALSE.

CBasePane::CanBeResized

Determina se o painel pode ser redimensionado.

virtual BOOL CanBeResized() const;

Valor de retorno

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

Observações

Esse método verifica o sinalizador AFX_CBRS_RESIZE, que é especificado por padrão em CBasePane::OnCreate. Se esse sinalizador não for especificado, o gerenciador de encaixe sinalizará o painel internamente como imó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 retorno

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

Observações

Somente objetos de determinados CBasePanetipos derivados, 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 retorno

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

Observações

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.

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

CBasePane::CanFocus

Especifica se o painel pode receber foco.

virtual BOOL CanFocus() const;

Valor de retorno

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

Observações

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 da barra de ferramentas.

A estrutura tenta definir o foco de entrada quando um painel é encaixado ou flutuado.

CBasePane::CopyState

Copia o estado de um determinado painel.

virtual void CopyState(CBasePane* pOrgBar);

Parâmetros

pOrgBar
[em] Um ponteiro para outro painel.

Observações

Este método copia o estado de pOrgBar para este painel.

CBasePane::CreateDefaultMiniframe

Se o painel puder flutuar, esse método criará uma janela de miniquadro para ele.

virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);

Parâmetros

rectInitial
[em] Especifica as coordenadas iniciais da janela de miniquadro.

Valor de retorno

Um ponteiro para a nova janela de miniquadro ou NULL se a criação falhar.

Observações

A estrutura chama esse método quando um painel alterna para um estado flutuante. O método cria uma janela de miniquadro e anexa o painel a essa janela.

A implementação padrão retorna NULL.

CBasePane::CreateEx

Cria o controle de 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
[em] Os estilos estendidos (consulte CWnd::CreateEx para obter mais informações).

lpszClassName
[em] O nome da classe da janela.

lpszWindowName
[em] O nome da janela.

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

retângulo
[em] O retângulo inicial.

pParentWnd
[em] Um ponteiro para a janela pai.

nID
[em] Especifica a ID do painel. Deve ser único.

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

pContexto
[em] Um ponteiro para CcreateContext

Valor de retorno

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

Observações

Cria uma janela de classe lpszClassName. Se você especificar WS_CAPTION, esse método limpa o bit de estilo WS_CAPTION e define CBasePane::m_bHasCaption como TRUE, porque a biblioteca não oferece suporte a painéis com legendas.

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

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

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

CBasePane::D ockPane

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
[em] Um ponteiro para outro painel.

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

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

Valor de retorno

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

Observações

Chame essa função para encaixar um painel em outro painel ou uma barra de dock ( CDockSite Class) especificada por pDockBar, ou em um quadro principal se pDockBar for NULL.

dockMethod especifica como o painel é encaixado. Consulte CPane::D ockPane para obter uma lista de valores possíveis.

CBasePane::D ockPaneUsingRTTI

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

void DockPaneUsingRTTI(BOOL bUseDockSite);

Parâmetros

bUseDockSite
[em] Se VERDADEIRO, encaixe no local de ancoragem. Se FALSE, encaixe no quadro pai.

CBasePane::D ockToFrameWindow

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

dwAlinhamento
[em] O lado do quadro pai no qual você deseja encaixar o painel.

lpRect
[em] O tamanho desejado.

dwDockFlags
[em] Ignorado.

pRelativeBar
[em] Ignorado.

nRelativeIndex
[em] Ignorado.

bOuterEdge
[em] Se 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 FALSE, o painel é encaixado mais perto do centro da área do cliente.

Valor de retorno

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

Observações

Este método falhará se um divisor de painel ( CPaneDivider Class) não pode ser criado. Caso contrário, ele sempre retorna TRUE.

CBasePane::D oesAllowDynInsertBefore

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

virtual BOOL DoesAllowDynInsertBefore() const;

Valor de retorno

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

Observações

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

Por exemplo, suponha que seu 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 painel, 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::D oPaint

Preenche o plano de fundo do painel.

virtual void DoPaint(CDC* pDC);

Parâmetros

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

Observações

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

CBasePane::EnableDocking

Permite encaixar o painel no quadro principal.

virtual void EnableDocking(DWORD dwAlignment);

Parâmetros

dwAlinhamento
[em] Especifica o alinhamento de encaixe a ser habilitado.

Observações

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

EnableDocking Define o sinalizador CBasePane::m_dwEnabledAlignment interno e a estrutura verifica esse sinalizador quando um painel está encaixado.

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

CBasePane::EnableGripper

Ativa ou desativa a pinça. Se a garra estiver ativada, o usuário poderá arrastá-la para reposicionar o painel.

virtual void EnableGripper(BOOL bEnable);

Parâmetros

bAtivar
[em] TRUE para habilitar a garra; FALSO para desativá-lo.

Observações

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

CBasePane::FloatPane

Flutua o painel.

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

Parâmetros

rectFloat
[em] Especifica as coordenadas da tela onde o painel flutuante aparece.

dockMethod
[em] Especifica o método de dock a ser usado para flutuar o painel.

bMostrar
[em] Especifica se o painel flutuante é visível (TRUE) ou oculto (FALSE).

Valor de retorno

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

Observações

Chame esse método para 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 que está associado com o objeto especificado e o identificador do tópico apropriado nesse arquivo.

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

Parâmetros

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

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

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

Valor de retorno

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

Observações

Esta função faz parte do suporte de acessibilidade ativa no MFC. Substitua essa função em uma classe derivada para fornecer informações de ajuda sobre seu 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

pvarCrianças
[em] Recebe informações que identificam as crianças selecionadas.

Valor de retorno

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

Observações

Esta função faz parte do suporte de acessibilidade ativa no MFC. Substitua essa função em uma classe derivada se você tiver elementos de interface do usuário sem janela diferentes de controles ActiveX sem janela.

CBasePane::GetCaptionHeight

Retorna a altura da legenda.

virtual int GetCaptionHeight() const;

Valor de retorno

A altura da legenda.

CBasePane::GetControlBarStyle

Retorna o estilo da barra de controle.

virtual DWORD GetControlBarStyle() const

Valor de retorno

Uma combinação bitwise-OR de bandeiras AFX_CBRS_.

Observações

O valor de retorno é uma combinação dos seguintes valores possíveis.

CBasePane::GetCurrentAlignment

Retorna o alinhamento do painel atual.

virtual DWORD GetCurrentAlignment() const;

Valor de retorno

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

CBasePane::GetDockingMode

Retorna o modo de encaixe atual para o painel.

virtual AFX_DOCK_TYPE GetDockingMode() const;

Valor de retorno

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

Observações

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

Se CBasePane::m_dockMode estiver indefinido (DT_UNDEFINED), o modo de ancoragem será retirado do modo de ancoragem global (AFX_GLOBAL_DATA::m_dockModeGlobal).

Ao definir m_dockMode ou substituir, GetDockingMode você pode controlar o modo de encaixe para cada painel.

CBasePane::GetDockSiteFrameWnd

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

virtual CWnd* GetDockSiteFrameWnd() const;

Valor de retorno

Um ponteiro para o site do dock do painel.

Observações

Chame esse método para recuperar um ponteiro para o site de doca do painel. O local do dock pode ser uma janela de quadro principal se o painel estiver encaixado no quadro principal ou uma janela de miniquadro se o painel estiver flutuando.

CBasePane::GetEnabledAlignment

Retorna os estilos de CBRS_ALIGN_ aplicados ao painel.

virtual DWORD GetEnabledAlignment() const;

Valor de retorno

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

Observações

Chame esse método para determinar o alinhamento habilitado para o painel. O alinhamento ativado significa os lados da janela do quadro principal aos quais um painel pode ser encaixado.

Habilite o alinhamento de encaixe usando CBasePane::EnableDocking.

CBasePane::GetMFCStyle

Retorna os estilos de painel específicos do MFC.

virtual DWORD GetMFCStyle() const;

Valor de retorno

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

CBasePane::GetPaneIcon

Retorna uma alça para o ícone do painel.

virtual HICON GetPaneIcon(BOOL bBigIcon);

Parâmetros

bBigIcon
[em] Especifica um ícone de 32 pixels por 32 pixels se TRUE; especifica um ícone de 16 pixels por 16 pixels se FALSE.

Valor de retorno

Uma alça para o ícone do painel. Se não tiver êxito, retorna NULL.

Observações

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

CBasePane::GetPaneRow

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

CDockingPanesRow* GetPaneRow();

Valor de retorno

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

Observações

Chame esse método para acessar a linha onde 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 retorno

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

CBasePane::GetParentDockSite

Retorna um ponteiro para o site do dock pai.

virtual CDockSite* GetParentDockSite() const;

Valor de retorno

O local de doca pai.

CBasePane::GetParentMiniFrame

Retorna um ponteiro para a janela de miniquadro pai.

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

Parâmetros

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

Valor de retorno

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

Observações

Chame essa função para recuperar um ponteiro para a janela de miniquadro pai. Esse método itera através de 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 retorno

Um ponteiro para o painel com guias pai, se 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
[saídas] Se o valor de retorno não for NULL, esse parâmetro conterá o identificador para a janela com guias pai.

Valor de retorno

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

Observações

Use esta 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 ( CDockablePaneAdapter Class) ou dentro de um adaptador de painel ( CDockablePaneAdapter Class). GetParentTabWnd Usando você será capaz de recuperar um ponteiro válido nesses casos (assumindo que o pai é uma janela com guias).

CBasePane::GetRecentVisibleState

A estrutura chama esse método quando um painel é restaurado a partir de um arquivo.

virtual BOOL GetRecentVisibleState() const;

Valor de retorno

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

CBasePane::HideInPrintPreviewMode

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

virtual BOOL HideInPrintPreviewMode() const;

Valor de retorno

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

Observações

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

CBasePane::InsertPane

Registra o painel especificado com o gerenciador de encaixe.

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

Parâmetros

pBarra de controlo
[em] Um ponteiro para o painel a ser inserido.

pAlvo
[em] Um ponteiro para o painel adjacente.

bDepois
[em] Se TRUE, pControlBar é inserido após pTarget. Se FALSE, pControlBar é inserido antes de pTarget.

Valor de retorno

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

CBasePane::IsAccessibilityCompatible

Especifica se o painel oferece suporte à Acessibilidade Ativa.

virtual BOOL IsAccessibilityCompatible();

Valor de retorno

TRUE se o painel suportar 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 retorno

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

Observações

Os painéis 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 retorno

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

Observações

A estrutura usa esse método para garantir a consistência do layout para todos os painéis.

CBasePane::IsDocked

Determina se o painel está encaixado.

virtual BOOL IsDocked() const;

Valor de retorno

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

CBasePane::IsFloating

Determina se o painel está flutuando.

virtual BOOL IsFloating() const;

Valor de retorno

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

Observações

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 retorno

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

Observações

A implementação padrão verifica o alinhamento de encaixe atual para 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 retorno

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

Observações

Apenas 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 MDI como um documento com guias.

virtual BOOL IsMDITabbed() const;

Valor de retorno

TRUE se o painel foi adicionado a uma janela filho 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 retorno

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

Observações

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

CBasePane::IsPointNearDockSite

Determina se um ponto especificado está perto do local da doca.

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

Parâmetros

ponto
[em] O ponto especificado.

dwBarAlignment
[saídas] Especifica 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
[saídas] VERDADEIRO se o ponto estiver próximo da borda externa do local do cais; FALSO caso contrário.

Valor de retorno

TRUE se o ponto estiver perto do local da doca; caso contrário, FALSE.

Observações

O ponto está perto do local da doca quando está dentro da sensibilidade definida no gerenciador de ancoragem. A sensibilidade padrão é de 15 pixels.

CBasePane::IsResizable

Determina se o painel pode ser redimensionado.

virtual BOOL IsResizable() const;

Valor de retorno

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

Observações

Os painéis da classe CDockablePane podem ser redimensionados.

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

CBasePane::IsRestoredFromRegistry

Determina se o painel é restaurado a partir do Registro.

virtual BOOL IsRestoredFromRegistry() const;

Valor de retorno

TRUE se o painel for restaurado a partir do registo; caso contrário, FALSE.

CBasePane::IsTabbed

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

virtual BOOL IsTabbed() const;

Valor de retorno

TRUE se a barra de controlo estiver inserida num separador de uma janela com separadores; caso contrário, FALSE.

Observações

Esse método recupera um ponteiro para o pai imediato e determina se a classe de tempo de execução do pai é CMFCBaseTabCtrl Class.

CBasePane::IsVisible

Determina se o painel está visível.

virtual BOOL IsVisible() const;

Valor de retorno

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

Observações

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

Se o painel não estiver com tabulações (consulte CBasePane::IsTabbed), esse método verificará o estilo WS_VISIBLE. Se o painel estiver com 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 a partir do registo.

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

Parâmetros

lpszProfileName
[em] Nome do perfil.

nÍndice
[em] Índice de perfil.

uiID
[em] ID do painel.

Valor de retorno

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

Observações

A estrutura chama esse método para carregar o estado do painel do 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

retângulo
[em] Um retângulo especificando o novo local e tamanho do painel.

bRepintar
[em] Se TRUE, o painel é repintado. Se FALSE, o painel não será repintado.

HDWP
[em] Manipule uma estrutura de posição de janela adiada.

Valor de retorno

Um identificador para uma estrutura de posição de janela adiada ou NULL.

Observações

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

CBasePane::OnAfterChangeParent

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

virtual void OnAfterChangeParent(CWnd* pWndOldParent);

Parâmetros

pWndOldParent
[em] Um ponteiro para o pai anterior.

Observações

A estrutura chama esse método depois que o pai do painel é alterado, geralmente devido a uma operação de encaixe ou flutuante.

A implementação padrão não faz nada.

CBasePane::OnBeforeChangeParent

Chamado pela estrutura pouco antes de o painel alterar sua janela pai.

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

Parâmetros

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

bAtraso
[em] Especifica se os ajustes de layout devem ser atrasados.

Observações

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

A implementação padrão não faz nada.

CBasePane::OnDrawCaption

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

virtual void OnDrawCaption();

Observações

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

CBasePane::OnMovePaneDivider

Este método não é utilizado atualmente.

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

Parâmetros

não utilizados
[em] Não utilizado.

CBasePane::OnPaneContextMenu

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

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

Parâmetros

pParentFrame
[em] Um ponteiro para o quadro pai.

ponto
[em] Especifica o local do menu de atalho.

Observações

OnPaneContextMenu chama o gerenciador de encaixe, que mantém a lista de painéis que pertencem à janela de 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 esse comportamento.

CBasePane::OnRemoveFromMiniFrame

Chamado pela estrutura quando um painel é removido de sua janela de miniquadro pai.

virtual void OnRemoveFromMiniFrame(CPaneFrameWnd* pMiniFrame);

Parâmetros

pMiniFrame
[em] Um ponteiro para uma janela de miniquadro da qual o painel é removido.

Observações

A estrutura chama esse método quando um painel é removido de sua janela de miniquadro pai (como resultado de encaixe, por exemplo).

A implementação padrão não faz nada.

CBasePane::OnSetAccData

CBasePane não utiliza este método.

virtual BOOL OnSetAccData(long lVal);

Parâmetros

lVal
[em] Não utilizado.

Valor de retorno

Esse método sempre retorna TRUE.

Observações

CBasePane::P aneFromPoint

Retorna o painel que contém o ponto determinado.

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

Parâmetros

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

nSensibilidade
[em] Aumente a área de pesquisa neste montante. Um painel satisfará os critérios de pesquisa se o ponto dado cair na área aumentada.

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

pRTCBarType
[em] Se não for NULL, o método pesquisa apenas painéis do tipo especificado.

Valor de retorno

O CBasePaneobjeto -derivado que contém o ponto determinado, ou NULL se nenhum painel foi encontrado.

CBasePane::RecalcLayout

CBasePane não utiliza este 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
[em] Um ponteiro para um painel a ser removido.

bDestruir
[em] Se TRUE, o painel removido será destruído.

bAjustarLayout
[em] Se VERDADEIRO, ajuste o layout de encaixe imediatamente.

bAutoOcultar
[em] Se TRUE, o layout de encaixe está relacionado à lista de barras de ocultação automática. Se FALSE, o layout de encaixe está relacionado à lista de painéis regulares.

pBarSubstituição
[em] 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
[em] Nome do perfil.

nÍndice
[em] Índice de perfil.

uiID
[em] ID do painel.

Valor de retorno

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

Observações

A estrutura chama esse método quando salva o estado do painel no Registro. Substituir 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
[em] Um contexto de dispositivo.

Valor de retorno

Um ponteiro para o objeto CFont Class padrão.

CBasePane::SetControlBarStyle

Define o estilo da barra de controle.

virtual void SetControlBarStyle(DWORD dwNewStyle);

Parâmetros

dwNewStyle
[em] Uma combinação bitwise-OR dos seguintes valores possíveis.

CBasePane::SetDockingMode

Define o modo de encaixe para o painel.

void SetDockingMode(AFX_DOCK_TYPE dockModeNew);

Parâmetros

dockModeNovo
[em] Especifica o novo modo de encaixe para o painel.

Observações

A estrutura suporta dois modos de encaixe: padrão e imediato.

No modo de encaixe padrão, os painéis e as janelas de miniquadros são movidos usando um retângulo de arrasto. No modo de ancoragem imediata, as barras de controlo e as janelas de minimoldura são movidas imediatamente com o seu 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 SetDockingMode método.

CBasePane::SetPaneAlignment

Define o alinhamento para o painel.

virtual void SetPaneAlignment(DWORD dwAlignment);

Parâmetros

dwAlinhamento
[em] Especifica o novo alinhamento.

Observações

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

A tabela a seguir mostra os valores possíveis para dwAlignment:

CBasePane::SetPaneStyle

Define o estilo do painel.

virtual void SetPaneStyle(DWORD dwNewStyle);

Parâmetros

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

Observações

Este 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 com o alinhamento atual da seguinte maneira.

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

CBasePane::SetWindowPos

Altera o tamanho, a posição e a ordem 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
[em] Identifica o CWnd objeto que vem antes desse CWnd objeto na ordem Z. Para obter mais informações, consulte CWnd::SetWindowPos.

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

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

CX
[em] Especifica a largura da janela.

cy
[em] Especifica a altura da janela.

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

HDWP
[em] Manipule uma estrutura que contenha informações de tamanho e posição para uma ou mais janelas.

Valor de retorno

Um identificador para uma estrutura de posição de janela adiada atualizada ou NULL.

Observações

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

CBasePane::ShowPane

Mostra ou oculta o painel.

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

Parâmetros

bMostrar
[em] Especifica se deve mostrar (TRUE) ou ocultar (FALSE) um painel.

bAtraso
[em] Se TRUE, o recálculo do layout de encaixe está atrasado.

bAtivar
[em] Se TRUE, o painel estará ativo quando mostrado.

Observações

Este método mostra ou oculta um painel. Use esse método em vez de porque esse método notifica os gerenciadores de ShowWindow encaixe relevantes sobre 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

nComprimento
[em] O comprimento pelo qual esticar o painel.

bVert
[em] Se VERDADEIRO, estique o painel verticalmente. Se FALSE, estique o painel horizontalmente.

Valor de retorno

O tamanho do painel esticado.

CBasePane::UndockPane

Remove o painel do site do dock, do controle deslizante padrão ou da janela de miniquadro onde ele está encaixado no momento.

virtual void UndockPane(BOOL bDelay=FALSE);

Parâmetros

bAtraso
Se TRUE, o layout de encaixe não é recalculado imediatamente.

Observações

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

Se você quiser continuar a usar esse painel, chame CBasePane::D ockPane ou CBasePane::FloatPane antes de chamar esse método.

Ver também

Gráfico de Hierarquia
Aulas
CPane
CWnd Classe