CMFCBaseTabCtrl Classe

Implementa a funcionalidade base para janelas com guias. Para obter mais detalhes, consulte o código-fonte localizado na pasta VC\atlmfc\src\mfc da instalação do Visual Studio.

Sintaxe

class CMFCBaseTabCtrl : public CWnd

Membros

Métodos Públicos

Métodos Protegidos

Membros de dados

Observações

A CMFCBaseTabCtrl classe é uma classe abstrata. Portanto, não pode ser instanciado. Para criar uma janela com guias, você deve derivar uma classe de CMFCBaseTabCtrl. A biblioteca MFC contém alguns exemplos de classe derivada, dois dos quais são CMFCTabCtrl Class e CMFCOutlookBarTabCtrl Class.

A partir do Visual Studio 2015, essa classe oferece suporte ao Microsoft Ative Accessibility.

Dicas de personalização

As dicas a seguir referem-se às CMFCBaseTabCtrl Class classes e quaisquer que herdam dela:

• Se ativar os separadores destacáveis, não mantenha os ponteiros para as janelas com separadores. Estes separadores destacáveis podem ser criados e destruídos dinamicamente. Portanto, os ponteiros podem se tornar inválidos.

• Você pode configurar o controle de guia para que os usuários possam mover guias dinamicamente em um controle de guia usando o mouse. Essa funcionalidade é incorporada à CMFCBaseTabCtrl classe. Para habilitá-lo, chame CMFCBaseTabCtrl::EnableTabSwap.

• Por padrão, as guias são destacáveis quando você as adiciona a um controle de guia. Você também pode adicionar guias não destacáveis usando CMFCBaseTabCtrl::AddTab. Se você definir o parâmetro bDetachable como FALSE, a guia não será destacável. Você também pode alterar se as guias são destacáveis chamando o método CMFCBaseTabCtrl::EnableTabDetach.

• Os objetos derivados da classe CWnd podem ser colocados em uma barra de controle encaixável ou guia encaixável. Para que todo o controle seja encaixado, você deve tornar o CWnd objeto encaixável. Para fazer isso, MFC usa uma classe wrapper. Essa classe wrapper é a classe CDockablePaneAdapter. Todos os CWnd objetos que são adicionados a uma barra de controle encaixável ou guia encaixável serão encapsulados dentro de um CDockablePaneAdapter objeto. Você pode desativar o encapsulamento automático definindo o parâmetro m_bEnableWrapping do seu CMFCBaseTablCtrl objeto como FALSE. Você também pode alterar a classe que seu aplicativo usará como um wrapper usando o método CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Hierarquia de herança

CObject

CCmdTarget

CWnd

CMFCBaseTabCtrl

Requerimentos

Cabeçalho: afxbasetabctrl.h

CMFCBaseTabCtrl::AddIcon

Adiciona um ícone à lista de ícones no membro protegido CMap m_mapAddedIcons .

void AddIcon(
    HICON hIcon,
    int iIcon);

Parâmetros

hIcon
[em] Um identificador para o ícone a ser adicionado.

iIcon
[em] Índice baseado em zero do ícone no membro protegido CImageList m_Images .

Observações

CMFCBaseTabCtrl::AddTab

Adiciona uma nova guia ao controle de guia.

virtual void AddTab(
    CWnd* pTabWnd,
    LPCTSTR lpszTabLabel,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

virtual void AddTab(
    CWnd* pTabWnd,
    UINT uiResTabLabel,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

Parâmetros

pTabWnd
[em] Um ponteiro para a janela que esse método representa como uma nova guia.

lpszTabLabel
[em] Uma cadeia de caracteres que contém o rótulo da nova guia.

uiImageId
[em] Um ID de imagem da lista de imagens. O controle tab usa essa imagem como o ícone para a nova guia.

uiResTabLabel
[em] A ID do recurso para o rótulo.

bDestacável
[em] Um parâmetro booleano que determina se a nova guia é destacável.

Observações

Se pTabWnd apontar para um objeto que não é derivado da classe CDockablePane e se bDetachable for TRUE, a estrutura criará automaticamente um wrapper para o objeto pTabWnd . O wrapper torna o objeto pTabWnd destacável. Por padrão, o wrapper é uma instância da classe CDockablePaneAdapter. Se a funcionalidade oferecida pelo wrapper padrão for inaceitável, use o método CMFCBaseTabCtrl::SetDockingBarWrapperRTC para especificar um wrapper diferente.

CMFCBaseTabCtrl::ApplyRestoredTabInfo

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

Parâmetros

[em] bUseTabIndexes

Observações

CMFCBaseTabCtrl::AutoDestroyWindow

void AutoDestroyWindow(BOOL bAutoDestroy = TRUE);

Parâmetros

[em] bAutoDestruição

Observações

CMFCBaseTabCtrl::CalcRectEdit

virtual void CalcRectEdit(CRect& rectEdit);

Parâmetros

[em] rectEdit

Observações

CMFCBaseTabCtrl::Limpeza

virtual void CleanUp();

Observações

CMFCBaseTabCtrl::ClearImageList

virtual void ClearImageList();

Observações

CMFCBaseTabCtrl::CreateWrapper

Cria um wrapper para uma janela de quadro que é derivada da classe CWnd , mas não é derivada da classe CDockablePane.

virtual CWnd* CreateWrapper(
    CWnd* pWndToWrap,
    LPCTSTR lpszTabLabel,
    BOOL bDetachable);

Parâmetros

pWndToWrap
[em] Um ponteiro para a janela do quadro que está encapsulada.

lpszTabLabel
[em] Uma cadeia de caracteres que contém o rótulo da janela.

bDestacável
[em] Um parâmetro booleano que indica se a janela é destacável.

Valor de retorno

Um ponteiro para wrapper derivado da CDockablePane classe se CreateWrapper criar com êxito uma classe wrapper para pWndToWrap. Se o método falhar, ele retornará pWndToWrap.

Observações

Uma janela com guias pode encaixar qualquer objeto derivado de CWnd. No entanto, para que um CMFCBaseTabCtrl Class objeto seja encaixável, cada objeto no CMFCBaseTabCtrl deve ser destacável. Portanto, CMFCBaseTabCtrl encapsula automaticamente todos os objetos que não são derivados do CDockablePane.

Por padrão, o CMFCBaseTabCtrl cria instâncias da classe CDockablePaneAdapter. Para alterar a classe padrão do wrapper, chame CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Se pWndToWrap for derivado de CDockablePane, esse método não criará um wrapper. Em vez disso, ele falhará e retornará pWndToWrap.

CMFCBaseTabCtrl::D etachTab

A estrutura chama esse método para desanexar uma guia do controle tab.

virtual BOOL DetachTab(
    AFX_DOCK_METHOD dockMethod,
    int nTabNum = -1,
    BOOL bHide = FALSE);

Parâmetros

dockMethod
[em] Um tipo de dados enumerado fornecido pela classe CBasePane. Esse tipo de dados especifica o método que foi usado para desanexar a guia.

nTabNum
[em] O índice baseado em zero da guia a ser destacada.

bOcultar
[em] Um parâmetro booleano que indica se a estrutura deve ocultar a guia desanexada.

Valor de retorno

Diferente de zero se for bem-sucedido; caso contrário, 0.

Observações

Se a guia especificada por nTabNum não for destacável, essa função falhará e retornará FALSE.

CMFCBaseTabCtrl::EnableActivateLastActive

void EnableActivateLastActive(BOOL bLastActive = TRUE);

Parâmetros

[em] bLastAtivo

Observações

CMFCBaseTabCtrl::EnableAutoColor

Controla se a estrutura usa as cores de plano de fundo automáticas ao desenhar uma guia.

void EnableAutoColor(BOOL bEnable = TRUE);

Parâmetros

bAtivar
[em] Um parâmetro booleano que determina se a estrutura usa cores automáticas.

Observações

Um controle de guia tem uma matriz de várias cores predefinidas. Quando a estrutura usa cores automáticas, cada guia em uma série de guias recebe a próxima cor dessa matriz.

Por padrão, as cores automáticas são determinadas pelas cores definidas pela biblioteca. Você pode fornecer uma matriz personalizada de cores chamando CMFCBaseTabCtrl::SetAutoColors.

CMFCBaseTabCtrl::EnableCustomToolTips

Permite dicas de ferramentas personalizadas para o controle de guia.

BOOL EnableCustomToolTips(BOOL bEnable = TRUE);

Parâmetros

bAtivar
[em] Um booleano que determina se as dicas de ferramentas personalizadas devem ser usadas.

Valor de retorno

VERDADEIRO se bem sucedido; caso contrário, FALSE.

Observações

Se as dicas de ferramentas personalizadas estiverem habilitadas, o controle tab enviará a mensagem AFX_WM_ON_GET_TAB_TOOLTIP para o quadro principal. Se você quiser oferecer suporte a dicas de ferramentas personalizadas em seu aplicativo, a janela do quadro principal deve manipular esse método e fornecer o texto da dica de ferramenta personalizada. Para obter mais informações sobre como fornecer texto de dica de ferramenta personalizado, consulte Estrutura CMFCTabToolTipInfo.

CMFCBaseTabCtrl::EnableInPlaceEdit

Permite a edição direta das etiquetas dos separadores pelo utilizador.

virtual void EnableInPlaceEdit(BOOL bEnable) = 0;

Parâmetros

bAtivar
[em] Um parâmetro booleano que especifica se a edição direta dos rótulos de guia deve ser habilitada.

Observações

Por padrão, a edição direta dos rótulos de guia está desabilitada para controles de guia.

Você pode habilitar a edição direta para um subconjunto das guias no controle de guia. Para fazer isso, substitua o método CMFCBaseTabCtrl::StartRenameTab. StartRenameTab deve retornar um valor diferente de zero para todas as guias que oferecem suporte à edição direta de rótulos de guias.

CMFCBaseTabCtrl ClassNo , este método é uma função virtual pura e não tem implementação. Se você derivar uma classe de CMFCBaseTabCtrl, você deve implementar essa função.

CMFCBaseTabCtrl::EnableTabDetach

Permite separadores destacáveis.

virtual BOOL EnableTabDetach(
    int iTab,
    BOOL bEnable);

Parâmetros

iTab
[em] O índice baseado em zero de uma guia.

bAtivar
[em] Um booleano que indica se a guia deve ser destacável.

Valor de retorno

VERDADEIRO se bem sucedido; caso contrário, FALSE.

CMFCBaseTabCtrl::EnableTabSwap

Permite que o usuário altere a ordem de tabulação usando um mouse.

void EnableTabSwap(BOOL bEnable);

Parâmetros

bAtivar
[em] Um booleano que indica se a troca de guias deve ser habilitada.

Observações

Quando a troca de guias está habilitada, o usuário pode arrastar uma guia e alterar sua posição relativa no controle de guia.

CMFCBaseTabCtrl::EnsureVisible

Rola as guias até que a guia especificada fique visível.

virtual BOOL EnsureVisible(int iTab);

Parâmetros

iTab
[em] O índice baseado em zero de uma guia.

Valor de retorno

Diferente de zero se for bem-sucedido; caso contrário, 0.

Observações

Este método não tem efeito se o separador indicado pelo iTab já estiver visível.

Por padrão, esse método não é suportado CMFCBaseTabCtrl Classpelo . Você deve implementar essa função em uma classe personalizada derivada de se esse controle de guia personalizado oferecer suporte à rolagem de CMFCBaseTabCtrl guias. Este método é suportado pela classe CMFCTabCtrl.

CMFCBaseTabCtrl::EnterDragMode

void EnterDragMode();

Observações

CMFCBaseTabCtrl::FindTargetWnd

Identifica o painel que contém um ponto especificado.

virtual CWnd* FindTargetWnd(const CPoint& pt) = 0;

Parâmetros

pt
[em] Um ponto que é definido usando coordenadas de área do cliente do objeto CMFCBaseTabCtrl .

Valor de retorno

Um ponteiro para um objeto CWnd se bem-sucedido; caso contrário, NULL.

Observações

Na classe, esse método é uma função virtual pura CMFCBaseTabCtrl : você deve implementá-lo se derivar uma classe de CMFCBaseTabCtrl.

CMFCBaseTabCtrl::FireChangeActiveTab

virtual void FireChangeActiveTab(int nNewTab);

Parâmetros

[em] nNewTab

Observações

CMFCBaseTabCtrl::FireChangingActiveTab

virtual BOOL FireChangingActiveTab(int nNewTab);

Parâmetros

[em] nNewTab

Valor de retorno

Observações

CMFCBaseTabCtrl::GetActiveTab

Recupera o índice da guia ativa no momento.

virtual int GetActiveTab() const;

Valor de retorno

O índice baseado em zero da guia ativa; -1 se não houver uma guia ativa.

CMFCBaseTabCtrl::GetActiveTabColor

Recupera a cor do plano de fundo da guia ativa no momento.

virtual COLORREF GetActiveTabColor() const;

Valor de retorno

Um valor COLORREF que especifica a cor do plano de fundo da guia ativa.

Observações

Por padrão, a cor do plano de fundo da guia ativa é COLOR_WINDOW. Você pode alterar a cor do plano de fundo da guia ativa usando o método CMFCBaseTabCtrl::SetActiveTabColor.

CMFCBaseTabCtrl::GetActiveTabTextColor

Recupera a cor do texto para a guia ativa.

virtual COLORREF GetActiveTabTextColor() const;

Valor de retorno

Um valor COLORREF que especifica a cor do texto da guia ativa.

Observações

Por padrão, a cor do texto para guias ativas é COLOR_WINDOWTEXT. Você pode alterar a cor do texto com o método CMFCBaseTabCtrl::SetActiveTabTextColor.

CMFCBaseTabCtrl::GetActiveWnd

Recupera um ponteiro para a janela da guia ativa no momento.

virtual CWnd* GetActiveWnd() const;

Valor de retorno

Um ponteiro para uma janela.

CMFCBaseTabCtrl::GetAutoColors

Recupera a matriz de cores usada para coloração automática.

const CArray<COLORREF,COLORREF>& GetAutoColors() const;

Valor de retorno

Uma referência a uma matriz de valores COLORREF que o objeto CMFCBaseTabCtrl usa para coloração automática de guias.

Observações

Por padrão, a estrutura inicializa a matriz de cores para cores definidas pela biblioteca. Você pode fornecer uma matriz personalizada de cores chamando o método CMFCBaseTabCtrl::SetAutoColors.

CMFCBaseTabCtrl::GetFirstVisibleTab

Recupera um ponteiro para a primeira guia visível.

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

virtual CWnd* GetFirstVisibleTab(
    int iStartFrom,
    int& iTabNum);

Parâmetros

iTabNum
[saídas] Uma referência a um número inteiro. Esse método grava o índice baseado em zero da primeira guia visível para esse parâmetro.

iStartFrom
[em] O índice baseado em zero da primeira guia a ser verificada.

Valor de retorno

Um ponteiro para a primeira guia visível, se for bem-sucedido; caso contrário, NULL.

Observações

Se esse método falhar, ele grava o valor -1 para iStartFrom.

Se iStartFrom for maior ou igual ao número de guias no controle de guia, GetFirstVisibleTab falhará automaticamente.

CMFCBaseTabCtrl::GetFirstVisibleTabNum

virtual int GetFirstVisibleTabNum() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::GetHighlightedTab

Recupera o índice da guia atualmente realçada.

int GetHighlightedTab() const;

Valor de retorno

O índice baseado em zero da guia realçada.

CMFCBaseTabCtrl::GetImageList

virtual const CImageList* GetImageList() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::GetImageSize

virtual CSize GetImageSize() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::GetLastVisibleTab

virtual CWnd* GetLastVisibleTab(int& iTabNum);

Parâmetros

[em] iTabNum

Valor de retorno

Observações

CMFCBaseTabCtrl::GetLocation

Recupera o local da parte da área de tabulação do controle de guia.

Location GetLocation() const;

Valor de retorno

A localização da área da guia.

Observações

Os possíveis valores de localização da área da guia são LOCATION_BOTTOM e LOCATION_TOP.

CMFCBaseTabCtrl::GetMaxWindowSize

virtual CSize GetMaxWindowSize() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::GetTabArea

Recupera o tamanho e a posição da área de tabulação do controle de guia.

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

Parâmetros

rectTabAreaTop
[em] Uma referência a um CRect objeto. GetTabArea Usa esse objeto para armazenar o tamanho e a posição da área da guia superior.

rectTabAreaBottom
[em] Uma referência a um CRect objeto. GetTabArea usa esse objeto para armazenar o tamanho e a posição da área da guia inferior.

Observações

Após GetTabArea retornos, os CRect parâmetros contêm o tamanho e a posição da área da guia nas coordenadas do cliente do controle de guia. Se não houver nenhuma área de tabulação na parte superior ou inferior do controle de guia, rectTabAreaTop ou rectTabAreaBottom se estiverem vazios.

CMFCBaseTabCtrl ClassNo , este método é uma função virtual pura e não tem implementação. Se você derivar uma classe de CMFCBaseTabCtrl, você tem que implementar essa função.

CMFCBaseTabCtrl::GetTabBkColor

Recupera a cor do plano de fundo da guia especificada.

virtual COLORREF GetTabBkColor(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia.

Valor de retorno

Um valor COLORREF que indica a cor de plano de fundo da guia especificada; -1 se o iTab estiver fora do intervalo.

CMFCBaseTabCtrl::GetTabBorderSize

Recupera o tamanho das bordas de tabulação no controle de guia.

virtual int GetTabBorderSize() const;

Valor de retorno

O tamanho da borda da guia, em pixels.

Observações

O tamanho padrão para a borda da guia é de três pixels. Você pode alterar esse tamanho de borda com o método CMFCBaseTabCtrl::SetTabBorderSize.

CMFCBaseTabCtrl::GetTabByID

Recupera o índice de uma guia com base em um ID de guia.

virtual int GetTabByID(int id) const;

Parâmetros

ID
[em] Um ID de guia.

Valor de retorno

O índice baseado em zero de uma guia, se for encontrado; -1 se o ID da guia não for encontrado.

Observações

Os IDs de guia são atribuídos automaticamente quando as guias são adicionadas a um controle de guia.

CMFCBaseTabCtrl::GetTabCloseButton

CRect GetTabCloseButton() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::GetTabFromHwnd

Recupera o índice da guia que contém o objeto HWND especificado.

virtual int GetTabFromHwnd(HWND hwnd) const;

Parâmetros

HWND
[em] Uma alça para uma janela.

Valor de retorno

O índice baseado em zero da guia, se bem-sucedido; -1 se nenhuma guia contiver hwnd.

CMFCBaseTabCtrl::GetTabFromPoint

Recupera a guia que contém um ponto especificado.

virtual int GetTabFromPoint(CPoint& pt) const;

Parâmetros

pt
[em] Um ponto nas coordenadas do cliente do controle de guia.

Valor de retorno

O índice da guia que contém pt; -1 se nenhuma guia contiver pt.

CMFCBaseTabCtrl::GetTabFullWidth

virtual int GetTabFullWidth(int iTab) const;

Parâmetros

[em] iTab

Valor de retorno

Observações

CMFCBaseTabCtrl::GetTabHicon

Retorna o HICON associado à guia especificada.

virtual HICON GetTabHicon(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero para a guia.

Valor de retorno

O HICON associado a um rótulo de guia, se bem-sucedido; NULL se não houver HICON ou se o método falhar.

CMFCBaseTabCtrl::GetTabIcon

Recupera o ícone associado à guia especificada.

virtual UINT GetTabIcon(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia.

Valor de retorno

O ID do ícone para a guia especificada, se bem-sucedido; -1 se o índice for inválido.

Observações

O objeto CMFCBaseTabCtrl armazena os ícones no objeto CImageList interno.

CMFCBaseTabCtrl::GetTabID

Recupera a ID de uma guia especificada pelo índice da guia.

int GetTabID(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia.

Valor de retorno

Um ID do separador ou -1 se o iTab estiver fora do intervalo.

CMFCBaseTabCtrl::GetTabLabel

Recupera o texto de um rótulo de guia.

virtual BOOL GetTabLabel(
    int iTab,
    CString& strLabel) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia.

strLabel [en]
[saídas] Uma referência a um CString objeto. Este método armazena o rótulo da guia neste parâmetro.

Valor de retorno

VERDADEIRO se bem sucedido; FALSO caso contrário.

Observações

Este método falhará se o índice iTab for inválido.

Você define o rótulo para uma guia quando você cria a guia usando CMFCBaseTabCtrl::AddTab. Você também pode alterar o rótulo após a criação com o método CMFCBaseTabCtrl::SetTabLabel.

CMFCBaseTabCtrl::GetTabRect

Recupera o tamanho e a posição da guia especificada.

virtual BOOL GetTabRect(
    int iTab,
    CRect& rect) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia.

retângulo
[saídas] Uma referência a um CRect objeto. Esse método armazena o tamanho e a posição da guia nesse parâmetro.

Valor de retorno

VERDADEIRO se bem sucedido; FALSO se o índice de tabulação for inválido.

CMFCBaseTabCtrl::GetTabsHeight

virtual int GetTabsHeight() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::GetTabsNum

Recupera o número de guias no controle de guia.

virtual int GetTabsNum() const;

Valor de retorno

O número de guias no controle de guia.

CMFCBaseTabCtrl::GetTabsRect

virtual void GetTabsRect(CRect& rect) const;

Parâmetros

[em] Rect

Observações

CMFCBaseTabCtrl::GetTabTextColor

Recupera a cor do texto para a guia especificada.

virtual COLORREF GetTabTextColor(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia.

Valor de retorno

Um parâmetro COLORREF que indica a cor do texto da guia especificada; -1 se o iTab estiver fora do intervalo.

CMFCBaseTabCtrl::GetTabWnd

Retorna o ponteiro para o painel que reside na guia especificada.

virtual CWnd* GetTabWnd(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero de uma guia.

Valor de retorno

Um ponteiro para o objeto CWnd que reside na guia especificada pelo iTab . NULL se o iTab for inválido.

Observações

O objeto retornado é aquele que o aplicativo adicionou quando chamou CMFCBaseTabCtrl::AddTab ou CMFCBaseTabCtrl::InsertTab.

Se o objeto em uma guia tiver um wrapper, esse método retornará o wrapper para o objeto. Para obter mais informações sobre wrappers, consulte CMFCBaseTabCtrl::CreateWrapper. Se você quiser acessar um ponteiro para o objeto direto sem o wrapper, use o método CMFCBaseTabCtrl::GetTabWndNoWrapper.

CMFCBaseTabCtrl::GetTabWndNoWrapper

Retorna um ponteiro para o controle que reside em uma guia, mesmo que o controle tenha um wrapper.

virtual CWnd* GetTabWndNoWrapper(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero de uma guia.

Valor de retorno

Um ponteiro para o objeto CWnd que reside na guia especificada; NULL se o iTab for inválido.

Observações

Esse método recupera um ponteiro direto para o CWnd objeto que você adicionou usando o método CMFCBaseTabCtrl::AddTab ou CMFCBaseTabCtrl::InsertTab. GetTabWndNoWrapper recuperará um ponteiro para o adicionado CWnd, mesmo que a estrutura tenha adicionado um wrapper para o objeto. Para obter mais informações sobre wrappers e a classe CMFCBaseTabCtrl, consulte CMFCBaseTabCtrl::CreateWrapper.

Use o método CMFCBaseTabCtrl::GetTabWnd se não quiser ignorar a classe wrapper.

CMFCBaseTabCtrl::GetToolTipCtrl

Recupera uma referência ao contorl de dica de ferramenta.

CToolTipCtrl& GetToolTipCtrl() const;

Valor de retorno

Uma referência ao controle de dica de ferramenta.

CMFCBaseTabCtrl::GetVisibleTabsNum

Recupera o número de guias visíveis no momento.

virtual int GetVisibleTabsNum() const;

Valor de retorno

O número de separadores visíveis.

CMFCBaseTabCtrl::HasImage

virtual BOOL HasImage(int iTab) const;

Parâmetros

[em] iTab

Valor de retorno

Observações

CMFCBaseTabCtrl::HideSingleTab

Define a opção para ocultar as guias para o controle de guia quando há uma guia visível.

virtual void HideSingleTab(BOOL bHide = TRUE);

Parâmetros

bOcultar
[em] Um booleano que especifica se a ocultação de guias únicas deve ser habilitada.

Observações

Quando seu aplicativo é configurado para ocultar guias únicas, a estrutura exibe automaticamente as guias quando uma segunda guia é adicionada ao controle de guia.

CMFCBaseTabCtrl::InsertTab

Insere uma guia no controle de guia.

Virtual void InsertTab(
    CWnd* pNewWnd,
    LPCTSTR lpszTabLabel,
    int nInsertAt,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

virtual void InsertTab(
    CWnd* pNewWnd,
    UINT uiResTabLabel,
    int nInsertAt,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

Parâmetros

pNewWnd
[em] Um ponteiro para a janela que esse método adiciona como uma nova guia.

lpszTabLabel
[em] Uma cadeia de caracteres que contém o rótulo da nova guia.

nInsertAt
[em] O índice baseado em zero da nova guia.

uiImageId
[em] Um ID de imagem da lista de imagens. O controle tab usa essa imagem como o ícone para a nova guia.

bDestacável
[em] Um parâmetro booleano que determina se a nova guia é destacável.

uiResTabLabel
[em] A ID do recurso para o rótulo.

Observações

Se o objeto indicado por pNewWnd não for derivado da classe CDockablePane e se o parâmetro bDetachable for TRUE, a estrutura criará um wrapper especial para a nova guia. Por padrão, o wrapper é uma instância da classe CDockablePaneAdapter. Use o método CMFCBaseTabCtrl::SetDockingBarWrapperRTC para criar uma classe de wrapper diferente. Qualquer classe de wrapper personalizada precisa ser derivada de CDockablePaneAdapter.

CMFCBaseTabCtrl::InvalidateTab

void InvalidateTab(int iTab);

Parâmetros

[em] iTab

Observações

CMFCBaseTabCtrl::IsActiveTabCloseButton

virtual BOOL IsActiveTabCloseButton() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsAutoColor

Determina se o controle de guia está no modo de cor automática.

BOOL IsAutoColor() const;

Valor de retorno

TRUE se o controle de tabulação estiver no modo de cor automática; FALSO caso contrário.

Observações

Você pode habilitar ou desabilitar o modo de cor automática usando o método CMFCBaseTabCtrl::EnableAutoColor .

CMFCBaseTabCtrl::IsAutoDestroyWindow

BOOL IsAutoDestroyWindow() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsColored

virtual BOOL IsColored() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsDialogControl

BOOL IsDialogControl() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsDrawNoPrefix

BOOL IsDrawNoPrefix() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsFlatFrame

Indica se o quadro do controle de guia é renderizado em um estilo simples ou em um estilo 3D.

virtual BOOL IsFlatFrame() const;

Valor de retorno

TRUE se o quadro do controle de tabulação for renderizado em um estilo plano; FALSO se o quadro for renderizado em um estilo 3D.

Observações

Use CMFCTabCtrl::SetFlatFrame para alterar o estilo do quadro do controle de guia.

Os controles de guia que usam o estilo do Outlook não podem ser renderizados com quadros simples. Isso inclui a classe CMFCOutlookBarTabCtrl e quaisquer classes derivadas dessa classe.

CMFCBaseTabCtrl::IsFlatTab

virtual BOOL IsFlatTab() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsHideSingleTab

Determina se o controle tab oculta o rótulo da guia se houver apenas uma guia.

virtual BOOL IsHideSingleTab() const;

Valor de retorno

TRUE se o controle tab oculta o rótulo da guia quando ele tem uma guia; caso contrário, FALSE.

Observações

Use o método CMFCBaseTabCtrl::HideSingleTab para habilitar a ocultação do rótulo da guia quando houver apenas uma guia.

CMFCBaseTabCtrl::IsIconAdded

BOOL IsIconAdded(
    HICON hIcon,
    int& iIcon);

Parâmetros

[em] hIcon

[em] iIcon

Valor de retorno

Observações

CMFCBaseTabCtrl::IsInPlaceEdit

Indica se o controle de guia está configurado para permitir que o usuário modifique dinamicamente os rótulos de guia.

virtual BOOL IsInPlaceEdit() const;

Valor de retorno

Diferente de zero se a edição in-loco estiver ativada; caso contrário, 0.

Observações

Você pode habilitar ou desabilitar a edição in-loco chamando o método CMFCBaseTabCtrl::EnableInPlaceEdit.

CMFCBaseTabCtrl::IsLeftRightRounded

virtual BOOL IsLeftRightRounded() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsMDITab

BOOL IsMDITab() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsOneNoteStyle

Determina se as guias são exibidas no estilo do Microsoft OneNote.

virtual BOOL IsOneNoteStyle() const;

Valor de retorno

TRUE se as guias forem exibidas no estilo do Microsoft OneNote; caso contrário, FALSE.

Observações

Chame o método CMDIFrameWndEx::EnableMDITabs para habilitar o estilo do Microsoft OneNote. Você também pode habilitar esse estilo ao instanciar a classe CMFCTabCtrl: basta passar o estilo STYLE_3D_ONENOTE para o método CMFCTabCtrl::Create.

Por padrão, o estilo do Microsoft OneNote não é suportado em uma classe personalizada derivada do CMFCBaseTabCtrl Class. No entanto, ele é suportado CMFCTabCtrl na classe.

CMFCBaseTabCtrl::IsPtInTabArea

Determina se um ponto está dentro da área da guia.

virtual BOOL IsPtInTabArea(CPoint point) const = 0;

Parâmetros

ponto
[em] O ponto a testar.

Valor de retorno

Diferente de zero se o ponto estiver na área da guia; 0 caso contrário.

Observações

CMFCBaseTabCtrl ClassNo , este método é uma função virtual pura e não tem implementação. Se você derivar uma classe de CMFCBaseTabCtrl, você tem que implementar essa função.

CMFCBaseTabCtrl::IsTabCloseButtonHighlighted

BOOL IsTabCloseButtonHighlighted() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsTabCloseButtonPressionado

BOOL IsTabCloseButtonPressed() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::IsTabDestacável

Determina se uma guia é destacável.

virtual BOOL IsTabDetachable(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia a ser verificada.

Valor de retorno

TRUE se o separador for destacável; FALSO caso contrário.

Observações

Para tornar uma guia destacável, use o método CMFCBaseTabCtrl::EnableTabDetach.

CMFCBaseTabCtrl::IsTabIconOnly

Determina se um rótulo de guia contém apenas ícones e nenhum texto.

virtual BOOL IsTabIconOnly(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia.

Valor de retorno

TRUE se um rótulo de tabulação tiver apenas ícones; FALSO caso contrário.

Observações

Para definir as guias em seu aplicativo para exibir apenas ícones, chame o método CMFCBaseTabCtrl::SetTabIconOnly.

CMFCBaseTabCtrl::IsTabSwapEnabled

Determina se o controle tab permite que o usuário altere as posições da guia usando o mouse.

BOOL IsTabSwapEnabled() const;

Valor de retorno

Diferente de zero se as posições das guias puderem ser alteradas pelo usuário; caso contrário, 0.

Observações

Por padrão, os usuários não podem alterar a ordem das guias em um controle de guia. Use o método CMFCBaseTabCtrl::EnableTabSwap para habilitar essa funcionalidade.

CMFCBaseTabCtrl::IsTabVisible

Indica se a guia especificada está visível.

virtual BOOL IsTabVisible(int iTab) const;

Parâmetros

iTab
[em] O índice baseado em zero da guia a ser verificada.

Valor de retorno

Diferente de zero se a guia especificada estiver visível; caso contrário, 0.

CMFCBaseTabCtrl::IsVS2005Style

virtual BOOL IsVS2005Style() const;

Valor de retorno

Observações

CMFCBaseTabCtrl::m_bActivateTabOnRightClick

m_bActivateTabOnRightClick Determina se as guias estão em foco quando o usuário clica em um rótulo de guia usando o botão direito do mouse.

BOOL m_bActivateTabOnRightClick;

Observações

O valor padrão para esse membro de dados é FALSE.

CMFCBaseTabCtrl::m_bAutoDestroyWindow

m_bAutoDestroyWindow Determina se a estrutura destrói automaticamente os objetos nas guias quando as guias são removidas.

BOOL m_bAutoDestroyWindow;

Observações

Por padrão, esse membro é FALSE.

CMFCBaseTabCtrl::MoveTab

virtual void MoveTab(
    int nSource,
    int nDest);

Parâmetros

[em] nFonte

[em] nDest

Observações

CMFCBaseTabCtrl::OnChangeTabs

A estrutura chama esse método quando o número de guias em um controle de guia muda.

virtual void OnChangeTabs();

Observações

Por padrão, esse método não faz nada. Substitua esse método para executar código personalizado quando o número de guias no controle de guia for alterado.

CMFCBaseTabCtrl::OnDrop

virtual BOOL OnDrop(
    COleDataObject*,
    DROPEFFECT,
    CPoint);

Parâmetros

[em] COleDataObject*

[em] EFEITO GOTA

[em] CPoint

Valor de retorno

Observações

CMFCBaseTabCtrl::OnDragOver

virtual DROPEFFECT OnDragOver(
    COleDataObject*,
    DWORD,
    CPoint);

Parâmetros

[em] COleDataObject*

[em] DWORD

[em] CPoint

Valor de retorno

Observações

CMFCBaseTabCtrl::OnDragLeave

virtual void OnDragLeave();

Observações

CMFCBaseTabCtrl::OnDragEnter

virtual DROPEFFECT OnDragEnter(
    COleDataObject*,
    DWORD,
    CPoint);

Parâmetros

[em] COleDataObject*

[em] DWORD

[em] CPoint

Valor de retorno

Observações

CMFCBaseTabCtrl::OnRenameTab

virtual BOOL OnRenameTab(int, CString&);

Parâmetros

[em] Int

[em] CString&

Valor de retorno

Observações

CMFCBaseTabCtrl::P reTranslateMessage

virtual BOOL PreTranslateMessage(MSG* pMsg);

Parâmetros

[em] pMsg

Valor de retorno

Observações

CMFCBaseTabCtrl::RecalcLayout

Recalcula o layout interno do controle de guia.

virtual void RecalcLayout() = 0;

Observações

No , este método é uma função virtual pura CMFCBaseTabCtrl Class. Se você derivar uma classe de CMFCBaseTabCtrl, você tem que implementar essa função.

CMFCBaseTabCtrl::RemoveAllTabs

Remove todas as guias do controle de guia.

virtual void RemoveAllTabs();

Observações

Se CMFCBaseTabCtrl::m_bAutoDestroyWindow for TRUE, a estrutura excluirá todos os objetos CWnd anexados às guias removidas.

CMFCBaseTabCtrl::RemoveTab

Remove uma guia do controle de guia.

virtual BOOL RemoveTab(
    int iTab,
    BOOL bRecalcLayout = TRUE);

Parâmetros

iTab
[em] O índice baseado em zero de uma guia.

bRecalcLayout
[em] Um parâmetro booleano que especifica se o layout da guia deve ser recalculado.

Valor de retorno

TRUE se o método remover a guia com êxito; caso contrário, FALSE.

Observações

Se CMFCBaseTabCtrl::m_bAutoDestroyWindow for TRUE, RemoveTab destruirá o objeto CWnd associado à guia especificada.

CMFCBaseTabCtrl::RenameTab

virtual BOOL RenameTab();

Valor de retorno

Observações

CMFCBaseTabCtrl::ResetImageList

Redefine a lista de imagens para uma instância da classe CMFCBaseTabCtrl.

void ResetImageList();

CMFCBaseTabCtrl::Serializar

virtual void Serialize(CArchive& ar);

Parâmetros

[em] RA

Observações

CMFCBaseTabCtrl::SetActiveTab

Ativa a guia especificada.

virtual BOOL SetActiveTab(int iTab) = 0;

Parâmetros

iTab
[em] O índice baseado em zero de uma guia. SetActiveTab Torna a guia com esse índice ativa.

Valor de retorno

VERDADEIRO se bem sucedido; caso contrário, FALSE.

Observações

No , este método é uma função virtual pura CMFCBaseTabCtrl Class. Se você derivar uma classe de CMFCBaseTabCtrl, você tem que implementar essa função.

CMFCBaseTabCtrl::SetActiveTabColor

Define a cor do plano de fundo para a guia ativa.

virtual void SetActiveTabColor(COLORREF clr);

Parâmetros

CLR
[em] Especifica a nova cor do plano de fundo.

Observações

A estrutura obtém a cor de plano de fundo padrão para guias ativas do método GetSysColor .

CMFCBaseTabCtrl::SetActiveTabTextColor

Define a cor do texto para guias ativas.

virtual void SetActiveTabTextColor(COLORREF clr);

Parâmetros

CLR
[em] Um parâmetro COLORREF que especifica a nova cor do texto.

Observações

Por padrão, a estrutura obtém a cor do texto de GetSysColor. Substitua essa cor padrão usando o SetActiveTabTextColor método.

CMFCBaseTabCtrl::SetAutoColors

Define as cores do controle de guia que a estrutura usa no modo de cor automático.

void SetAutoColors(const CArray<COLORREF,COLORREF>& arColors);

Parâmetros

arCores
[em] Uma matriz de cores RGB.

Observações

Se você fornecer uma matriz personalizada de cores, a matriz padrão de cores será ignorada. Se o parâmetro arColors estiver vazio, a estrutura será revertida para a matriz padrão de cores.

Para habilitar o modo de cor automática, use o método CMFCBaseTabCtrl::EnableAutoColor .

CMFCBaseTabCtrl::SetDockingBarWrapperRTC

Define a classe wrapper que é usada para quaisquer objetos que não são derivados da classe CDockablePane.

void SetDockingBarWrapperRTC(CRuntimeClass* pRTC);

Parâmetros

pRTC
[em] As informações da classe de tempo de execução para a nova classe wrapper.

Observações

Adicionar guias a um controle de guia usando os métodos CMFCBaseTabCtrl::AddTab e CMFCBaseTabCtrl::InsertTab. Quando você adiciona uma guia, cada controle nessa guia deve ser encaixável. Todos os objetos que não são derivados de devem ser encapsulados CDockablePane . AddTab e InsertTab crie um invólucro para esses objetos. A classe wrapper padrão é a classe CDockablePaneAdapter. O método SetDockingBarWrapperRTC permite que você altere a classe que é usada como uma classe wrapper. A classe wrapper que você fornece deve ser derivada de CDockablePaneAdapter.

CMFCBaseTabCtrl::SetDrawNoPrefix

Habilita e desabilita o processamento de caracteres de prefixo em rótulos de tabulação.

void SetDrawNoPrefix(
    BOOL bNoPrefix,
    BOOL bRedraw = TRUE);

Parâmetros

bNoPrefix
[em] TRUE se você quiser processar caracteres de prefixo; caso contrário, FALSE.

bRedesenhar
[em] TRUE se você quiser redesenhar a janela com abas; caso contrário, FALSE.

Observações

Um caractere prefixo é um caractere mnemônico que é precedido por um E comercial (&).

CMFCBaseTabCtrl::SetImageList

Define a lista de imagens de ícones para o controle de guia.

virtual BOOL SetImageList(
    UINT uiID,
    int cx = 15,
    COLORREF clrTransp = RGB(255, 0, 255));

virtual BOOL SetImageList(HIMAGELIST hImageList);

Parâmetros

uiID
[em] Um ID de recurso de bitmap. SetImageList carrega a lista de imagens deste recurso.

CX
[em] A largura de cada imagem em pixels.

clrTransp
[em] Um parâmetro COLORREF que indica a cor transparente da imagem.

hImageList
[em] Um identificador para uma lista de imagens pré-carregadas.

Valor de retorno

Diferente de zero se o método foi bem-sucedido; 0 caso contrário.

Observações

As imagens da lista de imagens de ícones são exibidas ao lado dos rótulos da guia. Para exibir um ícone, você deve especificar seu índice ao chamar CMFCBaseTabCtrl::AddTab.

SetImageList falhará se o controle tab tiver sido criado com um estilo simples. Ele também falhará se a estrutura não puder carregar a imagem indicada pelo uiID.

Este método recalcula a altura da guia de acordo com os tamanhos de imagem e texto.

CMFCBaseTabCtrl::SetLocation

virtual void SetLocation(Location location);

Parâmetros

[em] Localização

Observações

CMFCBaseTabCtrl::SetTabBkColor

Define a cor do plano de fundo para a guia especificada.

virtual BOOL SetTabBkColor(
    int iTab,
    COLORREF color = (COLORREF)-1);

Parâmetros

iTab
[em] O índice baseado em zero da guia.

cor
[em] A cor a definir.

Valor de retorno

VERDADEIRO se bem sucedido; FALSO caso contrário.

CMFCBaseTabCtrl::SetTabBorderSize

Define um novo tamanho de borda para o controle de guia.

virtual void SetTabBorderSize(
    int nTabBorderSize,
    BOOL bRepaint = TRUE);

Parâmetros

nTabBorderSize
[em] O novo tamanho da borda, em pixels.

bRepintar
[em] Um parâmetro booleano que indica se a estrutura redesenha o controle.

CMFCBaseTabCtrl::SetTabHicon

Define o ícone de um rótulo de guia.

virtual BOOL SetTabHicon(
    int iTab,
    HICON hIcon);

Parâmetros

iTab
[em] O índice baseado em zero de uma guia. Este método altera o ícone para este separador.

hIcon
[em] Um identificador para um ícone.

Valor de retorno

VERDADEIRO se bem sucedido; caso contrário, FALSE.

CMFCBaseTabCtrl::SetTabIcon

Define o ícone de uma guia.

virtual BOOL SetTabIcon(
    int iTab,
    UINT uiIcon);

Parâmetros

iTab
[em] O índice baseado em zero da guia a ser atualizada.

uiIcon
[em] O ID do ícone para o novo ícone. Essa ID faz referência ao objeto CImageList interno.

Valor de retorno

VERDADEIRO se bem sucedido; caso contrário, FALSE.

CMFCBaseTabCtrl::SetTabIconOnly

Permite exibir apenas um ícone (e nenhum rótulo de texto) em uma guia específica.

virtual BOOL SetTabIconOnly(
    int iTab,
    BOOL bIconOnly = TRUE,
    BOOL bShowTooltipAlways = FALSE);

Parâmetros

iTab
[em] O índice baseado em zero da guia a ser alterada.

bIconOnly
[em] Um parâmetro booleano que determina se os ícones devem ser exibidos.

bShowTooltipSempre
[em] Um parâmetro booleano que determina se a estrutura mostra dicas de ferramentas para um rótulo de guia que exibe apenas ícones.

Valor de retorno

VERDADEIRO se bem sucedido; caso contrário, FALSE.

Observações

Por padrão, um controle de guia exibe o ícone e o rótulo de texto para cada guia.

CMFCBaseTabCtrl::SetTabLabel

Define o texto para um rótulo de guia.

virtual BOOL SetTabLabel(
    int iTab,
    const CString& strLabel);

Parâmetros

iTab
[em] O índice baseado em zero da guia a ser atualizada.

strLabel [en]
[em] Uma referência a uma cadeia de caracteres que contém o novo texto para o rótulo da guia.

Valor de retorno

Diferente de zero se for bem-sucedido; 0 caso contrário.

CMFCBaseTabCtrl::SetTabsHeight

virtual void SetTabsHeight();

Observações

CMFCBaseTabCtrl::SetTabsOrder

Organiza as guias na ordem especificada.

BOOL SetTabsOrder(const CArray<int,int>& arOrder);

Parâmetros

arOrdem
[em] Uma matriz de índices baseados em zero que define a nova ordem de tabulação.

Valor de retorno

VERDADEIRO se bem sucedido; FALHAR caso contrário.

Observações

O tamanho da matriz arOrder deve ser igual ao número de guias no controle de guia.

CMFCBaseTabCtrl::SetTabTextColor

Define a cor do texto para uma guia específica.

virtual BOOL SetTabTextColor(
    int iTab,
    COLORREF color = (COLORREF)-1);

Parâmetros

iTab
[em] O índice baseado em zero da guia.

cor
[em] Um parâmetro COLORREF que indica a nova cor do texto.

Valor de retorno

Diferente de zero se for bem-sucedido; 0 caso contrário.

CMFCBaseTabCtrl::ShowTab

Mostra ou oculta a guia especificada.

virtual BOOL ShowTab(
    int iTab,
    BOOL bShow = TRUE,
    BOOL bRecalcLayout = TRUE,
    BOOL bActivate = FALSE);

Parâmetros

iTab
[em] O índice da guia que ShowTab mostrará ou ocultará.

bMostrar
[em] Um parâmetro booleano que indica se a guia deve ser mostrada.

bRecalcLayout
[em] Um parâmetro booleano que indica se o layout da janela deve ser recalculado imediatamente.

bAtivar
[em] Um parâmetro booleano que indica se a guia especificada pelo iTab deve ser selecionada.

Valor de retorno

Diferente de zero se for bem-sucedido; caso contrário, 0.

Observações

O parâmetro bActivate só se aplica se bShow for TRUE. Se bActivate for TRUE e se ShowTab for bem-sucedido, ShowTab enviará a mensagem AFX_WM_CHANGE_ATIVE_TAB para o pai da janela da guia.

CMFCBaseTabCtrl::StartRenameTab

virtual BOOL StartRenameTab(int iTab);

Parâmetros

[em] iTab

Valor de retorno

Observações

CMFCBaseTabCtrl::SwapTabs

virtual void SwapTabs(
    int nFisrtTabID,
    int nSecondTabID);

Parâmetros

[em] nFisrtTabID

[em] nSecondTabID

Observações

Ver também

Gráfico de Hierarquia
Aulas
Classe CMFCTabCtrl
Classe CMFCOutlookBarTabCtrl