CBaseTabbedPane (clase)

Extiende la funcionalidad de CDockablePane Class para permitir la creación de ventanas con pestañas.

Sintaxis

class CBaseTabbedPane : public CDockablePane

Miembros

Constructores públicos

Nombre	Descripción
CBaseTabbedPane::CBaseTabbedPane	Constructor predeterminado.

Métodos públicos

Nombre	Descripción
CBaseTabbedPane::AddTab	Agrega una pestaña nueva al panel con pestañas.
CBaseTabbedPane::AllowDestroyEmptyTabbedPane	Especifica si se puede destruir un panel con fichas vacío.
CBaseTabbedPane::ApplyRestoredTabInfo	Aplica la configuración de las pestañas, que se carga desde el registro, en un panel con pestañas.
CBaseTabbedPane::CanFloat	Determina si el panel puede ser flotante. (Reemplaza a CBasePane::CanFloat).
CBaseTabbedPane::CanSetCaptionTextToTabName	Determina si el título del panel con pestañas debe mostrar el mismo texto que la pestaña activa.
CBaseTabbedPane::ConvertToTabbedDocument	(Invalida CDockablePane::ConvertToTabbedDocument).
CBaseTabbedPane::DetachPane	Convierte uno o varios paneles acoplables en documentos con fichas de MDI.
CBaseTabbedPane::EnableSetCaptionTextToTabName	Habilita o deshabilita la capacidad del panel con pestañas para sincronizar el texto del título con el texto de la etiqueta en la pestaña activa.
CBaseTabbedPane::FillDefaultTabsOrderArray	Restaura el orden de pestañas interno a un estado predeterminado.
CBaseTabbedPane::FindBarByTabNumber	Devuelve un panel que reside en una pestaña cuando esta se identifica mediante un índice de pestañas de base cero.
CBaseTabbedPane::FindPaneByID	Devuelve un panel que identifica el id. de panel.
CBaseTabbedPane::FloatTab	Convierte un panel en flotante, pero solo si el panel se encuentra actualmente en una pestaña desmontable.
CBaseTabbedPane::GetDefaultTabsOrder	Devuelve el orden predeterminado de las pestañas en el panel.
CBaseTabbedPane::GetFirstVisibleTab	Recupera un puntero a la primera pestaña mostrada.
CBaseTabbedPane::GetMinSize	Recupera el tamaño mínimo permitido para el panel. (Invalida CPane::GetMinSize).
CBaseTabbedPane::GetPaneIcon	Devuelve un manipulador al icono del panel. (Invalida CBasePane::GetPaneIcon).
CBaseTabbedPane::GetPaneList	Devuelve una lista de paneles incluidos en el panel con pestañas.
CBaseTabbedPane::GetTabArea	Devuelve los rectángulos delimitadores de las áreas de pestañas superior e inferior.
CBaseTabbedPane::GetTabsNum	Devuelve el recuento de pestañas en una ventana de pestañas.
CBaseTabbedPane::GetUnderlyingWindow	Obtiene la ventana de la pestaña subyacente (ajustada).
CBaseTabbedPane::GetVisibleTabsNum	Devuelve el recuento de pestañas mostradas.
CBaseTabbedPane::HasAutoHideMode	Determina si el panel con pestañas se puede cambiar a modo de ocultación automática.
CBaseTabbedPane::IsHideSingleTab	Determina si el panel con pestañas está oculto si solo se muestra una pestaña.
CBaseTabbedPane::LoadSiblingPaneIDs	Se usa internamente durante la serialización.
CBaseTabbedPane::RecalcLayout	Recalcula la información de diseño del panel. (Invalida CPane::RecalcLayout).
CBaseTabbedPane::RemovePane	Quita un panel del panel con pestañas.
CBaseTabbedPane::SaveSiblingBarIDs	Se usa internamente durante la serialización.
CBaseTabbedPane::Serialize	(Invalida CDockablePane::Serialize).
CBaseTabbedPane::SerializeTabWindow	Se usa internamente durante la serialización.
CBaseTabbedPane::SetAutoDestroy	Determina si la barra de control con pestañas se destruirá automáticamente.
CBaseTabbedPane::SetAutoHideMode	Alterna el panel de acoplamiento entre el modo de visualización y el de ocultación automática. (Invalida CDockablePane::SetAutoHideMode).
CBaseTabbedPane::ShowTab	Muestra u oculta una pestaña.

Comentarios

Esta es una clase abstracta y no puede crearse instancias de ella. Implementa los servicios que son comunes a todos los tipos de paneles con pestañas.

Actualmente, la biblioteca incluye dos clases de panel con pestañas derivadas: clase CTabbedPane y clase CMFCOutlookBar.

Un objeto CBaseTabbedPane encapsula un puntero a un objeto CMFCBaseTabCtrl Class. Después, la clase CMFCBaseTabCtrl se convierte en una ventana secundaria del panel con pestañas.

Para obtener más información sobre cómo crear paneles con pestañas, vea Clase CDockablePane, Clase CTabbedPane y Clase CMFCOutlookBar.

Jerarquía de herencia

CObject

CCmdTarget

CWnd

CBasePane

CPane

CDockablePane

CBaseTabbedPane

Requisitos

Encabezado: afxBaseTabbedPane.h

CBaseTabbedPane::AddTab

Agrega una pestaña nueva al panel con pestañas.

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

Parámetros

pNewBar
[in, out] Puntero al panel que se va a agregar. Este puntero puede no ser válido después de llamar a este método. Para obtener más información, vea la sección Comentarios.

bVisible
[in] Es TRUE para que la pestaña sea visible; de lo contrario, es FALSE.

bSetActive
[in] Es TRUE para que la pestaña sea la activa; de lo contrario, es FALSE.

bDetachable
[in] Es TRUE para que la pestaña sea desasociada; de lo contrario, es FALSE.

Valor devuelto

Es TRUE si el panel se agregó correctamente como una pestaña y no se destruyó en el proceso. Es FALSE si el panel que se va a agregar es un objeto de tipo CBaseTabbedPane. Para obtener más información, vea la sección Comentarios.

Comentarios

Llame a este método para agregar un panel como una pestaña nueva en un panel con pestañas. Si pNewBar apunta a un objeto de tipo CBaseTabbedPane, todas sus pestañas se copian en el panel con pestañas y, después, se destruye pNewBar. Por lo tanto, pNewBar se convierte en un puntero no válido y no debe usarse.

CBaseTabbedPane::AllowDestroyEmptyTabbedPane

Especifica si se puede destruir un panel con fichas vacío.

virtual BOOL AllowDestroyEmptyTabbedPane() const;

Valor devuelto

Es TRUE si se puede destruir un panel con fichas vacío; de lo contrario, es FALSE. La implementación predeterminada siempre devuelve TRUE.

Comentarios

Si no se permite destruir un panel con pestañas vacío, en lugar de eso el marco oculta el panel.

CBaseTabbedPane::ApplyRestoredTabInfo

Carga la configuración de las pestañas del registro y las aplica a un panel con pestañas.

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

Parámetros

bUseTabIndexes
[in] El marco usa este parámetro internamente.

Comentarios

El marco llama a este método cuando vuelve a cargar la información del estado de acoplamiento del registro. El método obtiene información sobre el orden y los nombres de las pestañas de un panel con pestañas.

CBaseTabbedPane::CanFloat

Especifica si el panel con pestañas puede ser flotante.

virtual BOOL CanFloat() const;

Valor devuelto

Es TRUE si el panel puede ser flotante; de lo contrario, es FALSE.

CBaseTabbedPane::CanSetCaptionTextToTabName

Determina si el título del panel con pestañas debe mostrar el mismo texto que la pestaña activa.

virtual BOOL CanSetCaptionTextToTabName() const;

Valor devuelto

Es TRUE si el texto del título del panel con pestañas se establece en el texto de la pestaña activa; de lo contrario, es FALSE.

Comentarios

El método se usa para determinar si el texto que se muestra en el título del panel con pestañas duplica la etiqueta de la pestaña activa. Puede habilitar o deshabilitar esta función llamando a CBaseTabbedPane::EnableSetCaptionTextToTabName.

CBaseTabbedPane::ConvertToTabbedDocument

Convierte uno o varios paneles acoplables en documentos con fichas de MDI.

virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);

Parámetros

bActiveTabOnly
[in] Al convertir un panel con pestañas, especifique TRUE para convertir solo la pestaña activa. Especifique FALSE para convertir todas las pestañas del panel.

CBaseTabbedPane::DetachPane

Desasocia un panel del panel con pestañas.

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

Parámetros

pBar
[in] Puntero al panel que se va a desasociar.

bHide
[in] Parámetro booleano que especifica si el marco oculta el panel después de desasociarlo.

Valor devuelto

Es TRUE si el marco desasocia correctamente el panel; es FALSE si pBar es NULL o hace referencia a un panel que no está en el panel con pestañas.

Comentarios

El marco hace flotante el panel desasociado si es posible. Para obtener más información, vea CBasePane::CanFloat.

CBaseTabbedPane::EnableSetCaptionTextToTabName

Habilita o deshabilita la capacidad del panel con pestañas para sincronizar el texto del título con el texto de la etiqueta en la pestaña activa.

virtual void EnableSetCaptionTextToTabName(BOOL bEnable);

Parámetros

bEnable
[in] Es TRUE para sincronizar el título del panel con pestañas con el título de pestaña activo; de lo contrario, es FALSE.

CBaseTabbedPane::FillDefaultTabsOrderArray

Restaura el orden de pestañas interno a un estado predeterminado.

void FillDefaultTabsOrderArray();

Comentarios

Se llama a este método cuando el marco restaura una barra de Outlook a un estado inicial.

CBaseTabbedPane::FindPaneByID

Devuelve un panel que identifica el id. de panel.

virtual CWnd* FindPaneByID(UINT uBarID);

Parámetros

uBarID
[in] Especifica el id. del panel que se va a buscar.

Valor devuelto

Puntero al panel si se encontró; de lo contrario, es NULL.

Comentarios

Este método compara todas las pestañas del panel y devuelve la que tiene el id. que especifica el parámetro uBarID.

CBaseTabbedPane::FindBarByTabNumber

Devuelve un panel que se encuentra en una pestaña.

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

Parámetros

nTabNum
[in] Especifica el índice de base cero de la pestaña que se va a recuperar.

bGetWrappedBar
[in] Es TRUE para devolver la ventana subyacente (ajustada) del panel en lugar del propio panel; en caso contrario, es FALSE. Este parámetro se aplica únicamente a las clases derivadas de CDockablePaneAdapter.

Valor devuelto

Si se encuentra el panel, se devuelve un puntero válido al panel que se busca; de lo contrario, es NULL.

Comentarios

Llame a este método para recuperar el panel que se encuentra en la pestaña que especifica el parámetro nTabNum.

CBaseTabbedPane::FloatTab

Convierte un panel en flotante, pero solo si el panel se encuentra actualmente en una pestaña desmontable.

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

Parámetros

pBar
[in, out] Puntero al panel que se va a hacer flotante.

nTabID
[in] Especifica el índice de base cero de la pestaña que se va a hacer flotante.

dockMethod
[in] Especifica el método que se va a usar para que el panel sea flotante. Para obtener más información, vea la sección Comentarios.

bHide
[in] Es TRUE para ocultar el panel antes de que sea flotante; de lo contrario, es FALSE.

Valor devuelto

Es TRUE si el panel es flotante; de lo contrario, es FALSE.

Comentarios

Llame a este método para hacer flotante un panel que se encuentra actualmente en una pestaña que se puede desasociar.

Si quiere desasociar un panel mediante programación, especifique DM_SHOW en el parámetro dockMethod. Si quiere hacer flotante el panel en la misma posición en la que era flotante anteriormente, especifique DM_DBL_CLICK como parámetro dockMethod.

CBaseTabbedPane::GetDefaultTabsOrder

Devuelve el orden predeterminado de las pestañas en el panel.

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

Valor devuelto

Objeto CArray que especifica el orden predeterminado de las pestañas en el panel.

Comentarios

El marco llama a este método cuando se restablece una barra de Outlook a un estado inicial.

CBaseTabbedPane::GetFirstVisibleTab

Recupera un puntero a la primera pestaña mostrada.

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

Parámetros

iTabNum
[in] Referencia a un entero. Este método escribe el índice de base cero de la primera pestaña mostrada en este parámetro, o bien -1 si no se encuentra ninguna pestaña mostrada.

Valor devuelto

Puntero a la primera pestaña visible si es correcto; de lo contrario, es NULL.

CBaseTabbedPane::GetMinSize

Recupera el tamaño mínimo permitido para el panel.

virtual void GetMinSize(CSize& size) const;

Parámetros

size
[out] Objeto CSize que se rellena con el tamaño mínimo permitido.

Comentarios

Si el control coherente de los tamaños mínimos del panel está activo (CPane::m_bHandleMinSize), size se rellena con el tamaño mínimo permitido para la pestaña activa. De lo contrario, size se rellena con el valor devuelto de CPane::GetMinSize.

CBaseTabbedPane::GetPaneIcon

Recupera el tamaño mínimo permitido para el panel.

virtual void GetMinSize(CSize& size) const;

Parámetros

size
[out] Objeto CSize que se rellena con el tamaño mínimo permitido.

Comentarios

Si el control coherente de los tamaños mínimos del panel está activo (CPane::m_bHandleMinSize), size se rellena con el tamaño mínimo permitido para la pestaña activa. De lo contrario, size se rellena con el valor devuelto de CPane::GetMinSize.

CBaseTabbedPane::GetPaneList

Devuelve una lista de paneles incluidos en el panel con pestañas.

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

Parámetros

lst
[out] Elemento CObList que se rellena con los paneles incluidos en el panel con pestañas.

pRTCFilter
[in] Si no es NULL, la lista devuelta solo contiene paneles que son de la clase en tiempo de ejecución especificada.

CBaseTabbedPane::GetTabArea

Devuelve los rectángulos delimitadores de las áreas de pestañas superior e inferior.

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

Parámetros

rectTabAreaTop
[out] Recibe las coordenadas de pantalla del área de pestañas superior.

rectTabAreaBottom
[out] Recibe las coordenadas de pantalla del área de pestañas inferior.

Comentarios

Llame a este método para determinar los rectángulos delimitadores, en coordenadas de pantalla, para las áreas de pestañas superior e inferior.

CBaseTabbedPane::GetTabsNum

Devuelve el recuento de pestañas en una ventana de pestañas.

virtual int GetTabsNum() const;

Valor devuelto

Número de pestañas en el panel con pestañas.

CBaseTabbedPane::GetUnderlyingWindow

Obtiene la ventana de la pestaña subyacente (ajustada).

virtual CMFCBaseTabCtrl* GetUnderlyingWindow();

Valor devuelto

Puntero a la ventana de pestañas subyacente.

CBaseTabbedPane::GetVisibleTabsNum

Devuelve el recuento de pestañas visibles.

virtual int GetVisibleTabsNum() const;

Valor devuelto

Número de pestañas visibles, que serán mayores o iguales que cero.

Comentarios

Llame a este método para determinar el número de pestañas visibles en el panel con pestañas.

CBaseTabbedPane::HasAutoHideMode

Determina si el panel con pestañas se puede cambiar a modo de ocultación automática.

virtual BOOL HasAutoHideMode() const;

Valor devuelto

Es TRUE si el panel se puede cambiar al modo de ocultación automática; de lo contrario, es FALSE.

Comentarios

Si el modo de ocultación automática está deshabilitado, no se muestra ningún botón de anclaje en el título del panel con pestañas.

CBaseTabbedPane::IsHideSingleTab

Determina si el panel con pestañas está oculto si solo se muestra una pestaña.

virtual BOOL IsHideSingleTab() const;

Valor devuelto

Es TRUE si la ventana de pestañas no se muestra cuando solo hay una pestaña visible; de lo contrario, es FALSE.

Comentarios

Si el panel no se muestra porque solo hay una pestaña abierta, puede llamar a este método para determinar si el panel con pestañas funciona correctamente.

CBaseTabbedPane::RemovePane

Quita un panel del panel con pestañas.

virtual BOOL RemovePane(CWnd* pBar);

Parámetros

pBar
[in, out] Puntero al panel que se va a quitar del panel con pestañas.

Valor devuelto

Es TRUE si el panel se quitó correctamente del panel con pestañas y si este último sigue siendo válido. Es FALSE si el último panel se ha quitado del panel con pestañas y si este último está a punto de destruirse. Si el valor devuelto es FALSE, deje de usar el panel con pestañas.

Comentarios

Llame a este método para quitar el panel que especifica el parámetro pBar del panel con pestañas.

CBaseTabbedPane::SetAutoDestroy

Determina si la barra de control con pestañas se destruirá automáticamente.

void SetAutoDestroy(BOOL bAutoDestroy = TRUE);

Parámetros

bAutoDestroy
[in] Es TRUE si el panel con pestañas se creó dinámicamente y no controla su duración; de lo contrario, es FALSE.

Comentarios

Establezca el modo de destrucción automática en TRUE si crea un panel con pestañas dinámicamente y no controla su duración. Si el modo de destrucción automática es TRUE, el marco destruirá automáticamente el panel con pestañas.

CBaseTabbedPane::ShowTab

Muestra u oculta una pestaña.

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

Parámetros

pBar
[in] Puntero al panel que se va a mostrar u ocultar.

bShow
[in] Es TRUE para mostrar el panel; es FALSE para ocultarlo.

bDelay
[in] Es TRUE para retrasar el ajuste del diseño de la pestaña; de lo contrario, es FALSE.

bActivate
[in] Es TRUE para que la pestaña sea la activa; de lo contrario, es FALSE.

Valor devuelto

Es TRUE si la pestaña se ha mostrado u ocultado correctamente; de lo contrario, es FALSE.

Comentarios

Al llamar a este método, se muestra u oculta un panel, en función del valor del parámetro bShow. Si oculta una pestaña y esta es la última visible en la ventana de pestañas subyacente, el panel con pestañas se oculta. Si muestra una pestaña cuando anteriormente no había pestañas visibles, se muestra el panel con pestañas.

CBaseTabbedPane::RecalcLayout

Recalcula la información de diseño del panel.

virtual void RecalcLayout();

Comentarios

Si el panel es flotante, este método notifica al marco que cambie el tamaño del panel al tamaño actual del minimarco.

Si el panel está acoplado, este método no hace nada.

CBaseTabbedPane::SetAutoHideMode

Establece el modo de ocultación automática para paneles que se pueden desasociar en el panel con pestañas.

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

Parámetros

bMode
[in] Es TRUE para habilitar el modo de ocultación automática; es FALSE para habilitar el modo de acoplamiento normal.

dwAlignment
[in] Especifica la alineación del panel de ocultación automática que se va a crear. Para obtener una lista de valores posibles, vea CPane::MoveByAlignment.

pCurrAutoHideBar
[in, out] Puntero a la barra de herramientas de ocultación automática actual. Puede ser NULL.

bUseTimer
[in] Especifica si se debe usar el efecto de ocultación automática cuando el usuario cambia el panel al modo de ocultación automática o si se debe ocultar el panel inmediatamente.

Valor devuelto

Puntero a la barra de herramientas de ocultación automática que se crea al cambiar al modo de ocultación automática, o NULL si no se crea ninguna barra de herramientas.

Comentarios

El marco llama a este método cuando un usuario elige el botón de anclaje para cambiar el panel con pestañas al modo de ocultación automática o al de acoplamiento normal.

El modo de ocultación automática se establece para cada panel que se puede desasociar en el panel con pestañas. Los paneles que no se pueden desasociar se omiten. Para obtener más información, vea CMFCBaseTabCtrl::EnableTabDetach.

Llame a este método para cambiar un panel con pestañas al modo de ocultación automática mediante programación. El panel debe acoplarse a la ventana de marco principal (CDockablePane::GetDefaultPaneDivider debe devolver un puntero válido a CPaneDivider).

Consulte también

Gráfico de jerarquías
Clases
CDockablePane (clase)