Classe CPaneFrameWnd

Para mais detalhes, consulte o código-fonte localizado na pasta VC\atlmfc\src\mfc da sua instalação no Visual Studio.

Implementa uma janela mini-frame que contém um painel. O painel preenche a área do cliente da janela.

Sintaxe

class CPaneFrameWnd : public CWnd

Membros

Métodos Públicos

Métodos Protegidos

Membros de Dados

Observações

A estrutura cria automaticamente um CPaneFrameWnd objeto quando um painel é alterado de um estado acoplado para um estado flutuante.

Uma janela mini-frame pode ser arrastada com o seu conteúdo visível (acoplamento imediato) ou usando um retângulo de arrasto (acoplamento padrão). O modo de acoplamento do painel do contentor do mini-frame determina o comportamento de arrasto do mini-frame. Para mais informações, veja CBasePane::GetDockingMode.

Uma janela de mini-moldura exibe botões na legenda de acordo com o estilo do painel contido. Se o painel puder ser fechado ( CBasePane::CanBeClosed), mostra um botão de Fechar. Se o painel tiver o estilo AFX_CBRS_AUTO_ROLLUP, mostra um alfinete.

Se derivares uma classe a partir de CPaneFrameWnd, tens de dizer ao framework como a criar. Ou cria a classe sobrescrevendo o CPane::CreateDefaultMiniframe, ou define o CPane::m_pMiniFrameRTC membro para que aponte para a informação da classe em tempo de execução da sua classe.

Hierarquia de herança

CObject

CCmdTarget

CWnd

CPaneFrameWnd

Requerimentos

Cabeçalho: afxPaneFrameWnd.h

CPaneFrameWnd::AddPane

Acrescenta um painel.

virtual void AddPane(CBasePane* pWnd);

Parâmetros

pWnd
[dentro] O painel a acrescentar.

CPaneFrameWnd::AddRemovePaneFromGlobalList

Adiciona ou remove um painel da lista global.

static BOOL __stdcall AddRemovePaneFromGlobalList(
    CBasePane* pWnd,
    BOOL bAdd);

Parâmetros

pWnd
[dentro] O painel para adicionar ou remover.

bAdd
[dentro] Se for diferente de zero, adiciona o painel. Se for 0, remova o painel.

Valor de retorno

Não nulo se o método fosse bem-sucedido; caso contrário, 0.

CPaneFrameWnd::AdjustLayout

Ajusta a disposição da janela de mini-moldura.

virtual void AdjustLayout();

CPaneFrameWnd::AdjustPaneFrames

virtual void AdjustPaneFrames();

Observações

CPaneFrameWnd::CalcBorderSize

Calcula o tamanho das bordas para uma janela de miniframe.

virtual void CalcBorderSize(CRect& rectBorderSize) const;

Parâmetros

rectBorderSize
[fora] Contém o tamanho, em pixels, da borda da janela do miniframe.

Observações

Este método é chamado pelo framework para calcular o tamanho da borda de uma janela de miniframe. O tamanho devolvido depende se uma janela de miniframe contém uma barra de ferramentas ou um CDockablePane.

CPaneFrameWnd::CalcExpectedDockedRect

Calcule o retângulo esperado de uma janela acoplada.

virtual void CalcExpectedDockedRect(
    CWnd* pWndToDock,
    CPoint ptMouse,
    CRect& rectResult,
    BOOL& bDrawTab,
    CDockablePane** ppTargetBar);

Parâmetros

pWndToDock
[dentro] Um apontador para a janela de acoplamento.

ptMouse
[dentro] A localização do rato.

rectResult
[fora] O retângulo calculado.

bDrawTab
[fora] Se for VERDADEIRO, desenha uma tab. Se FALSO, não desenhe uma tabulação.

ppTargetBar
[fora] Um apontador para o painel alvo.

Observações

Este método calcula o retângulo que uma janela ocuparia se um utilizador arrastasse a janela até ao ponto especificado pelo ptMouse e a acoplasse aí.

CPaneFrameWnd::PodeEstarAnexado

Determina se o painel atual pode ser acoplado a outro painel ou janela de frame.

virtual BOOL CanBeAttached() const;

Valor de retorno

TRUE se o painel puder ser acoplado a outro painel ou janela de moldura; caso contrário, FALSO.

CPaneFrameWnd::PodeEstarAcopladoA Pane

Determina se a janela do mini-frame pode ser acoplada a um painel.

virtual BOOL CanBeDockedToPane(const CDockablePane* pDockingBar) const;

Parâmetros

pDockingBar
[dentro] Um vidro.

Valor de retorno

Diferente de zero se o mini-frame puder ser acoplado ao pDockingBar; caso contrário, 0.

CPaneFrameWnd::VerificarGripperVisibilidade

virtual void CheckGripperVisibility();

Observações

CPaneFrameWnd::ConvertToTabbedDocument

Converte o painel num documento separado.

virtual void ConvertToTabbedDocument();

CPaneFrameWnd::Create

Cria uma janela de miniframe e anexa-a ao objeto CPaneFrameWnd .

virtual BOOL Create(
    LPCTSTR lpszWindowName,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    CCreateContext* pContext = NULL);

Parâmetros

lpszWindowName
[dentro] Especifica o texto a mostrar na janela do miniframe.

dwStyle
[dentro] Especifica o estilo da janela. Para mais informações, consulte Estilos de Janela.

retângulo
[dentro] Especifica o tamanho inicial e a posição da janela do miniframe.

pParentWnd
[inspira, expira] Especifica o frame pai da janela do miniframe. Este valor não pode ser NULL.

pContext
[inspira, expira] Especifica o contexto definido pelo utilizador.

Valor de retorno

TRUE se a janela foi criada com sucesso; caso contrário, FALSO.

Observações

Uma janela de miniframe é criada em dois passos. Primeiro, a estrutura cria um CPaneFrameWnd objeto. Em segundo lugar, chama Create para criar a janela miniframe do Windows e anexá-la ao CPaneFrameWnd objeto.

CPaneFrameWnd::CreateEx

Cria uma janela de miniframe e anexa-a ao objeto CPaneFrameWnd .

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

Parâmetros

dwStyleEx
[dentro] Especifica o estilo da janela estendida. Para mais informações, consulte Estilos de Janelas Estendidas

lpszWindowName
[dentro] Especifica o texto a mostrar na janela do miniframe.

dwStyle
[dentro] Especifica o estilo da janela. Para mais informações, consulte Estilos de Janela.

retângulo
[dentro] Especifica o tamanho inicial e a posição da janela do miniframe.

pParentWnd
[inspira, expira] Especifica o frame pai da janela do miniframe. Este valor não pode ser NULL.

pContext
[inspira, expira] Especifica o contexto definido pelo utilizador.

Valor de retorno

TRUE se a janela foi criada com sucesso; caso contrário, FALSO.

Observações

Uma janela de miniframe é criada em dois passos. Primeiro, a estrutura cria um CPaneFrameWnd objeto. Em segundo lugar, chama Create para criar a janela miniframe do Windows e anexá-la ao CPaneFrameWnd objeto.

CPaneFrameWnd::D ockPane

Atraca o vidro.

virtual CDockablePane* DockPane(BOOL& bWasDocked);

Parâmetros

bEstavaAcoplado
[fora] VERDADE se o painel já estivesse acoplado; caso contrário, FALSO.

Valor de retorno

Se a operação fosse bem-sucedida, o CDockablePane que o painel estava acoplado; caso contrário, NULL.

CPaneFrameWnd::FindFloatingPaneByID

Encontra um painel com o ID de controlo especificado na lista global de painéis flutuantes.

static CBasePane* FindFloatingPaneByID(UINT nID);

Parâmetros

nID
[dentro] Representa o ID de controlo do painel a encontrar.

Valor de retorno

O painel com o ID de controlo especificado; caso contrário, NULL, se nenhum painel tiver o ID de controlo especificado.

CPaneFrameWnd::FrameFromPoint

Encontra a janela de mini-frame que contém o ponto especificado.

static CPaneFrameWnd* __stdcall FrameFromPoint(
    CPoint pt,
    int nSensitivity,
    CPaneFrameWnd* pFrameToExclude = NULL,
    BOOL bFloatMultiOnly = FALSE);

Parâmetros

pt
[dentro] O ponto, em coordenadas do ecrã.

nSensibilidade
[dentro] Aumente a área de pesquisa da janela da mini-moldura neste tamanho. Uma janela de mini-frame satisfaz os critérios de pesquisa se o ponto dado estiver na área aumentada.

pFrameToExclude
[dentro] Especifica uma janela de mini-frame a excluir da pesquisa.

bFloatMultiOnly
[dentro] Se for VERDADEIRO, procura apenas janelas mini-frame que tenham o estilo CBRS_FLOAT_MULTI. Se FALSE, procure todas as janelas de mini-frame.

Valor de retorno

Um ponteiro para a janela de mini-moldura que contém pt; caso contrário, NULL.

CPaneFrameWnd::GetCaptionHeight

Devolve a altura da legenda da janela do mini-frame.

virtual int GetCaptionHeight() const;

Valor de retorno

A altura, em píxeis, da janela do mini-frame.

Observações

Chame este método para determinar a altura de uma janela de mini-moldura. Por defeito, a altura está definida para SM_CYSMCAPTION. Para mais informações, consulte a Função GetSystemMetrics.

CPaneFrameWnd::GetCaptionRect

Calcula o retângulo delimitador de uma legenda de janela em mini-frame.

virtual void GetCaptionRect(CRect& rectCaption) const;

Parâmetros

rectCaption
[fora] Contém o tamanho e a posição da legenda da janela do mini-frame, em coordenadas do ecrã.

Observações

Este método é chamado pela estrutura para calcular o retângulo delimitador de uma legenda de janela mini-frame.

CPaneFrameWnd::GetCaptionText

Devolve o texto da legenda.

virtual CString GetCaptionText();

Valor de retorno

O texto da legenda da janela de mini-moldura.

Observações

Este método é chamado pelo framework quando apresenta o texto da legenda.

CPaneFrameWnd::GetDockingManager

CDockingManager* GetDockingManager() const;

Valor de retorno

Observações

CPaneFrameWnd::GetDockingMode

Retorna o modo de acoplamento.

virtual AFX_DOCK_TYPE GetDockingMode() const;

Valor de retorno

O modo de acoplagem. Um dos seguintes valores:

• DT_STANDARD

• DT_IMMEDIATE

• DT_SMART

CPaneFrameWnd::GetFirstVisiblePane

Devolve o primeiro painel visível que está contido numa janela de mini-moldura.

virtual CWnd* GetFirstVisiblePane() const;

Valor de retorno

O primeiro painel na janela do mini-frame, ou NULL se a janela do mini-frame não contiver painéis.

CPaneFrameWnd::GetHotPoint

CPoint GetHotPoint() const;

Valor de retorno

Observações

CPaneFrameWnd::GetPane

Devolve um painel que está contido na janela do mini-frame.

virtual CWnd* GetPane() const;

Valor de retorno

O painel contido no mini-frame, ou NULL se a janela do mini-frame não tiver painéis.

Observações

CPaneFrameWnd::GetPaneCount

Devolve o número de painéis contidos numa janela de mini-moldura.

virtual int GetPaneCount() const;

Valor de retorno

O número de vidros na janela de mini-moldura. Este valor pode ser zero.

Observações

CPaneFrameWnd::GetParent

CWnd* GetParent();

Valor de retorno

Observações

CPaneFrameWnd::GetPinState

BOOL GetPinState() const;

Valor de retorno

Observações

CPaneFrameWnd::GetRecentFloatingRect

CRect GetRecentFloatingRect() const;

Valor de retorno

Observações

CPaneFrameWnd::GetVisiblePaneCount

Devolve o número de painéis visíveis contidos numa janela de mini-moldura.

virtual int GetVisiblePaneCount() const;

Valor de retorno

O número de vidros visíveis.

Observações

CPaneFrameWnd::HitTest

Determina que parte de uma janela de mini-moldura está num dado ponto.

virtual LRESULT HitTest(
    CPoint point,
    BOOL bDetectCaption);

Parâmetros

ponto
[dentro] O objetivo de testar.

bDetectCaption
[dentro] Se for VERDADEIRO, verifica o ponto com a legenda. Se FALSO, ignore a legenda.

Valor de retorno

Um dos seguintes valores:

CPaneFrameWnd::IsCapturado

BOOL IsCaptured() const;

Valor de retorno

Observações

CPaneFrameWnd::IsDelayShow

BOOL IsDelayShow() const;

Valor de retorno

Observações

CPaneFrameWnd::IsRollDown

Determina se uma janela de mini-moldura deve ser descida.

virtual BOOL IsRollDown() const;

Valor de retorno

VERDADEIRO se a janela do mini-frame tiver de ser baixada; caso contrário, FALSO.

Observações

Este método é chamado pelo framework para determinar se uma janela de mini-frame deve ser descida. A funcionalidade de rollup/rolldown está ativada para uma janela de mini-frame se esta contiver pelo menos um painel com a bandeira AFX_CBRS_AUTO_ROLLUP. Este flag é definido quando um painel é criado. Para mais informações, consulte CBasePane::CreateEx.

Por defeito, o framework verifica se o ponteiro do rato está dentro do retângulo delimitador da janela do mini-frame para determinar se a janela tem de ser descida. Podes sobrepor este comportamento numa classe derivada.

CPaneFrameWnd::IsRollUp

Determina se uma janela de mini-moldura deve ser enrolada.

virtual BOOL IsRollUp() const;

Valor de retorno

TRUE se a janela do mini-frame tiver de ser enrolada; caso contrário, FALSO.

Observações

Este método é chamado pelo framework para determinar se uma janela de mini-frame deve ser enrolada. A funcionalidade de rollup/rolldown está ativada para uma janela de mini-frame se esta contiver pelo menos um painel com a bandeira AFX_CBRS_AUTO_ROLLUP. Este flag é definido quando um painel é criado. Para mais informações, consulte CBasePane::CreateEx.

Por defeito, o framework verifica se o ponteiro do rato está dentro do retângulo delimitador da janela do mini-frame para determinar se a janela tem de ser enrolada para cima. Podes sobrepor este comportamento numa classe derivada.

CPaneFrameWnd::KillDockingTimer

Para o temporizador de acoplamento.

void KillDockingTimer();

CPaneFrameWnd::LoadState

Carrega o estado do painel a partir do registo.

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

Parâmetros

lpszProfileName
[dentro] O nome do perfil.

uiID
[dentro] O ID do painel.

Valor de retorno

TRUE se o estado do painel foi carregado com sucesso; caso contrário, FALSO.

CPaneFrameWnd::m_bUseSaveBits

Especifica se deve registar a classe janela que tem o estilo CS_SAVEBITS classe.

AFX_IMPORT_DATA static BOOL m_bUseSaveBits;

Observações

Defina este membro estático em TRUE para registar a classe janela mini-frame que tem o estilo CS_SAVEBITS. Isto pode ajudar a reduzir o cintilar quando um utilizador arrasta a janela do mini-frame.

CPaneFrameWnd::OnBeforeDock

Determina se o acoplamento é possível.

virtual BOOL OnBeforeDock();

Valor de retorno

TRUE se o acoplamento for possível; caso contrário, FALSO.

CPaneFrameWnd::OnCheckRollState

Determina se uma janela de mini-estrutura deve ser enrolada para cima ou para baixo.

virtual void OnCheckRollState();

Observações

Este método é chamado pela estrutura para determinar se uma janela mini-frame deve ser enrolada para cima ou para baixo.

Por defeito, o framework chama CPaneFrameWnd::IsRollUp e CPaneFrameWnd::IsRollDown e apenas estica ou restaura a janela do mini-frame. Pode sobrescrever este método numa classe derivada para usar um efeito visual diferente.

CPaneFrameWnd::OnDockToRecentPos

Acopla a janela em miniatura na sua posição mais recente.

virtual void OnDockToRecentPos();

CPaneFrameWnd::OnDrawBorder

Desenha as bordas de uma janela em miniatura.

virtual void OnDrawBorder(CDC* pDC);

Parâmetros

pDC
[dentro] O contexto do dispositivo usado para desenhar a fronteira.

Observações

Este método é chamado pela estrutura para desenhar as bordas da janela do mini-frame.

CPaneFrameWnd::OnKillRollUpTimer

Para o temporizador de rollup.

virtual void OnKillRollUpTimer();

CPaneFrameWnd::OnMovePane

Move a janela do mini-frame por um deslocamento especificado.

virtual void OnMovePane(
    CPane* pBar,
    CPoint ptOffset);

Parâmetros

pBar
[dentro] Um apontador para um painel (ignorado).

ptOffset
[dentro] O deslocamento para mover o painel.

CPaneFrameWnd::OnPaneRecalcLayout

Ajusta a disposição de um painel dentro de uma janela em mini-moldura.

virtual void OnPaneRecalcLayout();

Observações

A estrutura chama a este método quando tem de ajustar a disposição de um painel dentro da janela do mini-frame.

Por defeito, o painel está posicionado para cobrir toda a área do cliente da janela do mini-frame.

CPaneFrameWnd::OnSetRollUpTimer

Define o temporizador de rollup.

virtual void OnSetRollUpTimer();

CPaneFrameWnd::OnShowPane

Chamado pela estrutura quando um painel na janela do mini-frame está oculto ou exibido.

virtual void OnShowPane(
    CDockablePane* pBar,
    BOOL bShow);

Parâmetros

pBar
[dentro] O painel que está a ser mostrado ou escondido.

bShow
[dentro] TRUE se o painel estiver a ser mostrado; FALSE se o painel estiver a ser escondido.

Observações

Chamado pela estrutura quando um painel na janela do mini-frame é mostrado ou escondido. A implementação padrão não faz nada.

CPaneFrameWnd::P in

void Pin(BOOL bPin = TRUE);

Parâmetros

[dentro] bPin

Observações

CPaneFrameWnd::P aneFromPoint

Devolve um painel se este contiver um ponto fornecido pelo utilizador dentro de uma janela de mini-frame.

virtual CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    BOOL bCheckVisibility);

Parâmetros

ponto
[dentro] O ponto em que o utilizador clicava, nas coordenadas do ecrã.

nSensibilidade
[dentro] Este parâmetro não é utilizado.

bCheckVisibilidade
[dentro] TRUE para especificar que apenas os painéis visíveis devem ser devolvidos; caso contrário, FALSO.

Valor de retorno

O painel em que o utilizador clicou, ou NULL se não existir painel nesse local.

Observações

Chame este método para obter um painel que contenha o ponto indicado.

CPaneFrameWnd::RedrawAll

Redesenha todas as janelas em mini-estrutura.

static void RedrawAll();

Observações

Este método atualiza todas as mini-janelas de frames chamando CWnd::RedrawWindow para cada janela.

CPaneFrameWnd::RemoveNonValidPanes

Chamado pelo framework para remover painéis não válidos.

virtual void RemoveNonValidPanes();

CPaneFrameWnd::RemovePane

Remove um vidro da janela da mini-moldura.

virtual void RemovePane(
    CBasePane* pWnd,
    BOOL bDestroy = FALSE,
    BOOL bNoDelayedDestroy = FALSE);

Parâmetros

pWnd
[dentro] Um apontador para o painel para remover.

bDestruir
[dentro] Especifica o que acontece à janela de mini-moldura. Se o bDestroy for VERDADEIRO, este método destrói imediatamente a janela do mini-frame. Se for FALSO, este método destrói a janela do mini-frame após um certo atraso.

bNoDelayedDestroy
[dentro] Se TRUE, a destruição retardada está desativada. Se FALSE, a destruição retardada está ativada.

Observações

A estrutura pode destruir janelas de mini-frame imediatamente ou após um certo atraso. Se quiseres atrasar a destruição de janelas de mini-frame, passa FALSE no parâmetro bNoDelayedDestruct . A destruição tardia ocorre quando o framework processa a mensagem AFX_WM_CHECKEMPTYMINIFRAME.

CPaneFrameWnd::ReplacePane

Substitui um painel por outro.

virtual void ReplacePane(
    CBasePane* pBarOrg,
    CBasePane* pBarReplaceWith);

Parâmetros

pBarOrg
[dentro] Um apontador para o painel original.

pBarReplaceWith
[dentro] Um apontador para o painel que substitui o painel original.

CPaneFrameWnd::SaveState

Guarda o estado do painel no registo.

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

Parâmetros

lpszProfileName
[dentro] O nome do perfil.

uiID
[dentro] O ID do painel.

Valor de retorno

TRUE se o estado do painel foi salvo com sucesso; caso contrário, FALSO.

CPaneFrameWnd::BotõesSetCaptionButtons

Define botões de legenda.

virtual void SetCaptionButtons(DWORD dwButtons);

Parâmetros

dwButtons
[em] Bitwise-OR combinação dos seguintes valores:

• AFX_CAPTION_BTN_CLOSE

• AFX_CAPTION_BTN_PIN

• AFX_CAPTION_BTN_MENU

• AFX_CAPTION_BTN_CUSTOMIZE

CPaneFrameWnd::SetDelayShow

void SetDelayShow(BOOL bDelayShow);

Parâmetros

[dentro] bDelayShow

Observações

CPaneFrameWnd::SetDockingManager

void SetDockingManager(CDockingManager* pManager);

Parâmetros

[dentro] pManager

Observações

CPaneFrameWnd::SetTimeDockingTimer

Define o temporizador de acoplagem.

void SetDockingTimer(UINT nTimeOut);

Parâmetros

nTimeOut
[dentro] Valor de timeout em milissegundos.

CPaneFrameWnd::SetDockState

Define o estado de acoplagem.

virtual void SetDockState(CDockingManager* pDockManager);

Parâmetros

pDockManager
[dentro] Uma pista para um gestor de acoplamento.

CPaneFrameWnd::SetHotPoint

void SetHotPoint(CPoint& ptNew);

Parâmetros

[dentro] ptNew

Observações

CPaneFrameWnd::SetPreDockState

Chamado pelo framework para definir o estado de pré-acoplamento.

virtual BOOL SetPreDockState(
    AFX_PREDOCK_STATE preDockState,
    CBasePane* pBarToDock = NULL,
    AFX_DOCK_METHOD dockMethod = DM_MOUSE);

Parâmetros

Pré-DockState
[dentro] Valores possíveis:

• PDS_NOTHING,

• PDS_DOCK_REGULAR,

• PDS_DOCK_TO_TAB

pBarToDock
[dentro] Um apontador para o painel para acoplar.

dockMethod
[dentro] O método de acoplagem. (Este parâmetro é ignorado.)

Valor de retorno

TRUE se a janela do mini-frame estiver sem dock; FALSE se estiver acoplado.

CPaneFrameWnd::TamanhoToConteúdo

Ajusta o tamanho de uma janela de mini-moldura para que seja equivalente a um painel contido.

virtual void SizeToContent();

Observações

Chame este método para ajustar o tamanho de uma janela mini-frame ao tamanho de um painel contido.

CPaneFrameWnd::StartTearOff

Arranca um menu.

BOOL StartTearOff(CMFCPopu* pMenu);

Parâmetros

pMenu
[dentro] Um indicador para um menu.

Valor de retorno

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

CPaneFrameWnd::StoreRecentDockSiteInfo

virtual void StoreRecentDockSiteInfo(CPane* pBar);

Parâmetros

[dentro] pBar

Observações

CPaneFrameWnd::StoreRecentTabRelatedInfo

virtual void StoreRecentTabRelatedInfo(
    CDockablePane* pDockingBar,
    CDockablePane* pTabbedBar);

Parâmetros

[dentro] pDockingBar
[dentro] pTabbedBar

Observações

Consulte também

Gráfico de Hierarquia
Classes
CWnd Classe