#include <atlwin.h>

Inheritance diagram for ATL::CContainedWindowT< TBase, TWinTraits >:

Collaboration diagram for ATL::CContainedWindowT< TBase, TWinTraits >:

[legend]

Public Member Functions
	CContainedWindowT (CMessageMap *pObject, DWORD dwMsgMapID=0)

	CContainedWindowT (LPCTSTR lpszClassName, CMessageMap *pObject, DWORD dwMsgMapID=0)

LRESULT	DefWindowProc (UINT uMsg, WPARAM wParam, LPARAM lParam)

BOOL	SubclassWindow (HWND hWnd)

HWND	UnsubclassWindow (BOOL bForce=FALSE)

Public Member Functions inherited from ATL::CWindow
	CWindow (HWND hWnd=NULL)

	operator HWND () const

UINT	ArrangeIconicWindows ()

void	Attach (HWND hWndNew)

HDC	BeginPaint (LPPAINTSTRUCT lpPaint)

BOOL	BringWindowToTop ()

BOOL	CenterWindow (HWND hWndCenter=NULL)

BOOL	ChangeClipboardChain (HWND hWndNewNext)

BOOL	CheckDlgButton (int nIDButton, UINT nCheck)

BOOL	CheckRadioButton (int nIDFirstButton, int nIDLastButton, int nIDCheckButton)

HWND	ChildWindowFromPoint (POINT point) const

HWND	ChildWindowFromPointEx (POINT point, UINT uFlags) const

BOOL	ClientToScreen (LPPOINT lpPoint) const

BOOL	ClientToScreen (LPRECT lpRect) const

HWND	Create (LPCTSTR lpstrWndClass, HWND hWndParent, _U_RECT rect=NULL, LPCTSTR szWindowName=NULL, DWORD dwStyle=0, DWORD dwExStyle=0, _U_MENUorID MenuOrID=0U, LPVOID lpCreateParam=NULL)

BOOL	CreateCaret (HBITMAP pBitmap)

BOOL	CreateGrayCaret (int nWidth, int nHeight)

BOOL	CreateSolidCaret (int nWidth, int nHeight)

HDWP	DeferWindowPos (HDWP hWinPosInfo, HWND hWndInsertAfter, int x, int y, int cx, int cy, UINT uFlags)

BOOL	DestroyWindow ()

HWND	Detach ()

int	DlgDirList (LPTSTR lpPathSpec, int nIDListBox, int nIDStaticPath, UINT nFileType)

int	DlgDirListComboBox (LPTSTR lpPathSpec, int nIDComboBox, int nIDStaticPath, UINT nFileType)

BOOL	DlgDirSelect (LPTSTR lpString, int nCount, int nIDListBox)

BOOL	DlgDirSelectComboBox (LPTSTR lpString, int nCount, int nIDComboBox)

void	DragAcceptFiles (BOOL bAccept=TRUE)

BOOL	DrawMenuBar ()

BOOL	EnableScrollBar (UINT uSBFlags, UINT uArrowFlags=ESB_ENABLE_BOTH)

BOOL	EnableWindow (BOOL bEnable=TRUE)

void	EndPaint (LPPAINTSTRUCT lpPaint)

BOOL	FlashWindow (BOOL bInvert)

BOOL	GetClientRect (LPRECT lpRect) const

HDC	GetDC ()

HDC	GetDCEx (HRGN hRgnClip, DWORD flags)

HWND	GetDescendantWindow (int nID) const

HRESULT	GetDlgControl (int nID, REFIID iid, void **ppCtrl)

int	GetDlgCtrlID () const

HRESULT	GetDlgHost (int nID, REFIID iid, void **ppHost)

HWND	GetDlgItem (_In_ int nID) const

UINT	GetDlgItemInt (_In_ int nID, _Out_opt_ BOOL *lpTrans=NULL, _In_ BOOL bSigned=TRUE) const

UINT	GetDlgItemText (_In_ int nID, _Out_writes_to_(nMaxCount, return+1) LPTSTR lpStr, _In_ int nMaxCount) const

BOOL	GetDlgItemText (_In_ int nID, _Inout_ _Outref_result_maybenull_ _Post_z_ BSTR &bstrText) const

DWORD	GetExStyle () const

HFONT	GetFont () const

DWORD	GetHotKey () const

HICON	GetIcon (BOOL bBigIcon=TRUE) const

HWND	GetLastActivePopup () const

HMENU	GetMenu () const

HWND	GetNextDlgGroupItem (HWND hWndCtl, BOOL bPrevious=FALSE) const

HWND	GetNextDlgTabItem (HWND hWndCtl, BOOL bPrevious=FALSE) const

CWindow	GetParent () const

BOOL	GetScrollInfo (int nBar, LPSCROLLINFO lpScrollInfo)

BOOL	GetScrollPos (int nBar)

BOOL	GetScrollRange (int nBar, LPINT lpMinPos, LPINT lpMaxPos) const

DWORD	GetStyle () const

HMENU	GetSystemMenu (BOOL bRevert)

HWND	GetTopLevelParent () const

HWND	GetTopLevelWindow () const

HWND	GetTopWindow () const

BOOL	GetUpdateRect (LPRECT lpRect, BOOL bErase=FALSE)

int	GetUpdateRgn (HRGN hRgn, BOOL bErase=FALSE)

HWND	GetWindow (UINT nCmd) const

DWORD	GetWindowContextHelpId () const

HDC	GetWindowDC ()

LONG	GetWindowLong (int nIndex) const

LONG_PTR	GetWindowLongPtr (int nIndex) const

BOOL	GetWindowPlacement (WINDOWPLACEMENT *lpwndpl) const

DWORD	GetWindowProcessID ()

BOOL	GetWindowRect (LPRECT lpRect) const

int	GetWindowRgn (HRGN hRgn)

int	GetWindowText (_Out_writes_to_(nMaxCount, return+1) LPTSTR lpszStringBuf, _In_ int nMaxCount) const

BOOL	GetWindowText (_Inout_ _Outref_result_maybenull_ _Post_z_ BSTR &bstrText) const

int	GetWindowTextLength () const

DWORD	GetWindowThreadID ()

WORD	GetWindowWord (int nIndex) const

void	GotoDlgCtrl (HWND hWndCtrl) const

BOOL	HideCaret ()

BOOL	HiliteMenuItem (HMENU hMenu, UINT uHiliteItem, UINT uHilite)

BOOL	Invalidate (BOOL bErase=TRUE)

BOOL	InvalidateRect (LPCRECT lpRect, BOOL bErase=TRUE)

void	InvalidateRgn (HRGN hRgn, BOOL bErase=TRUE)

BOOL	IsChild (const HWND hWnd) const

BOOL	IsDialogMessage (LPMSG lpMsg)

UINT	IsDlgButtonChecked (int nIDButton) const

BOOL	IsIconic () const

BOOL	IsParentDialog ()

BOOL	IsWindow () const

BOOL	IsWindowEnabled () const

BOOL	IsWindowVisible () const

BOOL	IsWindowUnicode ()

BOOL	IsZoomed () const

BOOL	KillTimer (UINT_PTR nIDEvent)

BOOL	LockWindowUpdate (BOOL bLock=TRUE)

int	MapWindowPoints (HWND hWndTo, LPPOINT lpPoint, UINT nCount) const

int	MapWindowPoints (HWND hWndTo, LPRECT lpRect) const

int	MessageBox (LPCTSTR lpszText, LPCTSTR lpszCaption=NULL, UINT nType=MB_OK)

BOOL	ModifyStyle (DWORD dwRemove, DWORD dwAdd, UINT nFlags=0)

BOOL	ModifyStyleEx (DWORD dwRemove, DWORD dwAdd, UINT nFlags=0)

BOOL	MoveWindow (int x, int y, int nWidth, int nHeight, BOOL bRepaint=TRUE)

void	NextDlgCtrl () const

BOOL	OpenClipboard ()

BOOL	PostMessage (UINT message, WPARAM wParam=0, LPARAM lParam=0)

void	PrevDlgCtrl () const

void	Print (HDC hDC, DWORD dwFlags) const

void	PrintClient (HDC hDC, DWORD dwFlags) const

BOOL	RedrawWindow (LPCRECT lpRectUpdate=NULL, HRGN hRgnUpdate=NULL, UINT flags=RDW_INVALIDATE\|RDW_UPDATENOW\|RDW_ERASE)

int	ReleaseDC (HDC hDC)

BOOL	ResizeClient (int nWidth, int nHeight, BOOL bRedraw=FALSE)

BOOL	ScreenToClient (LPPOINT lpPoint) const

BOOL	ScrollWindow (int xAmount, int yAmount, LPCRECT lpRect=NULL, LPCRECT lpClipRect=NULL)

int	ScrollWindowEx (int dx, int dy, LPCRECT lpRectScroll, LPCRECT lpRectClip, HRGN hRgnUpdate, LPRECT lpRectUpdate, UINT flags)

LRESULT	SendDlgItemMessage (int nID, UINT message, WPARAM wParam=0, LPARAM lParam=0)

LRESULT	SendMessage (UINT message, WPARAM wParam=0, LPARAM lParam=0)

void	SendMessageToDescendants (UINT message, WPARAM wParam=0, LPARAM lParam=0, BOOL bDeep=TRUE)

BOOL	SendNotifyMessage (UINT message, WPARAM wParam=0, LPARAM lParam=0)

HWND	SetActiveWindow ()

HWND	SetCapture ()

HWND	SetClipboardViewer ()

int	SetDlgCtrlID (int nID)

BOOL	SetDlgItemInt (int nID, UINT nValue, BOOL bSigned=TRUE)

BOOL	SetDlgItemText (int nID, LPCTSTR lpszString)

HWND	SetFocus ()

void	SetFont (HFONT hFont, BOOL bRedraw=TRUE)

int	SetHotKey (WORD wVirtualKeyCode, WORD wModifiers)

HICON	SetIcon (HICON hIcon, BOOL bBigIcon=TRUE)

BOOL	SetMenu (HMENU hMenu)

HWND	SetParent (HWND hWndNewParent)

void	SetRedraw (BOOL bRedraw=TRUE)

int	SetScrollInfo (int nBar, LPSCROLLINFO lpScrollInfo, BOOL bRedraw=TRUE)

int	SetScrollPos (int nBar, int nPos, BOOL bRedraw=TRUE)

BOOL	SetScrollRange (int nBar, int nMinPos, int nMaxPos, BOOL bRedraw=TRUE)

UINT_PTR	SetTimer (UINT_PTR nIDEvent, UINT nElapse, void(CALLBACK *lpfnTimer)(HWND, UINT, UINT_PTR, DWORD)=NULL)

BOOL	SetWindowContextHelpId (DWORD dwContextHelpId)

LONG	SetWindowLong (int nIndex, LONG dwNewLong)

LONG_PTR	SetWindowLongPtr (int nIndex, LONG_PTR dwNewLong)

BOOL	SetWindowPlacement (const WINDOWPLACEMENT *lpwndpl)

BOOL	SetWindowPos (HWND hWndInsertAfter, int x, int y, int cx, int cy, UINT nFlags)

int	SetWindowRgn (HRGN hRgn, BOOL bRedraw=FALSE)

BOOL	SetWindowText (LPCTSTR lpszString)

WORD	SetWindowWord (int nIndex, WORD wNewWord)

BOOL	ShowCaret ()

BOOL	ShowOwnedPopups (BOOL bShow=TRUE)

BOOL	ShowScrollBar (UINT nBar, BOOL bShow=TRUE)

BOOL	ShowWindow (int nCmdShow)

BOOL	ShowWindowAsync (int nCmdShow)

BOOL	UpdateWindow ()

BOOL	ValidateRect (LPCRECT lpRect)

BOOL	ValidateRgn (HRGN hRgn)

BOOL	WinHelp (LPCTSTR lpszHelp, UINT nCmd=HELP_CONTEXT, DWORD dwData=0)

Static Public Member Functions
static LRESULT CALLBACK	StartWindowProc (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)

static LRESULT CALLBACK	WindowProc (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)

Static Public Member Functions inherited from ATL::CWindow
static LPCTSTR	GetWndClassName ()

static LRESULT	SendMessage (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)

Public Attributes
CWndProcThunk	m_thunk

LPCTSTR	m_lpszClassName

WNDPROC	m_pfnSuperWindowProc

CMessageMap *	m_pObject

DWORD	m_dwMsgMapID

const _ATL_MSG *	m_pCurrentMsg

Public Attributes inherited from ATL::CWindow
HWND	m_hWnd

Additional Inherited Members
Static Public Attributes inherited from ATL::CWindow
static RECT	rcDefault

Detailed Description

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>
class ATL::CContainedWindowT< TBase, TWinTraits >

Definition at line 1758 of file atlwin.h.

Constructor & Destructor Documentation

◆ CContainedWindowT() [1/2]

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

ATL::CContainedWindowT< TBase, TWinTraits >::CContainedWindowT	(	CMessageMap *	pObject,
		DWORD	dwMsgMapID = `0`
	)

inline

Definition at line 1773 of file atlwin.h.

    {
        m_lpszClassName = TBase::GetWndClassName();
        m_pfnSuperWindowProc = ::DefWindowProc;
        m_pObject = pObject;
        m_dwMsgMapID = dwMsgMapID;
        m_pCurrentMsg = NULL;
    }

◆ CContainedWindowT() [2/2]

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

ATL::CContainedWindowT< TBase, TWinTraits >::CContainedWindowT	(	LPCTSTR	lpszClassName,
		CMessageMap *	pObject,
		DWORD	dwMsgMapID = `0`
	)

inline

Definition at line 1782 of file atlwin.h.

    {
        m_lpszClassName = lpszClassName;
        m_pfnSuperWindowProc = ::DefWindowProc;
        m_pObject = pObject;
        m_dwMsgMapID = dwMsgMapID;
        m_pCurrentMsg = NULL;
    }

Member Function Documentation

◆ DefWindowProc()

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

LRESULT ATL::CContainedWindowT< TBase, TWinTraits >::DefWindowProc	(	UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam
	)

inline

Definition at line 1791 of file atlwin.h.

    {
        return ::CallWindowProc(m_pfnSuperWindowProc, this->m_hWnd, uMsg, wParam, lParam);
    }

Referenced by ATL::CContainedWindowT< TBase, TWinTraits >::WindowProc().

◆ StartWindowProc()

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

static LRESULT CALLBACK ATL::CContainedWindowT< TBase, TWinTraits >::StartWindowProc	(	HWND	hWnd,
		UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam
	)

inlinestatic

Definition at line 1840 of file atlwin.h.

    {
        CContainedWindowT<TBase>* pThis;
        WNDPROC newWindowProc;
        WNDPROC GCCU(pOldProc);
 
        pThis = reinterpret_cast<CContainedWindowT<TBase>*>(_AtlWinModule.ExtractCreateWndData());
        ATLASSERT(pThis != NULL);
        if (pThis == NULL)
            return 0;
        pThis->m_thunk.Init(WindowProc, pThis);
        newWindowProc = pThis->m_thunk.GetWNDPROC();
        pOldProc = reinterpret_cast<WNDPROC>(::SetWindowLongPtr(hWnd, GWLP_WNDPROC, reinterpret_cast<LONG_PTR>(newWindowProc)));
        Unused(pOldProc); // TODO: should generate trace message if overwriting another subclass
        pThis->m_hWnd = hWnd;
        return newWindowProc(hWnd, uMsg, wParam, lParam);
    }

◆ SubclassWindow()

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

BOOL ATL::CContainedWindowT< TBase, TWinTraits >::SubclassWindow ( HWND hWnd )

inline

Definition at line 1796 of file atlwin.h.

    {
        ATLASSERT(m_hWnd == NULL);
        ATLASSERT(::IsWindow(hWnd));
 
        CContainedWindowT<TBase>* pThis;
        pThis = reinterpret_cast<CContainedWindowT<TBase>*>(this);
 
        BOOL result = m_thunk.Init(WindowProc, pThis);
        if (result == FALSE)
            return FALSE;
 
        WNDPROC newWindowProc = m_thunk.GetWNDPROC();
        WNDPROC oldWindowProc = reinterpret_cast<WNDPROC>(
            ::SetWindowLongPtr(hWnd, GWLP_WNDPROC, reinterpret_cast<LONG_PTR>(newWindowProc)));
        if (oldWindowProc == NULL)
            return FALSE;
 
        pThis->m_pfnSuperWindowProc = oldWindowProc;
        pThis->m_hWnd = hWnd;
        return TRUE;
    }

Referenced by CAddressEditBox::Init().

◆ UnsubclassWindow()

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

HWND ATL::CContainedWindowT< TBase, TWinTraits >::UnsubclassWindow ( BOOL bForce = FALSE )

inline

Definition at line 1819 of file atlwin.h.

    {
        ATLASSERT(m_hWnd != NULL);
        ATLASSERT(::IsWindow(m_hWnd));
 
        CContainedWindowT<TBase>* pThis;
        pThis = reinterpret_cast<CContainedWindowT<TBase>*>(this);
        HWND hwndOld = pThis->m_hWnd;
 
        WNDPROC subclassedProc = reinterpret_cast<WNDPROC>(
            ::GetWindowLongPtr(hwndOld, GWLP_WNDPROC));
        if (!bForce && m_thunk.GetWNDPROC() != subclassedProc)
            return NULL;
 
        ::SetWindowLongPtr(hwndOld, GWLP_WNDPROC,
                           (LONG_PTR)pThis->m_pfnSuperWindowProc);
        pThis->m_pfnSuperWindowProc = ::DefWindowProc;
        pThis->m_hWnd = NULL;
        return hwndOld;
    }

◆ WindowProc()

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

static LRESULT CALLBACK ATL::CContainedWindowT< TBase, TWinTraits >::WindowProc	(	HWND	hWnd,
		UINT	uMsg,
		WPARAM	wParam,
		LPARAM	lParam
	)

inlinestatic

Definition at line 1858 of file atlwin.h.

    {
        CContainedWindowT<TBase>* pThis = reinterpret_cast<CContainedWindowT<TBase>*>(hWnd);
        _ATL_MSG msg(pThis->m_hWnd, uMsg, wParam, lParam);
        LRESULT lResult;
        const _ATL_MSG *previousMessage;
        BOOL handled;
        LONG_PTR saveWindowProc;
 
        ATLASSERT(pThis != NULL && pThis->m_hWnd != NULL && pThis->m_pObject != NULL);
        if (pThis == NULL || pThis->m_hWnd == NULL || pThis->m_pObject == NULL)
            return 0;
 
        hWnd = pThis->m_hWnd;
        previousMessage = pThis->m_pCurrentMsg;
        pThis->m_pCurrentMsg = &msg;
 
        handled = pThis->m_pObject->ProcessWindowMessage(hWnd, uMsg, wParam, lParam, lResult, pThis->m_dwMsgMapID);
        ATLASSERT(pThis->m_pCurrentMsg == &msg);
 
        pThis->m_pCurrentMsg = previousMessage;
        if (handled == FALSE)
        {
            if (uMsg == WM_NCDESTROY)
            {
                saveWindowProc = ::GetWindowLongPtr(hWnd, GWLP_WNDPROC);
                lResult = pThis->DefWindowProc(uMsg, wParam, lParam);
                if (pThis->m_pfnSuperWindowProc != ::DefWindowProc && saveWindowProc == ::GetWindowLongPtr(hWnd, GWLP_WNDPROC))
                    ::SetWindowLongPtr(hWnd, GWLP_WNDPROC, reinterpret_cast<LONG_PTR>(pThis->m_pfnSuperWindowProc));
                pThis->m_hWnd = NULL;
            }
            else
                lResult = pThis->DefWindowProc(uMsg, wParam, lParam);
        }
        return lResult;
    }

Referenced by ATL::CContainedWindowT< TBase, TWinTraits >::StartWindowProc(), and ATL::CContainedWindowT< TBase, TWinTraits >::SubclassWindow().

Member Data Documentation

◆ m_dwMsgMapID

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

DWORD ATL::CContainedWindowT< TBase, TWinTraits >::m_dwMsgMapID

Definition at line 1769 of file atlwin.h.

Referenced by ATL::CContainedWindowT< TBase, TWinTraits >::CContainedWindowT(), and ATL::CContainedWindowT< TBase, TWinTraits >::WindowProc().

◆ m_lpszClassName

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

LPCTSTR ATL::CContainedWindowT< TBase, TWinTraits >::m_lpszClassName

Definition at line 1766 of file atlwin.h.

Referenced by ATL::CContainedWindowT< TBase, TWinTraits >::CContainedWindowT().

◆ m_pCurrentMsg

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

const _ATL_MSG* ATL::CContainedWindowT< TBase, TWinTraits >::m_pCurrentMsg

Definition at line 1770 of file atlwin.h.

Referenced by ATL::CContainedWindowT< TBase, TWinTraits >::CContainedWindowT(), and ATL::CContainedWindowT< TBase, TWinTraits >::WindowProc().

◆ m_pfnSuperWindowProc

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

WNDPROC ATL::CContainedWindowT< TBase, TWinTraits >::m_pfnSuperWindowProc

Definition at line 1767 of file atlwin.h.

Referenced by ATL::CContainedWindowT< TBase, TWinTraits >::CContainedWindowT(), ATL::CContainedWindowT< TBase, TWinTraits >::DefWindowProc(), ATL::CContainedWindowT< TBase, TWinTraits >::SubclassWindow(), ATL::CContainedWindowT< TBase, TWinTraits >::UnsubclassWindow(), and ATL::CContainedWindowT< TBase, TWinTraits >::WindowProc().

◆ m_pObject

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

CMessageMap* ATL::CContainedWindowT< TBase, TWinTraits >::m_pObject

Definition at line 1768 of file atlwin.h.

Referenced by ATL::CContainedWindowT< TBase, TWinTraits >::CContainedWindowT(), and ATL::CContainedWindowT< TBase, TWinTraits >::WindowProc().

◆ m_thunk

template<class TBase = CWindow, class TWinTraits = CControlWinTraits>

CWndProcThunk ATL::CContainedWindowT< TBase, TWinTraits >::m_thunk

Definition at line 1765 of file atlwin.h.

Referenced by ATL::CContainedWindowT< TBase, TWinTraits >::StartWindowProc(), ATL::CContainedWindowT< TBase, TWinTraits >::SubclassWindow(), and ATL::CContainedWindowT< TBase, TWinTraits >::UnsubclassWindow().

The documentation for this class was generated from the following file:

sdk/lib/atl/atlwin.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CContainedWindowT() [1/2]

◆ CContainedWindowT() [2/2]

Member Function Documentation

◆ DefWindowProc()

◆ StartWindowProc()

◆ SubclassWindow()

◆ UnsubclassWindow()

◆ WindowProc()

Member Data Documentation

◆ m_dwMsgMapID

◆ m_lpszClassName

◆ m_pCurrentMsg

◆ m_pfnSuperWindowProc

◆ m_pObject

◆ m_thunk