Classe CBaseTabbedPane

Estende a funcionalidade da Classe CDockablePane para dar suporte à criação de janelas com guias.

Sintaxe

class CBaseTabbedPane : public CDockablePane

Membros

Construtores públicos

Métodos públicos

Comentários

Essa é uma classe abstrata e não pode ter uma instância criada. Ele implementa os serviços comuns a todos os tipos de painéis com guias.

Atualmente, a biblioteca inclui duas classes de painel com guias: classe CTabbedPane e classe CMFCOutlookBar.

Um objeto CBaseTabbedPane encapsula um ponteiro para um objeto CMFCBaseTabCtrl Class. A classe CMFCBaseTabCtrl torna-se uma janela filho do painel com guias.

Para obter mais informações sobre como criar painéis com guias, consulte Classe CDockablePane, Classe CTabbedPane e Classe CMFCOutlookBar.

Hierarquia de herança

CObject

CCmdTarget

CWnd

CBasePane

CPane

CDockablePane

CBaseTabbedPane

Requisitos

Cabeçalho: afxBaseTabbedPane.h

CBaseTabbedPane::AddTab

Adiciona uma nova guia a um painel com guias.

virtual BOOL AddTab(
    CWnd* pNewBar,
    BOOL bVisible = TRUE,
    BOOL bSetActive = TRUE,
    BOOL bDetachable = TRUE);

Parâmetros

pNewBar
[in, out] Um ponteiro para o painel a ser adicionado. Esse ponteiro poderá se tornar inválido após você chamar esse método. Para obter mais informações, consulte a seção Comentários.

bVisible
[in] TRUE para tornar a guia visível; caso contrário, FALSE.

bSetActive
[in] TRUE para fazer da guia a guia ativa; caso contrário, FALSE.

bDetachable
[in] TRUE para tornar a guia desanexável; caso contrário, FALSE.

Valor de retorno

TRUE se o painel foi adicionado com êxito como uma guia e não foi destruído no processo. FALSE se o painel que está sendo adicionado for um objeto do tipo CBaseTabbedPane. Para obter mais informações, consulte a seção Comentários.

Comentários

Chame esse método para adicionar um painel como uma nova guia em um painel com guias. Se pNewBar apontar para um objeto do tipo CBaseTabbedPane, todas as suas guias serão copiadas no painel com guias e pNewBar será destruída. Portanto, pNewBar se tornará ponteiro inválido e não deverá ser usada.

CBaseTabbedPane::AllowDestroyEmptyTabbedPane

Especifica se um painel com guias vazio pode ser destruído.

virtual BOOL AllowDestroyEmptyTabbedPane() const;

Valor de retorno

TRUE se um painel com guias vazio puder ser destruído; caso contrário, FALSE. A implementação padrão sempre retorna TRUE.

Comentários

Se um painel com guias vazio não puder ser destruído, a estrutura ocultará o painel.

CBaseTabbedPane::ApplyRestoredTabInfo

Carrega as configurações da guia do registro e as aplica a um painel com guias.

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

Parâmetros

bUseTabIndexes
[in] Esse parâmetro é usado internamente pela estrutura.

Comentários

Esse método é chamado pela estrutura quando recarrega as informações de estado de encaixe do registro. O método obtém informações sobre a ordem de tabulação e os nomes das guias para um painel com guias.

CBaseTabbedPane::CanFloat

Especifica se o painel com guias pode flutuar.

virtual BOOL CanFloat() const;

Valor de retorno

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

CBaseTabbedPane::CanSetCaptionTextToTabName

Determina se a legenda do painel com guias deve exibir o mesmo texto que a guia ativa.

virtual BOOL CanSetCaptionTextToTabName() const;

Valor de retorno

TRUE se o texto de legenda do painel com guias estiver definido como o texto da guia ativa; caso contrário, FALSE.

Comentários

O método é usado para determinar se o texto exibido na legenda do painel com guias duplica o rótulo da guia ativa. Você pode habilitar ou desabilitar essa funcionalidade chamando CBaseTabbedPane::EnableSetCaptionTextToTabName.

CBaseTabbedPane::ConvertToTabbedDocument

Converte um ou mais painéis encaixáveis em documentos com guia MDI.

virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);

Parâmetros

bActiveTabOnly
[in] Ao converter um painel com guias, especifique TRUE para converter apenas a guia ativa e FALSE para converter todas as guias no painel.

CBaseTabbedPane::DetachPane

Desanexa um painel do painel com guias.

virtual BOOL DetachPane(
    CWnd* pBar,
    BOOL bHide = FALSE);

Parâmetros

pBar
[in] Ponteiro para o painel que será desanexado.

bHide
[in] Parâmetro booliano que especifica se a estrutura oculta o painel após ele ser desanexado.

Valor de retorno

TRUE se a estrutura desanexar com êxito o painel; FALSE se pBar for NULL ou se referir a um painel que não está no painel com guias.

Comentários

A estrutura faz com que o painel desanexado flutue, se possível. Para obter mais informações, consulte CBasePane::CanFloat.

CBaseTabbedPane::EnableSetCaptionTextToTabName

Habilita ou desabilita a capacidade do painel com guias de sincronizar o texto de legenda com o texto de rótulo na guia ativa.

virtual void EnableSetCaptionTextToTabName(BOOL bEnable);

Parâmetros

bEnable
[in] TRUE para sincronizar a legenda do painel com guias e a legenda da guia ativa; caso contrário, FALSE.

CBaseTabbedPane::FillDefaultTabsOrderArray

Restaura a ordem de tabulação interna para um estado padrão.

void FillDefaultTabsOrderArray();

Comentários

Esse método é chamado quando a estrutura restaura uma barra do Outlook para o estado inicial.

CBaseTabbedPane::FindPaneByID

Retorna um painel identificado pela ID de painel.

virtual CWnd* FindPaneByID(UINT uBarID);

Parâmetros

uBarID
[in] Especifica a ID do painel a ser localizado.

Valor de retorno

Um ponteiro para o painel, se localizado; caso contrário, NULL.

Comentários

Esse método compara todas as guias no painel e retorna aquela com a ID especificada pelo parâmetro uBarID.

CBaseTabbedPane::FindBarByTabNumber

Retorna um painel que reside em uma guia.

virtual CWnd* FindBarByTabNumber(
    int nTabNum,
    BOOL bGetWrappedBar = FALSE);

Parâmetros

nTabNum
[in] Especifica o índice baseado em zero da guia a ser recuperada.

bGetWrappedBar
[in] TRUE para retornar a janela subjacente (encapsulada) do painel em vez do próprio painel; caso contrário, FALSE. Isso se aplica somente a painéis derivados de CDockablePaneAdapter.

Valor de retorno

Se o painel for encontrado, um ponteiro válido para o painel que está sendo pesquisado será retornado; caso contrário, NULL.

Comentários

Chame esse método para recuperar o painel que reside na guia especificada pelo parâmetro nTabNum.

CBaseTabbedPane::FloatTab

Faz com que um painel flutue, mas somente se o painel residir em uma guia desanexável.

virtual BOOL FloatTab(
    CWnd* pBar,
    int nTabID,
    AFX_DOCK_METHOD dockMethod,
    BOOL bHide = FALSE);

Parâmetros

pBar
[in, out] Um ponteiro para o painel que deverá flutuar.

nTabID
[in] Especifica o índice baseado em zero da guia que deverá flutuar.

dockMethod
[in] Especifica o método a ser usado para fazer o painel flutuar. Para obter mais informações, consulte a seção Comentários.

bHide
[in] TRUE para ocultar o painel antes de flutuar; caso contrário, FALSE.

Valor de retorno

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

Comentários

Chame esse método para fazer flutuar um painel que reside em uma guia desanexável.

Se você quiser desanexar um painel de maneira programática, especifique DM_SHOW para o parâmetro dockMethod. Se você quiser fazer o painel flutuar na mesma posição em que ele flutuou anteriormente, especifique DM_DBL_CLICK como o parâmetro dockMethod.

CBaseTabbedPane::GetDefaultTabsOrder

Retorna a ordem padrão das guias no painel.

const CArray<int,int>& GetDefaultTabsOrder();

Valor de retorno

Um objeto CArray que especifica a ordem padrão das guias no painel.

Comentários

A estrutura chama esse método quando uma barra do Outlook é redefinida para um estado inicial.

CBaseTabbedPane::GetFirstVisibleTab

Recupera um ponteiro para a primeira guia exibida.

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

Parâmetros

iTabNum
[in] Uma referência a um inteiro. Esse método gravará o índice baseado em zero da primeira guia exibida nesse parâmetro ou -1 se nenhuma guia exibida for encontrada.

Valor de retorno

Se tiver êxito, um ponteiro para a primeira guia exibida; caso contrário, NULL.

CBaseTabbedPane::GetMinSize

Recupera o tamanho mínimo permitido para o painel.

virtual void GetMinSize(CSize& size) const;

Parâmetros

size
[out] Um objeto CSize que é preenchido com o tamanho mínimo permitido.

Comentários

Se a manipulação consistente de tamanhos mínimos do painel estiver ativa (CPane::m_bHandleMinSize), size será preenchido com o tamanho mínimo permitido para a guia ativa. Caso contrário, size será preenchido com o valor retornado de CPane::GetMinSize.

CBaseTabbedPane::GetPaneIcon

Recupera o tamanho mínimo permitido para o painel.

virtual void GetMinSize(CSize& size) const;

Parâmetros

size
[out] Um objeto CSize que é preenchido com o tamanho mínimo permitido.

Comentários

Se a manipulação consistente de tamanhos mínimos do painel estiver ativa (CPane::m_bHandleMinSize), size será preenchido com o tamanho mínimo permitido para a guia ativa. Caso contrário, size será preenchido com o valor retornado de CPane::GetMinSize.

CBaseTabbedPane::GetPaneList

Retorna uma lista de painéis contidos no painel com guias.

virtual void GetPaneList(
    CObList& lst,
    CRuntimeClass* pRTCFilter = NULL);

Parâmetros

lst
[out] Um CObList preenchido com os painéis contidos no painel com guias.

pRTCFilter
[in] Se ele não for NULL, a lista retornada conterá apenas painéis da classe de runtime especificada.

CBaseTabbedPane::GetTabArea

Retorna os retângulos delimitadores para as áreas superior e inferior da guia.

virtual void GetTabArea(
    CRect& rectTabAreaTop,
    CRect& rectTabAreaBottom) const = 0;

Parâmetros

rectTabAreaTop
[out] Recebe as coordenadas de tela da área superior da guia.

rectTabAreaBottom
[out] Recebe as coordenadas de tela da área inferior da guia.

Comentários

Chame esse método para determinar os retângulos delimitadores, em coordenadas de tela, para as áreas superior e inferior da guia.

CBaseTabbedPane::GetTabsNum

Retorna a contagem de guias em uma janela de guia.

virtual int GetTabsNum() const;

Valor de retorno

O número de guias no painel com guias.

CBaseTabbedPane::GetUnderlyingWindow

Obtém a janela da guia subjacente (encapsulada).

virtual CMFCBaseTabCtrl* GetUnderlyingWindow();

Valor de retorno

Um ponteiro para a janela da guia subjacente.

CBaseTabbedPane::GetVisibleTabsNum

Retorna a contagem de guias visíveis.

virtual int GetVisibleTabsNum() const;

Valor de retorno

O número de guias visíveis, que será maior ou igual a zero.

Comentários

Chame esse método para determinar o número de guias visíveis no painel com guias.

CBaseTabbedPane::HasAutoHideMode

Determina se o painel com guias pode ser alternado para o modo de ocultação automática.

virtual BOOL HasAutoHideMode() const;

Valor de retorno

TRUE se o painel puder ser alternado para o modo de ocultação automática; caso contrário, FALSE.

Comentários

Se o modo de ocultação automática estiver desabilitado, nenhum botão de fixação será exibido na legenda do painel com guias.

CBaseTabbedPane::IsHideSingleTab

Determina se o painel com guias será ocultado se apenas uma guia for exibida.

virtual BOOL IsHideSingleTab() const;

Valor de retorno

TRUE se a janela com guias não for mostrada quando houver apenas uma guia visível; caso contrário, FALSE.

Comentários

Se o painel não for exibido porque apenas uma guia está aberta, você poderá chamar esse método para determinar se o painel com guias está funcionando corretamente.

CBaseTabbedPane::RemovePane

Remove um painel do painel com guias.

virtual BOOL RemovePane(CWnd* pBar);

Parâmetros

pBar
[in, out] Um ponteiro para o painel a ser removido do painel com guias.

Valor de retorno

TRUE se o painel tiver sido removido com êxito do painel com guias e se o painel com guias ainda for válido. FALSE se o último painel tiver sido removido do painel com guias e o painel com guias estiver prestes a ser destruído. Se o valor retornado for FALSE, não use mais o painel com guias.

Comentários

Chame esse método para remover o painel especificado pelo parâmetro pBar do painel com guias.

CBaseTabbedPane::SetAutoDestroy

Determina se a barra de controle com guias será destruída automaticamente.

void SetAutoDestroy(BOOL bAutoDestroy = TRUE);

Parâmetros

bAutoDestroy
[in] TRUE se o painel com guias foi criado dinamicamente e você não está controlando o tempo de vida dele; caso contrário, FALSE.

Comentários

Defina o modo de destruição automática como TRUE se você criar um painel com guias dinamicamente e se não estiver controlando o tempo de vida dele. Se o modo de destruição automática for TRUE, o painel com guias será destruído automaticamente pela estrutura.

CBaseTabbedPane::ShowTab

Mostra ou oculta uma guia.

virtual BOOL ShowTab(
    CWnd* pBar,
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

Parâmetros

pBar
[in] Um ponteiro para o painel a ser mostrado ou ocultado.

bShow
[in] TRUE para mostrar o painel; FALSE para ocultá-lo.

bDelay
[in] TRUE para atrasar o ajuste do layout da guia; caso contrário, FALSE.

bActivate
[in] TRUE para fazer da guia a guia ativa; caso contrário, FALSE.

Valor de retorno

TRUE se a guia foi mostrada ou ocultada com êxito; caso contrário, FALSE.

Comentários

Quando você chama esse método, um painel é mostrado ou ocultado, dependendo do valor do parâmetro bShow. Se você ocultar uma guia e ela for a última guia visível na janela da guia subjacente, o painel com guias ficará oculto. Se você mostrar uma guia quando não havia guias visíveis anteriormente, o painel com guias será mostrado.

CBaseTabbedPane::RecalcLayout

Recalcula informações de layout do painel.

virtual void RecalcLayout();

Comentários

Se o painel estiver flutuando, esse método notificará a estrutura para redimensionar o painel para o tamanho atual da minimoldura.

Se o painel estiver encaixado, o método não fará nada.

CBaseTabbedPane::SetAutoHideMode

Define o modo de ocultação automática para painéis desanexáveis no painel com guias.

virtual CMFCAutoHideToolBar* SetAutoHideMode(
    BOOL bMode,
    DWORD dwAlignment,
    CMFCAutoHideToolBar* pCurrAutoHideBar = NULL,
    BOOL bUseTimer = TRUE);

Parâmetros

bMode
[in] TRUE para habilitar o modo de ocultação automática; FALSE para habilitar o modo de encaixe regular.

dwAlignment
[in] Especifica o alinhamento do painel com ocultação automática a ser criado. Para obter uma lista de valores possíveis, confira CPane::MoveByAlignment.

pCurrAutoHideBar
[in, out] Um ponteiro para a barra de ferramentas com ocultação automática atual. Pode ser NULL.

bUseTimer
[in] Especifica se é necessário usar o efeito de ocultação automática quando o usuário alterna o painel para o modo de ocultação automática ou se o painel deve ser ocultado imediatamente.

Valor de retorno

Um ponteiro para a barra de ferramentas com ocultação automática criada ao alternar para o modo com ocultação automática ou NULL se nenhuma barra de ferramentas for criada.

Comentários

A estrutura chama esse método quando um usuário escolhe o botão fixar para alternar o painel com guias para o modo de ocultação automática ou para o modo de encaixe regular.

O modo de ocultação automática é definido para cada painel desanexável no painel com guias. Painéis que não são desanexáveis são ignorados. Para obter mais informações, consulte CMFCBaseTabCtrl::EnableTabDetach.

Chame esse método para alternar um painel com guias para o modo de ocultação automática de maneira programática. O painel deve ser encaixado na janela de quadro principal (CDockablePane::GetDefaultPaneDivider deve retornar um ponteiro válido para o CPaneDivider).

Confira também

Gráfico da hierarquia
Classes
Classe CDockablePane