CExplorerBand Class Reference

#include <CExplorerBand.h>

Inheritance diagram for CExplorerBand:

Collaboration diagram for CExplorerBand:

Public Member Functions
	CExplorerBand ()
virtual	~CExplorerBand ()
STDMETHODIMP	GetClassID (CLSID *pClassID) override
STDMETHODIMP	OnSelectionChanged (_In_ PCIDLIST_ABSOLUTE pidl) override
STDMETHODIMP	Invoke (_In_ PCIDLIST_ABSOLUTE pidl) override
STDMETHODIMP	GetTypeInfoCount (UINT *pctinfo) override
STDMETHODIMP	GetTypeInfo (UINT iTInfo, LCID lcid, ITypeInfo **ppTInfo) override
STDMETHODIMP	GetIDsOfNames (REFIID riid, LPOLESTR *rgszNames, UINT cNames, LCID lcid, DISPID *rgDispId) override
STDMETHODIMP	Invoke (DISPID dispIdMember, REFIID riid, LCID lcid, WORD wFlags, DISPPARAMS *pDispParams, VARIANT *pVarResult, EXCEPINFO *pExcepInfo, UINT *puArgErr) override
Public Member Functions inherited from ATL::CComObjectRootEx< CComMultiThreadModelNoCS >
	~CComObjectRootEx ()
ULONG	InternalAddRef ()
ULONG	InternalRelease ()
void	Lock ()
void	Unlock ()
HRESULT	_AtlInitialConstruct ()
Public Member Functions inherited from ATL::CComObjectRootBase
	CComObjectRootBase ()
	~CComObjectRootBase ()
void	SetVoid (void *)
HRESULT	_AtlFinalConstruct ()
HRESULT	FinalConstruct ()
void	InternalFinalConstructAddRef ()
void	InternalFinalConstructRelease ()
void	FinalRelease ()
Public Member Functions inherited from IDispatch
HRESULT	GetTypeInfoCount ([out] UINT *pctinfo)
HRESULT	GetTypeInfo ([in] UINT iTInfo, [in] LCID lcid, [out] ITypeInfo **ppTInfo)
HRESULT	GetIDsOfNames ([in] REFIID riid, [in, size_is(cNames)] LPOLESTR *rgszNames, [in] UINT cNames, [in] LCID lcid, [out, size_is(cNames)] DISPID *rgDispId)
HRESULT	Invoke ([in] DISPID dispIdMember, [in] REFIID riid, [in] LCID lcid, [in] WORD wFlags, [in, out] DISPPARAMS *pDispParams, [out] VARIANT *pVarResult, [out] EXCEPINFO *pExcepInfo, [out] UINT *puArgErr)
HRESULT	RemoteInvoke ([in] DISPID dispIdMember, [in] REFIID riid, [in] LCID lcid, [in] DWORD dwFlags, [in] DISPPARAMS *pDispParams, [out] VARIANT *pVarResult, [out] EXCEPINFO *pExcepInfo, [out] UINT *pArgErr, [in] UINT cVarRef, [in, size_is(cVarRef)] UINT *rgVarRefIdx, [in, out, size_is(cVarRef)] VARIANTARG *rgVarRef)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()

Protected Member Functions
INT	_GetRootCsidl () override
DWORD	_GetTVStyle () override
DWORD	_GetTVExStyle () override
DWORD	_GetEnumFlags () override
HRESULT	_CreateTreeView (HWND hwndParent) override
void	_DestroyTreeView () override
BOOL	_WantsRootItem () override
BOOL	_GetTitle (LPWSTR pszTitle, INT cchTitle) override
void	_SortItems (HTREEITEM hParent) override
BOOL	_NavigateToCurrentFolder ()
BOOL	_NavigateToPIDL (_In_ LPCITEMIDLIST dest, _Out_ HTREEITEM *phItem, _In_ BOOL bExpand, _In_ BOOL bInsert, _In_ BOOL bSelect)

Static Protected Member Functions
static INT CALLBACK	_CompareTreeItems (LPARAM p1, LPARAM p2, LPARAM p3)

Additional Inherited Members
Public Types inherited from IDispatch
typedef IDispatch *	LPDISPATCH
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Static Public Member Functions inherited from ATL::CComObjectRootBase
static void WINAPI	ObjectMain (bool)
static const struct _ATL_CATMAP_ENTRY *	GetCategoryMap ()
static HRESULT WINAPI	InternalQueryInterface (void *pThis, const _ATL_INTMAP_ENTRY *pEntries, REFIID iid, void **ppvObject)
Public Attributes inherited from ATL::CComObjectRootBase
LONG	m_dwRef
Public Attributes inherited from IDispatch
const DISPID	DISPID_UNKNOWN = -1
const DISPID	DISPID_VALUE = 0
const DISPID	DISPID_PROPERTYPUT = -3
const DISPID	DISPID_NEWENUM = -4
const DISPID	DISPID_EVALUATE = -5
const DISPID	DISPID_CONSTRUCTOR = -6
const DISPID	DISPID_DESTRUCTOR = -7
const DISPID	DISPID_COLLECT = -8

Detailed Description

Definition at line 13 of file CExplorerBand.h.

Constructor & Destructor Documentation

CExplorerBand()

CExplorerBand::CExplorerBand

(

)

Definition at line 21 of file CExplorerBand.cpp.

{
}

~CExplorerBand()

CExplorerBand::~CExplorerBand ( )

virtual

Definition at line 25 of file CExplorerBand.cpp.

{
}

Member Function Documentation

_CompareTreeItems()

INT CALLBACK CExplorerBand::_CompareTreeItems ( LPARAM  p1, LPARAM  p2, LPARAM  p3  )

staticprotected

Definition at line 96 of file CExplorerBand.cpp.

{
    CItemData *info1 = (CItemData*)p1;
    CItemData *info2 = (CItemData*)p2;
    IShellFolder *pDesktop = (IShellFolder *)p3;
    HRESULT hr = pDesktop->CompareIDs(0, info1->absolutePidl, info2->absolutePidl);
    if (FAILED(hr))
        return 0;
    return (SHORT)HRESULT_CODE(hr);
}

Referenced by _SortItems().

_CreateTreeView()

HRESULT CExplorerBand::_CreateTreeView ( HWND  hwndParent )

overrideprotected

Definition at line 107 of file CExplorerBand.cpp.

{
    HRESULT hr = CNSCBand::_CreateTreeView(hwndParent);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    // Insert the root node
    m_hRoot = _InsertItem(NULL, m_pDesktop, m_pidlRoot, m_pidlRoot, FALSE);
    if (!m_hRoot)
    {
        ERR("Failed to create root item\n");
        return E_FAIL;
    }
    TreeView_Expand(m_hwndTreeView, m_hRoot, TVE_EXPAND);
 
    // Navigate to current folder position
    _NavigateToCurrentFolder();
 
    // Register browser connection endpoint
    CComPtr<IWebBrowser2> browserService;
    hr = IUnknown_QueryService(m_pSite, SID_SWebBrowserApp, IID_PPV_ARG(IWebBrowser2, &browserService));
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    // Communicate via IDispatch
    hr = AtlAdvise(browserService, dynamic_cast<IDispatch*>(this), DIID_DWebBrowserEvents, &m_adviseCookie);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    return hr;
}

_DestroyTreeView()

void CExplorerBand::_DestroyTreeView ( )

overrideprotected

Definition at line 139 of file CExplorerBand.cpp.

{
    CComPtr<IWebBrowser2> browserService;
    HRESULT hr = IUnknown_QueryService(m_pSite, SID_SWebBrowserApp,
                                       IID_PPV_ARG(IWebBrowser2, &browserService));
    if (FAILED_UNEXPECTEDLY(hr))
        return;
 
    AtlUnadvise(browserService, DIID_DWebBrowserEvents, m_adviseCookie);
 
    CNSCBand::_DestroyTreeView();
}

_GetEnumFlags()

DWORD CExplorerBand::_GetEnumFlags ( )

overrideprotected

Definition at line 54 of file CExplorerBand.cpp.

{
    return SHCONTF_FOLDERS;
}

_GetRootCsidl()

INT CExplorerBand::_GetRootCsidl ( )

overrideprotected

Definition at line 37 of file CExplorerBand.cpp.

{
    return CSIDL_DESKTOP;
}

_GetTitle()

BOOL CExplorerBand::_GetTitle ( LPWSTR  pszTitle, INT  cchTitle  )

overrideprotected

Definition at line 59 of file CExplorerBand.cpp.

{
    return ::LoadStringW(instance, IDS_FOLDERSLABEL, pszTitle, cchTitle);
}

_GetTVExStyle()

DWORD CExplorerBand::_GetTVExStyle ( )

overrideprotected

Definition at line 49 of file CExplorerBand.cpp.

{
    return 0;
}

_GetTVStyle()

DWORD CExplorerBand::_GetTVStyle ( )

overrideprotected

Definition at line 42 of file CExplorerBand.cpp.

{
    // Remove TVS_SINGLEEXPAND for now since it has strange behaviour
    return WS_CHILD | WS_VISIBLE | WS_CLIPCHILDREN | WS_CLIPSIBLINGS | TVS_HASLINES |
           TVS_HASBUTTONS | TVS_SHOWSELALWAYS | TVS_EDITLABELS /* | TVS_SINGLEEXPAND*/;
}

_NavigateToCurrentFolder()

BOOL CExplorerBand::_NavigateToCurrentFolder ( )

protected

Definition at line 197 of file CExplorerBand.cpp.

{
    CComHeapPtr<ITEMIDLIST> pidl;
    HRESULT hr = _GetCurrentLocation(&pidl);
    if (FAILED_UNEXPECTEDLY(hr))
        return FALSE;
 
    // Find PIDL into our explorer
    ++m_mtxBlockNavigate;
    HTREEITEM hItem;
    BOOL result = _NavigateToPIDL(pidl, &hItem, TRUE, FALSE, TRUE);
    --m_mtxBlockNavigate;
 
    return result;
}

Referenced by _CreateTreeView(), and Invoke().

_NavigateToPIDL()

BOOL CExplorerBand::_NavigateToPIDL ( _In_ LPCITEMIDLIST  dest, _Out_ HTREEITEM *  phItem, _In_ BOOL  bExpand, _In_ BOOL  bInsert, _In_ BOOL  bSelect  )

protected

Navigate to a given PIDL in the treeview, and return matching tree item handle

• dest: The absolute PIDL we should navigate in the treeview
• item: Handle of the tree item matching the PIDL
• bExpand: expand collapsed nodes in order to find the right element
• bInsert: insert the element at the right place if we don't find it
• bSelect: select the item after we found it

Definition at line 222 of file CExplorerBand.cpp.

{
    if (!phItem)
        return FALSE;
 
    *phItem = NULL;
 
    HTREEITEM hItem = TreeView_GetFirstVisible(m_hwndTreeView);
    HTREEITEM hParent = NULL, tmp;
    while (TRUE)
    {
        CItemData *pItemData = GetItemData(hItem);
        if (!pItemData)
        {
            ERR("Something has gone wrong, no data associated to node\n");
            return FALSE;
        }
 
        // If we found our node, give it back
        if (!m_pDesktop->CompareIDs(0, pItemData->absolutePidl, dest))
        {
            if (bSelect)
                TreeView_SelectItem(m_hwndTreeView, hItem);
            *phItem = hItem;
            return TRUE;
        }
 
        // Check if we are a parent of the requested item
        TVITEMW tvItem;
        LPITEMIDLIST relativeChild = ILFindChild(pItemData->absolutePidl, dest);
        if (relativeChild)
        {
            // Notify treeview we have children
            tvItem.mask = TVIF_CHILDREN;
            tvItem.hItem = hItem;
            tvItem.cChildren = 1;
            TreeView_SetItem(m_hwndTreeView, &tvItem);
 
            // If we can expand and the node isn't expanded yet, do it
            if (bExpand)
            {
                if (!pItemData->expanded)
                {
                    _InsertSubitems(hItem, pItemData->absolutePidl);
                    pItemData->expanded = TRUE;
                }
                TreeView_Expand(m_hwndTreeView, hItem, TVE_EXPAND);
            }
 
            // Try to get a child
            tmp = TreeView_GetChild(m_hwndTreeView, hItem);
            if (tmp)
            {
                // We have a child, let's continue with it
                hParent = hItem;
                hItem = tmp;
                continue;
            }
 
            if (bInsert && pItemData->expanded)
            {
                // Happens when we have to create a subchild inside a child
                hItem = _InsertItem(hItem, dest, relativeChild, TRUE);
            }
 
            // We end up here, without any children, so we found nothing
            // Tell the parent node it has children
            ZeroMemory(&tvItem, sizeof(tvItem));
            return FALSE;
        }
 
        // Find sibling
        tmp = TreeView_GetNextSibling(m_hwndTreeView, hItem);
        if (tmp)
        {
            hItem = tmp;
            continue;
        }
 
        if (bInsert)
        {
            *phItem = hItem = _InsertItem(hParent, dest, ILFindLastID(dest), TRUE);
            return TRUE;
        }
 
        return FALSE;
    }
 
    UNREACHABLE;
}

Referenced by _NavigateToCurrentFolder().

_SortItems()

void CExplorerBand::_SortItems ( HTREEITEM  hParent )

overrideprotected

Definition at line 87 of file CExplorerBand.cpp.

{
    TVSORTCB sortCallback;
    sortCallback.hParent = hParent;
    sortCallback.lpfnCompare = _CompareTreeItems;
    sortCallback.lParam = (LPARAM)(PVOID)m_pDesktop; // m_pDesktop is not a pointer
    TreeView_SortChildrenCB(m_hwndTreeView, &sortCallback, 0);
}

_WantsRootItem()

BOOL CExplorerBand::_WantsRootItem ( )

overrideprotected

Definition at line 64 of file CExplorerBand.cpp.

{
    return TRUE;
}

GetClassID()

STDMETHODIMP CExplorerBand::GetClassID ( CLSID *  pClassID )

override

Definition at line 29 of file CExplorerBand.cpp.

{
    if (!pClassID)
        return E_POINTER;
    *pClassID = CLSID_ExplorerBand;
    return S_OK;
}

GetIDsOfNames()

STDMETHODIMP CExplorerBand::GetIDsOfNames ( REFIID  riid, LPOLESTR *  rgszNames, UINT  cNames, LCID  lcid, DISPID *  rgDispId  )

override

Implements IDispatch.

Definition at line 166 of file CExplorerBand.cpp.

{
    UNIMPLEMENTED;
    return E_NOTIMPL;
}

GetTypeInfo()

STDMETHODIMP CExplorerBand::GetTypeInfo ( UINT  iTInfo, LCID  lcid, ITypeInfo **  ppTInfo  )

override

Implements IDispatch.

Definition at line 160 of file CExplorerBand.cpp.

{
    UNIMPLEMENTED;
    return E_NOTIMPL;
}

GetTypeInfoCount()

STDMETHODIMP CExplorerBand::GetTypeInfoCount ( UINT *  pctinfo )

override

Implements IDispatch.

Definition at line 154 of file CExplorerBand.cpp.

{
    UNIMPLEMENTED;
    return E_NOTIMPL;
}

Invoke() [1/2]

STDMETHODIMP CExplorerBand::Invoke ( _In_ PCIDLIST_ABSOLUTE  pidl )

override

Definition at line 76 of file CExplorerBand.cpp.

{
    /* Prevents navigation if selection is initiated inside the band */
    if (m_mtxBlockNavigate)
        return S_OK;
 
    _UpdateBrowser(pidl);
    m_hwndTreeView.SetFocus();
    return S_OK;
}

Referenced by OnSelectionChanged().

Invoke() [2/2]

STDMETHODIMP CExplorerBand::Invoke ( DISPID  dispIdMember, REFIID  riid, LCID  lcid, WORD  wFlags, DISPPARAMS *  pDispParams, VARIANT *  pVarResult, EXCEPINFO *  pExcepInfo, UINT *  puArgErr  )

override

Implements IDispatch.

Definition at line 173 of file CExplorerBand.cpp.

{
    switch (dispIdMember)
    {
        case DISPID_DOWNLOADCOMPLETE:
        case DISPID_NAVIGATECOMPLETE2:
        {
            TRACE("dispId %d received\n", dispIdMember);
            _NavigateToCurrentFolder();
            return S_OK;
        }
    }
    TRACE("Unknown dispid requested: %08x\n", dispIdMember);
    return E_INVALIDARG;
}

OnSelectionChanged()

STDMETHODIMP CExplorerBand::OnSelectionChanged ( _In_ PCIDLIST_ABSOLUTE  pidl )

override

Definition at line 70 of file CExplorerBand.cpp.

{
    return Invoke(pidl);
}

---

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

• dll/win32/shdocvw/CExplorerBand.h
• dll/win32/shdocvw/CExplorerBand.cpp