CMenuSFToolbar Class Reference

#include <CMenuToolbars.h>

Inheritance diagram for CMenuSFToolbar:

Collaboration diagram for CMenuSFToolbar:

Public Member Functions
	CMenuSFToolbar (CMenuBand *menuBand)
virtual	~CMenuSFToolbar ()
HRESULT	SetShellFolder (IShellFolder *psf, LPCITEMIDLIST pidlFolder, HKEY hKey, DWORD dwFlags)
HRESULT	GetShellFolder (DWORD *pdwFlags, LPITEMIDLIST *ppidl, REFIID riid, void **ppv)
virtual HRESULT	FillToolbar (BOOL clearFirst=FALSE) override
Public Member Functions inherited from CMenuToolbarBase
	CMenuToolbarBase (CMenuBand *menuBand, BOOL usePager)
virtual	~CMenuToolbarBase ()
HRESULT	IsWindowOwner (HWND hwnd)
HRESULT	CreateToolbar (HWND hwndParent, DWORD dwFlags)
HRESULT	GetWindow (HWND *phwnd)
HRESULT	ShowDW (BOOL fShow)
HRESULT	Close ()
HRESULT	OnWinEvent (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT *theResult)
HRESULT	ChangeHotItem (CMenuToolbarBase *toolbar, INT item, DWORD dwFlags)
HRESULT	ChangePopupItem (CMenuToolbarBase *toolbar, INT item)
HRESULT	PopupSubMenu (UINT itemId, UINT index, IShellMenu *childShellMenu, BOOL keyInitiated)
HRESULT	PopupSubMenu (UINT itemId, UINT index, HMENU menu)
HRESULT	TrackContextMenu (IContextMenu *contextMenu, POINT pt)
HRESULT	KeyboardItemChange (DWORD changeType)
HRESULT	PrepareExecuteItem (INT iItem)
HRESULT	ExecuteItem ()
HRESULT	GetSizes (SIZE *pMinSize, SIZE *pMaxSize, SIZE *pIntegralSize)
HRESULT	SetPosSize (int x, int y, int cx, int cy)
void	InvalidateDraw ()
HRESULT	DisableMouseTrack (BOOL bDisable)
virtual HRESULT	FillToolbar (BOOL clearFirst=FALSE)=0
HRESULT	CancelCurrentPopup ()
HRESULT	PopupItem (INT iItem, BOOL keyInitiated)
HRESULT	GetDataFromId (INT iItem, INT *pIndex, DWORD_PTR *pData)
HRESULT	KillPopupTimer ()
HRESULT	MenuBarMouseDown (INT iIndex, BOOL isLButton)
HRESULT	MenuBarMouseUp (INT iIndex, BOOL isLButton)
HRESULT	ProcessClick (INT iItem)
HRESULT	ProcessContextMenu (INT iItem)
HRESULT	BeforeCancelPopup ()

Protected Member Functions
virtual HRESULT	OnDeletingButton (const NMTOOLBAR *tb) override
virtual HRESULT	InternalGetTooltip (INT iItem, INT index, DWORD_PTR dwData, LPWSTR pszText, INT cchTextMax) override
virtual HRESULT	InternalExecuteItem (INT iItem, INT index, DWORD_PTR dwData) override
virtual HRESULT	InternalPopupItem (INT iItem, INT index, DWORD_PTR dwData, BOOL keyInitiated) override
virtual HRESULT	InternalHasSubMenu (INT iItem, INT index, DWORD_PTR dwData) override
virtual HRESULT	InternalContextMenu (INT iItem, INT index, DWORD_PTR dwData, POINT pt) override
Protected Member Functions inherited from CMenuToolbarBase
virtual HRESULT	OnDeletingButton (const NMTOOLBAR *tb) PURE
virtual HRESULT	InternalGetTooltip (INT iItem, INT index, DWORD_PTR dwData, LPWSTR pszText, INT cchTextMax) PURE
virtual HRESULT	InternalExecuteItem (INT iItem, INT index, DWORD_PTR dwData) PURE
virtual HRESULT	InternalPopupItem (INT iItem, INT index, DWORD_PTR dwData, BOOL keyInitiated) PURE
virtual HRESULT	InternalHasSubMenu (INT iItem, INT index, DWORD_PTR dwData) PURE
virtual HRESULT	InternalContextMenu (INT iItem, INT index, DWORD_PTR dwData, POINT pt) PURE
HRESULT	AddButton (DWORD commandId, LPCWSTR caption, BOOL hasSubMenu, INT iconId, DWORD_PTR buttonData, BOOL last)
HRESULT	AddSeparator (BOOL last)
HRESULT	AddPlaceholder ()
HRESULT	ClearToolbar ()
HWND	GetToolbar ()

Private Attributes
CComPtr< IShellFolder >	m_shellFolder
LPCITEMIDLIST	m_idList
HKEY	m_hKey

Additional Inherited Members
Protected Attributes inherited from CMenuToolbarBase
CMenuBand *	m_menuBand
DWORD	m_dwMenuFlags
BOOL	m_hasSizes
SIZE	m_idealSize
SIZE	m_itemSize
BOOL	m_usePager
CMenuToolbarBase *	m_hotBar
INT	m_hotItem
CMenuToolbarBase *	m_popupBar
INT	m_popupItem
DWORD	m_initFlags
BOOL	m_isTrackingPopup
INT	m_executeIndex
INT	m_executeItem
DWORD_PTR	m_executeData
BOOL	m_cancelingPopup

Detailed Description

Definition at line 167 of file CMenuToolbars.h.

Constructor & Destructor Documentation

CMenuSFToolbar()

CMenuSFToolbar::CMenuSFToolbar

(

CMenuBand *

menuBand

)

Definition at line 1318 of file CMenuToolbars.cpp.

                                                   :
    CMenuToolbarBase(menuBand, TRUE),
    m_shellFolder(NULL),
    m_idList(NULL),
    m_hKey(NULL)
{
}

~CMenuSFToolbar()

CMenuSFToolbar::~CMenuSFToolbar ( )

virtual

Definition at line 1326 of file CMenuToolbars.cpp.

{
}

Member Function Documentation

FillToolbar()

HRESULT CMenuSFToolbar::FillToolbar ( BOOL  clearFirst = FALSE )

overridevirtual

Implements CMenuToolbarBase.

Definition at line 1356 of file CMenuToolbars.cpp.

{
    HRESULT hr;
 
    CComPtr<IEnumIDList> eidl;
    hr = m_shellFolder->EnumObjects(GetToolbar(), SHCONTF_FOLDERS | SHCONTF_NONFOLDERS, &eidl);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    HDPA dpaSort = DPA_Create(10);
 
    LPITEMIDLIST item = NULL;
    hr = eidl->Next(1, &item, NULL);
    while (hr == S_OK)
    {
        if (m_menuBand->_CallCBWithItemPidl(item, 0x10000000, 0, 0) == S_FALSE)
        {
            DPA_AppendPtr(dpaSort, item);
        }
        else
        {
            CoTaskMemFree(item);
        }
 
        hr = eidl->Next(1, &item, NULL);
    }
 
    // If no items were added, show the "empty" placeholder
    if (DPA_GetPtrCount(dpaSort) == 0)
    {
        DPA_Destroy(dpaSort);
        return AddPlaceholder();
    }
 
    TRACE("FillToolbar added %d items to the DPA\n", DPA_GetPtrCount(dpaSort));
 
    DPA_Sort(dpaSort, PidlListSort, (LPARAM) m_shellFolder.p);
 
    BOOL StartMenuAdminTools = SHRegGetBoolUSValueW(
        L"Software\\Microsoft\\Windows\\CurrentVersion\\Explorer\\Advanced",
        L"StartMenuAdminTools", FALSE, TRUE);
 
    BOOL bMustHideAdminTools = IsPidlPrograms(m_idList) && !StartMenuAdminTools;
    TRACE("StartMenuAdminTools: %d\n", StartMenuAdminTools);
    TRACE("bMustHideAdminTools: %d\n", bMustHideAdminTools);
 
    WCHAR szAdminTools[MAX_PATH];
    if (bMustHideAdminTools)
    {
        LoadStringW(GetModuleHandleW(L"shell32.dll"), IDS_ADMINISTRATIVETOOLS,
                    szAdminTools, _countof(szAdminTools));
    }
 
    for (int i = 0; i<DPA_GetPtrCount(dpaSort);)
    {
        item = (LPITEMIDLIST)DPA_GetPtr(dpaSort, i);
 
        STRRET sr = { STRRET_CSTR };
        hr = m_shellFolder->GetDisplayNameOf(item, SIGDN_NORMALDISPLAY, &sr);
        if (FAILED_UNEXPECTEDLY(hr))
        {
            DPA_Destroy(dpaSort);
            return hr;
        }
 
        PWSTR MenuString;
        StrRetToStr(&sr, NULL, &MenuString);
 
        if (bMustHideAdminTools && lstrcmpiW(MenuString, szAdminTools) == 0)
        {
            ++i;
            CoTaskMemFree(MenuString);
            continue;
        }
 
        INT index = SHMapPIDLToSystemImageListIndex(m_shellFolder, item, NULL);
        BOOL isPureFolder = GetFolderItemBaseType(m_shellFolder, item) == SFGAO_FOLDER; // Don't expand .cab/.zip
 
        // Fetch next item already, so we know if the current one is the last
        i++;
 
        AddButton(i, MenuString, isPureFolder, index, reinterpret_cast<DWORD_PTR>(item), i >= DPA_GetPtrCount(dpaSort));
 
        CoTaskMemFree(MenuString);
    }
 
    DPA_Destroy(dpaSort);
    return hr;
}

Referenced by CMenuBand::SetShellFolder(), and CMenuBand::SetSite().

GetShellFolder()

HRESULT CMenuSFToolbar::GetShellFolder	(	DWORD *	pdwFlags,
		LPITEMIDLIST *	ppidl,
		REFIID	riid,
		void **	ppv
	)

Definition at line 1472 of file CMenuToolbars.cpp.

{
    HRESULT hr;
 
    hr = m_shellFolder->QueryInterface(riid, ppv);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    if (pdwFlags)
        *pdwFlags = m_dwMenuFlags;
 
    if (ppidl)
    {
        LPITEMIDLIST pidl = NULL;
 
        if (m_idList)
        {
            pidl = ILClone(m_idList);
            if (!pidl)
            {
                ERR("ILClone failed!\n");
                (*reinterpret_cast<IUnknown**>(ppv))->Release();
                return E_FAIL;
            }
        }
 
        *ppidl = pidl;
    }
 
    return hr;
}

Referenced by CMenuBand::_CallCB(), and CMenuBand::GetShellFolder().

InternalContextMenu()

HRESULT CMenuSFToolbar::InternalContextMenu ( INT  iItem, INT  index, DWORD_PTR  dwData, POINT  pt  )

overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1504 of file CMenuToolbars.cpp.

{
    HRESULT hr;
    CComPtr<IContextMenu> contextMenu = NULL;
    LPCITEMIDLIST pidl = reinterpret_cast<LPCITEMIDLIST>(dwData);
 
    hr = m_shellFolder->GetUIObjectOf(GetToolbar(), 1, &pidl, IID_NULL_PPV_ARG(IContextMenu, &contextMenu));
    if (FAILED_UNEXPECTEDLY(hr))
    {
        return hr;
    }
 
    hr = TrackContextMenu(contextMenu, pt);
 
    return hr;
}

InternalExecuteItem()

HRESULT CMenuSFToolbar::InternalExecuteItem ( INT  iItem, INT  index, DWORD_PTR  dwData  )

overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1521 of file CMenuToolbars.cpp.

{
    return m_menuBand->_CallCBWithItemPidl(reinterpret_cast<LPITEMIDLIST>(data), SMC_SFEXEC, 0, 0);
}

InternalGetTooltip()

HRESULT CMenuSFToolbar::InternalGetTooltip ( INT  iItem, INT  index, DWORD_PTR  dwData, LPWSTR  pszText, INT  cchTextMax  )

overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1446 of file CMenuToolbars.cpp.

{
    //ITEMIDLIST * pidl = reinterpret_cast<LPITEMIDLIST>(dwData);
    UNIMPLEMENTED;
    return E_NOTIMPL;
}

InternalHasSubMenu()

HRESULT CMenuSFToolbar::InternalHasSubMenu ( INT  iItem, INT  index, DWORD_PTR  dwData  )

overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1563 of file CMenuToolbars.cpp.

{
    LPCITEMIDLIST pidl = reinterpret_cast<LPITEMIDLIST>(dwData);
    BOOL isPureFolder = GetFolderItemBaseType(m_shellFolder, pidl) == SFGAO_FOLDER;
    return isPureFolder ? S_OK : S_FALSE;
}

InternalPopupItem()

HRESULT CMenuSFToolbar::InternalPopupItem ( INT  iItem, INT  index, DWORD_PTR  dwData, BOOL  keyInitiated  )

overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1526 of file CMenuToolbars.cpp.

{
    HRESULT hr;
    UINT uId;
    UINT uIdAncestor;
    DWORD flags;
    CComPtr<IShellMenuCallback> psmc;
    CComPtr<IShellMenu> shellMenu;
 
    LPITEMIDLIST pidl = reinterpret_cast<LPITEMIDLIST>(dwData);
 
    if (!pidl)
        return E_FAIL;
 
    hr = CMenuBand_CreateInstance(IID_PPV_ARG(IShellMenu, &shellMenu));
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    m_menuBand->GetMenuInfo(&psmc, &uId, &uIdAncestor, &flags);
 
    // FIXME: not sure what to use as uId/uIdAncestor here
    hr = shellMenu->Initialize(psmc, 0, uId, SMINIT_VERTICAL);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    CComPtr<IShellFolder> childFolder;
    hr = m_shellFolder->BindToObject(pidl, NULL, IID_PPV_ARG(IShellFolder, &childFolder));
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    hr = shellMenu->SetShellFolder(childFolder, NULL, NULL, SMSET_TOP);
    if (FAILED_UNEXPECTEDLY(hr))
        return hr;
 
    return PopupSubMenu(iItem, index, shellMenu, keyInitiated);
}

OnDeletingButton()

HRESULT CMenuSFToolbar::OnDeletingButton ( const NMTOOLBAR *  tb )

overrideprotectedvirtual

Reimplemented from CMenuToolbarBase.

Definition at line 1453 of file CMenuToolbars.cpp.

{
    ILFree(reinterpret_cast<LPITEMIDLIST>(tb->tbButton.dwData));
    return S_OK;
}

SetShellFolder()

HRESULT CMenuSFToolbar::SetShellFolder	(	IShellFolder *	psf,
		LPCITEMIDLIST	pidlFolder,
		HKEY	hKey,
		DWORD	dwFlags
	)

Definition at line 1459 of file CMenuToolbars.cpp.

{
    m_shellFolder = psf;
    m_idList = ILClone(pidlFolder);
    m_hKey = hKey;
    m_dwMenuFlags = dwFlags;
 
    if (IsWindow())
        ClearToolbar();
 
    return S_OK;
}

Referenced by CMenuBand::SetShellFolder().

Member Data Documentation

m_hKey

HKEY CMenuSFToolbar::m_hKey

private

Definition at line 173 of file CMenuToolbars.h.

Referenced by SetShellFolder().

m_idList

LPCITEMIDLIST CMenuSFToolbar::m_idList

private

Definition at line 172 of file CMenuToolbars.h.

Referenced by FillToolbar(), GetShellFolder(), and SetShellFolder().

m_shellFolder

CComPtr<IShellFolder> CMenuSFToolbar::m_shellFolder

private

Definition at line 171 of file CMenuToolbars.h.

Referenced by FillToolbar(), GetShellFolder(), InternalContextMenu(), InternalHasSubMenu(), InternalPopupItem(), and SetShellFolder().

---

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

• dll/win32/shell32/shellmenu/CMenuToolbars.h
• dll/win32/shell32/shellmenu/CMenuToolbars.cpp