CMFCBaseTabCtrl (clase)

Artículo
06/16/2023

Implementa la funcionalidad básica para las ventanas con pestañas. Para obtener información más detallada, consulta el código fuente que se ubica en la carpeta VC\atlmfc\src\mfc de la instalación de Visual Studio.

Sintaxis

class CMFCBaseTabCtrl : public CWnd

Miembros

Métodos públicos

Nombre	Descripción
CMFCBaseTabCtrl::AddIcon
CMFCBaseTabCtrl::AddTab	Agrega una pestaña nueva a la ventana con pestañas.
CMFCBaseTabCtrl::ApplyRestoredTabInfo
CMFCBaseTabCtrl::AutoDestroyWindow
CMFCBaseTabCtrl::CalcRectEdit
CMFCBaseTabCtrl::CleanUp
CMFCBaseTabCtrl::ClearImageList
CMFCBaseTabCtrl::DetachTab	Desasocia una pestaña de una ventana con pestañas.
CMFCBaseTabCtrl::EnableActivateLastActive
CMFCBaseTabCtrl::EnableAutoColor	Habilita o deshabilita el coloreado automático de las pestañas.
CMFCBaseTabCtrl::EnableCustomToolTips	Habilita o deshabilita la información sobre herramientas personalizada para las pestañas.
CMFCBaseTabCtrl::EnableInPlaceEdit	Habilita o deshabilita la edición directa de etiquetas de pestaña.
CMFCBaseTabCtrl::EnableTabDetach	Habilita la capacidad de desasociar pestañas.
CMFCBaseTabCtrl::EnableTabSwap	Permite o no que el usuario cambie el orden de las pestañas con el mouse.
CMFCBaseTabCtrl::EnsureVisible	Desplaza las pestañas hasta que la pestaña especificada sea visible. Este método no tiene ningún efecto si la pestaña especificada ya es visible.
CMFCBaseTabCtrl::EnterDragMode
CMFCBaseTabCtrl::FindTargetWnd	Devuelve un panel que contiene un punto especificado.
CMFCBaseTabCtrl::FireChangeActiveTab
CMFCBaseTabCtrl::FireChangingActiveTab
CMFCBaseTabCtrl::GetActiveTab	Devuelve el índice de la pestaña activa.
CMFCBaseTabCtrl::GetActiveTabColor	Devuelve el color de fondo de la pestaña activa.
CMFCBaseTabCtrl::GetActiveTabTextColor	Devuelve el color del texto de la pestaña activa.
CMFCBaseTabCtrl::GetActiveWnd	Devuelve un puntero a la página activa del control de pestañas.
CMFCBaseTabCtrl::GetAutoColors	Devuelve una referencia a la matriz de colores que se usan para el coloreado automático.
CMFCBaseTabCtrl::GetFirstVisibleTab	Devuelve un puntero a la primera pestaña visible.
CMFCBaseTabCtrl::GetFirstVisibleTabNum
CMFCBaseTabCtrl::GetHighlightedTab	Devuelve el índice de la pestaña resaltada actualmente.
CMFCBaseTabCtrl::GetImageList
CMFCBaseTabCtrl::GetImageSize
CMFCBaseTabCtrl::GetLastVisibleTab
CMFCBaseTabCtrl::GetLocation	Devuelve una variable del tipo de datos LOCATION, que indica dónde se sitúa el área de pestañas en relación con el control de pestaña. Por ejemplo, en la parte superior o en la parte inferior.
CMFCBaseTabCtrl::GetMaxWindowSize
CMFCBaseTabCtrl::GetTabArea	Devuelve el tamaño y la posición del área de pestañas de la ventana con pestañas. La posición del área de pestañas se define con coordenadas.
CMFCBaseTabCtrl::GetTabBkColor	Devuelve el color de fondo de la pestaña especificada.
CMFCBaseTabCtrl::GetTabBorderSize	Devuelve el tamaño de los bordes de la pestaña en el control de pestaña.
CMFCBaseTabCtrl::GetTabByID	Devuelve el índice de la pestaña que se identifica con un id. especificado.
CMFCBaseTabCtrl::GetTabCloseButton
CMFCBaseTabCtrl::GetTabFromHwnd	Devuelve el índice de una pestaña que contiene un objeto HWND especificado.
CMFCBaseTabCtrl::GetTabFromPoint	Devuelve la pestaña que contiene un punto especificado.
CMFCBaseTabCtrl::GetTabFullWidth
CMFCBaseTabCtrl::GetTabHicon	Devuelve el icono asociado a la pestaña especificada.
CMFCBaseTabCtrl::GetTabID	Devuelve el id. de una pestaña con el índice de la pestaña.
CMFCBaseTabCtrl::GetTabIcon	Devuelve el id. del icono de una pestaña especificada.
CMFCBaseTabCtrl::GetTabLabel	Devuelve el texto de una pestaña especificada.
CMFCBaseTabCtrl::GetTabRect	Recupera el tamaño y la posición de una pestaña especificada.
CMFCBaseTabCtrl::GetTabsHeight
CMFCBaseTabCtrl::GetTabsRect
CMFCBaseTabCtrl::GetTabTextColor	Devuelve el color del texto de una pestaña especificada.
CMFCBaseTabCtrl::GetTabWnd	Devuelve el puntero a un panel que se encuentra en una pestaña especificada.
CMFCBaseTabCtrl::GetTabWndNoWrapper	Devuelve el puntero directo a un control que se encuentra en una pestaña especificada, incluso si el control tiene un contenedor.
CMFCBaseTabCtrl::GetTabsNum	Devuelve el número de pestañas que se encuentran en el control de pestaña.
CMFCBaseTabCtrl::GetToolTipCtrl	Devuelve una referencia al control de información sobre herramientas asociado al objeto `CMFCBaseTabCtrl` .
CMFCBaseTabCtrl::GetVisibleTabsNum	Devuelve el número de pestañas visibles.
CMFCBaseTabCtrl::HasImage
CMFCBaseTabCtrl::HideSingleTab	Establece una opción que oculta la pestaña de una ventana, pero solo si la ventana con pestañas muestra una sola pestaña visible.
CMFCBaseTabCtrl::InsertTab	Inserta una pestaña nueva.
CMFCBaseTabCtrl::InvalidateTab
CMFCBaseTabCtrl::IsActiveTabCloseButton
CMFCBaseTabCtrl::IsAutoColor	Devuelve un valor que indica si una ventana con pestañas está en modo de color automático.
CMFCBaseTabCtrl::IsAutoDestroyWindow
CMFCBaseTabCtrl::IsColored
CMFCBaseTabCtrl::IsDialogControl
CMFCBaseTabCtrl::IsDrawNoPrefix
CMFCBaseTabCtrl::IsFlatFrame	Devuelve un valor que indica si el formato del marco del área de pestañas es plano o en 3D.
CMFCBaseTabCtrl::IsFlatTab
CMFCBaseTabCtrl::IsHideSingleTab	Devuelve un valor que indica si el control de pestaña está configurado para ocultar una pestaña, pero solo si la ventana con pestañas tiene una sola pestaña visible.
CMFCBaseTabCtrl::IsIconAdded
CMFCBaseTabCtrl::IsInPlaceEdit	Indica si los usuarios pueden modificar la etiqueta de una pestaña.
CMFCBaseTabCtrl::IsLeftRightRounded
CMFCBaseTabCtrl::IsMDITab
CMFCBaseTabCtrl::IsOneNoteStyle	Indica si una ventana con pestañas muestra las pestañas con el estilo de Microsoft OneNote.
CMFCBaseTabCtrl::IsPtInTabArea	Comprueba si existe un punto especificado en el área de pestañas.
CMFCBaseTabCtrl::IsTabCloseButtonHighlighted
CMFCBaseTabCtrl::IsTabCloseButtonPressed
CMFCBaseTabCtrl::IsTabDetachable	Indica si una pestaña se puede desasociar.
CMFCBaseTabCtrl::IsTabIconOnly	Indica si las pestañas muestran iconos pero no etiquetas.
CMFCBaseTabCtrl::IsTabSwapEnabled	Indica si el usuario puede cambiar la posición de las pestañas arrastrándolas.
CMFCBaseTabCtrl::IsTabVisible	Indica si una pestaña especificada es visible.
CMFCBaseTabCtrl::IsVS2005Style
CMFCBaseTabCtrl::MoveTab
CMFCBaseTabCtrl::OnChangeTabs	Llamado por el marco cuando cambia el número de pestañas.
CMFCBaseTabCtrl::OnDragEnter
CMFCBaseTabCtrl::OnDragLeave
CMFCBaseTabCtrl::OnDragOver
CMFCBaseTabCtrl::OnDrop
CMFCBaseTabCtrl::OnRenameTab
CMFCBaseTabCtrl::PreTranslateMessage	La clase CWinApp lo usa para traducir los mensajes de ventana antes de que se envíen a las funciones de Windows TranslateMessage y DispatchMessage . (Invalida CWnd::PreTranslateMessage).
CMFCBaseTabCtrl::RecalcLayout	Vuelve a calcular el diseño interno de una ventana con pestañas.
CMFCBaseTabCtrl::RemoveAllTabs	Quita todas las pestañas de la ventana con pestañas.
CMFCBaseTabCtrl::RemoveTab	Quita una pestaña de una ventana con pestañas.
CMFCBaseTabCtrl::RenameTab
CMFCBaseTabCtrl::ResetImageList	Restablece la lista de imágenes que se adjunta a una ventana con pestañas.
CMFCBaseTabCtrl::Serialize	Lee o escribe este objeto de o en un archivo. (Invalida CObject::Serialize).
CMFCBaseTabCtrl::SetActiveTab	Activa una pestaña.
CMFCBaseTabCtrl::SetActiveTabColor	Establece el color de fondo de la pestaña actualmente activa.
CMFCBaseTabCtrl::SetActiveTabTextColor	Establece el color del texto de las pestañas activas.
CMFCBaseTabCtrl::SetAutoColors	Establece los colores de control de pestaña que se aplican en el modo de color automático.
CMFCBaseTabCtrl::SetDockingBarWrapperRTC	Establece la clase de contenedor que se usa para los objetos que no derivan de la CDockablePane Class.
CMFCBaseTabCtrl::SetDrawNoPrefix	Habilita y deshabilita el procesamiento de caracteres de prefijo cuando se dibujan las etiquetas de la pestaña.
CMFCBaseTabCtrl::SetImageList	Establece la lista de imágenes de iconos.
CMFCBaseTabCtrl::SetLocation
CMFCBaseTabCtrl::SetTabBkColor	Establece el color de fondo de una pestaña especificada.
CMFCBaseTabCtrl::SetTabBorderSize	Establece un nuevo tamaño de borde de pestaña.
CMFCBaseTabCtrl::SetTabHicon	Establece un icono de pestaña.
CMFCBaseTabCtrl::SetTabIcon	Establece un id. de icono de pestaña.
CMFCBaseTabCtrl::SetTabIconOnly	Habilita y deshabilita el modo "solo icono" de una pestaña especificada.
CMFCBaseTabCtrl::SetTabLabel	Establece una etiqueta de pestaña igual que un valor de cadena especificado.
CMFCBaseTabCtrl::SetTabsHeight
CMFCBaseTabCtrl::SetTabTextColor	Establece el color del texto de una pestaña especificada.
CMFCBaseTabCtrl::SetTabsOrder	Organiza las pestañas en el orden especificado.
CMFCBaseTabCtrl::ShowTab	Muestra u oculta la pestaña especificada.
CMFCBaseTabCtrl::StartRenameTab
CMFCBaseTabCtrl::SwapTabs

Métodos protegidos

Nombre	Descripción
CMFCBaseTabCtrl::CreateWrapper	Crea un contenedor para un objeto derivado de CWnd que no deriva de `CDockablePane`. Para acoplar un objeto `CMFCBaseTabCtrl` , cada control incrustado debe tener un contenedor de acoplamiento o bien debe derivarse de `CDockablePane`. Establece la clase del contenedor mediante `SetDockingBayWrapperRTC`.

Miembros de datos

Nombre	Descripción
CMFCBaseTabCtrl::m_bActivateTabOnRightClick	Especifica si las pestañas se seleccionan con un clic en el botón izquierdo o secundario del mouse.
CMFCBaseTabCtrl::m_bAutoDestroyWindow	Especifica si los paneles incluidos en las pestañas se destruyen automáticamente.

Comentarios

La clase CMFCBaseTabCtrl es una clase abstracta. Por lo tanto, no se pueden crear instancias en ella. Para crear una ventana con pestañas, debe derivar una clase de CMFCBaseTabCtrl. La biblioteca MFC contiene algunos ejemplos de clases derivadas, dos de las cuales son CMFCTabCtrl Class y CMFCOutlookBarTabCtrl Class.

A partir de Visual Studio 2015, esta clase es compatible con Active Accessibility de Microsoft.

Sugerencias de personalización

Las siguientes sugerencias se refieren a la CMFCBaseTabCtrl Class y a todas sus clases heredadas:

Si permite que las pestañas se puedan desasociar, no mantenga los punteros a las ventanas con pestañas. Estas pestañas desasociables se pueden crear y destruir de forma dinámica. Por lo tanto, los punteros pueden quedar invalidados.
Puede configurar el control de pestaña para que los usuarios puedan mover las pestañas dinámicamente en un control de pestaña con el mouse. Esta funcionalidad está integrada en la clase CMFCBaseTabCtrl . Para habilitarla, llame a CMFCBaseTabCtrl::EnableTabSwap.
De forma predeterminada, las pestañas son desasociables al agregarlas a un control de pestaña. También puede agregar pestañas no desasociables mediante CMFCBaseTabCtrl::AddTab. Si establece el parámetro bDetachable en FALSE, la pestaña no se podrá desasociar. También puede cambiar si las pestañas son desasociables llamando al método CMFCBaseTabCtrl::EnableTabDetach.
Los objetos derivados de la clase CWnd se pueden colocar en una barra de control o pestaña acoplables. Para que todo el control se acople, deberá hacer que el objeto CWnd sea acoplable. Para ello, MFC usa una clase contenedora. Esta clase de contenedor es CDockablePaneAdapter Class. Cualquier objeto CWnd que se agregue a una barra de control acoplable o a una pestaña acoplable se ajustará dentro de un objeto CDockablePaneAdapter . Puede deshabilitar el ajuste automático estableciendo el parámetro m_bEnableWrapping del objeto CMFCBaseTablCtrl en FALSE. También puede cambiar la clase de la aplicación podrá usar como un contenedor mediante el método CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Jerarquía de herencia

Requisitos

Encabezado: afxbasetabctrl.h

CMFCBaseTabCtrl::AddIcon

Agrega un icono a la lista de iconos del miembro protegido CMap m_mapAddedIcons.

void AddIcon(
    HICON hIcon,
    int iIcon);

Parámetros

hIcon
[in] Identificador del icono que se vaya a agregar.

iIcon
[in] Índice de base cero del icono del miembro protegido CImageList m_Images.

Comentarios

CMFCBaseTabCtrl::AddTab

Agrega una pestaña nueva al control de pestañas.

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] Puntero a la ventana que este método represente como una pestaña nueva.

lpszTabLabel
[in] Cadena que contiene la etiqueta de la nueva pestaña.

uiImageId
[in] Identificador de imagen de la lista de imágenes. El control de pestaña usa esta imagen como icono de la nueva pestaña.

uiResTabLabel
[in] Identificador de recurso de la etiqueta.

bDetachable
[in] Parámetro booleano que determina si la nueva pestaña es desasociable.

Comentarios

Si pTabWnd apuntara a un objeto que no derivase de la clase CDockablePane y si bDetachable fuera TRUE, el marco creará automáticamente un contenedor para el objeto pTabWnd. El contenedor hace que el objeto pTabWnd sea desasociable. De forma predeterminada, el contenedor será una instancia de la clase CDockablePaneAdapter. Si la funcionalidad que ofreciera el contenedor predeterminado fuera inaceptable, use el método CMFCBaseTabCtrl::SetDockingBarWrapperRTC para especificar un contenedor diferente.

CMFCBaseTabCtrl::ApplyRestoredTabInfo

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

Parámetros

[in] bUseTabIndexes

Comentarios

CMFCBaseTabCtrl::AutoDestroyWindow

void AutoDestroyWindow(BOOL bAutoDestroy = TRUE);

Parámetros

[in] bAutoDestroy

Comentarios

CMFCBaseTabCtrl::CalcRectEdit

virtual void CalcRectEdit(CRect& rectEdit);

Parámetros

[in] rectEdit

Comentarios

CMFCBaseTabCtrl::CleanUp

virtual void CleanUp();

Comentarios

CMFCBaseTabCtrl::ClearImageList

virtual void ClearImageList();

Comentarios

CMFCBaseTabCtrl::CreateWrapper

Crea un contenedor para una ventana de marco derivada de la clase CWnd, pero no derivada de la clase CDockablePane.

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

Parámetros

pWndToWrap
[in] Puntero a la ventana de marco que esté ajustada.

lpszTabLabel
[in] Cadena que contiene la etiqueta de la ventana.

bDetachable
[in] Parámetro booleano que indica si la ventana es desasociable.

Valor devuelto

Puntero al contenedor derivado de la clase CDockablePane si CreateWrapper creara correctamente una clase contenedora para pWndToWrap. Si se produjera un error en el método, devolverá pWndToWrap.

Comentarios

Una ventana con pestañas puede acoplar cualquier objeto derivado de CWnd. Sin embargo, para que un objeto CMFCBaseTabCtrl Class sea acoplable, cada objeto de CMFCBaseTabCtrl deberá ser desasociable. Por lo tanto, CMFCBaseTabCtrl ajustará automáticamente cualquier objeto que no derive de CDockablePane.

De forma predeterminada, CMFCBaseTabCtrl creará instancias de la clase CDockablePaneAdapter. Para cambiar la clase predeterminada del contenedor, llame a CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Si pWndToWrap derivara de CDockablePane, este método no creará un contenedor. En su lugar, se producirá un error y se devolverá pWndToWrap.

CMFCBaseTabCtrl::DetachTab

El marco llamará a este método para desasociar una pestaña del control pestañas.

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

Parámetros

dockMethod
[in] Tipo de datos enumerado proporcionado por la clase CBasePane. Este tipo de datos especifica el método que se usó para desasociar la pestaña.

nTabNum
[in] Índice de base cero de la pestaña que se vaya a desasociar.

bHide
[in] Parámetro booleano que indica si el marco debería ocultar la pestaña desasociada.

Valor devuelto

Si es correcta, su valor es distinto de cero. En caso contrario, es cero.

Comentarios

Si la pestaña especificada por nTabNum no se pudiera desasociar, esta función producirá un error y devolverá FALSE.

CMFCBaseTabCtrl::EnableActivateLastActive

void EnableActivateLastActive(BOOL bLastActive = TRUE);

Parámetros

[in] bLastActive

Comentarios

CMFCBaseTabCtrl::EnableAutoColor

Controla si el marco usa los colores de fondo automáticos al dibujar una pestaña.

void EnableAutoColor(BOOL bEnable = TRUE);

Parámetros

bEnable
[in] Parámetro booleano que determina si el marco usa colores automáticos.

Comentarios

Un control de pestaña tiene una matriz de varios colores predefinidos. Cuando el marco use colores automáticos, a cada pestaña de una serie de pestañas se le asignará el siguiente color de esta matriz.

De forma predeterminada, los colores automáticos vienen determinados por los colores definidos por la biblioteca. Es posible proporcionar una matriz personalizada de colores llamando a CMFCBaseTabCtrl::SetAutoColors.

CMFCBaseTabCtrl::EnableCustomToolTips

Habilita la información sobre herramientas personalizada para el control de pestaña.

BOOL EnableCustomToolTips(BOOL bEnable = TRUE);

Parámetros

bEnable
[in] Valor booleano que determina si se va a usar información sobre herramientas personalizada.

Valor devuelto

TRUE si es correcto; en caso contrario, FALSE.

Comentarios

Si la información sobre herramientas personalizada está habilitada, el control de pestaña enviará el mensaje AFX_WM_ON_GET_TAB_TOOLTIP al marco principal. Si deseara admitir información sobre herramientas personalizada en la aplicación, la ventana de marco principal deberá controlar este método y proporcionar el texto de información personalizado. Para obtener más información sobre cómo proporcionar texto de información sobre herramientas personalizado, vea CMFCTabToolTipInfo Structure.

CMFCBaseTabCtrl::EnableInPlaceEdit

Habilita la edición directa de las etiquetas de pestaña por el usuario.

virtual void EnableInPlaceEdit(BOOL bEnable) = 0;

Parámetros

bEnable
[in] Parámetro booleano que especifica si se va a habilitar la edición directa de las etiquetas de pestaña.

Comentarios

De forma predeterminada, la edición directa de las etiquetas de pestaña estará deshabilitada para los controles de pestaña.

Es posible habilitar la edición directa para un subconjunto de las pestañas del control de pestañas. Para hacerlo, invalide el método CMFCBaseTabCtrl::StartRenameTab. StartRenameTab debería devolver un valor distinto de cero para todas las pestañas que admitan la edición directa de etiquetas de pestaña.

En CMFCBaseTabCtrl Class, este método es una función virtual pura y no tiene ninguna implementación. Si deriva una clase de CMFCBaseTabCtrl, deberá implementar esta función.

CMFCBaseTabCtrl::EnableTabDetach

Habilita la capacidad de desasociar pestañas.

virtual BOOL EnableTabDetach(
    int iTab,
    BOOL bEnable);

Parámetros

iTab
[in] El índice de base cero de una pestaña.

bEnable
[in] Valor booleano que indica si se desasociará la pestaña.

Valor devuelto

TRUE si es correcto; en caso contrario, FALSE.

CMFCBaseTabCtrl::EnableTabSwap

Habilitará al usuario para cambiar el orden de tabulación con el mouse.

void EnableTabSwap(BOOL bEnable);

Parámetros

bEnable
[in] Valor booleano que indica si se va a habilitar el intercambio de pestañas.

Comentarios

Cuando se habilite el intercambio de pestañas, el usuario podrá arrastrar una pestaña y cambiar su posición relativa en el control de ficha.

CMFCBaseTabCtrl::EnsureVisible

Desplaza las pestañas hasta que la pestaña especificada sea visible.

virtual BOOL EnsureVisible(int iTab);

Parámetros

iTab
[in] El índice de base cero de una pestaña.

Valor devuelto

Si es correcta, su valor es distinto de cero. En caso contrario, es cero.

Comentarios

Este método no tendrá ningún efecto si la pestaña indicada por iTab ya fuera visible.

De forma predeterminada, este método no se admite por CMFCBaseTabCtrl Class. Deberá implementar esta función en una clase personalizada derivada de CMFCBaseTabCtrl si ese control de pestaña personalizado admitiera el desplazamiento por tabulaciones. CMFCTabCtrl Class admite este método.

CMFCBaseTabCtrl::EnterDragMode

void EnterDragMode();

Comentarios

CMFCBaseTabCtrl::FindTargetWnd

Identificará el panel que contenga un punto especificado.

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

Parámetros

pt
[in] Punto definido mediante coordenadas de área de cliente del objeto CMFCBaseTabCtrl.

Valor devuelto

Puntero a un objeto CWnd si se ejecutara correctamente; en caso contrario, será NULL.

Comentarios

En la clase CMFCBaseTabCtrl, este método es una función virtual pura: deberá implementarla si derivara una clase de CMFCBaseTabCtrl.

CMFCBaseTabCtrl::FireChangeActiveTab

virtual void FireChangeActiveTab(int nNewTab);

Parámetros

[in] nNewTab

Comentarios

CMFCBaseTabCtrl::FireChangingActiveTab

virtual BOOL FireChangingActiveTab(int nNewTab);

Parámetros

[in] nNewTab

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetActiveTab

Recupera el índice de la pestaña activa actualmente.

virtual int GetActiveTab() const;

Valor devuelto

Índice de base cero de la pestaña activa. -1 si no hubiera ninguna pestaña activa.

CMFCBaseTabCtrl::GetActiveTabColor

Recupera el color de fondo de la pestaña activa actualmente.

virtual COLORREF GetActiveTabColor() const;

Valor devuelto

Valor COLORREF que especifica el color de fondo de la pestaña activa.

Comentarios

De forma predeterminada, el color de fondo de la pestaña activa será COLOR_WINDOW. Es posible cambiar el color de fondo de la pestaña activa mediante el método CMFCBaseTabCtrl::SetActiveTabColor.

CMFCBaseTabCtrl::GetActiveTabTextColor

Recupera el color de texto de la pestaña activa.

virtual COLORREF GetActiveTabTextColor() const;

Valor devuelto

Valor COLORREF que especifica el color de texto de la pestaña activa.

Comentarios

De forma predeterminada, el color de texto de las pestañas activas será COLOR_WINDOWTEXT. Es posible cambiar el color de texto con el método CMFCBaseTabCtrl::SetActiveTabTextColor.

CMFCBaseTabCtrl::GetActiveWnd

Recupera un puntero a la ventana de la pestaña actualmente activa.

virtual CWnd* GetActiveWnd() const;

Valor devuelto

Puntero a una ventana.

CMFCBaseTabCtrl::GetAutoColors

Recupera el array de colores usado para la coloración automática.

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

Valor devuelto

Referencia a una matriz de valores COLORREF que el objeto CMFCBaseTabCtrl utilizará para la coloración automática de tabulación.

Comentarios

De forma predeterminada, el marco inicializará la matriz de colores en colores definidos por la biblioteca. Es posible proporcionar una matriz personalizada de colores llamando al método CMFCBaseTabCtrl::SetAutoColors.

CMFCBaseTabCtrl::GetFirstVisibleTab

Recupera un puntero a la primera pestaña visible.

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

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

Parámetros

iTabNum
[out] Referencia a un entero. Este método escribirá el índice de base cero de la primera pestaña visible en este parámetro.

iStartFrom
[in] Índice de base cero de la primera pestaña que se vaya a comprobar.

Valor devuelto

Puntero a la primera pestaña visible si fuera correcta. En caso contrario, será NULL.

Comentarios

Si se produjera un error en este método, escribirá el valor -1 en iStartFrom.

Si iStartFrom fuera mayor o igual que el número de pestañas del control de pestañas, GetFirstVisibleTab producirá un error automáticamente.

CMFCBaseTabCtrl::GetFirstVisibleTabNum

virtual int GetFirstVisibleTabNum() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetHighlightedTab

Recuperará el índice de la pestaña resaltada en ese momento.

int GetHighlightedTab() const;

Valor devuelto

Índice de base cero de la pestaña resaltada.

CMFCBaseTabCtrl::GetImageList

virtual const CImageList* GetImageList() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetImageSize

virtual CSize GetImageSize() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetLastVisibleTab

virtual CWnd* GetLastVisibleTab(int& iTabNum);

Parámetros

[in] iTabNum

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetLocation

Recuperará la ubicación de la parte del área de la pestaña del control de pestañas.

Location GetLocation() const;

Valor devuelto

Ubicación del área de la pestaña.

Comentarios

Los posibles valores de ubicación del área de la pestaña serán LOCATION_BOTTOM y LOCATION_TOP.

CMFCBaseTabCtrl::GetMaxWindowSize

virtual CSize GetMaxWindowSize() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetTabArea

Recupera el tamaño y la posición del área de la pestaña del control de pestañas.

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

Parámetros

rectTabAreaTop
[in] Referencia a un objeto CRect. GetTabArea usará este objeto para almacenar el tamaño y la posición del área de la pestaña superior.

rectTabAreaBottom
[in] Referencia a un objeto CRect. GetTabArea usará este objeto para almacenar el tamaño y la posición del área de la pestaña inferior.

Comentarios

Después de la devolución de GetTabArea, los parámetros CRect contendrán el tamaño y la posición del área de la pestaña en las coordenadas de cliente del control de pestañas. Si no hubiera ningún área de pestaña en la parte superior o inferior del control de la pestaña, los valores de rectTabAreaTop o rectTabAreaBottom estarán vacíos.

En CMFCBaseTabCtrl Class, este método es una función virtual pura y no tiene ninguna implementación. Si derivara una clase de CMFCBaseTabCtrl, deberá implementar esta función.

CMFCBaseTabCtrl::GetTabBkColor

Devolverá el color de fondo de la pestaña especificada.

virtual COLORREF GetTabBkColor(int iTab) const;

Parámetros

iTab
[in] Índice de base cero de la pestaña.

Valor devuelto

Valor COLORREF que indicará el color de fondo de la pestaña especificada. Devolverá -1 si iTab estuviera fuera del intervalo.

CMFCBaseTabCtrl::GetTabBorderSize

Recuperará el tamaño de los bordes de la pestaña en el control de pestaña.

virtual int GetTabBorderSize() const;

Valor devuelto

Tamaño del borde de la pestaña en píxeles.

Comentarios

El tamaño predeterminado del borde de tabulación es de tres píxeles. Es posible cambiar este tamaño de borde con el método CMFCBaseTabCtrl::SetTabBorderSize.

CMFCBaseTabCtrl::GetTabByID

Recuperará el índice de una pestaña basándose en un identificador de pestaña.

virtual int GetTabByID(int id) const;

Parámetros

id
[in] Un id. de pestaña.

Valor devuelto

Índice de base cero de una pestaña si se encontrara. Devolverá -1 si no se encontrara el id. de pestaña.

Comentarios

Los id. de pestaña se asignarán automáticamente cuando se agreguen pestañas a un control de pestaña.

CMFCBaseTabCtrl::GetTabCloseButton

CRect GetTabCloseButton() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetTabFromHwnd

Recuperará el índice de la pestaña que contenga el objeto HWND especificado.

virtual int GetTabFromHwnd(HWND hwnd) const;

Parámetros

hwnd
[in] Manipulador de una ventana.

Valor devuelto

Índice de base cero de la pestaña en caso correcto. Devolverá -1 si ninguna pestaña contiene hwnd.

CMFCBaseTabCtrl::GetTabFromPoint

Recupera la pestaña que contenga un punto especificado.

virtual int GetTabFromPoint(CPoint& pt) const;

Parámetros

pt
[in] Punto en coordenadas de cliente del control de pestaña.

Valor devuelto

Índice de la pestaña que contenga pt. Devolverá -1 si ninguna pestaña contuviera pt.

CMFCBaseTabCtrl::GetTabFullWidth

virtual int GetTabFullWidth(int iTab) const;

Parámetros

[in] iTab

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetTabHicon

Devuelve el HICON asociado a la pestaña especificada.

virtual HICON GetTabHicon(int iTab) const;

Parámetros

iTab
[in] Índice de base cero de la pestaña.

Valor devuelto

HICON asociado a una etiqueta de pestaña en caso correcto. Devolverá NULL si no hubiera HICON o si se produjera un error en el método.

CMFCBaseTabCtrl::GetTabIcon

Recupera el icono asociado a la pestaña especificada.

virtual UINT GetTabIcon(int iTab) const;

Parámetros

iTab
[in] Índice de base cero de la pestaña.

Valor devuelto

Id. del icono de la pestaña especificada en caso correcto. Devolverá -1 si el índice no fuera válido.

Comentarios

El objeto CMFCBaseTabCtrl almacena los iconos en el objeto CImageList interno.

CMFCBaseTabCtrl::GetTabID

Recupera el id. de una pestaña especificada por el índice de pestañas.

int GetTabID(int iTab) const;

Parámetros

iTab
[in] Índice de base cero de la pestaña.

Valor devuelto

Id. de la pestaña o -1 si iTab estuviera fuera del intervalo.

CMFCBaseTabCtrl::GetTabLabel

Recupera el texto de una etiqueta de pestaña.

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

Parámetros

iTab
[in] Índice de base cero de la pestaña.

strLabel
[out] Referencia a un objeto CString. Este método almacena la etiqueta de la pestaña en este parámetro.

Valor devuelto

TRUE en caso correcto. De lo contrario, FALSE.

Comentarios

Este método producirá un error si el índice iTab no es válido.

La etiqueta de una pestaña se establece al crear la pestaña mediante CMFCBaseTabCtrl::AddTab. También es posible cambiar la etiqueta después de la creación con el método CMFCBaseTabCtrl::SetTabLabel.

CMFCBaseTabCtrl::GetTabRect

Recupera el tamaño y la posición de la pestaña especificada.

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

Parámetros

iTab
[in] Índice de base cero de la pestaña.

rect
[out] Referencia a un objeto CRect. Este método almacenará el tamaño y la posición de la pestaña en este parámetro.

Valor devuelto

TRUE en caso correcto. FALSE si el índice de tabulación no fuera válido.

CMFCBaseTabCtrl::GetTabsHeight

virtual int GetTabsHeight() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetTabsNum

Recupera el número de pestañas del control de pestañas.

virtual int GetTabsNum() const;

Valor devuelto

Número de pestañas en el control de pestañas.

CMFCBaseTabCtrl::GetTabsRect

virtual void GetTabsRect(CRect& rect) const;

Parámetros

[in] rect

Comentarios

CMFCBaseTabCtrl::GetTabTextColor

Recupera el color del texto de la pestaña especificada.

virtual COLORREF GetTabTextColor(int iTab) const;

Parámetros

iTab
[in] Índice de base cero de la pestaña.

Valor devuelto

Un parámetro COLORREF que indicará el color del texto de la pestaña especificada; -1 si iTab estuviera fuera del intervalo.

CMFCBaseTabCtrl::GetTabWnd

Devuelve el puntero al panel que resida en la pestaña especificada.

virtual CWnd* GetTabWnd(int iTab) const;

Parámetros

iTab
[in] El índice de base cero de una pestaña.

Valor devuelto

Un puntero al objeto CWnd que resida en la pestaña que iTab especifique. NULL si iTab no es válido.

Comentarios

El objeto devuelto es el que la aplicación agregó cuando llamó a CMFCBaseTabCtrl::AddTab o CMFCBaseTabCtrl::InsertTab.

Si el objeto de una pestaña tuviera un contenedor, este método devolverá el contenedor para el objeto. Para obtener más información sobre los contenedores, vea CMFCBaseTabCtrl::CreateWrapper. Si desea que un puntero acceda al objeto directo sin el contenedor, use el método CMFCBaseTabCtrl::GetTabWndNoWrapper.

CMFCBaseTabCtrl::GetTabWndNoWrapper

Devolverá un puntero al control que resida en una pestaña, incluso aunque el control tenga un contenedor.

virtual CWnd* GetTabWndNoWrapper(int iTab) const;

Parámetros

iTab
[in] El índice de base cero de una pestaña.

Valor devuelto

Puntero al objeto CWnd que resida en la pestaña especificada. Será NULL si iTab no fuera válido.

Comentarios

Este método recuperará un puntero directo al objeto CWnd que agregó mediante el método CMFCBaseTabCtrl::AddTab o CMFCBaseTabCtrl::InsertTab. GetTabWndNoWrapper recuperará un puntero al elemento agregado CWnd, incluso si el marco agregó un contenedor para el objeto. Para obtener más información sobre los contenedores y la clase CMFCBaseTabCtrl, consulte CMFCBaseTabCtrl::CreateWrapper.

Use el método CMFCBaseTabCtrl::GetTabWnd si no desea omitir la clase contenedora.

CMFCBaseTabCtrl::GetToolTipCtrl

Recuperará una referencia al control de información sobre herramientas.

CToolTipCtrl& GetToolTipCtrl() const;

Valor devuelto

Referencia al control de información sobre herramientas.

CMFCBaseTabCtrl::GetVisibleTabsNum

Recupera el número de pestañas visibles actualmente.

virtual int GetVisibleTabsNum() const;

Valor devuelto

Número de pestañas visibles.

CMFCBaseTabCtrl::HasImage

virtual BOOL HasImage(int iTab) const;

Parámetros

[in] iTab

Valor devuelto

Comentarios

CMFCBaseTabCtrl::HideSingleTab

Establece la opción de ocultar las pestañas del control de pestañas cuando haya una pestaña visible.

virtual void HideSingleTab(BOOL bHide = TRUE);

Parámetros

bHide
[in] Valor booleano que especifica si se debería habilitar la ocultación de pestañas únicas.

Comentarios

Cuando la aplicación esté configurada para ocultar pestañas únicas, el marco mostrará automáticamente las pestañas cuando se agregue una segunda pestaña al control de pestañas.

CMFCBaseTabCtrl::InsertTab

Inserta una pestaña en el control de ficha.

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] Puntero a la ventana que este método agrega como una pestaña nueva.

lpszTabLabel
[in] Cadena que contiene la etiqueta de la nueva pestaña.

nInsertAt
[in] Índice de base cero de la pestaña nueva.

uiImageId
[in] Identificador de imagen de la lista de imágenes. El control de pestaña usa esta imagen como icono de la nueva pestaña.

bDetachable
[in] Parámetro booleano que determina si la nueva pestaña es desasociable.

uiResTabLabel
[in] Identificador de recurso de la etiqueta.

Comentarios

Si el objeto indicado por pNewWnd no derivase de la clase CDockablePane y el parámetro bDetachable fuera TRUE, el marco creará un contenedor especial para la nueva pestaña. De forma predeterminada, el contenedor será una instancia de la clase CDockablePaneAdapter. Use el método CMFCBaseTabCtrl::SetDockingBarWrapperRTC para crear una clase contenedora diferente. Cualquier clase contenedora personalizada deberá derivar de CDockablePaneAdapter.

CMFCBaseTabCtrl::InvalidateTab

void InvalidateTab(int iTab);

Parámetros

[in] iTab

Comentarios

CMFCBaseTabCtrl::IsActiveTabCloseButton

virtual BOOL IsActiveTabCloseButton() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsAutoColor

Determina si el control de pestañas está en modo de color automático.

BOOL IsAutoColor() const;

Valor devuelto

TRUE si el control de pestañas estuviera en modo de color automático. En caso contrario, FALSE.

Comentarios

Es posible habilitar o deshabilitar el modo de color automático mediante el método CMFCBaseTabCtrl::EnableAutoColor.

CMFCBaseTabCtrl::IsAutoDestroyWindow

BOOL IsAutoDestroyWindow() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsColored

virtual BOOL IsColored() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsDialogControl

BOOL IsDialogControl() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsDrawNoPrefix

BOOL IsDrawNoPrefix() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsFlatFrame

Indica si el marco del control de pestañas se representa con estilo plano o de 3D.

virtual BOOL IsFlatFrame() const;

Valor devuelto

TRUE si el marco del control de pestañas se representase con estilo plano y FALSE si el marco se representara en estilo 3D.

Comentarios

Use CMFCTabCtrl::SetFlatFrame para cambiar el estilo del marco del control de pestañas.

Los controles de pestañas que usen el estilo de Outlook no se podrán representar con marcos planos. Esto incluye la clase CMFCOutlookBarTabCtrl y cualquier otra derivada de esa clase.

CMFCBaseTabCtrl::IsFlatTab

virtual BOOL IsFlatTab() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsHideSingleTab

Determina si el control de pestañas oculta la etiqueta de pestaña si solo hubiera una pestaña.

virtual BOOL IsHideSingleTab() const;

Valor devuelto

TRUE si el control de pestañas ocultara la etiqueta de pestaña cuando tenga una pestaña, de lo contrario, FALSE.

Comentarios

Use el método CMFCBaseTabCtrl::HideSingleTab para habilitar la ocultación de la etiqueta de pestaña cuando solo haya una pestaña.

CMFCBaseTabCtrl::IsIconAdded

BOOL IsIconAdded(
    HICON hIcon,
    int& iIcon);

Parámetros

[in] hIcon

[in] iIcon

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsInPlaceEdit

Indica si el control de pestañas está configurado para permitir al usuario modificar dinámicamente las etiquetas de pestaña.

virtual BOOL IsInPlaceEdit() const;

Valor devuelto

Distinto de cero si la edición en contexto está habilitada, de lo contrario, 0.

Comentarios

Es posible habilitar o deshabilitar la edición en contexto llamando al método CMFCBaseTabCtrl::EnableInPlaceEdit.

CMFCBaseTabCtrl::IsLeftRightRounded

virtual BOOL IsLeftRightRounded() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsMDITab

BOOL IsMDITab() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsOneNoteStyle

Determina si las pestañas se mostrarán con el estilo de Microsoft OneNote.

virtual BOOL IsOneNoteStyle() const;

Valor devuelto

TRUE para que las pestañas se muestren con el estilo de Microsoft OneNote, de lo contrario, FALSE.

Comentarios

Llame al método CMDIFrameWndEx::EnableMDITabs para habilitar el estilo de Microsoft OneNote. También es posible habilitar este estilo al crear una instancia de la clase CMFCTabCtrl: simplemente pase el estilo STYLE_3D_ONENOTE al método CMFCTabCtrl::Create.

De forma predeterminada, el estilo de Microsoft OneNote no se admitirá en una clase personalizada derivada de CMFCBaseTabCtrl Class. Sin embargo, se admitirá en la clase CMFCTabCtrl.

CMFCBaseTabCtrl::IsPtInTabArea

Determina si un punto está dentro del área de pestaña.

virtual BOOL IsPtInTabArea(CPoint point) const = 0;

Parámetros

point
[in] Punto de prueba.

Valor devuelto

Distinto de cero si el punto estuviera en el área de pestaña y, en caso contrario, 0.

Comentarios

En CMFCBaseTabCtrl Class, este método es una función virtual pura y no tiene ninguna implementación. Si derivara una clase de CMFCBaseTabCtrl, deberá implementar esta función.

CMFCBaseTabCtrl::IsTabCloseButtonHighlighted

BOOL IsTabCloseButtonHighlighted() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsTabCloseButtonPressed

BOOL IsTabCloseButtonPressed() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::IsTabDetachable

Determina si es posible desasociar una pestaña.

virtual BOOL IsTabDetachable(int iTab) const;

Parámetros

iTab
[in] Índice de base cero de la pestaña que se comprobará.

Valor devuelto

TRUE si la pestaña estuviera desasociada, de lo contrario, FALSE.

Comentarios

Para desasociar una pestaña, use el método CMFCBaseTabCtrl::EnableTabDetach.

CMFCBaseTabCtrl::IsTabIconOnly

Determina si una etiqueta de pestaña contendrá solo iconos y nada de texto.

virtual BOOL IsTabIconOnly(int iTab) const;

Parámetros

iTab
[in] Índice de base cero de la pestaña.

Valor devuelto

TRUE si una etiqueta de pestaña solo tuviera iconos, de lo contrario, FALSE.

Comentarios

Para establecer que las pestañas de la aplicación solo muestren iconos, llame al método CMFCBaseTabCtrl::SetTabIconOnly.

CMFCBaseTabCtrl::IsTabSwapEnabled

Determina si el control de pestañas permitirá al usuario cambiar las posiciones de la pestaña con el mouse.

BOOL IsTabSwapEnabled() const;

Valor devuelto

Distinto de cero si el usuario puede cambiar las posiciones de pestañas, de lo contrario, 0.

Comentarios

De forma predeterminada, los usuarios no podrán cambiar el orden de las pestañas en un control de pestañas. Use el método CMFCBaseTabCtrl::EnableTabSwap para habilitar esta función.

CMFCBaseTabCtrl::IsTabVisible

Indica si la pestaña especificada es visible.

virtual BOOL IsTabVisible(int iTab) const;

Parámetros

iTab
[in] Índice de base cero de la pestaña que se comprobará.

Valor devuelto

Distinto de cero si la pestaña especificada es visible, de lo contrario, 0.

CMFCBaseTabCtrl::IsVS2005Style

virtual BOOL IsVS2005Style() const;

Valor devuelto

Comentarios

CMFCBaseTabCtrl::m_bActivateTabOnRightClick

m_bActivateTabOnRightClick determina si las pestañas están en el foco cuando el usuario haga clic en una etiqueta de pestaña con el botón derecho del mouse.

BOOL m_bActivateTabOnRightClick;

Comentarios

El valor predeterminado de este miembro de datos es FALSE.

CMFCBaseTabCtrl::m_bAutoDestroyWindow

m_bAutoDestroyWindow determina si el marco destruye automáticamente los objetos de las pestañas cuando estas se quitan.

BOOL m_bAutoDestroyWindow;

Comentarios

De forma predeterminada, este miembro es FALSE.

CMFCBaseTabCtrl::MoveTab

virtual void MoveTab(
    int nSource,
    int nDest);

Parámetros

[in] nSource

[in] nDest

Comentarios

CMFCBaseTabCtrl::OnChangeTabs

El marco llamará a este método cuando cambie el número de pestañas de un control de pestañas.

virtual void OnChangeTabs();

Comentarios

De forma predeterminada, este método no hace nada. Invalide este método para ejecutar código personalizado cuando cambie el número de pestañas del control de pestañas.

CMFCBaseTabCtrl::OnDrop

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

Parámetros

[in] COleDataObject*

[in] DROPEFFECT

[in] CPoint

Valor devuelto

Comentarios

CMFCBaseTabCtrl::OnDragOver

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

Parámetros

[in] COleDataObject*

[in] DWORD

[in] CPoint

Valor devuelto

Comentarios

CMFCBaseTabCtrl::OnDragLeave

virtual void OnDragLeave();

Comentarios

CMFCBaseTabCtrl::OnDragEnter

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

Parámetros

[in] COleDataObject*

[in] DWORD

[in] CPoint

Valor devuelto

Comentarios

CMFCBaseTabCtrl::OnRenameTab

virtual BOOL OnRenameTab(int, CString&);

Parámetros

[in] int

[in] CString&

Valor devuelto

Comentarios

CMFCBaseTabCtrl::PreTranslateMessage

virtual BOOL PreTranslateMessage(MSG* pMsg);

Parámetros

[in] pMsg

Valor devuelto

Comentarios

CMFCBaseTabCtrl::RecalcLayout

Vuelve a calcular el diseño interno del control de pestañas.

virtual void RecalcLayout() = 0;

Comentarios

En CMFCBaseTabCtrl Class, este método es una función virtual pura. Si derivara una clase de CMFCBaseTabCtrl, deberá implementar esta función.

CMFCBaseTabCtrl::RemoveAllTabs

Quita todas las pestañas del control de pestañas.

virtual void RemoveAllTabs();

Comentarios

Si CMFCBaseTabCtrl::m_bAutoDestroyWindow es TRUE, el marco eliminará todos los objetos CWnd asociados a las pestañas quitadas.

CMFCBaseTabCtrl::RemoveTab

Quita una pestaña del control de pestañas.

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

Parámetros

iTab
[in] El índice de base cero de una pestaña.

bRecalcLayout
[in] Parámetro booleano que especifica si se deberá volver a calcular el diseño de la pestaña.

Valor devuelto

TRUE si el método quita la pestaña correctamente. En caso contrario, FALSE.

Comentarios

Si CMFCBaseTabCtrl::m_bAutoDestroyWindow es TRUE, RemoveTab destruye el objeto CWnd asociado a la pestaña especificada.

CMFCBaseTabCtrl::RenameTab

virtual BOOL RenameTab();

Valor devuelto

Comentarios

CMFCBaseTabCtrl::ResetImageList

Restablece la lista de imágenes de una instancia de la clase CMFCBaseTabCtrl.

void ResetImageList();

CMFCBaseTabCtrl::Serialize

virtual void Serialize(CArchive& ar);

Parámetros

[in] ar

Comentarios

CMFCBaseTabCtrl::SetActiveTab

Activa la pestaña especificada.

virtual BOOL SetActiveTab(int iTab) = 0;

Parámetros

iTab
[in] Índice de base cero de una pestaña. SetActiveTab activará la pestaña con este índice.

Valor devuelto

TRUE si es correcto; en caso contrario, FALSE.

Comentarios

En CMFCBaseTabCtrl Class, este método es una función virtual pura. Si derivara una clase de CMFCBaseTabCtrl, deberá implementar esta función.

CMFCBaseTabCtrl::SetActiveTabColor

Establece el color de fondo de la pestaña activa.

virtual void SetActiveTabColor(COLORREF clr);

Parámetros

clr
[in] Especifica el nuevo color de fondo.

Comentarios

El marco obtiene el color de fondo predeterminado para las pestañas activas del método GetSysColor.

CMFCBaseTabCtrl::SetActiveTabTextColor

Establece el color del texto de las pestañas activas.

virtual void SetActiveTabTextColor(COLORREF clr);

Parámetros

clr
[in] Parámetro COLORREF que especifica el nuevo color del texto.

Comentarios

De forma predeterminada, el marco obtendrá el color del texto de GetSysColor. El método SetActiveTabTextColor invalidará el color predeterminado.

CMFCBaseTabCtrl::SetAutoColors

Establece los colores del control de pestañas que el marco usará en modo de color automático.

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

Parámetros

arColors
[in] Matriz de colores RGB.

Comentarios

Al proporcionar una matriz personalizada de colores, se ignorará la matriz de colores predeterminada. Si el parámetro arColors estuviera vacío, el marco revertirá a la matriz de colores predeterminada.

Para habilitar el modo de color automático, use el método CMFCBaseTabCtrl::EnableAutoColor.

CMFCBaseTabCtrl::SetDockingBarWrapperRTC

Establece la clase de contenedor que se usa para los objetos que no derivan de la CDockablePane Class.

void SetDockingBarWrapperRTC(CRuntimeClass* pRTC);

Parámetros

pRTC
[in] Información de clase en tiempo de ejecución para la nueva clase contenedora.

Comentarios

Es posible agregar pestañas a un control de pestañas mediante los métodos CMFCBaseTabCtrl::AddTab y CMFCBaseTabCtrl::InsertTab. Al agregar una pestaña, cada control de esa pestaña deberá ser acoplable. Cualquier objeto que no derive de CDockablePane deberá ajustarse. AddTab y InsertTab crearán un contenedor para estos objetos. La clase de contenedora predeterminada es la clase CDockablePaneAdapter. El método SetDockingBarWrapperRTC permite cambiar la clase que se use como clase contenedora. La clase contenedora que proporcione deberá derivar de CDockablePaneAdapter.

CMFCBaseTabCtrl::SetDrawNoPrefix

Habilita y deshabilita el proceso de caracteres de prefijo en etiquetas de pestaña.

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

Parámetros

bNoPrefix
[in] TRUE si desea procesar caracteres de prefijo, de lo contrario, FALSE.

bRedraw
[in] TRUE si desea volver a dibujar la ventana con pestañas, de lo contrario, FALSE.

Comentarios

Un carácter de prefijo es un carácter mnemotécnico precedido por una y comercial (&).

CMFCBaseTabCtrl::SetImageList

Establece la lista de imágenes de icono para el control de pestañas.

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

virtual BOOL SetImageList(HIMAGELIST hImageList);

Parámetros

uiID
[in] Id. de recurso de mapa de bits. SetImageList carga la lista de imágenes de este recurso.

cx
[in] Ancho de cada imagen en píxeles.

clrTransp
[in] Parámetro COLORREF que indica el color transparente de la imagen.

hImageList
[in] Un manipulador de una lista de imágenes precargadas.

Valor devuelto

Distinto de cero si el método se realizó correctamente. En caso contrario, 0.

Comentarios

Las imágenes de la lista de imágenes de icono se mostrarán junto con las etiquetas de la pestaña. Para mostrar un icono, se deberá especificar su índice al llamar a CMFCBaseTabCtrl::AddTab.

SetImageList producirá un error si el control de ficha se creó con un estilo plano. También se producirá un error si el marco no pudiera cargar la imagen indicada por uiID.

Este método volverá a calcular el alto de la pestaña según los tamaños de imagen y texto.

CMFCBaseTabCtrl::SetLocation

virtual void SetLocation(Location location);

Parámetros

[in] ubicación

Comentarios

CMFCBaseTabCtrl::SetTabBkColor

Establece el color de fondo de la pestaña especificada.

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

Parámetros

iTab
[in] Índice de base cero de la pestaña.

color
[in] Color que se establecerá.

Valor devuelto

TRUE en caso correcto. De lo contrario, FALSE.

CMFCBaseTabCtrl::SetTabBorderSize

Establece un nuevo tamaño de borde para el control de pestañas.

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

Parámetros

nTabBorderSize
[in] Nuevo tamaño de borde, en píxeles.

bRepaint
[in] Parámetro booleano que indica si el marco vuelve a dibujar el control.

CMFCBaseTabCtrl::SetTabHicon

Establece el icono de una etiqueta de pestaña.

virtual BOOL SetTabHicon(
    int iTab,
    HICON hIcon);

Parámetros

iTab
[in] Índice de base cero de una pestaña. Este método cambiará el icono de esta pestaña.

hIcon
[in] Manipulador de un icono.

Valor devuelto

TRUE si es correcto; en caso contrario, FALSE.

CMFCBaseTabCtrl::SetTabIcon

Establece el icono de una pestaña.

virtual BOOL SetTabIcon(
    int iTab,
    UINT uiIcon);

Parámetros

iTab
[in] Índice de base cero de la pestaña que se actualizará.

uiIcon
[in] Id. del icono del nuevo icono. Este id. hace referencia al objeto CImageList.

Valor devuelto

TRUE si es correcto; en caso contrario, FALSE.

CMFCBaseTabCtrl::SetTabIconOnly

Permite mostrar solo un icono (y ninguna etiqueta de texto) en una pestaña específica.

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

Parámetros

iTab
[in] Índice de base cero de la pestaña que se cambiará.

bIconOnly
[in] Parámetro booleano que determina si se deberán mostrar solo los iconos.

bShowTooltipAlways
[in] Parámetro booleano que determina si el marco mostrará información sobre herramientas para una etiqueta de pestaña que solo muestre iconos.

Valor devuelto

TRUE si es correcto; en caso contrario, FALSE.

Comentarios

De forma predeterminada, un control de pestaña mostrará el icono y la etiqueta de texto de cada pestaña.

CMFCBaseTabCtrl::SetTabLabel

Establece el texto de una etiqueta de pestaña.

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

Parámetros

iTab
[in] Índice de base cero de la pestaña que se actualizará.

strLabel
[in] Referencia a una cadena que contiene el nuevo texto de la etiqueta de pestaña.

Valor devuelto

Su valor será distinto de cero en caso correcto, de lo contrario, será cero.

CMFCBaseTabCtrl::SetTabsHeight

virtual void SetTabsHeight();

Comentarios

CMFCBaseTabCtrl::SetTabsOrder

Organiza las pestañas en el orden especificado.

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

Parámetros

arOrder
[in] Matriz de índices de base cero que define el nuevo orden de pestañas.

Valor devuelto

TRUE si es correcto. En caso contrario, FALSE.

Comentarios

El tamaño de la matriz arOrder deberá ser igual al número de pestañas del control de pestañas.

CMFCBaseTabCtrl::SetTabTextColor

Establece el color del texto de una pestaña especificada.

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

Parámetros

iTab
[in] Índice de base cero de la pestaña.

color
[in] Parámetro COLORREF que indica el nuevo color del texto.

Valor devuelto

Su valor será distinto de cero en caso correcto, de lo contrario, será cero.

CMFCBaseTabCtrl::ShowTab

Muestra u oculta la pestaña especificada.

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

Parámetros

iTab
[in] Índice de la pestaña que ShowTab mostrará u ocultará.

bShow
[in] Parámetro booleano que indica si se mostrará la pestaña.

bRecalcLayout
[in] Parámetro booleano que indica si se va a volver a calcular inmediatamente el diseño de la ventana.

bActivate
[in] Parámetro booleano que indica si se seleccionará la pestaña especificada por iTab.

Valor devuelto

Si es correcta, su valor es distinto de cero. En caso contrario, es cero.

Comentarios

El parámetro bActivate solo se aplicará si bShow es TRUE. Si bActivate es TRUE y si ShowTab es correcto, ShowTab enviará el mensaje AFX_WM_CHANGE_ACTIVE_TAB al elemento primario de la ventana de tabulación.

CMFCBaseTabCtrl::StartRenameTab

virtual BOOL StartRenameTab(int iTab);

Parámetros

[in] iTab

Valor devuelto

Comentarios

CMFCBaseTabCtrl::SwapTabs

virtual void SwapTabs(
    int nFisrtTabID,
    int nSecondTabID);

Parámetros

[in] nFisrtTabID

[in] nSecondTabID

Comentarios

Consulte también

Gráfico de jerarquías
Clases
CMFCTabCtrl (clase)
CMFCOutlookBarTabCtrl (clase)

Compartir a través de

CMFCBaseTabCtrl (clase)

Sintaxis

Miembros

Métodos públicos

Métodos protegidos

Miembros de datos

Comentarios

Sugerencias de personalización

Jerarquía de herencia

Requisitos

CMFCBaseTabCtrl::AddIcon

Parámetros

Comentarios

CMFCBaseTabCtrl::AddTab

Parámetros

Comentarios

CMFCBaseTabCtrl::ApplyRestoredTabInfo

Parámetros

Comentarios

CMFCBaseTabCtrl::AutoDestroyWindow

Parámetros

Comentarios

CMFCBaseTabCtrl::CalcRectEdit

Parámetros

Comentarios

CMFCBaseTabCtrl::CleanUp

Comentarios

CMFCBaseTabCtrl::ClearImageList

Comentarios

CMFCBaseTabCtrl::CreateWrapper

Parámetros

Valor devuelto

Comentarios

CMFCBaseTabCtrl::DetachTab

Parámetros

Valor devuelto

Comentarios

CMFCBaseTabCtrl::EnableActivateLastActive

Parámetros

Comentarios

CMFCBaseTabCtrl::EnableAutoColor

Parámetros

Comentarios

CMFCBaseTabCtrl::EnableCustomToolTips

Parámetros

Valor devuelto

Comentarios

CMFCBaseTabCtrl::EnableInPlaceEdit

Parámetros

Comentarios

CMFCBaseTabCtrl::EnableTabDetach

Parámetros

Valor devuelto

CMFCBaseTabCtrl::EnableTabSwap

Parámetros

Comentarios

CMFCBaseTabCtrl::EnsureVisible

Parámetros

Valor devuelto

Comentarios

CMFCBaseTabCtrl::EnterDragMode

Comentarios

CMFCBaseTabCtrl::FindTargetWnd

Parámetros

Valor devuelto

Comentarios

CMFCBaseTabCtrl::FireChangeActiveTab

Parámetros

Comentarios

CMFCBaseTabCtrl::FireChangingActiveTab

Parámetros

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetActiveTab

Valor devuelto

CMFCBaseTabCtrl::GetActiveTabColor

Valor devuelto

Comentarios

CMFCBaseTabCtrl::GetActiveTabTextColor