Skip to content

Latest commit

 

History

History
150 lines (115 loc) · 4.29 KB

File metadata and controls

150 lines (115 loc) · 4.29 KB
title CDockablePaneAdapter Class | Microsoft Docs
ms.custom
ms.date 11/04/2016
ms.reviewer
ms.suite
ms.technology
cpp-windows
ms.tgt_pltfrm
ms.topic reference
f1_keywords
CDockablePaneAdapter
AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter
AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter::GetWrappedWnd
AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter::LoadState
AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter::SaveState
AFXDOCKABLEPANEADAPTER/CDockablePaneAdapter::SetWrappedWnd
dev_langs
C++
helpviewer_keywords
CDockablePaneAdapter class
ms.assetid 6ed6cf82-f39c-4d0c-bf7c-8641495cf8f3
caps.latest.revision 22
author mikeblome
ms.author mblome
manager ghogen
translation.priority.ht
cs-cz
de-de
es-es
fr-fr
it-it
ja-jp
ko-kr
pl-pl
pt-br
ru-ru
tr-tr
zh-cn
zh-tw

CDockablePaneAdapter Class

Provides docking support for CWnd-derived panes.

Syntax

class CDockablePaneAdapter : public CDockablePane  

Members

Public Methods

Name Description
CDockablePaneAdapter::GetWrappedWnd Returns the wrapped window.
CDockablePaneAdapter::LoadState (Overrides CDockablePane::LoadState.)
CDockablePaneAdapter::SaveState (Overrides CDockablePane::SaveState.)
CDockablePaneAdapter::SetWrappedWnd

Remarks

Usually, the framework instantiates objects of this class when you use the CMFCBaseTabCtrl::AddTab or CMFCBaseTabCtrl::InsertTab methods.

If you want to customize the CDockablePaneAdapter behavior, just derive a new class from it and set the runtime class information to a tabbed window by using CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Inheritance Hierarchy

CObject CCmdTarget CWnd

CBasePane CPane CDockablePane

CDockablePaneAdapter

Requirements

Header: afxDockablePaneAdapter.h

CDockablePaneAdapter::GetWrappedWnd

Returns the underlying window for the dockable pane adapter.

virtual CWnd* GetWrappedWnd() const;  

Return Value

A pointer to the wrapped window.

Remarks

Use this function to access the wrapped window.

CDockablePaneAdapter::LoadState

Loads the state of the pane from the registry.

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

Parameters

[in] lpszProfileName
The profile name.

[in] nIndex
The profile index.

[in] uiID
The pane ID.

Return Value

Remarks

CDockablePaneAdapter::SaveState

Saves the state of the pane to the registry.

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

Parameters

[in] lpszProfileName
The profile name.

[in] nIndex
The profile index (defaults to the control ID of the window).

[in] uiID
The pane ID.

Return Value

Remarks

CDockablePaneAdapter::SetWrappedWnd

Sets the underlying window for the dockable pane adapter.

virtual BOOL SetWrappedWnd(CWnd* pWnd);

Parameters

[in] pWnd
A pointer to the window for the pane adapter to wrap.

Return Value

Remarks

See Also

Hierarchy Chart
Classes
CDockablePane Class