CDefViewBckgrndMenu Class Reference

Inheritance diagram for CDefViewBckgrndMenu:

Collaboration diagram for CDefViewBckgrndMenu:

Public Member Functions
	CDefViewBckgrndMenu ()
	~CDefViewBckgrndMenu ()
HRESULT	Initialize (IShellFolder *psf)
STDMETHOD()	QueryContextMenu (HMENU hMenu, UINT indexMenu, UINT idCmdFirst, UINT idCmdLast, UINT uFlags) override
STDMETHOD()	InvokeCommand (LPCMINVOKECOMMANDINFO lpcmi) override
STDMETHOD()	GetCommandString (UINT_PTR idCommand, UINT uFlags, UINT *lpReserved, LPSTR lpszName, UINT uMaxNameLen) override
STDMETHOD()	HandleMenuMsg (UINT uMsg, WPARAM wParam, LPARAM lParam) override
STDMETHOD()	HandleMenuMsg2 (UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT *plResult) override
STDMETHOD()	SetSite (IUnknown *pUnkSite) override
STDMETHOD()	GetSite (REFIID riid, void **ppvSite) 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 ()
HRESULT	HandleMenuMsg2 ([in] UINT uMsg, [in] WPARAM wParam, [in] LPARAM lParam, [out] LRESULT *plResult)
HRESULT	HandleMenuMsg ([in] UINT uMsg, [in] WPARAM wParam, [in] LPARAM lParam)
HRESULT	QueryContextMenu ([in] HMENU hmenu, [in] UINT indexMenu, [in] UINT idCmdFirst, [in] UINT idCmdLast, [in] UINT uFlags)
HRESULT	InvokeCommand ([in] LPCMINVOKECOMMANDINFO lpici)
HRESULT	GetCommandString ([in] UINT_PTR idCmd, [in] UINT uType, [out] UINT *pwReserved, [out, size_is(cchMax)] LPSTR pszName, [in] UINT cchMax)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()
Public Member Functions inherited from IObjectWithSite
HRESULT	SetSite ([in] IUnknown *pUnkSite)
HRESULT	GetSite ([in] REFIID riid, [out, iid_is(riid)] PVOID *ppvSite)

Private Member Functions
BOOL	_bIsDesktopBrowserMenu ()
BOOL	_bCanPaste ()

Private Attributes
CComPtr< IUnknown >	m_site
CComPtr< IShellFolder >	m_psf
CComPtr< IContextMenu >	m_folderCM
UINT	m_idCmdFirst
UINT	m_LastFolderCMId

Additional Inherited Members
Public Types inherited from IContextMenu3
typedef IContextMenu3 *	LPCONTEXTMENU3
Public Types inherited from IContextMenu2
typedef IContextMenu2 *	LPCONTEXTMENU2
Public Types inherited from IContextMenu
typedef IContextMenu *	LPCONTEXTMENU
typedef struct IContextMenu::tagCMINVOKECOMMANDINFO	CMINVOKECOMMANDINFO
typedef struct IContextMenu::tagCMINVOKECOMMANDINFO *	LPCMINVOKECOMMANDINFO
typedef struct IContextMenu::tagCMInvokeCommandInfoEx	CMINVOKECOMMANDINFOEX
typedef struct IContextMenu::tagCMInvokeCommandInfoEx *	LPCMINVOKECOMMANDINFOEX
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Public Types inherited from IObjectWithSite
typedef IObjectWithSite *	LPOBJECTWITHSITE
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
Static Public Attributes inherited from IContextMenu
static const WCHAR	CMDSTR_NEWFOLDERW [] = {'N','e','w','F','o','l','d','e','r',0}
static const WCHAR	CMDSTR_VIEWLISTW [] = {'V','i','e','w','L','i','s','t',0}
static const WCHAR	CMDSTR_VIEWDETAILSW [] = {'V','i','e','w','D','e','t','a','i','l','s',0}

Detailed Description

Definition at line 13 of file CDefViewBckgrndMenu.cpp.

Constructor & Destructor Documentation

CDefViewBckgrndMenu()

CDefViewBckgrndMenu::CDefViewBckgrndMenu

(

)

Definition at line 56 of file CDefViewBckgrndMenu.cpp.

{
    m_idCmdFirst = 0;
    m_LastFolderCMId = 0;
}

~CDefViewBckgrndMenu()

CDefViewBckgrndMenu::~CDefViewBckgrndMenu

(

)

Definition at line 62 of file CDefViewBckgrndMenu.cpp.

{
}

Member Function Documentation

_bCanPaste()

BOOL CDefViewBckgrndMenu::_bCanPaste ( )

private

Definition at line 85 of file CDefViewBckgrndMenu.cpp.

{
    /* If the folder doesn't have a drop target we can't paste */
    CComPtr<IDropTarget> pdt;
    HRESULT hr = m_psf->CreateViewObject(NULL, IID_PPV_ARG(IDropTarget, &pdt));
    if (FAILED(hr))
        return FALSE;
 
    /* We can only paste if CFSTR_SHELLIDLIST is present in the clipboard */
    CComPtr<IDataObject> pDataObj;
    hr = OleGetClipboard(&pDataObj);
    if (FAILED(hr))
        return FALSE;
 
    STGMEDIUM medium;
    FORMATETC formatetc;
 
    /* Set the FORMATETC structure*/
    InitFormatEtc(formatetc, RegisterClipboardFormatW(CFSTR_SHELLIDLIST), TYMED_HGLOBAL);
    hr = pDataObj->GetData(&formatetc, &medium);
    if (FAILED(hr))
        return FALSE;
 
    ReleaseStgMedium(&medium);
    return TRUE;
}

Referenced by QueryContextMenu().

_bIsDesktopBrowserMenu()

BOOL CDefViewBckgrndMenu::_bIsDesktopBrowserMenu ( )

private

Definition at line 66 of file CDefViewBckgrndMenu.cpp.

{
    if (!m_site)
        return FALSE;
 
    /* Get a pointer to the shell browser */
    CComPtr<IShellView> psv;
    HRESULT hr = IUnknown_QueryService(m_site, SID_SFolderView, IID_PPV_ARG(IShellView, &psv));
    if (FAILED_UNEXPECTEDLY(hr))
        return FALSE;
 
    FOLDERSETTINGS FolderSettings;
    hr = psv->GetCurrentInfo(&FolderSettings);
    if (FAILED_UNEXPECTEDLY(hr))
        return FALSE;
 
    return ((FolderSettings.fFlags & FWF_DESKTOP) == FWF_DESKTOP);
}

Referenced by QueryContextMenu().

GetCommandString()

HRESULT WINAPI CDefViewBckgrndMenu::GetCommandString ( UINT_PTR  idCommand, UINT  uFlags, UINT *  lpReserved, LPSTR  lpszName, UINT  uMaxNameLen  )

override

Implements IContextMenu.

Definition at line 284 of file CDefViewBckgrndMenu.cpp.

{
    if (m_folderCM)
    {
        return m_folderCM->GetCommandString(idCommand, uFlags, lpReserved, lpszName, uMaxNameLen);
    }
 
    return E_NOTIMPL;
}

GetSite()

HRESULT WINAPI CDefViewBckgrndMenu::GetSite ( REFIID  riid, void **  ppvSite  )

override

Definition at line 138 of file CDefViewBckgrndMenu.cpp.

{
    if (!m_site)
        return E_FAIL;
 
    return m_site->QueryInterface(riid, ppvSite);
}

HandleMenuMsg()

HRESULT WINAPI CDefViewBckgrndMenu::HandleMenuMsg ( UINT  uMsg, WPARAM  wParam, LPARAM  lParam  )

override

Implements IContextMenu2.

Definition at line 296 of file CDefViewBckgrndMenu.cpp.

{
    if(m_folderCM)
    {
        CComPtr<IContextMenu2> pfolderCM2;
        HRESULT hr = m_folderCM->QueryInterface(IID_PPV_ARG(IContextMenu2, &pfolderCM2));
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
 
        return pfolderCM2->HandleMenuMsg(uMsg, wParam, lParam);
    }
 
    return E_NOTIMPL;
}

HandleMenuMsg2()

HRESULT WINAPI CDefViewBckgrndMenu::HandleMenuMsg2 ( UINT  uMsg, WPARAM  wParam, LPARAM  lParam, LRESULT *  plResult  )

override

Implements IContextMenu3.

Definition at line 313 of file CDefViewBckgrndMenu.cpp.

{
    if(m_folderCM)
    {
        CComPtr<IContextMenu3> pfolderCM3;
        HRESULT hr = m_folderCM->QueryInterface(IID_PPV_ARG(IContextMenu3, &pfolderCM3));
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
 
        return pfolderCM3->HandleMenuMsg2(uMsg, wParam, lParam, plResult);
    }
 
    return E_NOTIMPL;
}

Initialize()

HRESULT CDefViewBckgrndMenu::Initialize

(

IShellFolder *

psf

)

Definition at line 113 of file CDefViewBckgrndMenu.cpp.

{
    m_psf = psf;
 
    /* Get the context menu of the folder. Do it here because someone may call
       InvokeCommand without calling QueryContextMenu. It is fine if this fails */
    m_psf->CreateViewObject(NULL, IID_PPV_ARG(IContextMenu, &m_folderCM));
 
    return S_OK;
}

InvokeCommand()

HRESULT WINAPI CDefViewBckgrndMenu::InvokeCommand ( LPCMINVOKECOMMANDINFO  lpcmi )

override

Implements IContextMenu.

Definition at line 216 of file CDefViewBckgrndMenu.cpp.

{
    UINT idCmd = LOWORD(lpcmi->lpVerb);
 
    if (HIWORD(lpcmi->lpVerb) && !strcmp(lpcmi->lpVerb, CMDSTR_VIEWLISTA))
    {
        idCmd = FCIDM_SHVIEW_LISTVIEW;
    }
    else if (HIWORD(lpcmi->lpVerb) && !strcmp(lpcmi->lpVerb, CMDSTR_VIEWDETAILSA))
    {
        idCmd = FCIDM_SHVIEW_REPORTVIEW;
    }
    else if(HIWORD(lpcmi->lpVerb) != 0 || idCmd < m_LastFolderCMId)
    {
        if (m_folderCM)
        {
            return m_folderCM->InvokeCommand(lpcmi);
        }
        WARN("m_folderCM is NULL!\n");
        return E_NOTIMPL;
    }
    else
    {
        /* The default part of the background menu doesn't have shifted ids so we need to convert the id offset to the real id */
        idCmd += m_idCmdFirst;
    }
 
    /* The commands that are handled by the def view are forwarded to it */
    switch (idCmd)
    {
    case FCIDM_SHVIEW_INSERT:
    case FCIDM_SHVIEW_INSERTLINK:
        if (m_folderCM)
        {
            lpcmi->lpVerb = MAKEINTRESOURCEA(idCmd);
            return m_folderCM->InvokeCommand(lpcmi);
        }
        WARN("m_folderCM is NULL!\n");
        return E_NOTIMPL;
    case FCIDM_SHVIEW_BIGICON:
    case FCIDM_SHVIEW_SMALLICON:
    case FCIDM_SHVIEW_LISTVIEW:
    case FCIDM_SHVIEW_REPORTVIEW:
    case FCIDM_SHVIEW_AUTOARRANGE:
    case FCIDM_SHVIEW_SNAPTOGRID:
    case FCIDM_SHVIEW_REFRESH:
    case FCIDM_SHVIEW_ALIGNTOGRID:
        if (!m_site)
            return E_FAIL;
 
        /* Get a pointer to the shell browser */
        CComPtr<IShellView> psv;
        HRESULT hr = IUnknown_QueryService(m_site, SID_SFolderView, IID_PPV_ARG(IShellView, &psv));
        if (FAILED_UNEXPECTEDLY(hr))
            return hr;
 
        HWND hwndSV = NULL;
        if (SUCCEEDED(psv->GetWindow(&hwndSV)))
            SendMessageW(hwndSV, WM_COMMAND, MAKEWPARAM(idCmd, 0), 0);
        return S_OK;
    }
 
    ERR("Got unknown command id %ul\n", LOWORD(lpcmi->lpVerb));
    return E_FAIL;
}

QueryContextMenu()

HRESULT WINAPI CDefViewBckgrndMenu::QueryContextMenu ( HMENU  hMenu, UINT  indexMenu, UINT  idCmdFirst, UINT  idCmdLast, UINT  uFlags  )

override

Implements IContextMenu.

Definition at line 148 of file CDefViewBckgrndMenu.cpp.

{
    HRESULT hr;
    HMENU hMenuPart;
    UINT cIds = 0;
 
    /* This is something the implementations of IContextMenu should never really do.
       However CDefViewBckgrndMenu is more or less an overengineering result, its code could really be part of the
       CDefView. Given this, I think that abusing the interface here is not that bad since only CDefView is the ony
       user of this class. Here we need to do two things to keep things as simple as possible.
       First we want the menu part added by the shell folder to be the first to add so as to make as few id translations
       as possible. Second, we want to add the default part of the background menu without shifted ids, so as
       to let the CDefView fill some parts like filling the arrange modes or checking the view mode. In order
       for that to work we need to save idCmdFirst because our caller will pass id offsets to InvokeCommand.
       This makes it impossible to concatenate the CDefViewBckgrndMenu with other menus since it abuses IContextMenu
       but as stated above, its sole user is CDefView and should really be that way. */
    m_idCmdFirst = idCmdFirst;
 
    /* Let the shell folder add any items it wants to add in the background context menu */
    if (m_folderCM)
    {
        hr = m_folderCM->QueryContextMenu(hMenu, indexMenu, idCmdFirst, idCmdLast, uFlags);
        if (SUCCEEDED(hr))
        {
            m_LastFolderCMId = LOWORD(hr);
            cIds = m_LastFolderCMId;
        }
        else
        {
            WARN("QueryContextMenu failed!\n");
        }
    }
    else
    {
        WARN("GetUIObjectOf didn't give any context menu!\n");
    }
 
    /* Load the default part of the background context menu */
    hMenuPart = LoadMenuW(shell32_hInstance, L"MENU_002");
    if (hMenuPart)
    {
        /* Don't show the view submenu for the desktop */
        if (_bIsDesktopBrowserMenu())
        {
            DeleteMenu(hMenuPart, FCIDM_SHVIEW_VIEW, MF_BYCOMMAND);
        }
 
        /* Disable the paste options if it is not possible */
        if (!_bCanPaste())
        {
            EnableMenuItem(hMenuPart, FCIDM_SHVIEW_INSERT, MF_BYCOMMAND | MF_GRAYED);
            EnableMenuItem(hMenuPart, FCIDM_SHVIEW_INSERTLINK, MF_BYCOMMAND | MF_GRAYED);
        }
 
        /* merge general background context menu in */
        Shell_MergeMenus(hMenu, GetSubMenu(hMenuPart, 0), indexMenu, 0, idCmdLast, MM_DONTREMOVESEPS | MM_SUBMENUSHAVEIDS | MM_ADDSEPARATOR);
        DestroyMenu(hMenuPart);
    }
    else
    {
        ERR("Failed to load menu from resource!\n");
    }
 
    return MAKE_HRESULT(SEVERITY_SUCCESS, 0, cIds);
}

SetSite()

HRESULT WINAPI CDefViewBckgrndMenu::SetSite ( IUnknown *  pUnkSite )

override

Implements IObjectWithSite.

Definition at line 126 of file CDefViewBckgrndMenu.cpp.

{
    m_site = pUnkSite;
 
    if(m_folderCM)
        IUnknown_SetSite(m_folderCM, pUnkSite);
 
    return S_OK;
}

Member Data Documentation

m_folderCM

CComPtr<IContextMenu> CDefViewBckgrndMenu::m_folderCM

private

Definition at line 21 of file CDefViewBckgrndMenu.cpp.

Referenced by GetCommandString(), HandleMenuMsg(), HandleMenuMsg2(), Initialize(), InvokeCommand(), QueryContextMenu(), and SetSite().

m_idCmdFirst

UINT CDefViewBckgrndMenu::m_idCmdFirst

private

Definition at line 23 of file CDefViewBckgrndMenu.cpp.

Referenced by CDefViewBckgrndMenu(), InvokeCommand(), and QueryContextMenu().

m_LastFolderCMId

UINT CDefViewBckgrndMenu::m_LastFolderCMId

private

Definition at line 24 of file CDefViewBckgrndMenu.cpp.

Referenced by CDefViewBckgrndMenu(), InvokeCommand(), and QueryContextMenu().

m_psf

CComPtr<IShellFolder> CDefViewBckgrndMenu::m_psf

private

Definition at line 20 of file CDefViewBckgrndMenu.cpp.

Referenced by _bCanPaste(), and Initialize().

m_site

CComPtr<IUnknown> CDefViewBckgrndMenu::m_site

private

Definition at line 19 of file CDefViewBckgrndMenu.cpp.

Referenced by _bIsDesktopBrowserMenu(), GetSite(), InvokeCommand(), and SetSite().

---

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

• dll/win32/shell32/CDefViewBckgrndMenu.cpp