Clase CBasePane

Clase base de todos los paneles de MFC.

Sintaxis

class CBasePane : public CWnd

Miembros

Constructores públicos

Nombre	Descripción
CBasePane::CBasePane	Constructor predeterminado.
CBasePane::~CBasePane	Destructor.

Métodos públicos

Nombre	Descripción
CBasePane::accHitTest	El marco llama a este método para recuperar el elemento u objeto secundario situado en un punto dado de la pantalla. (Invalida CWnd::accHitTest).
CBasePane::accLocation	El marco llama a este método para recuperar la ubicación actual del objeto especificado en la pantalla. (Invalida CWnd::accLocation).
CBasePane::AccNotifyObjectFocusEvent	CBasePane no usa este método.
CBasePane::accSelect	El marco llama a este método para modificar la selección o desplazar el foco de teclado del objeto especificado. (Invalida CWnd::accSelect).
CBasePane::AddPane	Agrega un panel al administrador de acoplamiento.
CBasePane::AdjustDockingLayout	Redirige una llamada al administrador de acoplamiento para ajustar el diseño del acoplamiento.
CBasePane::AdjustLayout	Lo llama el marco cuando el panel debe ajustar su diseño interno.
CBasePane::CalcFixedLayout	Calcula el tamaño horizontal de una barra de control.
CBasePane::CanAcceptPane	Determina si se puede acoplar otro panel al panel.
CBasePane::CanAutoHide	Determina si el panel admite el modo de ocultación automática.
CBasePane::CanBeAttached	Determina si se puede acoplar el panel a otro panel.
CBasePane::CanBeClosed	Determina si se puede cerrar el panel.
CBasePane::CanBeDocked	Determina si se puede acoplar el panel a otro panel.
CBasePane::CanBeResized	Determina si se puede cambiar el tamaño del panel.
CBasePane::CanBeTabbedDocument	Especifica si el panel se puede convertir en un documento MDI con pestañas.
CBasePane::CanFloat	Determina si el panel puede ser flotante.
CBasePane::CanFocus	Especifica si el panel puede recibir el foco.
CBasePane::CopyState	Copia el estado de un panel determinado.
CBasePane::CreateDefaultMiniframe	Si el panel puede flotar, crea una ventana minimarco.
CBasePane::CreateEx	Crea el control del panel.
CBasePane::DockPane	Acopla un panel a otro panel o a una ventana de marco.
CBasePane::DockPaneUsingRTTI	Acopla el panel mediante información de tipos en tiempo de ejecución.
CBasePane::DockToFrameWindow	Acopla un panel acoplable a un marco.
CBasePane::DoesAllowDynInsertBefore	Determina si se puede insertar otro panel dinámicamente entre este panel y el marco primario.
CBasePane::EnableDocking	Habilita el acoplamiento del panel al marco principal.
CBasePane::EnableGripper	Habilita o deshabilita la barra de redimensionamiento. Si la barra de redimensionamiento está habilitada, el usuario puede arrastrarla para cambiar la posición del panel.
CBasePane::FillWindowRect	Utilizado de forma interna.
CBasePane::FloatPane	Hace que el panel flote.
CBasePane::get_accChild	El marco llama a este método para recuperar la dirección de una interfaz IDispatch del elemento secundario especificado. (Invalida CWnd::get_accChild).
CBasePane::get_accChildCount	El marco llama a este método para recuperar el número de elementos secundarios que pertenecen a este objeto. (Invalida CWnd::get_accChildCount).
CBasePane::get_accDefaultAction	El marco llama a este método para recuperar una cadena que describe la acción predeterminada del objeto. (Invalida CWnd::get_accDefaultAction).
CBasePane::get_accDescription	El marco llama a este método para recuperar una cadena que describe la apariencia visual del objeto especificado. (Invalida CWnd::get_accDescription).
CBasePane::get_accFocus	El marco llama a este método para recuperar el objeto que tiene el foco de teclado. (Invalida CWnd::get_accFocus).
CBasePane::get_accHelp	El marco llama a este método para recuperar una cadena de propiedad Help del objeto. (Invalida CWnd::get_accHelp).
CBasePane::get_accHelpTopic	El marco llama a este método para recuperar la ruta de acceso completa del archivo WinHelp que está asociado al objeto especificado y el identificador del tema adecuado en ese archivo. (Invalida CWnd::get_accHelpTopic).
CBasePane::get_accKeyboardShortcut	El marco llama a este método para recuperar la tecla de método abreviado especificada para el objeto. (Invalida CWnd::get_accKeyboardShortcut).
CBasePane::get_accName	El marco llama a este método para recuperar el nombre del objeto especificado. (Invalida CWnd::get_accName).
CBasePane::get_accParent	El marco llama a este método para recuperar la interfaz IDispatch del elemento principal del objeto. (Invalida CWnd::get_accParent).
CBasePane::get_accRole	El marco llama a este método para recuperar información que describe el rol del objeto especificado. (Invalida CWnd::get_accRole).
CBasePane::get_accSelection	El marco llama a este método para recuperar el elemento secundario seleccionado de este objeto. (Invalida CWnd::get_accSelection).
CBasePane::get_accState	El marco llama a este método para recuperar el estado actual del objeto especificado. (Invalida CWnd::get_accState).
CBasePane::get_accValue	El marco llama a este método para recuperar el valor del objeto especificado. (Invalida CWnd::get_accValue).
CBasePane::GetCaptionHeight	Devuelve la altura del título.
CBasePane::GetControlBarStyle	Devuelve el estilo de la barra de control.
CBasePane::GetCurrentAlignment	Devuelve la alineación del panel actual.
CBasePane::GetDockingMode	Devuelve el modo de acoplamiento actual para el panel.
CBasePane::GetDockSiteFrameWnd	Devuelve un puntero a la ventana que es el sitio de acoplamiento del panel.
CBasePane::GetEnabledAlignment	Devuelve los estilos CBRS_ALIGN_ que se aplican al panel.
CBasePane::GetMFCStyle	Devuelve los estilos de panel específicos de MFC.
CBasePane::GetPaneIcon	Devuelve un manipulador al icono del panel.
CBasePane::GetPaneRect	Utilizado de forma interna.
CBasePane::GetPaneRow	Devuelve un puntero al objeto CDockingPanesRow en el que se acopla el panel.
CBasePane::GetPaneStyle	Devuelve el estilo del panel.
CBasePane::GetParentDockSite	Devuelve un puntero al sitio de acoplamiento primario.
CBasePane::GetParentMiniFrame	Devuelve un puntero a la ventana minimarco primaria.
CBasePane::GetParentTabbedPane	Devuelve un puntero al panel primario con pestañas.
CBasePane::GetParentTabWnd	Devuelve un puntero a la ventana primaria que está dentro de una pestaña.
CBasePane::GetRecentVisibleState	El marco llama a este método cuando se restaura un panel desde un archivo.
CBasePane::HideInPrintPreviewMode	Especifica si el panel está oculto en la vista previa de impresión.
CBasePane::InsertPane	Registra el panel especificado con el administrador de acoplamiento.
CBasePane::IsAccessibilityCompatible	Especifica si el panel admite Active Accessibility.
CBasePane::IsAutoHideMode	Determina si un panel está en modo de ocultación automática.
CBasePane::IsDialogControl	Especifica si el panel es un control de diálogo.
CBasePane::IsDocked	Determina si el panel está acoplado.
CBasePane::IsFloating	Determina si el panel está flotando.
CBasePane::IsHorizontal	Determina si el panel está acoplado de manera horizontal.
CBasePane::IsInFloatingMultiPaneFrameWnd	Especifica si el panel está en una ventana de marco de varios panel.
CBasePane::IsMDITabbed	Determina si el panel se agregó a una ventana secundaria de MDI como documento con pestañas.
CBasePane::IsPaneVisible	Especifica si la marca WS_VISIBLE está establecida para el panel.
CBasePane::IsPointNearDockSite	Determina si un punto especificado está cerca del sitio de acoplamiento.
CBasePane::IsResizable	Determina si se puede cambiar el tamaño del panel.
CBasePane::IsRestoredFromRegistry	Determina si el panel se restaura desde el registro.
CBasePane::IsTabbed	Determina si el panel se insertó en el control de pestaña de una ventana con pestañas.
CBasePane::IsTooltipTopmost	Utilizado de forma interna.
CBasePane::IsVisible	Determina si el panel está visible.
CBasePane::LoadState	Carga el estado del panel desde el registro.
CBasePane::MoveWindow	Mueve el panel.
CBasePane::OnAfterChangeParent	El marco llama a este método cuando ha cambiado el elemento primario del panel.
CBasePane::OnBeforeChangeParent	El marco llama a este método justo antes de que el panel cambie su ventana primaria.
CBasePane::OnDrawCaption	El marco llama a este método cuando se dibuja el título.
CBasePane::OnMovePaneDivider	Este método no se usa actualmente.
CBasePane::OnPaneContextMenu	El marco llama a este método cuando crea un menú que tiene una lista de paneles.
CBasePane::OnRemoveFromMiniFrame	El marco llama a este método cuando se quita un panel de su ventana minimarco primaria.
CBasePane::OnSetAccData	CBasePane no usa este método.
CBasePane::OnUpdateCmdUI	Utilizado de forma interna.
CBasePane::PaneFromPoint	Devuelve el panel que contiene el punto especificado.
CBasePane::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).
CBasePane::RecalcLayout	CBasePane no usa este método.
CBasePane::RemovePaneFromDockManager	Anula el registro de un panel y lo quita de la lista del administrador de acoplamiento.
CBasePane::SaveState	Guarda el estado del panel en el registro.
CBasePane::SelectDefaultFont	Selecciona la fuente predeterminada para un contexto de dispositivo determinado.
CBasePane::Serialize	Lee o escribe este objeto de o en un archivo. (Invalida CObject::Serialize).
CBasePane::SetControlBarStyle	Establece el estilo de la barra de control.
CBasePane::SetDockingMode	Establece el modo de acoplamiento para el panel.
CBasePane::SetMDITabbed	Utilizado de forma interna.
CBasePane::SetPaneAlignment	Establece la alineación del panel.
CBasePane::SetPaneRect	Utilizado de forma interna.
CBasePane::SetPaneStyle	Establece el estilo del panel.
CBasePane::SetRestoredFromRegistry	Utilizado de forma interna.
CBasePane::SetWindowPos	Cambia el tamaño, la posición y el orden Z de un panel.
CBasePane::ShowPane	Muestra u oculta el panel.
CBasePane::StretchPane	Expande un panel vertical u horizontalmente.
CBasePane::UndockPane	Quita el panel del sitio de acoplamiento, el control deslizante predeterminado o la ventana minimarco donde está acoplado actualmente.

Métodos protegidos

Nombre	Descripción
CBasePane::DoPaint	Llena el fondo del panel.

Comentarios

Si desea crear una clase de panel que admita las características de acoplamiento extendidas disponibles en MFC, debe derivarla de CBasePane o de la clase CPane.

Sugerencias de personalización

Las sugerencias de personalización siguientes se refieren a la CBasePane Class y a todas las clases que heredan de ella:

• Cuando crea un panel, puede aplicar varios estilos nuevos:

  • AFX_CBRS_FLOAT hace que el panel flote.

  • AFX_CBRS_AUTOHIDE habilita el modo de ocultación automática.

  • AFX_CBRS_CLOSE permite que el panel se cierre (oculte).

  Se trata de marcas que se pueden combinar con una operación OR bit a bit.

CBasePane implementa los métodos booleanos virtuales siguientes para reflejar estas marcas: CBasePane::CanBeClosed, CBasePane::CanAutoHide, CBasePane::CanFloat. Puede invalidarlos en clases derivadas para personalizar su comportamiento.

• Para personalizar el comportamiento de acoplamiento, invalide CBasePane::CanAcceptPane. Haga que el panel devuelva FALSE desde este método para evitar que se le acople otro panel.

• Si desea crear un panel estático que no pueda flotar y que impida que cualquier otro panel se acople frente a él (de manera similar a la barra de Outlook en el ejemplo de OutlookDemo), créelo como no flotante e invalide CBasePane::DoesAllowDynInsertBefore para devolver FALSE. La implementación predeterminada devuelve FALSE si el panel se crea sin el estilo AFX_CBRS_FLOAT.

• Cree todos los paneles con identificadores distintos de -1.

• Para determinar la visibilidad del panel, use CBasePane::IsVisible. Manipula correctamente el estado de visibilidad en los modos de ocultación automática y con pestañas.

• Si desea crear un panel ajustable y no flotante, créelo sin el estilo AFX_CBRS_FLOAT y llame a CFrameWnd::DockControlBar.

• Para excluir un panel de un diseño de acoplamiento o para quitar una barra de herramientas de su barra de acoplamiento, llame a CBasePane::UndockPane. No llame a este método para paneles en modo de ocultación automática o para paneles que residen en pestañas de ventanas con pestañas.

• Si desea desacoplar o hacer que flote un panel que está en modo de ocultación automática, debe llamar a CDockablePane::SetAutoHideMode con FALSE como el primer argumento antes de llamar a CBasePane::FloatPane o CBasePane::UndockPane.

Ejemplo

En el siguiente ejemplo se muestra cómo usar los distintos métodos en la clase CBasePane . En el ejemplo, se muestra cómo recuperar un panel de la clase CFrameWndEx y cómo establecer el modo de acoplamiento, la alineación del panel y el estilo del panel. El código procede del ejemplo de WordPad.

// This CMainFrame class extends the CFrameWndEx class.
// GetPane is a method in the CFrameWndEx class which
// Returns a pointer to the pane that has the specified ID.
CBasePane *pBar = GetPane(ID_VIEW_FORMATBAR);
if (pBar != NULL)
{
    // Set the docking mode, the pane alignment, and the pane style.
    pBar->SetDockingMode(DT_STANDARD);
    pBar->SetPaneAlignment(CBRS_ALIGN_LEFT);
    pBar->SetPaneStyle(pBar->GetCurrentAlignment() | CBRS_TOOLTIPS);
    pBar->ShowPane(TRUE, FALSE, FALSE);
}

Jerarquía de herencia

CObject

CCmdTarget

CWnd

CBasePane

Requisitos

Encabezado: afxbasepane.h

CBasePane::AccNotifyObjectFocusEvent

CBasePane no usa este método.

virtual void AccNotifyObjectFocusEvent(int);

Parámetros

int
[in] No se utiliza.

CBasePane::AddPane

Agrega un panel al administrador de acoplamiento.

void AddPane(CBasePane* pBar);

Parámetros

pBar
[in] Puntero a un panel que se va a agregar.

Comentarios

Este es un método práctico que agrega un panel a un administrador de acoplamiento. Al usar este método, no es necesario escribir código que analice el tipo del marco primario.

Para más información, consulte Clase CDockingManager y CMDIFrameWndEx::AddPane.

CBasePane::AdjustDockingLayout

Redirige una llamada al administrador de acoplamiento para ajustar el diseño del acoplamiento.

virtual void AdjustDockingLayout(HDWP hdwp=NULL);

Parámetros

hdwp
[out] Manipulador de una estructura que contiene varias posiciones de ventana.

Comentarios

Este es un método práctico que ajusta el diseño de acoplamiento. Al usar este método, no es necesario escribir código que analice el tipo del marco primario.

Para más información, consulte CDockingManager::AdjustDockingLayout

CBasePane::AdjustLayout

El marco llama a este método para ajustar el diseño interno de un panel.

virtual void AdjustLayout();

Comentarios

El marco llama a este método cuando un panel tiene que ajustar su diseño interno. La implementación base no hace nada.

CBasePane::CalcFixedLayout

Calcula el tamaño horizontal de una barra de control.

virtual CSize CalcFixedLayout(
    BOOL bStretch,
    BOOL bHorz);

Parámetros

bStretch
[in] Indica si la barra debe ajustarse al tamaño del marco. El parámetro bStretch es distinto de cero cuando la barra no es una barra de acoplamiento (no disponible para el acoplamiento) y es 0 cuando está acoplada o es flotante (disponible para acoplamiento).

bHorz
[in] Indica que la barra está orientada horizontal o verticalmente. El parámetro bHorz es distinto de cero si la barra está orientada horizontalmente y es 0 si lo está verticalmente.

Valor devuelto

El tamaño de la barra de control, en píxeles, de un objeto CSize.

Comentarios

Consulte la sección de comentarios en CControlBar::CalcFixedLayout

CBasePane::CanAcceptPane

Determina si se puede acoplar otro panel al panel.

virtual BOOL CanAcceptPane(const CBasePane* pBar) const;

Parámetros

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

Valor devuelto

TRUE si se puede aceptar otro panel; de lo contrario, FALSE.

Comentarios

El marco llama a este método antes de acoplar el panel especificado por pBar al panel actual.

Use este método y el método CBasePane::CanBeDocked para controlar cómo se acoplan los paneles a otros paneles de la aplicación.

La implementación predeterminada devuelve FALSE.

CBasePane::CanAutoHide

Determina si el panel admite el modo de ocultación automática.

virtual BOOL CanAutoHide() const;

Valor devuelto

TRUE si este panel admite el modo de ocultación automática; de lo contrario, FALSE.

Comentarios

El marco llama a esta función para determinar si el panel admite el modo de ocultación automática.

Durante la construcción, puede establecer esta capacidad pasando la marca AFX_CBRS_AUTOHIDE a CBasePane::CreateEx.

La implementación predeterminada comprueba la marca AFX_CBRS_AUTOHIDE. Invalide este método en una clase derivada para personalizar este comportamiento.

CBasePane::CanBeAttached

Determina si se puede acoplar el panel actual a otro panel o ventana de marco.

virtual BOOL CanBeAttached() const;

Valor devuelto

TRUE si el panel se puede acoplar a otro panel o ventana de marco; de lo contrario, FALSE.

Comentarios

La implementación predeterminada devuelve FALSE. Invalide este método en una clase derivada para habilitar o deshabilitar la capacidad de acoplamiento sin llamar a CBasePane::EnableDocking.

CBasePane::CanBeClosed

Determina si se puede cerrar el panel.

virtual BOOL CanBeClosed() const;

Valor devuelto

TRUE si se puede cerrar el panel; de lo contrario, FALSE.

Comentarios

El marco llama a este método para determinar si se puede cerrar el panel. Si el método devuelve TRUE, se agrega un botón Cerrar a la barra de título del panel o, si el panel es flotante, a la barra de título de la ventana minimarco del panel.

Durante la construcción, puede establecer esta capacidad pasando la marca AFX_CBRS_CLOSE a CBasePane::CreateEx.

La implementación predeterminada comprueba la marca AFX_CBRS_CLOSE.

CBasePane::CanBeDocked

Determina si se puede acoplar el panel a otro panel.

virtual BOOL CanBeDocked(CBasePane* pDockBar) const;

Parámetros

pDockBar
[in] Puntero a otro panel.

Valor devuelto

TRUE si este panel se puede acoplar a otro panel; de lo contrario, FALSE.

Comentarios

El marco llama a este método antes de acoplar el panel especificado por pDockBar al panel actual.

Use este método y el método CBasePane::CanAcceptPane para controlar cómo se acoplan los paneles a otros paneles de la aplicación.

La implementación predeterminada devuelve FALSE.

CBasePane::CanBeResized

Determina si se puede cambiar el tamaño del panel.

virtual BOOL CanBeResized() const;

Valor devuelto

TRUE si se puede cambiar el tamaño del panel; de lo contrario, FALSE.

Comentarios

Este método comprueba la marca AFX_CBRS_RESIZE, que se especifica de manera predeterminada en CBasePane::OnCreate. Si no se especifica esta marca, el administrador de acoplamiento marca el panel internamente como inamovible en lugar de acoplarlo.

CBasePane::CanBeTabbedDocument

Especifica si el panel se puede convertir en un documento MDI con pestañas.

virtual BOOL CanBeTabbedDocument() const;

Valor devuelto

TRUE si el panel se puede convertir en un documento con pestañas; de lo contrario, FALSE. CBasePane::CanBeTabbedDocument siempre devuelve FALSE.

Comentarios

Solo los objetos de determinados tipos derivados de CBasePane, como la clase CDockablePane, se pueden convertir en documentos con pestañas.

CBasePane::CanFloat

Determina si el panel puede ser flotante.

virtual BOOL CanFloat() const;

Valor devuelto

TRUE si el panel puede flotar; de lo contrario, FALSE.

Comentarios

El marco llama a este método para determinar si el panel puede flotar.

Durante la construcción, puede establecer esta capacidad pasando la marca AFX_CBRS_FLOAT a CBasePane::CreateEx.

Nota:

En el marco, se presupone que los paneles no flotantes son estáticos y que su estado de acoplamiento no puede cambiar. Por lo tanto, el marco no guarda el estado de acoplamiento de paneles no flotantes.

La implementación predeterminada comprueba el estilo AFX_CBRS_FLOAT.

CBasePane::CanFocus

Especifica si el panel puede recibir el foco.

virtual BOOL CanFocus() const;

Valor devuelto

TRUE si el panel puede recibir el foco; de lo contrario, FALSE.

Comentarios

Invalide este método en una clase derivada para controlar el foco. Por ejemplo, dado que las barras de herramientas no pueden recibir el foco, este método devuelve FALSE cuando se lo llama en los objetos de la barra de herramientas.

El marco intenta establecer el foco de entrada cuando un panel está acoplado o es flotante.

CBasePane::CopyState

Copia el estado de un panel determinado.

virtual void CopyState(CBasePane* pOrgBar);

Parámetros

pOrgBar
[in] Puntero a otro panel.

Comentarios

Este método copia el estado de pOrgBar en este panel.

CBasePane::CreateDefaultMiniframe

Si el panel puede flotar, este método crea una ventana minimarco para él.

virtual CPaneFrameWnd* CreateDefaultMiniframe(CRect rectInitial);

Parámetros

rectInitial
[in] Especifica las coordenadas iniciales de la ventana minimarco.

Valor devuelto

Puntero a la ventana minimarco nueva o NULL si se produjo un error en la creación.

Comentarios

El marco llama a este método cuando un panel cambia a un estado flotante. El método crea una ventana minimarco y asocia el panel a esta ventana.

La implementación predeterminada devuelve NULL.

CBasePane::CreateEx

Crea el control del panel.

virtual BOOL CreateEx(
    DWORD dwStyleEx,
    LPCTSTR lpszClassName,
    LPCTSTR lpszWindowName,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID,
    DWORD dwControlBarStyle=0,
    CCreateContext* pContext=NULL);

Parámetros

dwStyleEx
[in] Estilos extendidos (consulte CWnd::CreateEx para más información).

lpszClassName
[in] Nombre de la clase de la ventana.

lpszWindowName
[in] Nombre de la ventana.

dwStyle
[in] Estilo de la ventana (consulte CWnd::CreateEx).

rect
[in] Rectángulo inicial.

pParentWnd
[in] Puntero a la ventana primaria.

Nid
[in] Especifica el identificador del panel. Debe ser único.

dwControlBarStyle
[in] Marcas de estilo para paneles.

pContext
[in] Puntero a CcreateContext

Valor devuelto

TRUE si el panel se crea correctamente; de lo contrario, FALSE.

Comentarios

Crea una ventana de la clase lpszClassName. Si especifica WS_CAPTION, este método borra el bit de estilo WS_CAPTION y establece CBasePane::m_bHasCaption en TRUE, porque la biblioteca no admite paneles con títulos.

Puede usar cualquier combinación de estilos de ventana secundarios y estilos de barra de control MFC (CBRS_).

La biblioteca agrega varios estilos nuevos para paneles. En la tabla siguiente, se describen los eventos nuevos:

Estilo	Descripción
AFX_CBRS_FLOAT	El panel puede flotar.
AFX_CBRS_AUTOHIDE	El panel admite el modo de ocultación automática.
AFX_CBRS_RESIZE	Se puede cambiar el tamaño del panel. Importante: Este estilo no está implementado.
AFX_CBRS_CLOSE	El panel se puede cerrar.
AFX_CBRS_AUTO_ROLLUP	El panel se puede enrollar cuando flota.
AFX_CBRS_REGULAR_TABS	Cuando un panel se acopla a otro que tiene este estilo, se crea una ventana con pestañas normal. (Para más información, consulte Clase CTabbedPane).
AFX_CBRS_OUTLOOK_TABS	Cuando un panel se acopla a otro que tiene este estilo, se crea una ventana con pestañas con estilo de Outlook. (Para más información, consulte Clase CMFCOutlookBar).

Para usar los estilos nuevos, especifíquelos en dwControlBarStyle.

CBasePane::DockPane

Acopla un panel a otro panel o a una ventana de marco.

virtual BOOL DockPane(
    CBasePane* pDockBar,
    LPCRECT lpRect,
    AFX_DOCK_METHOD dockMethod);

Parámetros

pDockBar
[in] Puntero a otro panel.

lpRect
[in] Especifica el rectángulo de destino.

dockMethod
[in] Especifica el método de acoplamiento.

Valor devuelto

TRUE si la barra de control se acopló correctamente; de lo contrario, FALSE.

Comentarios

Llame a esta función para acoplar un panel a otro panel o a una barra de acoplamiento (clase CDockSite) que pDockBar especifica, o bien a un marco principal si pDockBar es NULL.

dockMethod especifica cómo se acopla el panel. Consulte CPane::DockPane para una lista de los valores posibles.

CBasePane::DockPaneUsingRTTI

Acopla el panel mediante información de tipos en tiempo de ejecución.

void DockPaneUsingRTTI(BOOL bUseDockSite);

Parámetros

bUseDockSite
[in] Si es TRUE, acoplar al sitio de acoplamiento. Si es FALSE, acoplar al marco primario.

CBasePane::DockToFrameWindow

Acopla un panel acoplable a un marco.

virtual BOOL DockToFrameWindow(
    DWORD dwAlignment,
    LPCRECT lpRect = NULL,
    DWORD dwDockFlags = DT_DOCK_LAST,
    CBasePane* pRelativeBar = NULL,
    int nRelativeIndex = -1,
    BOOL bOuterEdge = FALSE);

Parámetros

dwAlignment
[in] El lado del marco primario al que desea acoplar el panel.

lpRect
[in] El tamaño deseado.

dwDockFlags
[in] Ignorado.

pRelativeBar
[in] Ignorado.

nRelativeIndex
[in] Ignorado.

bOuterEdge
[in] Si es TRUE y hay otros paneles acoplables en el lado que dwAlignment especifica, el panel se acopla fuera de los demás paneles, más cerca del borde del marco primario. Si es FALSE, el panel se acopla más cerca del centro del área cliente.

Valor devuelto

TRUE si el método se aplicó correctamente; de lo contrario, FALSE.

Comentarios

Este método genera un error si no se puede crear un divisor de panel (clase CPaneDivider). De lo contrario, siempre devuelve TRUE.

CBasePane::DoesAllowDynInsertBefore

Determina si se puede insertar otro panel dinámicamente entre este panel y el marco primario.

virtual BOOL DoesAllowDynInsertBefore() const;

Valor devuelto

TRUE si un usuario puede insertar otro panel; de lo contrario, FALSE.

Comentarios

El marco llama a este método para determinar si un usuario puede insertar dinámicamente un panel antes de este panel.

Por ejemplo, supongamos que la aplicación crea un panel acoplado en el lado izquierdo del marco (como la barra de Outlook). Para evitar que el usuario acople otro panel a la izquierda del primer panel, invalide este método y devuelva FALSE.

Se recomienda invalidar este método y devolver FALSE en el caso de paneles no flotantes que deriven de la clase CDockablePane.

La implementación predeterminada devuelve TRUE.

CBasePane::DoPaint

Llena el fondo del panel.

virtual void DoPaint(CDC* pDC);

Parámetros

pDC
[in] Puntero a un contexto de dispositivo.

Comentarios

La implementación predeterminada llama al administrador visual actual para llenar el fondo (CMFCVisualManager::OnFillBarBackground).

CBasePane::EnableDocking

Habilita el acoplamiento del panel al marco principal.

virtual void EnableDocking(DWORD dwAlignment);

Parámetros

dwAlignment
[in] Especifica la alineación de acoplamiento que se va a habilitar.

Comentarios

Llame a este método para habilitar la alineación de acoplamiento en el marco principal. Puede pasar una combinación de marcas CBRS_ALIGN_ (para más información, consulte CControlBar::EnableDocking).

EnableDocking establece la marca interna CBasePane::m_dwEnabledAlignment y el marco comprueba esta marca cuando se acopla un panel.

Llame a CBasePane::GetEnabledAlignment para determinar la alineación de acoplamiento de un panel.

CBasePane::EnableGripper

Habilita o deshabilita la barra de redimensionamiento. Si la barra de redimensionamiento está habilitada, el usuario puede arrastrarla para cambiar la posición del panel.

virtual void EnableGripper(BOOL bEnable);

Parámetros

bEnable
[in] TRUE para habilitar la barra de redimensionamiento; FALSE para deshabilitarla.

Comentarios

El marco de trabajo usa este método para habilitar una barra de redimensionamiento en lugar de usar el estilo WS_CAPTION.

CBasePane::FloatPane

Hace que el panel flote.

virtual BOOL FloatPane(
    CRect rectFloat,
    AFX_DOCK_METHOD dockMethod=DM_UNKNOWN,
    bool bShow=true);

Parámetros

rectFloat
[in] Especifica las coordenadas de pantalla en las que aparece el panel flotante.

dockMethod
[in] Especifica el método de acoplamiento que se va a usar para que el panel flote.

bShow
[in] Especifica si el panel flotante está visible (TRUE) u oculto (FALSE).

Valor devuelto

TRUE si el panel flotó correctamente; de lo contrario, FALSE.

Comentarios

Llame a este método para que un panel flote en la posición de pantalla que rectFloat especifica.

CBasePane::get_accHelpTopic

El marco llama a este método para recuperar la ruta de acceso completa del archivo WinHelp que está asociado al objeto especificado y el identificador del tema adecuado en ese archivo.

virtual HRESULT get_accHelpTopic(
    BSTR* pszHelpFile,
    VARIANT varChild,
    long* pidTopic);

Parámetros

pszHelpFile
[in] Dirección de una cadena BSTR que recibe la ruta de acceso completa del archivo WinHelp que está asociado al objeto especificado, si existe.

varChild
[in] Especifica si el tema de Ayuda que se debe recuperar es el del objeto o uno de los elementos secundarios del objeto. Este parámetro puede ser CHILDID_SELF (para obtener un tema de Ayuda para el objeto) o un identificador secundario (para obtener un tema de Ayuda para uno de los elementos secundarios del objeto).

pidTopic
[in] Identifica el tema del archivo de Ayuda que está asociado al objeto especificado.

Valor devuelto

CBasePane no implementa este método. Por lo tanto, CBasePane::get_accHelpTopic siempre devuelve S_FALSE.

Comentarios

Esta función forma parte de la compatibilidad con Active Accessibility de MFC. Invalide esta función en una clase derivada para proporcionar información de ayuda sobre el objeto.

CBasePane::get_accSelection

El marco llama a este método para recuperar los elementos secundarios seleccionados de este objeto.

virtual HRESULT get_accSelection(VARIANT* pvarChildren);

Parámetros

pvarChildren
[in] Recibe información que identifica los elementos secundarios seleccionados.

Valor devuelto

CBasePane no implementa este método. Si pvarChildren es NULL, este método devuelve E_INVALIDARG. De lo contrario, este método devuelve DISP_E_MEMBERNOTFOUND.

Comentarios

Esta función forma parte de la compatibilidad con Active Accessibility de MFC. Invalide esta función en una clase derivada si tiene elementos de interfaz de usuario no en ventana distintos de los controles ActiveX sin ventana.

CBasePane::GetCaptionHeight

Devuelve la altura del título.

virtual int GetCaptionHeight() const;

Valor devuelto

Alto del título.

CBasePane::GetControlBarStyle

Devuelve el estilo de la barra de control.

virtual DWORD GetControlBarStyle() const

Valor devuelto

Combinación OR bit a bit de marcas AFX_CBRS_.

Comentarios

El valor devuelto es una combinación de los valores posibles siguientes.

Estilo	Descripción
AFX_CBRS_FLOAT	Hace que flote la barra de control.
AFX_CBRS_AUTOHIDE	Habilita el modo de ocultación automática.
AFX_CBRS_RESIZE	Habilita el cambio de tamaño de la barra de control. Cuando se establece esta marca, la barra de control se puede colocar en un panel acoplable.
AFX_CBRS_CLOSE	Habilita la ocultación de la barra de control.

CBasePane::GetCurrentAlignment

Devuelve la alineación del panel actual.

virtual DWORD GetCurrentAlignment() const;

Valor devuelto

Alineación actual de la barra de control. En la tabla siguiente, se muestran los valores posibles:

Valor	Alineación
CBRS_ALIGN_LEFT	Alineación a la izquierda
CBRS_ALIGN_RIGHT	Alineación a la derecha.
CBRS_ALIGN_TOP	Alineación superior.
CBRS_ALIGN_BOTTOM	Alineación inferior.

CBasePane::GetDockingMode

Devuelve el modo de acoplamiento actual para el panel.

virtual AFX_DOCK_TYPE GetDockingMode() const;

Valor devuelto

DT_STANDARD si un rectángulo de arrastre indica en la pantalla el arrastre del panel. DT_IMMEDIATE si se arrastra el contenido del panel.

Comentarios

El marco llama a este método para determinar el modo de acoplamiento actual del panel.

Si CBasePane::m_dockMode no está definido (DT_UNDEFINED), el modo de acoplamiento se toma del modo de acoplamiento global (AFX_GLOBAL_DATA::m_dockModeGlobal).

Al establecer m_dockMode o invalidar GetDockingMode, puede controlar el modo de acoplamiento para cada panel.

CBasePane::GetDockSiteFrameWnd

Devuelve un puntero al objeto CDockingPanesRow en el que se acopla el panel.

virtual CWnd* GetDockSiteFrameWnd() const;

Valor devuelto

Puntero al sitio de acoplamiento del panel.

Comentarios

Llame a este método para recuperar un puntero al sitio de acoplamiento del panel. El sitio de acoplamiento puede ser una ventana de marco principal si el panel está acoplado al marco principal, o bien una ventana minimarco si el panel es flotante.

CBasePane::GetEnabledAlignment

Devuelve los estilos CBRS_ALIGN_ que se aplican al panel.

virtual DWORD GetEnabledAlignment() const;

Valor devuelto

Combinación de estilos CBRS_ALIGN_. En la tabla siguiente, se muestran los estilos posibles:

Marca	Alineación habilitada
CBRS_ALIGN_LEFT	Izquierda.
CBRS_ALIGN_RIGHT	Exacto.
CBRS_ALIGN_TOP	Top.
CBRS_ALIGN_BOTTOM	Inferior.
CBRS_ALIGN_ANY	Combinación de todas las marcas.

Comentarios

Llame a este método para determinar la alineación habilitada para el panel. La alineación habilitada se refiere a los lados de la ventana de marco principal a los que se puede acoplar un panel.

Use CBasePane::EnableDocking para habilitar la alineación de acoplamiento.

CBasePane::GetMFCStyle

Devuelve los estilos de panel específicos para MFC.

virtual DWORD GetMFCStyle() const;

Valor devuelto

Combinación de estilos de panel específicos de la biblioteca (AFX_CBRS_).

CBasePane::GetPaneIcon

Devuelve un manipulador al icono del panel.

virtual HICON GetPaneIcon(BOOL bBigIcon);

Parámetros

bBigIcon
[in] Especifica un icono de 32 píxeles por 32 píxeles si es TRUE; especifica un icono de 16 píxeles por 16 píxeles si es FALSE.

Valor devuelto

Manipulador para el icono de panel. Si no se realiza correctamente, devuelve NULL.

Comentarios

La implementación predeterminada llama a CWnd::GetIcon.

CBasePane::GetPaneRow

Devuelve un puntero al objeto CDockingPanesRow en el que se acopla el panel.

CDockingPanesRow* GetPaneRow();

Valor devuelto

Puntero a CDockingPanesRow si el panel está acoplado o NULL si es flotante.

Comentarios

Llame a este método para acceder a la fila a la que está acoplado un panel. Por ejemplo, para organizar los paneles en una fila determinada, llame a GetPaneRow y, luego, a CDockingPanesRow::ArrangePanes.

CBasePane::GetPaneStyle

Devuelve el estilo del panel.

virtual DWORD GetPaneStyle() const;

Valor devuelto

Combinación de estilos de barra de control (incluidos los estilos CBRS_) que el método CBasePane::SetPaneStyle estableció en el momento de la creación.

CBasePane::GetParentDockSite

Devuelve un puntero al sitio de acoplamiento primario.

virtual CDockSite* GetParentDockSite() const;

Valor devuelto

Sitio de acoplamiento primario.

CBasePane::GetParentMiniFrame

Devuelve un puntero a la ventana minimarco primaria.

virtual CPaneFrameWnd* GetParentMiniFrame(BOOL bNoAssert=FALSE) const;

Parámetros

bNoAssert
[in] Si es TRUE, este método no comprueba si hay punteros no válidos. Si llama a este método cuando se cierra la aplicación, establezca este parámetro en TRUE.

Valor devuelto

Puntero válido a la ventana minimarco primaria si el panel es flotante; de lo contrario, NULL.

Comentarios

Llame a esta función para recuperar un puntero a la ventana minimarco primaria. Este método recorre en iteración todos los elementos primarios y comprueba si hay un objeto derivado de la clase CPaneFrameWnd.

Use GetParentMiniFrame para determinar si el panel es flotante.

CBasePane::GetParentTabbedPane

Devuelve un puntero al panel primario con pestañas.

CBaseTabbedPane* GetParentTabbedPane() const;

Valor devuelto

Puntero al panel con pestañas primario si existe; de lo contrario, NULL.

CBasePane::GetParentTabWnd

Devuelve un puntero a la ventana primaria que está dentro de una pestaña.

CMFCBaseTabCtrl* GetParentTabWnd(HWND& hWndTab) const;

Parámetros

hWndTab
[out] Si el valor devuelto no es NULL, este parámetro contiene el manipulador de la ventana con pestañas primaria.

Valor devuelto

Puntero válido a la ventana con pestañas primaria o NULL.

Comentarios

Use esta función para recuperar un puntero a la ventana con pestañas primaria. A veces, no basta con llamar a GetParent, porque un panel puede estar dentro de un contenedor de acoplamiento (clase CDockablePaneAdapter) o dentro de un adaptador de panel (clase CDockablePaneAdapter). Con GetParentTabWnd, podrá recuperar un puntero válido en esos casos (suponiendo que el elemento primario es una ventana con pestañas).

CBasePane::GetRecentVisibleState

El marco llama a este método cuando se restaura un panel desde un archivo.

virtual BOOL GetRecentVisibleState() const;

Valor devuelto

Un valor booleano que especifica el estado visible reciente. Si es TRUE, el panel estaba visible cuando se serializó y debería estar visible al restaurarlo. Si es FALSE, el panel estaba oculto cuando se serializó y debería estar oculto al restaurarlo.

CBasePane::HideInPrintPreviewMode

Especifica si el panel está oculto en la vista previa de impresión.

virtual BOOL HideInPrintPreviewMode() const;

Valor devuelto

TRUE si el panel no aparece en la vista previa de impresión; de lo contrario, FALSE.

Comentarios

Los paneles base no se muestran en la vista previa de impresión. Por lo tanto, este método siempre devuelve TRUE.

CBasePane::InsertPane

Registra el panel especificado con el administrador de acoplamiento.

BOOL InsertPane(
    CBasePane* pControlBar,
    CBasePane* pTarget,
    BOOL bAfter = TRUE);

Parámetros

pControlBar
[in] Puntero al panel que se va a insertar.

pTarget
[in] Puntero al panel adyacente.

bAfter
[in] Si es TRUE, pControlBar se inserta después de pTarget. Si es FALSE, pControlBar se inserta antes de pTarget.

Valor devuelto

TRUE si el método se realiza correctamente; de lo contrario, FALSE.

CBasePane::IsAccessibilityCompatible

Especifica si el panel admite Active Accessibility.

virtual BOOL IsAccessibilityCompatible();

Valor devuelto

TRUE si el panel admite Active Accessibility; de lo contrario, FALSE.

CBasePane::IsAutoHideMode

Determina si un panel está en modo de ocultación automática.

virtual BOOL IsAutoHideMode() const;

Valor devuelto

TRUE si el panel está en modo de ocultación automática; de lo contrario, FALSE.

Comentarios

Los paneles base no se pueden ocultar automáticamente. Este método siempre devuelve FALSE.

CBasePane::IsDialogControl

Especifica si el panel es un control de cuadro de diálogo.

BOOL IsDialogControl() const;

Valor devuelto

TRUE si el panel es un control de cuadro de diálogo; de lo contrario, FALSE.

Comentarios

El marco usa este método para garantizar la coherencia del diseño de todos los paneles.

CBasePane::IsDocked

Determina si el panel está acoplado.

virtual BOOL IsDocked() const;

Valor devuelto

TRUE si el elemento primario del panel no es un minimarco o si el panel flota en un minimarco con otro panel; de lo contrario, FALSE.

CBasePane::IsFloating

Determina si el panel está flotando.

virtual BOOL IsFloating() const;

Valor devuelto

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

Comentarios

Este método devuelve el valor opuesto de CBasePane::IsDocked.

CBasePane::IsHorizontal

Determina si el panel está acoplado de manera horizontal.

virtual BOOL IsHorizontal() const;

Valor devuelto

TRUE si el panel está acoplado de manera horizontal; de lo contrario, FALSE.

Comentarios

La implementación predeterminada comprueba la alineación de acoplamiento actual para CBRS_ORIENT_HORZ.

CBasePane::IsInFloatingMultiPaneFrameWnd

Especifica si el panel está en una ventana de marco de varios paneles (clase CMultiPaneFrameWnd).

virtual BOOL IsInFloatingMultiPaneFrameWnd() const;

Valor devuelto

TRUE si el panel está en una ventana de marco de varios paneles; de lo contrario, FALSE.

Comentarios

Solo los paneles acoplables pueden flotar en una ventana de marco de varios paneles. Por lo tanto, CBasePane::IsInFloatingMultiPaneFrameWnd siempre devuelve FALSE.

CBasePane::IsMDITabbed

Determina si el panel se agregó a una ventana secundaria de MDI como documento con pestañas.

virtual BOOL IsMDITabbed() const;

Valor devuelto

TRUE si el panel se agregó a una ventana secundaria de MDI como documento con pestañas; de lo contrario, FALSE.

CBasePane::IsPaneVisible

Especifica si la marca WS_VISIBLE está establecida para el panel.

BOOL IsPaneVisible() const;

Valor devuelto

TRUE si se establece WS_VISIBLE; de lo contrario, FALSE.

Comentarios

Use CBasePane::IsVisible para determinar la visibilidad del panel.

CBasePane::IsPointNearDockSite

Determina si un punto especificado está cerca del sitio de acoplamiento.

BOOL IsPointNearDockSite(
    CPoint point,
    DWORD& dwBarAlignment,
    BOOL& bOuterEdge) const;

Parámetros

point
[in] El punto especificado.

dwBarAlignment
[out] Especifica el borde que está cerca del punto. Los valores posibles son CBRS_ALIGN_LEFT, CBRS_ALIGN_RIGHT, CBRS_ALIGN_TOP y CBRS_ALIGN_BOTTOM

bOuterEdge
[out] TRUE si el punto está cerca del borde exterior del sitio de acoplamiento; de lo contrario, FALSE.

Valor devuelto

TRUE si el punto está cerca del sitio de acoplamiento; de lo contrario, FALSE.

Comentarios

El punto está cerca del sitio de acoplamiento cuando se encuentra dentro del conjunto de sensibilidad en el administrador de acoplamiento. La sensibilidad predeterminada es de 15 píxeles.

CBasePane::IsResizable

Determina si se puede cambiar el tamaño del panel.

virtual BOOL IsResizable() const;

Valor devuelto

TRUE si el usuario puede cambiar el tamaño del panel; de lo contrario, FALSE.

Comentarios

Se puede cambiar el tamaño de los paneles de la clase CDockablePane.

No se puede cambiar el tamaño de la barra de estado (clase CMFCStatusBar) ni de la barra de acoplamiento (clase CDockSite).

CBasePane::IsRestoredFromRegistry

Determina si el panel se restaura desde el registro.

virtual BOOL IsRestoredFromRegistry() const;

Valor devuelto

TRUE si el panel se restaura desde el Registro; de lo contrario, FALSE.

CBasePane::IsTabbed

Determina si el panel se insertó en el control de pestaña de una ventana con pestañas.

virtual BOOL IsTabbed() const;

Valor devuelto

TRUE si la barra de control está insertada en una pestaña de una ventana con pestañas; de lo contrario, FALSE.

Comentarios

Este método recupera un puntero al elemento primario inmediato y determina si la clase en tiempo de ejecución del elemento primario es la clase CMFCBaseTabCtrl.

CBasePane::IsVisible

Determina si el panel está visible.

virtual BOOL IsVisible() const;

Valor devuelto

TRUE si el panel está visible; de lo contrario, FALSE.

Comentarios

Use este método para determinar la visibilidad de un panel. No use ::IsWindowVisible.

Si el panel no tiene pestañas (consulte CBasePane::IsTabbed), este método comprueba el estilo WS_VISIBLE. Si el panel tiene pestañas, este método comprueba la visibilidad de la ventana con pestañas primaria. Si la ventana primaria está visible, la función comprueba la visibilidad de la pestaña del panel mediante CMFCBaseTabCtrl::IsTabVisible.

CBasePane::LoadState

Carga el estado del panel desde el registro.

virtual BOOL LoadState(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

Parámetros

lpszProfileName
[in] Nombre del perfil.

nIndex
[in] Índice del perfil.

uiID
[in] Identificador del panel.

Valor devuelto

TRUE si el estado del panel se cargó correctamente; de lo contrario, FALSE.

Comentarios

El marco llama a este método para cargar el estado del panel desde el Registro. Invalídelo en una clase derivada para cargar información adicional guardada por CBasePane::SaveState.

CBasePane::MoveWindow

Mueve el panel.

virtual HDWP MoveWindow(
    CRect& rect,
    BOOL bRepaint = TRUE,
    HDWP hdwp = NULL);

Parámetros

rect
[in] Rectángulo que especifica la nueva ubicación y tamaño del panel.

bRepaint
[in] Si es TRUE, se vuelve a pintar el panel. Si es FALSE, no se vuelve a pintar el panel.

hdwp
[in] Manipulador de una estructura de posición de ventana diferida.

Valor devuelto

Manipulador de una estructura de posición de ventana diferida o NULL.

Comentarios

Si se pasa NULL como el parámetro hdwp, este método mueve la ventana de manera habitual. Si se pasa un manipulador, este método realiza un movimiento de ventana diferida. Para obtener un manipulador, puede llamar a BeginDeferWindowPos o almacenar el valor devuelto de una llamada anterior a este método.

CBasePane::OnAfterChangeParent

La llama el marco después de cambios primarios del panel.

virtual void OnAfterChangeParent(CWnd* pWndOldParent);

Parámetros

pWndOldParent
[in] Puntero al elemento primario anterior.

Comentarios

El marco llama a este método después de cambios primarios del panel, por lo general debido a una operación de acoplamiento o flotación.

La implementación predeterminada no hace nada.

CBasePane::OnBeforeChangeParent

El marco llama a este método justo antes de que el panel cambie su ventana primaria.

virtual void OnBeforeChangeParent(
    CWnd* pWndNewParent,
    BOOL bDelay=FALSE);

Parámetros

pWndNewParent
[in] Puntero a una ventana primaria nueva.

bDelay
[in] Especifica si se deben retrasar los ajustes de diseño.

Comentarios

El marco llama a este método justo antes de los cambios primarios del panel, por lo general debido a una operación de acoplamiento, flotación u ocultación automática.

La implementación predeterminada no hace nada.

CBasePane::OnDrawCaption

El marco llama a este método cuando se dibuja el título.

virtual void OnDrawCaption();

Comentarios

Este método no tiene ninguna funcionalidad para la clase CBasePane.

CBasePane::OnMovePaneDivider

Este método no se usa actualmente.

virtual void OnMovePaneDivider(CPaneDivider* /* unused */);

Parámetros

Inusitado
[in] No se utiliza.

CBasePane::OnPaneContextMenu

El marco llama a este método cuando crea un menú que tiene una lista de paneles.

virtual void OnPaneContextMenu(
    CWnd* pParentFrame,
    CPoint point);

Parámetros

pParentFrame
[in] Puntero al marco primario.

point
[in] Especifica la ubicación del menú contextual.

Comentarios

OnPaneContextMenu llama al administrador de acoplamiento que mantiene la lista de paneles perteneciente a la ventana de marco actual. Este método agrega los nombres de los paneles a un menú contextual y lo muestra. Los comandos del menú muestran u ocultan paneles individuales.

Invalide este método para personalizar este comportamiento.

CBasePane::OnRemoveFromMiniFrame

El marco llama a este método cuando se quita un panel de su ventana minimarco primaria.

virtual void OnRemoveFromMiniFrame(CPaneFrameWnd* pMiniFrame);

Parámetros

pMiniFrame
[in] Puntero a una ventana minimarco desde la que se quita el panel.

Comentarios

El marco llama a este método cuando se quita un panel desde su ventana minimarco primaria (por ejemplo, como resultado del acoplamiento).

La implementación predeterminada no hace nada.

CBasePane::OnSetAccData

CBasePane no usa este método.

virtual BOOL OnSetAccData(long lVal);

Parámetros

lVal
[in] No se utiliza.

Valor devuelto

Este método devuelve siempre TRUE.

Comentarios

CBasePane::PaneFromPoint

Devuelve el panel que contiene el punto especificado.

CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    bool bExactBar = false,
    CRuntimeClass* pRTCBarType = NULL) const;

Parámetros

point
[in] Especifica el punto, en coordenadas de pantalla, que se va a comprobar.

nSensitivity
[in] Aumente el área de búsqueda por esta cantidad. Un panel cumplirá con los criterios de búsqueda si el punto dado cae en el área aumentada.

bExactBar
[in] TRUE para omitir el parámetro nSensitivity; de lo contrario, FALSE.

pRTCBarType
[in] Si no es NULL, el método solo busca paneles del tipo especificado.

Valor devuelto

Objeto derivado de CBasePane que contiene el punto dado, o bien NULL si no se encontró ningún panel.

CBasePane::RecalcLayout

CBasePane no usa este método.

virtual void RecalcLayout();

CBasePane::RemovePaneFromDockManager

Anula el registro de un panel y lo quita de la lista del administrador de acoplamiento.

void RemovePaneFromDockManager(
    CBasePane* pBar,
    BOOL bDestroy = TRUE,
    BOOL bAdjustLayout = FALSE,
    BOOL bAutoHide = FALSE,
    CBasePane* pBarReplacement = NULL);

Parámetros

pBar
[in] Puntero a un panel que se va a quitar.

bDestroy
[in] Si es TRUE, se destruye el panel quitado.

bAdjustLayout
[in] Si es TRUE, ajuste el diseño de acoplamiento de inmediato.

bAutoHide
[in] Si es TRUE, el diseño de acoplamiento está relacionado con la lista de barras de ocultación automática. Si es FALSE, el diseño de acoplamiento está relacionado con la lista de paneles normales.

pBarReplacement
[in] Puntero a un panel que reemplaza al panel quitado.

CBasePane::SaveState

Guarda el estado del panel en el registro.

virtual BOOL SaveState(
    LPCTSTR lpszProfileName=NULL,
    int nIndex=-1,
    UINT uiID=(UINT)-1);

Parámetros

lpszProfileName
[in] Nombre del perfil.

nIndex
[in] Índice del perfil.

uiID
[in] Identificador del panel.

Valor devuelto

TRUE si el estado se guardó correctamente; de lo contrario, FALSE.

Comentarios

El marco llama a este método cuando guarda el estado del panel en el Registro. Invalide SaveState en una clase derivada para almacenar información adicional.

CBasePane::SelectDefaultFont

Selecciona la fuente predeterminada para un contexto de dispositivo determinado.

CFont* SelectDefaultFont(CDC* pDC);

Parámetros

pDC
[in] Contexto de dispositivo.

Valor devuelto

Puntero al objeto predeterminado de la clase CFont.

CBasePane::SetControlBarStyle

Establece el estilo de la barra de control.

virtual void SetControlBarStyle(DWORD dwNewStyle);

Parámetros

dwNewStyle
[in] Combinación OR bit a bit de los valores posibles siguientes.

Estilo	Descripción
AFX_CBRS_FLOAT	Hace que flote la barra de control.
AFX_CBRS_AUTOHIDE	Habilita el modo de ocultación automática.
AFX_CBRS_RESIZE	Habilita el cambio de tamaño de la barra de control. Cuando se establece esta marca, la barra de control se puede colocar en un panel acoplable.
AFX_CBRS_CLOSE	Habilita la ocultación de la barra de control.

CBasePane::SetDockingMode

Establece el modo de acoplamiento para el panel.

void SetDockingMode(AFX_DOCK_TYPE dockModeNew);

Parámetros

dockModeNew
[in] Especifica el modo de acoplamiento nuevo para el panel.

Comentarios

El marco admite dos modos de acoplamiento: estándar e inmediato.

En el modo de acoplamiento estándar, los paneles y las ventanas minimarco se mueven mediante el uso de un rectángulo de arrastre. En el modo de acoplamiento inmediato, las barras de control y las ventanas minimarco se mueven de inmediato con su contexto.

De manera inicial, CDockingManager::m_dockModeGlobal define globalmente el modo de acoplamiento. Puede usar el método SetDockingMode para establecer el modo de acoplamiento para cada panel de manera individual.

CBasePane::SetPaneAlignment

Establece la alineación del panel.

virtual void SetPaneAlignment(DWORD dwAlignment);

Parámetros

dwAlignment
[in] Especifica la alineación nueva.

Comentarios

Por lo general, el marco llama a este método cuando se acopla un panel desde un lado del marco principal a otro.

En la tabla siguiente, se muestran los valores posibles de dwAlignment:

Valor	Alineación
CBRS_ALIGN_LEFT	Alineación a la izquierda
CBRS_ALIGN_RIGHT	Alineación a la derecha.
CBRS_ALIGN_TOP	Alineación superior.
CBRS_ALIGN_BOTTOM	Alineación inferior.

CBasePane::SetPaneStyle

Establece el estilo del panel.

virtual void SetPaneStyle(DWORD dwNewStyle);

Parámetros

dwNewStyle
[in] Especifica el estilo nuevo que se va a establecer.

Comentarios

Este método se puede utilizar para establecer cualquiera de los estilos CBRS_ que se definen en afxres.h. Como el estilo y la alineación del panel se almacenan juntos, si desea establecer el estilo nuevo, combínelo con la alineación actual tal como se indica a continuación.

pPane->SetPaneStyle (pPane->GetCurrentAlignment() | CBRS_TOOLTIPS);

CBasePane::SetWindowPos

Cambia el tamaño, la posición y el orden Z de un panel.

virtual HDWP SetWindowPos(
    const CWnd* pWndInsertAfter,
    int x,
    int y,
    int cx,
    int cy,
    UINT nFlags,
    HDWP hdwp = NULL);

Parámetros

pWndInsertAfter
[in] Identifica el objeto CWnd que viene antes de este objeto CWnd en el orden Z. Para más información, consulte CWnd::SetWindowPos.

x
[in] Especifica la posición del lado izquierdo de la ventana.

y
[in] Especifica la posición de la parte superior de la ventana.

cx
[in] Especifica el ancho de la ventana.

Cy
[in] Especifica el alto de la ventana.

nFlags
[in] Especifica las opciones de tamaño y posición. Para más información, consulte CWnd::SetWindowPos.

hdwp
[in] Manipule una estructura que contenga información sobre el tamaño y la posición para una o varias ventanas.

Valor devuelto

Manipulador de una estructura de posición de ventana diferida actualizada o NULL.

Comentarios

Si pWndInsertAfter es NULL, este método llama a CWnd::SetWindowPos. Si pWndInsertAfter no es NULL, este método llama a DeferWindowPos.

CBasePane::ShowPane

Muestra u oculta el panel.

virtual void ShowPane(
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

Parámetros

bShow
[in] Especifica si se va a mostrar (TRUE) u ocultar (FALSE) un panel.

bDelay
[in] Si es TRUE, se retrasa el recálculo del diseño de acoplamiento.

bActivate
[in] Si es TRUE, el panel está activo cuando se muestra.

Comentarios

Este método muestra u oculta un panel. Use este método en lugar de ShowWindow, porque este método notifica a los administradores de acoplamiento pertinentes los cambios en la visibilidad del panel.

Use CBasePane::IsVisible para determinar la visibilidad actual de un panel.

CBasePane::StretchPane

Expande un panel vertical u horizontalmente.

virtual CSize StretchPane(
    int nLength,
    BOOL bVert);

Parámetros

nLength
[in] Longitud según la cual se va a ajustar el panel.

bVert
[in] Si es TRUE, ajuste verticalmente el panel. Si es FALSE, ajuste horizontalmente el panel.

Valor devuelto

Tamaño del panel ajustado.

CBasePane::UndockPane

Quita el panel del sitio de acoplamiento, el control deslizante predeterminado o la ventana minimarco donde está acoplado actualmente.

virtual void UndockPane(BOOL bDelay=FALSE);

Parámetros

bDelay
Si es TRUE, el diseño de acoplamiento no se recalcula de inmediato.

Comentarios

Llame a este método para manipular el estado del panel o excluir el panel del diseño de acoplamiento.

Si desea seguir usando este panel, llame a CBasePane::DockPane o a CBasePane::FloatPane antes de llamar a este método.

Consulte también

Gráfico de jerarquías
Clases
CPane
CWnd (clase)