Classe CDockingManager

Implementa a funcionalidade principal que controla o layout do docking numa janela de mainframe.

Sintaxe

class CDockingManager : public CObject

Membros

Métodos Públicos

Membros de Dados

Observações

A janela do quadro principal cria e inicializa esta classe automaticamente.

O objeto gestor de docking contém uma lista de todos os painéis que estão no layout de docking, bem como uma lista de todas as janelas CPaneFrameWnd que pertencem à janela principal do frame.

A CDockingManager classe implementa alguns serviços que podes usar para encontrar um painel ou uma CPaneFrameWnd janela. Normalmente não se chama estes serviços diretamente porque estão envolvidos no objeto da janela do quadro principal. Para mais informações, consulte Classe CPaneFrameWnd.

Dicas de Personalização

As seguintes dicas aplicam-se a CDockingManager objetos:

• A classe CDockingManager suporta estes modos de acoplamento:

  • AFX_DOCK_TYPE::DT_IMMEDIATE

  • AFX_DOCK_TYPE::DT_STANDARD

  • AFX_DOCK_TYPE::DT_SMART

  Estes modos de acoplamento são definidos por CDockingManager::m_dockModeGlobal e são definidos chamando CDockingManager::SetDockingMode.

• Se quiser criar um painel não flutuante e não redimensionável, ligue ao método CDockingManager::AddPane . Este método regista o painel junto do gestor de docking, que é responsável pela disposição do painel.

Example

O exemplo seguinte demonstra como usar vários métodos na CDockingManager classe para configurar um CDockingManager objeto. O exemplo mostra como mostrar um botão adicional que abre um menu pop-up nas legendas de todos os painéis de acoplamento e como definir o modo de acoplamento do objeto. Este excerto de código faz parte do exemplo de demonstração do Visual Studio.

CDockingManager *pDockManager = GetDockingManager();
ASSERT_VALID(pDockManager);
pDockManager->AdjustPaneFrames();
pDockManager->EnableDockSiteMenu();
pDockManager->SetDockingMode(DT_STANDARD);

Hierarquia de herança

CObject

CDockingManager

Requerimentos

Cabeçalho: afxDockingManager.h

CDockingManager::AddDockSite

Cria um painel de dock e adiciona-o à lista de barras de controlo.

BOOL AddDockSite(
    const AFX_DOCKSITE_INFO& info,
    CDockSite** ppDockBar = NULL);

Parâmetros

informação
[dentro] Uma referência a uma estrutura de informação que contém alinhamento do painel de dock.

ppDockBar
[fora] Um apontador para um apontador para o novo painel da doca.

Valor de retorno

VERDADE se o painel da doca foi criado com sucesso; FALSO, caso contrário.

CDockingManager::AddHiddenMDITabbedBar

Adiciona uma maçaneta a um painel de barra à lista de vidros ocultos com separadores MDI.

void AddHiddenMDITabbedBar(CDockablePane* pBar);

Parâmetros

pBar
[dentro] Um apontador para um vidro de barra

CDockingManager::AddPane

Regista um painel junto do gestor de docking.

BOOL AddPane(
    CBasePane* pWnd,
    BOOL bTail = TRUE,
    BOOL bAutoHide = FALSE,
    BOOL bInsertForOuterEdge = FALSE);

Parâmetros

pWnd
[inspira, expira] Especifica o painel a adicionar ao gestor de docking.

bCauda
[dentro] TRUE para adicionar o painel ao final da lista de painéis para o gestor de acoplamento; caso contrário, FALSO.

bAutoHide
[dentro] Apenas para uso interno. Usa sempre o valor predefinido FALSE.

bInsertForOuterEdge
[dentro] Apenas para uso interno. Usa sempre o valor predefinido FALSE.

Valor de retorno

TRUE se o painel foi registado com sucesso junto do gestor de acoplamento; caso contrário, FALSO.

Observações

Chame este método para registar painéis não flutuantes e não redimensionáveis junto do gestor de acoplamento. Se não registares os painéis, eles não aparecerão corretamente quando o gestor de acoplamento estiver disponível.

CDockingManager::AdjustDockingLayout

Recalcula e ajusta a disposição de todos os vidros numa janela de moldura.

virtual void AdjustDockingLayout(HDWP hdwp = NULL);

Parâmetros

HDWP
[dentro] Especifica a estrutura de posição da janela diferida. Para mais informações, consulte Tipos de Dados do Windows.

Observações

CDockingManager::AddMiniFrame

Adiciona um frame à lista de mini frames.

virtual BOOL AddMiniFrame(CPaneFrameWnd* pWnd);

Parâmetros

pWnd
[dentro] Um apontador para uma moldura.

Valor de retorno

TRUE se o frame não estiver na lista de mini frames e tiver sido adicionado com sucesso; FALSO, caso contrário.

CDockingManager::AdjustPaneFrames

Faz com que a mensagem WM_NCCALCSIZE seja enviada para todos os vidros e CPaneFrameWnd janelas.

virtual void AdjustPaneFrames();

Observações

CDockingManager::AdjustRectToClientArea

Ajusta o alinhamento de um retângulo.

virtual BOOL AdjustRectToClientArea(
    CRect& rectResult,
    DWORD dwAlignment);

Parâmetros

rectResult
[dentro] Uma referência a um CRect objeto

dwAlignment
[dentro] O alinhamento do CRect objeto

Valor de retorno

TRUE se o alinhamento do CRect objeto foi ajustado; FALSO, caso contrário.

Observações

O parâmetro dwAlignment pode ter um dos seguintes valores:

• CBRS_ALIGN_TOP

• CBRS_ALIGN_BOTTOM

• CBRS_ALIGN_LEFT

• CBRS_ALIGN_RIGHT

CDockingManager::AlignAutoHidePane

Redimensiona um painel de acoplamento em modo de ocultação automática para que ocupe toda a largura ou altura da área cliente do quadro rodeada por locais de acoplamento.

void AlignAutoHidePane(
    CPaneDivider* pDefaultSlider,
    BOOL bIsVisible = TRUE);

Parâmetros

pDefaultSlider
[dentro] O painel deslizante de acoplagem.

bIsVisible
[dentro] TRUE se o painel de acoplamento for visível; FALSO, caso contrário.

CDockingManager::AutoHidePane

Cria uma barra de ferramentas de ocultação automática.

CMFCAutoHideToolBar* AutoHidePane(
    CDockablePane* pBar,
    CMFCAutoHideToolBar* pCurrAutoHideToolBar = NULL);

Parâmetros

pBar
[dentro] Um apontador para o vidro do bar.

pCurrAutoHideToolBar
[dentro] Um apontador para uma barra de ferramentas de ocultação automática.

Valor de retorno

NULL se a barra de ferramentas de ocultação automática não tivesse sido criada; caso contrário, um apontador para a nova barra de ferramentas.

CDockingManager::BringBarsToTop

Traz as barras acopladas que têm o alinhamento especificado para o topo.

void BringBarsToTop(
    DWORD dwAlignment = 0,
    BOOL bExcludeDockedBars = TRUE);

Parâmetros

dwAlignment
[dentro] O alinhamento das barras do cais que são trazidas para o topo de outras janelas.

bExcludeDockedBars
[dentro] TRUE para excluir as barras acopladas de ficarem no topo; caso contrário, FALSO.

CDockingManager::BuildPanesMenu

Adiciona nomes de painéis de acoplamento e barras de ferramentas a um menu.

void BuildPanesMenu(
    CMenu& menu,
    BOOL bToolbarsOnly);

Parâmetros

Menu
[dentro] Um menu para adicionar os nomes dos painéis de acoplamento e das barras de ferramentas.

bToolbarsOnly
[dentro] TRUE para adicionar apenas nomes das barras de ferramentas ao menu; FALSO, caso contrário.

CDockingManager::CalcExpectedDockedRect

Calcula o retângulo esperado de uma janela acoplada.

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

Parâmetros

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

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

rectResult
[fora] O retângulo calculado.

bDrawTab
[dentro] TRUE para desenhar uma tabulação; caso contrário, FALSO.

ppTargetBar
[fora] Um apontador para 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í.

CDockingManager::Create

Cria um gestor de acoplamento.

BOOL Create(CFrameWnd* pParentWnd);

Parâmetros

pParentWnd
[dentro] Um apontador para a estrutura principal do gestor de acoplamento. Este valor não pode ser NULL.

Valor de retorno

VERDADE sempre.

CDockingManager::D eterminePaneAndStatus

Determina o painel que contém um dado ponto e o seu estado de acoplagem.

virtual AFX_CS_STATUS DeterminePaneAndStatus(
    CPoint pt,
    int nSensitivity,
    DWORD dwEnabledAlignment,
    CBasePane** ppTargetBar,
    const CBasePane* pBarToIgnore,
    const CBasePane* pBarToDock);

Parâmetros

pt
[dentro] A localização do vidro para verificar.

nSensibilidade
[dentro] O valor para aumentar o retângulo da janela de cada vidro quadrado. Um painel satisfaz os critérios de pesquisa se o ponto dado estiver nesta região aumentada.

dwEnabledAlignment
[dentro] O alinhamento do painel de acoplamento.

ppTargetBar
[fora] Um apontador para um apontador para o painel alvo.

pBarToIgnore
[dentro] O painel que o método ignora.

pBarToDock
[dentro] O vidro que está acoplado.

Valor de retorno

O estado do acoplamento.

Observações

O estado de acoplamento pode ser um dos seguintes valores:

CDockingManager::D isableRestoreDockState

Ativa ou desativa o carregamento do layout de docking a partir do registo.

void DisableRestoreDockState(BOOL bDisable = TRUE);

Parâmetros

bDisable
[dentro] TRUE para desativar o carregamento do layout de docking a partir do registo; caso contrário, FALSO.

Observações

Chame este método quando tiver de preservar o layout atual dos painéis de docking e das barras de ferramentas quando o estado da aplicação estiver a carregar.

CDockingManager::D ockPane

Acopla um vidro a outro vidro ou a uma janela de moldura.

void DockPane(
    CBasePane* pBar,
    UINT nDockBarID = 0,
    LPCRECT lpRect = NULL);

Parâmetros

pBar
[dentro] Um indicador para um painel de barra para acoplar.

nDockBarID
[dentro] O ID do bar para atracar.

lpRect
[dentro] O retângulo de destino.

CDockingManager::D ockPaneLeftOf

Atraca um vidro à esquerda de outro vidro.

BOOL DockPaneLeftOf(
    CPane* pBarToDock,
    CPane* pTargetBar);

Parâmetros

pBarToDock
[dentro] Um apontador para o painel a ser acoplado à esquerda do pTargetBar.

pTargetBar
[dentro] Um apontador para o painel alvo.

Valor de retorno

VERDADE se o vidro foi acoplado com sucesso; caso contrário, FALSO.

CDockingManager::EnableAutoHidePanes

Permite o acoplamento do painel ao quadro principal, cria um painel de dock e adiciona-o à lista de barras de controlo.

BOOL EnableAutoHidePanes(DWORD dwStyle);

Parâmetros

dwStyle
[dentro] O alinhamento de acoplagem.

Valor de retorno

VERDADE se o painel da doca foi criado com sucesso; FALSO, caso contrário.

CDockingManager::EnableDocking

Cria um painel de dock e permite o acoplamento do painel ao frame principal.

BOOL EnableDocking(DWORD dwStyle);

Parâmetros

dwStyle
[dentro] O alinhamento de acoplagem.

Valor de retorno

VERDADE se o painel da doca foi criado com sucesso; FALSO, caso contrário.

CDockingManager::EnableDockSiteMenu

Mostra um botão adicional que abre um menu pop-up nas legendas de todos os painéis de acoplamento.

static void EnableDockSiteMenu(BOOL bEnable = TRUE);

Parâmetros

bEnable
[dentro] TRUE para ativar o menu do local da doca; caso contrário, FALSO.

Observações

O menu do local da doca apresenta as seguintes opções para alterar o estado de acoplamento do painel:

• Floating - Flutua um vidro

• Docking - Acopla um painel no quadro principal no local onde o painel foi acoplado pela última vez

• AutoHide - Muda o painel para modo de ocultação automática

• Hide - Esconde um vidro

Por defeito, este menu não é exibido.

CDockingManager::EnablePaneContextMenu

Diz à biblioteca para exibir um menu de contexto especial com uma lista de barras de ferramentas de aplicação e painéis de acoplamento quando o utilizador clica no botão direito do rato e a biblioteca está a processar a mensagem WM_CONTEXTMENU.

void EnablePaneContextMenu(
    BOOL bEnable,
    UINT uiCustomizeCmd,
    const CString& strCustomizeText,
    BOOL bToolbarsOnly = FALSE);

Parâmetros

bEnable
[dentro] Se TRUE, a biblioteca ativa o suporte para menu de contexto automático; se for FALSE, a biblioteca desativa o suporte para menu contextual automático.

uiCustomizeCmd
[dentro] Um id de comando para o item Personalizar no menu.

strCustomizeText
[dentro] O texto do item Personalizar .

bToolbarsOnly
[dentro] Se TRUE, o menu mostra apenas uma lista de barras de ferramentas de aplicação; se FALSE, a biblioteca adiciona painéis de acoplamento de aplicações a esta lista.

CDockingManager::FindDockSite

Recupera o painel de barras que está na posição especificada e que tem o alinhamento especificado.

virtual CDockSite* FindDockSite(
    DWORD dwAlignment,
    BOOL bOuter);

Parâmetros

dwAlignment
[dentro] O alinhamento do vidro da barra.

bOuter
[dentro] Se TRUE, recupere a barra na posição da cabeça na lista de barras de controlo. Caso contrário, recupere a barra na posição de cauda na lista de barras de controlo.

Valor de retorno

O painel de acoplamento que tem o alinhamento especificado; NULL caso contrário.

CDockingManager::FindPaneByID

Encontra um painel junto ao ID de controlo especificado.

virtual CBasePane* FindPaneByID(
    UINT uBarID,
    BOOL bSearchMiniFrames = FALSE);

Parâmetros

uBarID
[dentro] Especifica o ID de controlo do painel a encontrar.

bSearchMiniFrames
[dentro] TRUE para incluir todos os painéis flutuantes na pesquisa. FALSE para incluir apenas os painéis acoplados.

Valor de retorno

O objeto CBasePane que tem o ID de controlo especificado, ou NULL se o painel especificado não for encontrado.

Observações

CDockingManager::FindDockSiteByPane

Devolve o painel da barra que tem o id do painel da barra alvo.

virtual CDockSite* FindDockSiteByPane(CPane* pTargetBar);

Parâmetros

pTargetBar
[dentro] Um apontador para o painel da barra do alvo.

Valor de retorno

O painel de barra que tem o id do painel de barra alvo; NULL se tal painel de barra não existir.

CDockingManager::FixupVirtualRects

Faz commit de todas as posições atuais da barra de ferramentas em retângulos virtuais.

virtual void FixupVirtualRects();

Observações

Quando o utilizador começa a arrastar uma barra de ferramentas, a aplicação lembra-se da sua posição original no retângulo virtual. Quando o utilizador move uma barra de ferramentas pelo seu local de dock, esta pode deslocar outras barras de ferramentas. As posições originais das outras barras de ferramentas são armazenadas nos retângulos virtuais correspondentes.

CDockingManager::FrameFromPoint

Devolve o referencial que contém o ponto dado.

virtual CPaneFrameWnd* FrameFromPoint(
    CPoint pt,
    CPaneFrameWnd* pFrameToExclude,
    BOOL bFloatMultiOnly) const;

Parâmetros

pt
[dentro] Especifica o ponto, em coordenadas do ecrã, a verificar.

pFrameToExclude
[dentro] Um apontador para um frame para excluir.

bFloatMultiOnly
[dentro] TRUE para excluir frames que não são instâncias de CMultiPaneFrameWnd; FALSO, caso contrário.

Valor de retorno

O referencial que contém o ponto dado; NULL caso contrário.

CDockingManager::GetClientAreaBounds

Obtém o retângulo que contém os limites da área do cliente.

CRect GetClientAreaBounds() const;

void GetClientAreaBounds(CRect& rcClient);

Parâmetros

rcClient
[fora] Uma referência ao retângulo que contém os limites da área do cliente.

Valor de retorno

O retângulo que contém os limites da área do cliente.

CDockingManager::GetDockingMode

Devolve o modo de acoplamento atual.

static AFX_DOCK_TYPE GetDockingMode();

Valor de retorno

Um valor de enumerador que representa o modo de acoplamento atual. Pode ser um dos seguintes valores:

• DT_STANDARD

• DT_IMMEDIATE

• DT_SMART

Observações

Para definir o modo de acoplamento, ligue para CDockingManager::SetDockingMode.

CDockingManager::GetDockSiteFrameWnd

Recebe um apontador para a moldura da janela principal.

CFrameWnd* GetDockSiteFrameWnd() const;

Valor de retorno

Um apontador para a moldura da janela principal.

CDockingManager::GetEnabledAutoHideAlignment

Devolve o alinhamento permitido dos painéis.

DWORD GetEnabledAutoHideAlignment() const;

Valor de retorno

Uma combinação bit a bit de CBRS_ALIGN_ flags, ou 0 se os painéis de autoocultação não estiverem ativados. Para mais informações, veja CFrameWnd::EnableDocking.

Observações

O método devolve o alinhamento ativado para as barras de controlo autoocultadas. Para ativar barras de ocultação automática, ligue para CFrameWndEx::EnableAutoHidePanes.

CDockingManager::GetMiniFrames

Recebe uma lista de miniframes.

const CObList& GetMiniFrames() const;

Valor de retorno

Uma lista de miniframes que contêm as barras de controlo pertencentes ao gestor de docking.

CDockingManager::GetOuterEdgeBounds

Obtém um retângulo que contém as bordas exteriores da moldura.

CRect GetOuterEdgeBounds() const;

Valor de retorno

Um retângulo que contém as bordas exteriores da moldura.

CDockingManager::GetPaneList

Devolve uma lista de painéis que pertencem ao gestor de docking. Isto inclui todos os painéis flutuantes.

void GetPaneList(
    CObList& lstBars,
    BOOL bIncludeAutohide = FALSE,
    CRuntimeClass* pRTCFilter = NULL,
    BOOL bIncludeTabs = FALSE);

Parâmetros

lstBars
[inspira, expira] Contém todos os painéis do gestor de docking atual.

bIncludeAutohide
[dentro] TRUE para incluir os painéis que estão em modo de autoocultação; caso contrário, FALSO.

pRTCFilter
[dentro] Se não for NULL, a lista devolvida contém apenas painéis da classe de execução especificada.

bIncludeTabs
[dentro] TRUE incluir tabs; caso contrário, FALSO.

Observações

Se existirem painéis separados no gestor de docking, o método devolve apontadores para os objetos da Classe CBaseTabbedPane e deve enumerar explicitamente os separadores.

Use pRTCFilter para obter uma classe particular de painéis. Por exemplo, só pode obter barras de ferramentas definindo este valor de forma adequada.

CDockingManager::GetSmartDockingManager

Recupera um ponteiro para o gestor de acoplamento inteligente.

CSmartDockingManager* GetSmartDockingManager();

Valor de retorno

Um apontador para o gestor de acoplamento inteligente.

CDockingManager::GetSmartDockingManagerPermanent

Recupera um ponteiro para o gestor de acoplamento inteligente.

CSmartDockingManager* GetSmartDockingManagerPermanent() const;

Valor de retorno

Um apontador para o gestor de acoplamento inteligente.

CDockingManager::GetSmartDockingParams

Devolve os parâmetros de acoplamento inteligente para o gestor de acoplamento.

static CSmartDockingInfo& GetSmartDockingParams();

Valor de retorno

A classe que contém os parâmetros de acoplamento inteligente para o gestor de acoplamento atual. Para mais informações, consulte CSmartDockingInfo Class.

Observações

CDockingManager::HideAutoHidePanes

Esconde um painel que está em modo de ocultação automática.

void HideAutoHidePanes(
    CDockablePane* pBarToExclude = NULL,
    BOOL bImmediately = FALSE);

Parâmetros

pBarToExclude
[dentro] Um indicador para uma barra para excluir de esconder.

bImediatamente
[dentro] VERDADE para esconder o vidro imediatamente; FALSE para esconder o vidro com o efeito de auto-esconder.

CDockingManager::InsertDockSite

Cria um painel de dock e insere-o na lista de barras de controlo.

BOOL InsertDockSite(
    const AFX_DOCKSITE_INFO& info,
    DWORD dwAlignToInsertAfter,
    CDockSite** ppDockBar = NULL);

Parâmetros

informação
[dentro] Uma estrutura que contém a informação de alinhamento sobre o painel da doca.

dwAlignToInsertAfter
[dentro] Alinhamento do painel da doca.

ppDockBar
[fora] Um apontador para um ponteiro para um painel da doca.

Valor de retorno

VERDADE se o painel da doca foi criado com sucesso; FALSO, caso contrário.

CDockingManager::InsertPane

Insere um painel de controlo na lista de barras de controlo.

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

Parâmetros

pControlBar
[dentro] Um apontador para um painel de controlo.

pTarget
[dentro] Um apontador para um painel de alvo.

bDepois
[dentro] TRUE para inserir o painel após a posição do painel alvo; FALSO, caso contrário.

Valor de retorno

TRUE se o painel de controlo for adicionado com sucesso à lista de barras de controlo; FALSO, caso contrário.

Observações

Este método retorna false se o painel de controlo já estiver na lista de barras de controlo ou se o painel alvo não existir na lista de barras de controlo.

CDockingManager::IsDockSiteMenu

Especifica se um menu pop-up é exibido nas legendas de todos os painéis.

static BOOL IsDockSiteMenu();

Valor de retorno

TRUE se um menu de local de doca for exibido nas legendas de todos os painéis de acoplamento; caso contrário, FALSO.

Observações

Pode ativar o menu do local da dock ligando para CDockingManager::EnableDockSiteMenu.

CDockingManager::IsInAdadjust Layout

Determina se as disposições de todos os painéis são ajustadas.

BOOL IsInAdjustLayout() const;

Valor de retorno

TRUE se os layouts de todos os painéis forem ajustados; FALSO, caso contrário.

CDockingManager::IsOLEContainerMode

Especifica se o gestor de docking está em modo contentor OLE.

BOOL IsOLEContainerMode() const;

Valor de retorno

TRUE se o gestor de acoplamento estiver em modo contentor OLE; caso contrário, FALSO.

Observações

No modo contentor OLE, todos os painéis de acoplamento e as barras de ferramentas das aplicações estão ocultos. Os painéis também estão ocultos neste modo se tiver definido o CDockingManager::m_bHideDockingBarsInContainerMode para TRUE.

CDockingManager::IsPointNearDockSite

Determina se um ponto especificado está próximo do local do cais.

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

Parâmetros

ponto
[dentro] O ponto especificado.

dwBarAlignment
[fora] Especifica a que aresta 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
[fora] VERDADEIRO se o ponto estiver perto da fronteira exterior do local do cais; FALSO, caso contrário.

Valor de retorno

VERDADE se o ponto estiver perto do local do cais; caso contrário, FALSO.

CDockingManager::IsPrintPreviewValid

Determina se o modo de pré-visualização de impressão está definido.

BOOL IsPrintPreviewValid() const;

Valor de retorno

TRUE se o modo de pré-visualização de impressão estiver definido; FALSO, caso contrário.

CDockingManager::LoadState

Carrega o estado do gestor de docking a partir do registo.

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

Parâmetros

lpszProfileName
[dentro] Nome de perfil.

uiID
[dentro] O ID do gestor de atracação.

Valor de retorno

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

CDockingManager::LockUpdate

Tranca a janela dada.

void LockUpdate(BOOL bLock);

Parâmetros

bLock
[dentro] TRUE se a janela estiver trancada; FALSO, caso contrário.

Observações

Quando uma janela está trancada, não pode ser movida nem redesenhada.

CDockingManager::m_bHideDockingBarsInContainerMode

Especifica se o gestor de docking esconde painéis no modo contentor OLE.

AFX_IMPORT_DATA static BOOL m_bHideDockingBarsInContainerMode;

Observações

Defina este valor para FALSE se quiser manter todos os painéis acoplados ao quadro principal visíveis quando a aplicação estiver em modo contentor OLE. Por defeito, este valor é VERDADEIRO.

CDockingManager::m_dockModeGlobal

Especifica o modo de acoplamento global.

AFX_IMPORT_DATA static AFX_DOCK_TYPE m_dockModeGlobal;

Observações

Por defeito, cada painel de acoplamento usa este modo de acoplamento. Para mais informações sobre os valores a que este campo pode ser definido, veja CBasePane::GetDockingMode.

CDockingManager::m_nDockSensitivity

Especifica a sensibilidade de acoplamento.

AFX_IMPORT_DATA static int m_nDockSensitivity;

Observações

A sensibilidade ao acoplamento define quão perto um painel flutuante pode aproximar-se de um painel de acoplagem, local de acoplagem ou outro painel antes de o framework mudar o seu estado para acoplado.

CDockingManager::m_nTimeOutBeforeDockingBarDock

Especifica o tempo, em milissegundos, antes de um painel de acoplamento estar acoplado em modo imediato.

static UINT m_nTimeOutBeforeDockingBarDock;

Observações

Antes de um painel ser acoplado, a estrutura espera o tempo especificado. Isto evita que o painel seja acidentalmente acoplado a um local enquanto o utilizador ainda o está a arrastar.

CDockingManager::m_nTimeOutBeforeToolBarDock

Especifica o tempo, em milissegundos, antes de uma barra de ferramentas ser acoplada à janela principal do frame.

static UINT m_nTimeOutBeforeToolBarDock;

Observações

Antes de uma barra de ferramentas ser acoplada, o framework espera o tempo especificado. Isto impede que a barra de ferramentas seja acidentalmente acoplada a um local enquanto o utilizador ainda a está a arrastar.

CDockingManager::OnActivateFrame

Chamada pela estrutura quando a janela de frames é ativada ou desativada.

virtual void OnActivateFrame(BOOL bActivate);

Parâmetros

bAtivar
[dentro] Se TRUE, a janela de frame é ativada; se for FALSE, a janela do frame é desativada.

CDockingManager::OnClosePopupMenu

É chamado pelo framework quando um menu pop-up ativo processa uma mensagem WM_DESTROY.

void OnClosePopupMenu();

Observações

O framework envia uma mensagem WM_DESTROY quando está prestes a fechar a janela principal atual. Substitua este método para gerir notificações de CMFCPopupMenu objetos que pertencem à janela de frames quando um CMFCPopupMenu objeto processa uma mensagem WM_DESTROY.

CDockingManager::OnMoveMiniFrame

Chamado pela framework para mover uma janela de mini-frame.

virtual BOOL OnMoveMiniFrame(CWnd* pFrame);

Parâmetros

pFrame
[dentro] Um apontador para uma janela em miniatura.

Valor de retorno

TRUE se o método tiver sucesso; caso contrário, FALSO.

CDockingManager::OnPaneContextMenu

É chamado pelo framework quando este constrói um menu com uma lista de painéis.

void OnPaneContextMenu(CPoint point);

Parâmetros

ponto
[dentro] Especifica a localização do menu.

CDockingManager::P aneFromPoint

Devolve o painel que contém o ponto indicado.

virtual CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    bool bExactBar = false,
    CRuntimeClass* pRTCBarType = NULL,
    BOOL bCheckVisibility = FALSE,
    const CBasePane* pBarToIgnore = NULL) const;

virtual CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    DWORD& dwAlignment,
    CRuntimeClass* pRTCBarType = NULL,
    const CBasePane* pBarToIgnore = NULL) const;

Parâmetros

ponto
[dentro] Especifica o ponto, em coordenadas do ecrã, a verificar.

nSensibilidade
[dentro] O valor para inflar o retângulo da janela de cada vidro quadrilhado. Um painel satisfaz os critérios de pesquisa se o ponto dado estiver nesta região inflacionada.

bExactBar
[dentro] TRUE ignorar o parâmetro nSensibilidade ; caso contrário, FALSO.

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

bCheckVisibilidade
[dentro] TRUE para verificar apenas os vidros visíveis; caso contrário, FALSO.

dwAlignment
[fora] Se um painel for encontrado no ponto especificado, este parâmetro contém o lado do painel que estava mais próximo do ponto especificado. Para obter mais informações, consulte a seção Observações.

pBarToIgnore
[dentro] Se não for NULL, o método ignora os painéis especificados por este parâmetro.

Valor de retorno

O objeto derivado do CBasePane que contém o ponto dado, ou NULL se não foi encontrado nenhum painel.

Observações

Quando a função retorna e é encontrado um painel, dwAlignment contém o alinhamento do ponto especificado. Por exemplo, se o ponto estivesse mais próximo do topo do painel, o dwAlignment é definido para CBRS_ALIGN_TOP.

CDockingManager::P rocessPaneContextMenuCommandCommand

Chamado pelo framework para selecionar ou limpar uma caixa de seleção para o comando especificado e recalcular a disposição de um painel mostrado.

BOOL ProcessPaneContextMenuCommand(
    UINT nID,
    int nCode,
    void* pExtra,
    AFX_CMDHANDLERINFO* pHandlerInfo);

Parâmetros

nID
[dentro] O ID de uma barra de controlo no menu.

nCode
[dentro] O código de notificação de comando.

pExtra
[dentro] Um apontador para void que é lançado para um ponteiro para CCmdUI se nCode for CN_UPDATE_COMMAND_UI.

pHandlerInfo
[dentro] Um apontador para uma estrutura de informação. Este parâmetro não é utilizado.

Valor de retorno

TRUE se pEXtra não for NULL e nCode for igual a CN_UPDATE_COMMAND_UI, ou se houver uma barra de controlo com o nID especificado.

CDockingManager::RecalcLayout

Recalcula a disposição interna dos controlos presentes na lista de controlos.

virtual void RecalcLayout(BOOL bNotify = TRUE);

Parâmetros

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

CDockingManager::ReleaseEmptyPaneContainers

Liberta os recipientes vazios do vidro.

void ReleaseEmptyPaneContainers();

CDockingManager::RemoveHiddenMDITabbedBar

Remove o painel de barras oculto especificado.

void RemoveHiddenMDITabbedBar(CDockablePane* pBar);

Parâmetros

pBar
[dentro] Um apontador para um vidro de barra para remover.

CDockingManager::RemoveMiniFrame

Remove um frame especificado da lista de mini frames.

virtual BOOL RemoveMiniFrame(CPaneFrameWnd* pWnd);

Parâmetros

pWnd
[dentro] Um apontador para uma moldura para remover.

Valor de retorno

TRUE se o quadro especificado for removido; FALSO, caso contrário.

CDockingManager::RemovePaneFromDockManager

Desregista um painel e remove-o da lista no gestor de docking.

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

Parâmetros

pWnd
[dentro] Um apontador para um painel a ser removido.

bDestruir
[dentro] Se TRUE, o painel removido é destruído.

bAdajustLayout
[dentro] Se for VERDADE, ajusta imediatamente o layout do docking.

bAutoHide
[dentro] Se TRUE, o painel é removido da lista de barras de autoocultação. Se FALSE, o painel é removido da lista de painéis normais.

Substituição do pBar
[dentro] Um apontador para um painel que substitui o painel removido.

CDockingManager::ReplacePane

Substitui um painel por outro.

BOOL ReplacePane(
    CDockablePane* pOriginalBar,
    CDockablePane* pNewBar);

Parâmetros

pOriginalBar
[dentro] Um apontador para o painel original.

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

Valor de retorno

TRUE se o vidro for substituído com sucesso; FALSO, caso contrário.

CDockingManager::ResortMiniFramesForZOrder

Classifica os quadros na lista de mini quadros.

void ResortMiniFramesForZOrder();

CDockingManager::SaveState

Guarda o estado do gestor de docking no registo.

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

Parâmetros

lpszProfileName
[dentro] Um caminho para uma chave de registo.

uiID
[dentro] O ID do gestor de atracação.

Valor de retorno

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

Observações

Guardar o estado do gestor de acoplamento no registo envolve guardar os estados das barras de controlo, os estados das barras de autoocultação e os estados dos mini frames presentes no gestor de acoplamento.

CDockingManager::EnviarMensagemParaMiniFrames

Envia a mensagem especificada para todos os mini frames.

BOOL SendMessageToMiniFrames(
    UINT uMessage,
    WPARAM wParam = 0,
    LPARAM lParam = 0);

Parâmetros

uMessage
[dentro] A mensagem a enviar.

wParam
[dentro] Informação adicional dependente da mensagem.

lParam
[dentro] Informação adicional dependente da mensagem.

Valor de retorno

VERDADE sempre.

CDockingManager::Serializar

Escreve o gestor de docking num arquivo.

void Serialize(CArchive& ar);

Parâmetros

ar
[dentro] Uma referência a um objeto de arquivo.

Observações

Escrever o gestor de acoplamento num arquivo envolve determinar o número de barras de controlo e sliders de acoplamento, e escrever as barras de controlo, os mini frames, as barras de autoocultação e as barras de separação MDI no arquivo.

CDockingManager::SetAutohideZOrder

Define o tamanho, largura e altura das barras de controlo e do painel especificado.

void SetAutohideZOrder(CDockablePane* pAHDockingBar);

Parâmetros

pAHDockingBar
[dentro] Um apontador para um painel acoplável.

CDockingManager::SetDockingMode

Define o modo de acoplamento.

static void SetDockingMode(
    AFX_DOCK_TYPE dockMode,
    AFX_SMARTDOCK_THEME theme = AFX_SDT_DEFAULT);

Parâmetros

dockMode
Especifica o novo modo de acoplamento. Para obter mais informações, consulte a seção Observações.

Tema
Especifica o tema a ser usado para marcadores de acoplamento inteligente. Pode ser um dos seguintes valores enumerados: AFX_SDT_DEFAULT, AFX_SDT_VS2005, AFX_SDT_VS2008.

Observações

Chama este método estático para definir o modo de acoplamento.

O dockMode pode ter um dos seguintes valores:

• DT_STANDARD - Modo de acoplamento padrão, conforme implementado no Visual Studio .NET 2003. Os quadros são arrastados sem contexto de arrastamento.

• DT_IMMEDIATE - Modo de acoplamento imediato conforme implementado no Microsoft Visio. Os painéis são arrastados com um contexto de arrasto, mas não são exibidos marcadores.

• DT_SMART - Modo de acoplamento inteligente implementado no Visual Studio 2005. Os painéis são arrastados com um contexto de arrasto e são exibidos marcadores inteligentes que indicam onde o painel pode ser acoplado.

CDockingManager::SetDockState

Define o estado de acoplamento das barras de controlo, dos mini frames e das barras de autoocultação.

virtual void SetDockState();

CDockingManager::SetPrintPreviewMode

Define o modo de pré-visualização de impressão das barras que são exibidas na pré-visualização de impressão.

void SetPrintPreviewMode(
    BOOL bPreview,
    CPrintPreviewState* pState);

Parâmetros

bPré-visualização
[dentro] TRUE se o modo de pré-visualização de impressão estiver definido; FALSO, caso contrário.

pState
[dentro] Um apontador para um estado de pré-visualização. Este parâmetro não é utilizado.

CDockingManager::SetSmartDockingParams

Define os parâmetros que definem o comportamento do acoplamento inteligente.

static void SetSmartDockingParams(CSmartDockingInfo& params);

Parâmetros

params
[inspira, expira] Define os parâmetros para o acoplamento inteligente.

Observações

Chame a este método se quiser personalizar a aparência, cor ou forma dos marcadores de acoplamento inteligente.

Para usar a procura padrão dos marcadores de acoplamento inteligente, passa uma instância não inicializada da CSmartDockingInfo Class para parámetros.

CDockingManager::MostrarAtrasarMostrarMiniFrames

Mostra ou esconde as janelas das mini molduras.

void ShowDelayShowMiniFrames(BOOL bshow);

Parâmetros

bShow
[dentro] TRUE para ativar a janela do frame mostrado; FALSE para esconder a janela da moldura.

CDockingManager::ShowPanes

Mostra ou esconde os vidros das barras de controlo e auto-ocultação.

virtual BOOL ShowPanes(BOOL bShow);

Parâmetros

bShow
[dentro] FIEL para mostrar os vidros; FALSE para esconder os vidros.

Valor de retorno

Sempre FALSO.

CDockingManager::StartSDocking

Inicia o acoplamento inteligente da janela especificada de acordo com o alinhamento do gestor de acoplamento inteligente.

void StartSDocking(CWnd* pDockingWnd);

Parâmetros

pDockingWnd
[dentro] Um apontador para uma janela para acoplar.

CDockingManager::StopSDocking

Impede o acoplamento inteligente.

void StopSDocking();

CDockingManager::GetSmartDockingTheme

Um método estático que devolve um tema usado para mostrar marcadores de acoplamento inteligente.

static AFX_SMARTDOCK_THEME __stdcall GetSmartDockingTheme();

Valor de retorno

Devolve um dos seguintes valores enumerados: AFX_SDT_DEFAULT, AFX_SDT_VS2005, AFX_SDT_VS2008.

Observações

Consulte também

Gráfico de Hierarquia
Classes
CObject Classe
Classe CFrameWndEx
CDockablePane Classe
Classe CPaneFrameWnd