Classe CMFCBaseTabCtrl

Artigo
01/10/2024

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

Sintaxe

class CMFCBaseTabCtrl : public CWnd

Membros

Métodos públicos

Nome	Descrição
CMFCBaseTabCtrl::AddIcon
CMFCBaseTabCtrl::AddTab	Adiciona uma nova guia a uma janela com guias.
CMFCBaseTabCtrl::ApplyRestoredTabInfo
CMFCBaseTabCtrl::AutoDestroyWindow
CMFCBaseTabCtrl::CalcRectEdit
CMFCBaseTabCtrl::CleanUp
CMFCBaseTabCtrl::ClearImageList
CMFCBaseTabCtrl::DetachTab	Desanexa uma guia de uma janela com guias.
CMFCBaseTabCtrl::EnableActivateLastActive
CMFCBaseTabCtrl::EnableAutoColor	Habilita ou desabilita a coloração automática de guia.
CMFCBaseTabCtrl::EnableCustomToolTips	Habilita ou desabilita dicas de ferramentas personalizadas para guias.
CMFCBaseTabCtrl::EnableInPlaceEdit	Habilita ou desabilita a edição direta de rótulos de guia.
CMFCBaseTabCtrl::EnableTabDetach	Habilita guias desanexáveis.
CMFCBaseTabCtrl::EnableTabSwap	Habilita ou desabilita se o usuário pode alterar a ordem de tabulação usando um mouse.
CMFCBaseTabCtrl::EnsureVisible	Rola as guias até que a guia especificada fique visível. Esse método não terá efeito se a guia especificada já estiver visível.
CMFCBaseTabCtrl::EnterDragMode
CMFCBaseTabCtrl::FindTargetWnd	Retorna um painel que contém um ponto especificado.
CMFCBaseTabCtrl::FireChangeActiveTab
CMFCBaseTabCtrl::FireChangingActiveTab
CMFCBaseTabCtrl::GetActiveTab	Retorna o índice da guia ativa.
CMFCBaseTabCtrl::GetActiveTabColor	Retorna a cor da tela de fundo da guia ativa.
CMFCBaseTabCtrl::GetActiveTabTextColor	Retorna a cor do texto da guia ativa.
CMFCBaseTabCtrl::GetActiveWnd	Retorna um ponteiro para a página ativa do controle guia.
CMFCBaseTabCtrl::GetAutoColors	Retorna uma referência à matriz de cores usadas para coloração automática.
CMFCBaseTabCtrl::GetFirstVisibleTab	Retorna um ponteiro para a primeira guia visível.
CMFCBaseTabCtrl::GetFirstVisibleTabNum
CMFCBaseTabCtrl::GetHighlightedTab	Retorna o índice da guia realçada no momento.
CMFCBaseTabCtrl::GetImageList
CMFCBaseTabCtrl::GetImageSize
CMFCBaseTabCtrl::GetLastVisibleTab
CMFCBaseTabCtrl::GetLocation	Retorna uma variável do tipo de dados LOCATION que indica onde a área da guia está posicionada em relação ao controle guia. Por exemplo, na parte superior ou inferior.
CMFCBaseTabCtrl::GetMaxWindowSize
CMFCBaseTabCtrl::GetTabArea	Retorna o tamanho e a posição da área da guia na janela com guias. A posição da área da guia é definida usando coordenadas.
CMFCBaseTabCtrl::GetTabBkColor	Retorna a cor da tela de fundo da guia especificada.
CMFCBaseTabCtrl::GetTabBorderSize	Retorna o tamanho das bordas da guia no controle guia.
CMFCBaseTabCtrl::GetTabByID	Retorna o índice da guia que é identificado por uma ID especificada.
CMFCBaseTabCtrl::GetTabCloseButton
CMFCBaseTabCtrl::GetTabFromHwnd	Retorna o índice de uma guia que contém um objeto HWND especificado.
CMFCBaseTabCtrl::GetTabFromPoint	Recupera a guia que contém um ponto especificado.
CMFCBaseTabCtrl::GetTabFullWidth
CMFCBaseTabCtrl::GetTabHicon	Retorna o ícone associado à guia especificada.
CMFCBaseTabCtrl::GetTabID	Retorna a ID de uma guia usando o índice da guia.
CMFCBaseTabCtrl::GetTabIcon	Retorna a ID do ícone de uma guia especificada.
CMFCBaseTabCtrl::GetTabLabel	Retorna o texto de uma guia especificada.
CMFCBaseTabCtrl::GetTabRect	Recupera o tamanho e a posição de uma guia especificada.
CMFCBaseTabCtrl::GetTabsHeight
CMFCBaseTabCtrl::GetTabsRect
CMFCBaseTabCtrl::GetTabTextColor	Retorna a cor do texto de uma guia especificada.
CMFCBaseTabCtrl::GetTabWnd	Retorna o ponteiro para um painel que reside em uma página da guia especificada.
CMFCBaseTabCtrl::GetTabWndNoWrapper	Retorna o ponteiro direto para um controle que reside em uma página da guia especificada, mesmo se o controle tiver um wrapper.
CMFCBaseTabCtrl::GetTabsNum	Retorna o número de guias contidas no controle guia.
CMFCBaseTabCtrl::GetToolTipCtrl	Retorna uma referência ao controle de dica de ferramenta associado ao objeto `CMFCBaseTabCtrl`.
CMFCBaseTabCtrl::GetVisibleTabsNum	Retorna o número de guias visíveis.
CMFCBaseTabCtrl::HasImage
CMFCBaseTabCtrl::HideSingleTab	Define uma opção que oculta uma guia de janela, mas somente se a janela com guias exibir apenas uma guia visível.
CMFCBaseTabCtrl::InsertTab	Insere uma nova guia.
CMFCBaseTabCtrl::InvalidateTab
CMFCBaseTabCtrl::IsActiveTabCloseButton
CMFCBaseTabCtrl::IsAutoColor	Retorna um valor que indica se uma janela com guias está no modo de cor automática.
CMFCBaseTabCtrl::IsAutoDestroyWindow
CMFCBaseTabCtrl::IsColored
CMFCBaseTabCtrl::IsDialogControl
CMFCBaseTabCtrl::IsDrawNoPrefix
CMFCBaseTabCtrl::IsFlatFrame	Retorna um valor que indica se o quadro da área da guia é simples ou 3D.
CMFCBaseTabCtrl::IsFlatTab
CMFCBaseTabCtrl::IsHideSingleTab	Retorna um valor que indica se o controle guia está configurado para ocultar uma guia, mas somente se uma janela com guias tiver apenas uma guia visível.
CMFCBaseTabCtrl::IsIconAdded
CMFCBaseTabCtrl::IsInPlaceEdit	Indica se os usuários podem modificar o rótulo em uma guia.
CMFCBaseTabCtrl::IsLeftRightRounded
CMFCBaseTabCtrl::IsMDITab
CMFCBaseTabCtrl::IsOneNoteStyle	Indica se uma janela com guias exibe guias no estilo do Microsoft OneNote.
CMFCBaseTabCtrl::IsPtInTabArea	Verifica se existe um ponto especificado na área da guia.
CMFCBaseTabCtrl::IsTabCloseButtonHighlighted
CMFCBaseTabCtrl::IsTabCloseButtonPressed
CMFCBaseTabCtrl::IsTabDetachable	Indica se uma guia é desanexável.
CMFCBaseTabCtrl::IsTabIconOnly	Indica se as guias exibem ícones, mas não rótulos.
CMFCBaseTabCtrl::IsTabSwapEnabled	Indica se o usuário pode alterar as posições das guias arrastando guias.
CMFCBaseTabCtrl::IsTabVisible	Indica se uma guia especificada está visível.
CMFCBaseTabCtrl::IsVS2005Style
CMFCBaseTabCtrl::MoveTab
CMFCBaseTabCtrl::OnChangeTabs	Chamado pela estrutura quando o número de guias é alterado.
CMFCBaseTabCtrl::OnDragEnter
CMFCBaseTabCtrl::OnDragLeave
CMFCBaseTabCtrl::OnDragOver
CMFCBaseTabCtrl::OnDrop
CMFCBaseTabCtrl::OnRenameTab
CMFCBaseTabCtrl::PreTranslateMessage	Usado pela classe CWinApp para converter mensagens de janela antes que elas sejam expedidas para as funções TranslateMessage e DispatchMessage do Windows. (Substitui CWnd::PreTranslateMessage.)
CMFCBaseTabCtrl::RecalcLayout	Recalcula o layout interno de uma janela com guias.
CMFCBaseTabCtrl::RemoveAllTabs	Remove todas as guias da janela com guias.
CMFCBaseTabCtrl::RemoveTab	Desanexa uma guia de uma janela com guias.
CMFCBaseTabCtrl::RenameTab
CMFCBaseTabCtrl::ResetImageList	Redefine a lista de imagens que está anexada a uma janela com guias.
CMFCBaseTabCtrl::Serialize	Lê ou grava esse objeto de ou em uma camada de arquivos. (Substitui CObject::Serialize.)
CMFCBaseTabCtrl::SetActiveTab	Ativa uma guia.
CMFCBaseTabCtrl::SetActiveTabColor	Define a cor da tela de fundo da guia ativa no momento.
CMFCBaseTabCtrl::SetActiveTabTextColor	Define a cor do texto para guias ativas.
CMFCBaseTabCtrl::SetAutoColors	Define as cores do controle guia aplicadas no modo de cor automática.
CMFCBaseTabCtrl::SetDockingBarWrapperRTC	Define a classe wrapper usada para todos os objetos que não são derivados da classe CDockablePane.
CMFCBaseTabCtrl::SetDrawNoPrefix	Habilita e desabilita o processamento de caracteres de prefixo quando rótulos da guia são desenhados.
CMFCBaseTabCtrl::SetImageList	Define a lista de imagens de ícone.
CMFCBaseTabCtrl::SetLocation
CMFCBaseTabCtrl::SetTabBkColor	Define a cor da tela de fundo para uma guia especificada.
CMFCBaseTabCtrl::SetTabBorderSize	Define um novo tamanho da borda da guia.
CMFCBaseTabCtrl::SetTabHicon	Define um ícone de guia.
CMFCBaseTabCtrl::SetTabIcon	Define uma ID do ícone de guia.
CMFCBaseTabCtrl::SetTabIconOnly	Habilita e desabilita o modo "somente ícone" para uma guia especificada.
CMFCBaseTabCtrl::SetTabLabel	Define um rótulo de guia igual a um valor de cadeia de caracteres especificado.
CMFCBaseTabCtrl::SetTabsHeight
CMFCBaseTabCtrl::SetTabTextColor	Define a cor do texto para uma guia especificada.
CMFCBaseTabCtrl::SetTabsOrder	Organiza as guias na ordem especificada.
CMFCBaseTabCtrl::ShowTab	Mostra ou oculta a guia especificada.
CMFCBaseTabCtrl::StartRenameTab
CMFCBaseTabCtrl::SwapTabs

Métodos protegidos

Nome	Descrição
CMFCBaseTabCtrl::CreateWrapper	Cria um wrapper para um objeto derivado de CWnd que não é derivado de `CDockablePane`. Para encaixar um objeto `CMFCBaseTabCtrl`, cada controle inserido deve ter um wrapper de encaixe ou ser derivado de `CDockablePane`. Você define a classe do wrapper usando `SetDockingBayWrapperRTC`.

Membros de dados

Nome	Descrição
CMFCBaseTabCtrl::m_bActivateTabOnRightClick	Especifica se as guias são selecionadas usando um clique com o botão esquerdo ou com o botão direito do mouse.
CMFCBaseTabCtrl::m_bAutoDestroyWindow	Especifica se os painéis que estão contidos nas guias são destruídos automaticamente.

Comentários

A classe CMFCBaseTabCtrl é uma classe abstrata. Portanto, ela não pode ser instanciada. Para criar uma janela com guias, você deve derivar uma classe de CMFCBaseTabCtrl. A biblioteca MFC contém alguns exemplos de classe derivadas, sendo que dois são da classe CMFCTabCtrl e da classe CMFCOutlookBarTabCtrl.

A partir do Visual Studio 2015, essa classe dá suporte à Microsoft Active Accessibility.

Dias de personalização

As seguintes dicas de personalização dizem respeito a CMFCBaseTabCtrl Class e a todas as classes que herdam dela:

Se você habilitar guias desanexáveis, não mantenha ponteiros para as janelas com guia. Essas guias desanexáveis podem ser criadas e destruídas dinamicamente. Portanto, os ponteiros podem se tornar inválidos.
Você pode configurar o controle guia para que os usuários possam mover guias dinamicamente em um controle guia usando o mouse. Essa funcionalidade é integrada à CMFCBaseTabCtrl classe. Para habilitá-la, chame CMFCBaseTabCtrl::EnableTabSwap.
Por padrão, as guias são desanexáveis quando você as adiciona a um controle 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á desanexável. Você também pode alterar se as guias são desanexáveis chamando o método CMFCBaseTabCtrl::EnableTabDetach.
Objetos derivados da Classe CWnd podem ser colocados em uma barra de controle ou guia encaixável. Para que todo o controle seja encaixado, é necessário tornar o objeto CWnd encaixável. Para realizar isso, o MFC usa uma classe wrapper. Essa classe wrapper é a classe CDockablePaneAdapter. Todos os objetos CWnd adicionados a uma barra de controle ou guia encaixável serão encapsulados dentro de um objeto CDockablePaneAdapter. Você pode desabilitar o encapsulamento automático definindo o parâmetro m_bEnableWrapping do objeto CMFCBaseTablCtrl como FALSE. Também é possível alterar a classe que seu aplicativo usará como um wrapper usando o método CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Hierarquia de herança

Requisitos

Cabeçalho: afxbasetabctrl.h

CMFCBaseTabCtrl::AddIcon

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

void AddIcon(
    HICON hIcon,
    int iIcon);

Parâmetros

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

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

Comentários

CMFCBaseTabCtrl::AddTab

Adiciona uma nova guia ao controle 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
[in] Um ponteiro para a janela que esse método representa como uma nova guia.

lpszTabLabel
[in] Uma cadeia de caracteres que contém o rótulo para a nova guia.

uiImageId
[in] Uma ID da imagem da lista de imagens. O controle guia usa essa imagem como o ícone da nova guia.

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

bDetachable
[in] Um parâmetro booliano que determina se a nova guia é desanexável.

Comentários

Se pTabWnd apontar para um objeto que não seja 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 desanexá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

[in] bUseTabIndexes

Comentários

CMFCBaseTabCtrl::AutoDestroyWindow

void AutoDestroyWindow(BOOL bAutoDestroy = TRUE);

Parâmetros

[in] bAutoDestroy

Comentários

CMFCBaseTabCtrl::CalcRectEdit

virtual void CalcRectEdit(CRect& rectEdit);

Parâmetros

[in] rectEdit

Comentários

CMFCBaseTabCtrl::CleanUp

virtual void CleanUp();

Comentários

CMFCBaseTabCtrl::ClearImageList

virtual void ClearImageList();

Comentários

CMFCBaseTabCtrl::CreateWrapper

Cria um wrapper para uma janela com moldura derivada da classe CWnd, mas não derivada da classe CDockablePane.

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

Parâmetros

pWndToWrap
[in] Um ponteiro para a janela com moldura que está encapsulada.

lpszTabLabel
[in] Uma cadeia de caracteres que contém o rótulo para a janela.

bDetachable
[in] Um parâmetro booliano que indica se a janela é desanexável.

Valor de retorno

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

Comentários

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

Por padrã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::DetachTab

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

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

Parâmetros

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

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

bHide
[in] Um parâmetro booliano que indica se a estrutura deve ocultar a guia desanexada.

Valor de retorno

Diferente de zero se tiver êxito; caso contrário, 0.

Comentários

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

CMFCBaseTabCtrl::EnableActivateLastActive

void EnableActivateLastActive(BOOL bLastActive = TRUE);

Parâmetros

[in] bLastActive

Comentários

CMFCBaseTabCtrl::EnableAutoColor

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

void EnableAutoColor(BOOL bEnable = TRUE);

Parâmetros

bEnable
[in] Um parâmetro booliano que determina se a estrutura usa cores automáticas.

Comentários

Um controle guia tem uma matriz de várias cores predefinidas. Quando a estrutura usa cores automáticas, cada guia em uma série de guias é atribuída com 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

Habilita dicas de ferramentas personalizadas para o controle guia.

BOOL EnableCustomToolTips(BOOL bEnable = TRUE);

Parâmetros

bEnable
[in] Um booliano que determina se as dicas de ferramentas personalizadas devem ser usadas.

Valor de retorno

TRUE se tiver êxito; caso contrário, FALSE.

Comentários

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

CMFCBaseTabCtrl::EnableInPlaceEdit

Habilita a edição direta dos rótulos da guia pelo usuário.

virtual void EnableInPlaceEdit(BOOL bEnable) = 0;

Parâmetros

bEnable
[in] Um parâmetro booliano que especifica se a edição direta dos rótulos da guia deve ser habilitada.

Comentários

Por padrão, a edição direta dos rótulos da guia é desabilitada para controles guia.

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

Na CMFCBaseTabCtrl Class, esse método é uma função virtual pura e não tem implementação. Se você derivar uma classe de CMFCBaseTabCtrl, será necessário implementar essa função.

CMFCBaseTabCtrl::EnableTabDetach

Habilita guias desanexáveis.

virtual BOOL EnableTabDetach(
    int iTab,
    BOOL bEnable);

Parâmetros

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

bEnable
[in] Um booliano que indica se a guia deve ser tornada desanexável.

Valor de retorno

TRUE se tiver êxito; 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

bEnable
[in] Um booliano que indica se a troca de guias deve ser habilitada.

Comentários

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

CMFCBaseTabCtrl::EnsureVisible

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

virtual BOOL EnsureVisible(int iTab);

Parâmetros

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

Valor de retorno

Diferente de zero se tiver êxito; caso contrário, 0.

Comentários

Esse método não terá efeito se a guia indicada por iTab já estiver visível.

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

CMFCBaseTabCtrl::EnterDragMode

void EnterDragMode();

Comentários

CMFCBaseTabCtrl::FindTargetWnd

Identifica um painel que contém um ponto especificado.

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

Parâmetros

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

Valor de retorno

Um ponteiro para um objeto CWnd se tiver êxito; caso contrário, NULL.

Comentários

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

CMFCBaseTabCtrl::FireChangeActiveTab

virtual void FireChangeActiveTab(int nNewTab);

Parâmetros

[in] nNewTab

Comentários

CMFCBaseTabCtrl::FireChangingActiveTab

virtual BOOL FireChangingActiveTab(int nNewTab);

Parâmetros

[in] nNewTab

Valor de retorno

Comentários

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 da tela de fundo da guia ativa no momento.

virtual COLORREF GetActiveTabColor() const;

Valor de retorno

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

Comentários

Por padrão, a cor da tela de fundo da guia ativa é COLOR_WINDOW. Você pode alterar a cor da tela 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 da tela de fundo da guia ativa.

Comentários

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 com 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.

Comentários

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

Retorna um ponteiro para a primeira guia visível.

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

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

Parâmetros

iTabNum
[out] Uma referência a um inteiro. Esse método grava o índice baseado em zero da primeira guia visível nesse parâmetro.

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

Valor de retorno

Um ponteiro para a primeira guia visível se tiver êxito; caso contrário, NULL.

Comentários

Se esse método falhar, ele gravará o valor -1 em iStartFrom.

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

CMFCBaseTabCtrl::GetFirstVisibleTabNum

virtual int GetFirstVisibleTabNum() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetHighlightedTab

Recupera o índice da guia realçada no momento.

int GetHighlightedTab() const;

Valor de retorno

Especifica o índice baseado em zero da guia realçada.

CMFCBaseTabCtrl::GetImageList

virtual const CImageList* GetImageList() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetImageSize

virtual CSize GetImageSize() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetLastVisibleTab

virtual CWnd* GetLastVisibleTab(int& iTabNum);

Parâmetros

[in] iTabNum

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetLocation

Recupera a localização da parte da área da guia do controle guia.

Location GetLocation() const;

Valor de retorno

A localização da área da guia.

Comentários

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

Comentários

CMFCBaseTabCtrl::GetTabArea

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

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

Parâmetros

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

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

Comentários

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

Na CMFCBaseTabCtrl Class, esse método é uma função virtual pura e não tem implementação. Se você derivar uma classe de CMFCBaseTabCtrl, será necessário implementar essa função.

CMFCBaseTabCtrl::GetTabBkColor

Recupera a cor da tela de fundo da guia especificada.

virtual COLORREF GetTabBkColor(int iTab) const;

Parâmetros

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

Valor de retorno

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

CMFCBaseTabCtrl::GetTabBorderSize

Recupera o tamanho das bordas da guia no controle guia.

virtual int GetTabBorderSize() const;

Valor de retorno

O tamanho da borda da guia, em pixels.

Comentários

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

CMFCBaseTabCtrl::GetTabByID

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

virtual int GetTabByID(int id) const;

Parâmetros

id
[in] Uma ID da guia.

Valor de retorno

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

Comentários

As IDs da guia são atribuídas automaticamente quando guias são adicionadas a um controle guia.

CMFCBaseTabCtrl::GetTabCloseButton

CRect GetTabCloseButton() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetTabFromHwnd

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

virtual int GetTabFromHwnd(HWND hwnd) const;

Parâmetros

hwnd
[in] O identificador para uma janela.

Valor de retorno

O índice baseado em zero da guia, se tiver êxito; -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
[in] Um ponto nas coordenadas de cliente do controle 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

[in] iTab

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetTabHicon

Retorna o HICON associado à guia especificada.

virtual HICON GetTabHicon(int iTab) const;

Parâmetros

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

Valor de retorno

O HICON associado a um rótulo de guia, se tiver êxito; 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
[in] O índice baseado em zero da guia.

Valor de retorno

A ID do ícone da guia especificada, se tiver êxito; -1 se o índice for inválido.

Comentários

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

CMFCBaseTabCtrl::GetTabID

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

int GetTabID(int iTab) const;

Parâmetros

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

Valor de retorno

Uma ID da guia ou -1 se 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
[in] O índice baseado em zero da guia.

strLabel
[out] Uma referência a um objeto CString. Esse método armazena o rótulo da guia nesse parâmetro.

Valor de retorno

TRUE se tiver êxito; FALSE caso contrário.

Comentários

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

Você define o rótulo para uma guia ao criar 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 de uma guia especificada.

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

Parâmetros

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

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

Valor de retorno

TRUE se tiver êxito; FALSE se o índice de guias for inválido.

CMFCBaseTabCtrl::GetTabsHeight

virtual int GetTabsHeight() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetTabsNum

Recupera o número de guias no controle guia.

virtual int GetTabsNum() const;

Valor de retorno

O número de guias no controle guia.

CMFCBaseTabCtrl::GetTabsRect

virtual void GetTabsRect(CRect& rect) const;

Parâmetros

[in] rect

Comentários

CMFCBaseTabCtrl::GetTabTextColor

Recupera a cor do texto para a guia especificada.

virtual COLORREF GetTabTextColor(int iTab) const;

Parâmetros

iTab
[in] 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 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
[in] O índice baseado em zero de uma guia.

Valor de retorno

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

Comentários

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 do objeto. Para saber mais sobre wrappers, confira 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
[in] O índice baseado em zero de uma guia.

Valor de retorno

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

Comentários

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

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

CMFCBaseTabCtrl::GetToolTipCtrl

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

CToolTipCtrl& GetToolTipCtrl() const;

Valor de retorno

Uma referência para o 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 guias visíveis.

CMFCBaseTabCtrl::HasImage

virtual BOOL HasImage(int iTab) const;

Parâmetros

[in] iTab

Valor de retorno

Comentários

CMFCBaseTabCtrl::HideSingleTab

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

virtual void HideSingleTab(BOOL bHide = TRUE);

Parâmetros

bHide
[in] Um booliano que especifica se o ocultamento de guias individuais deve ser habilitado.

Comentários

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

CMFCBaseTabCtrl::InsertTab

Insere uma guia no controle 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
[in] Um ponteiro para a janela que esse método adiciona como uma nova guia.

lpszTabLabel
[in] Uma cadeia de caracteres que contém o rótulo para a nova guia.

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

uiImageId
[in] Uma ID da imagem da lista de imagens. O controle guia usa essa imagem como o ícone da nova guia.

bDetachable
[in] Um parâmetro booliano que determina se a nova guia é desanexável.

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

Comentários

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 wrapper diferente. Qualquer classe wrapper personalizada precisa ser derivada de CDockablePaneAdapter.

CMFCBaseTabCtrl::InvalidateTab

void InvalidateTab(int iTab);

Parâmetros

[in] iTab

Comentários

CMFCBaseTabCtrl::IsActiveTabCloseButton

virtual BOOL IsActiveTabCloseButton() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::IsAutoColor

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

BOOL IsAutoColor() const;

Valor de retorno

TRUE se o controle guia estiver no modo de cor automática; FALSE caso contrário.

Comentários

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

Comentários

CMFCBaseTabCtrl::IsColored

virtual BOOL IsColored() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::IsDialogControl

BOOL IsDialogControl() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::IsDrawNoPrefix

BOOL IsDrawNoPrefix() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::IsFlatFrame

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

virtual BOOL IsFlatFrame() const;

Valor de retorno

TRUE se o quadro do controle guia for renderizado em um estilo plano; FALSE se o quadro for renderizado em um estilo 3D.

Comentários

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

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

CMFCBaseTabCtrl::IsFlatTab

virtual BOOL IsFlatTab() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::IsHideSingleTab

Determina se o controle guia ocultará o rótulo da guia se houver apenas uma guia.

virtual BOOL IsHideSingleTab() const;

Valor de retorno

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

Comentários

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

CMFCBaseTabCtrl::IsIconAdded

BOOL IsIconAdded(
    HICON hIcon,
    int& iIcon);

Parâmetros

[in] hIcon

[in] iIcon

Valor de retorno

Comentários

CMFCBaseTabCtrl::IsInPlaceEdit

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

virtual BOOL IsInPlaceEdit() const;

Valor de retorno

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

Comentários

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

Comentários

CMFCBaseTabCtrl::IsMDITab

BOOL IsMDITab() const;

Valor de retorno

Comentários

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.

Comentários

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, não há suporte para o estilo do Microsoft OneNote em uma classe personalizada derivada de CMFCBaseTabCtrl Class. No entanto, há suporte na classe CMFCTabCtrl.

CMFCBaseTabCtrl::IsPtInTabArea

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

virtual BOOL IsPtInTabArea(CPoint point) const = 0;

Parâmetros

point
[in] O ponto a ser testado.

Valor de retorno

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

Comentários

Na CMFCBaseTabCtrl Class, esse método é uma função virtual pura e não tem implementação. Se você derivar uma classe de CMFCBaseTabCtrl, será necessário implementar essa função.

CMFCBaseTabCtrl::IsTabCloseButtonHighlighted

BOOL IsTabCloseButtonHighlighted() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::IsTabCloseButtonPressed

BOOL IsTabCloseButtonPressed() const;

Valor de retorno

Comentários

CMFCBaseTabCtrl::IsTabDetachable

Determina se uma guia é desanexável.

virtual BOOL IsTabDetachable(int iTab) const;

Parâmetros

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

Valor de retorno

TRUE se a guia for desanexável; FALSE caso contrário.

Comentários

Para tornar uma guia desanexá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
[in] O índice baseado em zero da guia.

Valor de retorno

TRUE se um rótulo de guia tiver apenas ícones; FALSE caso contrário.

Comentários

Para definir que as guias no aplicativo exibam apenas ícones, chame o método CMFCBaseTabCtrl::SetTabIconOnly.

CMFCBaseTabCtrl::IsTabSwapEnabled

Determina se o controle guia 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 da guia puderem ser alteradas pelo usuário; caso contrário, 0.

Comentários

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

CMFCBaseTabCtrl::IsTabVisible

Indica se uma guia especificada está visível.

virtual BOOL IsTabVisible(int iTab) const;

Parâmetros

iTab
[in] 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

Comentários

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;

Comentários

O valor padrão desse membro de dados é FALSE.

CMFCBaseTabCtrl::m_bAutoDestroyWindow

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

BOOL m_bAutoDestroyWindow;

Comentários

Por padrão, esse membro é definido como FALSE.

CMFCBaseTabCtrl::MoveTab

virtual void MoveTab(
    int nSource,
    int nDest);

Parâmetros

[in] nSource

[in] nDest

Comentários

CMFCBaseTabCtrl::OnChangeTabs

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

virtual void OnChangeTabs();

Comentários

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 guia for alterado.

CMFCBaseTabCtrl::OnDrop

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

Parâmetros

[in] COleDataObject*

[in] DROPEFFECT

[in] CPoint

Valor de retorno

Comentários

CMFCBaseTabCtrl::OnDragOver

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

Parâmetros

[in] COleDataObject*

[in] DWORD

[in] CPoint

Valor de retorno

Comentários

CMFCBaseTabCtrl::OnDragLeave

virtual void OnDragLeave();

Comentários

CMFCBaseTabCtrl::OnDragEnter

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

Parâmetros

[in] COleDataObject*

[in] DWORD

[in] CPoint

Valor de retorno

Comentários

CMFCBaseTabCtrl::OnRenameTab

virtual BOOL OnRenameTab(int, CString&);

Parâmetros

[in] int

[in] CString&

Valor de retorno

Comentários

CMFCBaseTabCtrl::PreTranslateMessage

virtual BOOL PreTranslateMessage(MSG* pMsg);

Parâmetros

[in] pMsg

Valor de retorno

Comentários

CMFCBaseTabCtrl::RecalcLayout

Recalcula o layout interno do controle guia.

virtual void RecalcLayout() = 0;

Comentários

Na CMFCBaseTabCtrl Class, esse método é uma função virtual pura. Se você derivar uma classe de CMFCBaseTabCtrl, será necessário implementar essa função.

CMFCBaseTabCtrl::RemoveAllTabs

Remove todas as guias do controle guia.

virtual void RemoveAllTabs();

Comentários

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

CMFCBaseTabCtrl::RemoveTab

Remove uma guia do controle tab.

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

Parâmetros

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

bRecalcLayout
[in] Um parâmetro booliano 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.

Comentários

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

CMFCBaseTabCtrl::RenameTab

virtual BOOL RenameTab();

Valor de retorno

Comentários

CMFCBaseTabCtrl::ResetImageList

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

void ResetImageList();

CMFCBaseTabCtrl::Serialize

virtual void Serialize(CArchive& ar);

Parâmetros

[in] ar

Comentários

CMFCBaseTabCtrl::SetActiveTab

Ativa a guia especificada.

virtual BOOL SetActiveTab(int iTab) = 0;

Parâmetros

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

Valor de retorno

TRUE se tiver êxito; caso contrário, FALSE.

Comentários

Na CMFCBaseTabCtrl Class, esse método é uma função virtual pura. Se você derivar uma classe de CMFCBaseTabCtrl, será necessário implementar essa função.

CMFCBaseTabCtrl::SetActiveTabColor

Define a cor da tela de fundo da guia ativa.

virtual void SetActiveTabColor(COLORREF clr);

Parâmetros

clr
[in] Especifica a nova cor da tela de fundo.

Comentários

A estrutura obtém a cor da tela de fundo padrão para guias ativas pelo método GetSysColor.

CMFCBaseTabCtrl::SetActiveTabTextColor

Define a cor do texto para guias ativas.

virtual void SetActiveTabTextColor(COLORREF clr);

Parâmetros

clr
[in] Um parâmetro COLORREF que especifica a nova cor do texto.

Comentários

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

CMFCBaseTabCtrl::SetAutoColors

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

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

Parâmetros

arColors
[in] Uma matriz de cores RGB.

Comentários

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 usada para todos os objetos que não são derivados da classe CDockablePane.

void SetDockingBarWrapperRTC(CRuntimeClass* pRTC);

Parâmetros

pRTC
[in] As informações de classe de runtime para a nova classe wrapper.

Comentários

Adicione guias a um controle 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 CDockablePane devem ser encapsulados. AddTab e InsertTab criam um wrapper para esses objetos. Essa classe wrapper padrão é a classe CDockablePaneAdapter. O método SetDockingBarWrapperRTC permite a você alterar a classe 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 da guia.

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

Parâmetros

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

bRedraw
[in] TRUE se você quiser redesenhar a janela com guias; caso contrário, FALSE.

Comentários

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

CMFCBaseTabCtrl::SetImageList

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

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

virtual BOOL SetImageList(HIMAGELIST hImageList);

Parâmetros

uiID
[in] O ID do recurso de um bitmap. SetImageList carrega a lista de imagens desse recurso.

cx
[in] A largura de cada imagem em pixels.

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

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

Valor de retorno

Diferente de zero se o método tiver êxito; 0, caso contrário.

Comentários

As imagens da lista de imagens de ícone são exibidas junto com os rótulos da guia. Para exibir um ícone, você deve especificar seu índice quando chamar CMFCBaseTabCtrl::AddTab.

SetImageList falhará se o controle guia foi criado com um estilo plano. Também falhará se a estrutura não puder carregar a imagem indicada por uiID.

Esse 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

[in] location

Comentários

CMFCBaseTabCtrl::SetTabBkColor

Define a cor da tela de fundo para a guia especificada.

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

Parâmetros

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

color
[in] A cor a ser definida.

Valor de retorno

TRUE se tiver êxito; FALSE caso contrário.

CMFCBaseTabCtrl::SetTabBorderSize

Define um novo tamanho da borda para o controle guia.

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

Parâmetros

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

bRepaint
[in] Um parâmetro booliano que indica se a estrutura redesenha o controle.

CMFCBaseTabCtrl::SetTabHicon

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

virtual BOOL SetTabHicon(
    int iTab,
    HICON hIcon);

Parâmetros

iTab
[in] O índice baseado em zero de uma guia. Esse método altera o ícone dessa guia.

hIcon
[in] Um identificador para um ícone.

Valor de retorno

TRUE se tiver êxito; caso contrário, FALSE.

CMFCBaseTabCtrl::SetTabIcon

Define o ícone para uma guia.

virtual BOOL SetTabIcon(
    int iTab,
    UINT uiIcon);

Parâmetros

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

uiIcon
[in] A ID do ícone para o novo ícone. Essa ID referencia o objeto CImageList interno.

Valor de retorno

TRUE se tiver êxito; 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
[in] O índice baseado em zero da guia a ser alterada.

bIconOnly
[in] Um parâmetro booliano que determina se somente os ícones devem ser exibidos.

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

Valor de retorno

TRUE se tiver êxito; caso contrário, FALSE.

Comentários

Por padrão, um controle 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
[in] O índice baseado em zero da guia a ser atualizada.

strLabel
[in] 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 tiver êxito; caso contrário, 0.

CMFCBaseTabCtrl::SetTabsHeight

virtual void SetTabsHeight();

Comentários

CMFCBaseTabCtrl::SetTabsOrder

Organiza as guias na ordem especificada.

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

Parâmetros

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

Valor de retorno

TRUE se tiver êxito; FAIL caso contrário.

Comentários

O tamanho da matriz arOrder deve ser igual ao número de guias no controle 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
[in] O índice baseado em zero da guia.

color
[in] Um parâmetro COLORREF que especifica a nova cor do texto.

Valor de retorno

Diferente de zero se tiver êxito; caso contrário, 0.

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
[in] O índice da guia que ShowTab mostrará ou ocultará.

bShow
[in] Um parâmetro booliano que indica se a guia deve ser exibida.

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

bActivate
[in] Um parâmetro booliano que indica se a guia especificada por iTab deve ser selecionada.

Valor de retorno

Diferente de zero se tiver êxito; caso contrário, 0.

Comentários

O parâmetro bActivate será aplicável somente se bShow for TRUE. Se bActivate for TRUE e se ShowTab for bem-sucedido, ShowTab enviará a mensagem AFX_WM_CHANGE_ACTIVE_TAB ao pai da janela com guia.

CMFCBaseTabCtrl::StartRenameTab

virtual BOOL StartRenameTab(int iTab);

Parâmetros

[in] iTab

Valor de retorno

Comentários

CMFCBaseTabCtrl::SwapTabs

virtual void SwapTabs(
    int nFisrtTabID,
    int nSecondTabID);

Parâmetros

[in] nFisrtTabID

[in] nSecondTabID

Comentários

Confira também

Gráfico da hierarquia
Classes
Classe CMFCTabCtrl
Classe CMFCOutlookBarTabCtrl

Share via

Classe CMFCBaseTabCtrl

Sintaxe

Membros

Métodos públicos

Métodos protegidos

Membros de dados

Comentários

Dias de personalização

Hierarquia de herança

Requisitos

CMFCBaseTabCtrl::AddIcon

Parâmetros

Comentários

CMFCBaseTabCtrl::AddTab

Parâmetros

Comentários

CMFCBaseTabCtrl::ApplyRestoredTabInfo

Parâmetros

Comentários

CMFCBaseTabCtrl::AutoDestroyWindow

Parâmetros

Comentários

CMFCBaseTabCtrl::CalcRectEdit

Parâmetros

Comentários

CMFCBaseTabCtrl::CleanUp

Comentários

CMFCBaseTabCtrl::ClearImageList

Comentários

CMFCBaseTabCtrl::CreateWrapper

Parâmetros

Valor de retorno

Comentários

CMFCBaseTabCtrl::DetachTab

Parâmetros

Valor de retorno

Comentários

CMFCBaseTabCtrl::EnableActivateLastActive

Parâmetros

Comentários

CMFCBaseTabCtrl::EnableAutoColor

Parâmetros

Comentários

CMFCBaseTabCtrl::EnableCustomToolTips

Parâmetros

Valor de retorno

Comentários

CMFCBaseTabCtrl::EnableInPlaceEdit

Parâmetros

Comentários

CMFCBaseTabCtrl::EnableTabDetach

Parâmetros

Valor de retorno

CMFCBaseTabCtrl::EnableTabSwap

Parâmetros

Comentários

CMFCBaseTabCtrl::EnsureVisible

Parâmetros

Valor de retorno

Comentários

CMFCBaseTabCtrl::EnterDragMode

Comentários

CMFCBaseTabCtrl::FindTargetWnd

Parâmetros

Valor de retorno

Comentários

CMFCBaseTabCtrl::FireChangeActiveTab

Parâmetros

Comentários

CMFCBaseTabCtrl::FireChangingActiveTab

Parâmetros

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetActiveTab

Valor de retorno

CMFCBaseTabCtrl::GetActiveTabColor

Valor de retorno

Comentários

CMFCBaseTabCtrl::GetActiveTabTextColor