propsheet.cpp File Reference

#include "precomp.h"

Include dependency graph for propsheet.cpp:

Go to the source code of this file.

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (shell)
static HRESULT	SHELL_GetShellExtensionRegCLSID (HKEY hKey, LPCWSTR KeyName, CLSID &clsid)
static HRESULT	SHELL_InitializeExtension (REFCLSID clsid, PCIDLIST_ABSOLUTE pidlFolder, IDataObject *pDO, HKEY hkeyProgID, REFIID riid, void **ppv)
static HRESULT	AddPropSheetHandlerPages (REFCLSID clsid, IDataObject *pDO, HKEY hkeyProgID, PROPSHEETHEADERW &psh)
static HRESULT	SHELL_CreatePropSheetStubWindow (CStubWindow32 &stub, PCIDLIST_ABSOLUTE pidl, const POINT *pPt)
static INT_PTR	SHELL32_PropertySheet (LPPROPSHEETHEADERW ppsh, IDataObject *pDO)
static BOOL	SHELL32_OpenPropSheet (LPCWSTR pszCaption, HKEY *ahKeys, UINT cKeys, const CLSID *pclsidDefault, IDataObject *pDO, LPCWSTR pStartPage)
EXTERN_C BOOL WINAPI	SHOpenPropSheetW (_In_opt_ LPCWSTR pszCaption, _In_opt_ HKEY *ahKeys, _In_ UINT cKeys, _In_ const CLSID *pclsidDefault, _In_ IDataObject *pDataObject, _In_opt_ IShellBrowser *pShellBrowser, _In_opt_ LPCWSTR pszStartPage)
HPROPSHEETPAGE	SH_CreatePropertySheetPageEx (WORD wDialogId, DLGPROC pfnDlgProc, LPARAM lParam, LPCWSTR pwszTitle, LPFNPSPCALLBACK Callback)
HPROPSHEETPAGE	SH_CreatePropertySheetPage (WORD wDialogId, DLGPROC pfnDlgProc, LPARAM lParam, LPCWSTR pwszTitle)

Function Documentation

AddPropSheetHandlerPages()

static HRESULT AddPropSheetHandlerPages ( REFCLSID  clsid, IDataObject *  pDO, HKEY  hkeyProgID, PROPSHEETHEADERW &  psh  )

static

Definition at line 47 of file propsheet.cpp.

{
    CComPtr<IShellPropSheetExt> SheetExt;
    HRESULT hr = SHELL_InitializeExtension(clsid, NULL, pDO, hkeyProgID, IID_PPV_ARG(IShellPropSheetExt, &SheetExt));
    if (SUCCEEDED(hr))
    {
        UINT OldCount = psh.nPages;
        hr = SheetExt->AddPages(AddPropSheetPageCallback, (LPARAM)&psh);
        // The returned index is one-based (relative to this extension).
        // See https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-ishellpropsheetext-addpages
        if (hr > 0)
        {
            hr += OldCount;
            psh.nStartPage = hr - 1;
        }
    }
    return hr;
}

Referenced by SHELL32_OpenPropSheet().

SH_CreatePropertySheetPage()

HPROPSHEETPAGE SH_CreatePropertySheetPage	(	WORD	wDialogId,
		DLGPROC	pfnDlgProc,
		LPARAM	lParam,
		LPCWSTR	pwszTitle
	)

Definition at line 208 of file propsheet.cpp.

{
    return SH_CreatePropertySheetPageEx(wDialogId, pfnDlgProc, lParam, pwszTitle, NULL);
}

Referenced by CDrvDefExt::AddPages(), CFileDefExt::AddPages(), CFolderOptions::AddPages(), RecycleBin_AddPropSheetPages(), and ShowFolderOptionsDialogThreadProc().

SH_CreatePropertySheetPageEx()

HPROPSHEETPAGE SH_CreatePropertySheetPageEx	(	WORD	wDialogId,
		DLGPROC	pfnDlgProc,
		LPARAM	lParam,
		LPCWSTR	pwszTitle,
		LPFNPSPCALLBACK	Callback
	)

Definition at line 188 of file propsheet.cpp.

{
    PROPSHEETPAGEW Page = { sizeof(Page), PSP_DEFAULT, shell32_hInstance };
    Page.pszTemplate = MAKEINTRESOURCEW(wDialogId);
    Page.pfnDlgProc = pfnDlgProc;
    Page.lParam = lParam;
    Page.pszTitle = pwszTitle;
    Page.pfnCallback = Callback;
 
    if (pwszTitle)
        Page.dwFlags |= PSP_USETITLE;
 
    if (Callback)
        Page.dwFlags |= PSP_USECALLBACK;
 
    return CreatePropertySheetPageW(&Page);
}

Referenced by CShellLink::AddPages(), CDrvDefExt::AddPages(), CFileDefExt::AddPages(), CFolderOptions::AddPages(), and SH_CreatePropertySheetPage().

SHELL32_OpenPropSheet()

static BOOL SHELL32_OpenPropSheet ( LPCWSTR  pszCaption, HKEY *  ahKeys, UINT  cKeys, const CLSID *  pclsidDefault, IDataObject *  pDO, LPCWSTR  pStartPage  )

static

Definition at line 121 of file propsheet.cpp.

{
    HKEY hKeyProgID = cKeys ? ahKeys[cKeys - 1] : NULL; // Windows uses the last key for some reason
    HPROPSHEETPAGE hppages[MAX_PROPERTY_SHEET_PAGE];
    PROPSHEETHEADERW psh = { sizeof(psh), PSH_PROPTITLE };
    psh.phpage = hppages;
    psh.hInstance = shell32_hInstance;
    psh.pszCaption = pszCaption;
    psh.pStartPage = pStartPage;
 
    if (pclsidDefault)
        AddPropSheetHandlerPages(*pclsidDefault, pDO, hKeyProgID, psh);
 
    for (UINT i = 0; i < cKeys; ++i)
    {
        // Note: We can't use SHCreatePropSheetExtArrayEx because we need the AddPages() return value (see AddPropSheetHandlerPages).
        HKEY hKey;
        if (RegOpenKeyExW(ahKeys[i], L"shellex\\PropertySheetHandlers", 0, KEY_ENUMERATE_SUB_KEYS, &hKey))
            continue;
        for (UINT index = 0;; ++index)
        {
            WCHAR KeyName[MAX_PATH];
            LRESULT err = RegEnumKeyW(hKey, index, KeyName, _countof(KeyName));
            KeyName[_countof(KeyName)-1] = UNICODE_NULL;
            if (err == ERROR_MORE_DATA)
                continue;
            if (err)
                break;
            CLSID clsid;
            if (SUCCEEDED(SHELL_GetShellExtensionRegCLSID(hKey, KeyName, clsid)))
                AddPropSheetHandlerPages(clsid, pDO, hKeyProgID, psh);
        }
        RegCloseKey(hKey);
    }
 
    if (pStartPage == psh.pStartPage && pStartPage)
        psh.dwFlags |= PSH_USEPSTARTPAGE;
    INT_PTR Result = SHELL32_PropertySheet(&psh, pDO);
    return (Result != -1);
}

Referenced by SHOpenPropSheetW().

SHELL32_PropertySheet()

static INT_PTR SHELL32_PropertySheet ( LPPROPSHEETHEADERW  ppsh, IDataObject *  pDO  )

static

Definition at line 87 of file propsheet.cpp.

{
    CStubWindow32 stub;
    POINT pt, *ppt = NULL;
    if (pDO && SUCCEEDED(DataObject_GetOffset(pDO, &pt)))
        ppt = &pt;
    PIDLIST_ABSOLUTE pidl = SHELL_DataObject_ILCloneFullItem(pDO, 0);
    HRESULT hr = SHELL_CreatePropSheetStubWindow(stub, pidl, ppt);
    ILFree(pidl);
    if (FAILED(hr))
        return hr == HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS) ? 0 : -1;
 
    INT_PTR Result = -1;
    ppsh->hwndParent = stub;
    if (ppsh->nPages)
    {
        Result = PropertySheetW(ppsh);
    }
    else
    {
        WCHAR szFormat[128], szMessage[_countof(szFormat) + 42];
        LoadStringW(shell32_hInstance, IDS_CANTSHOWPROPERTIES, szFormat, _countof(szFormat));
        wsprintfW(szMessage, szFormat, ERROR_CAN_NOT_COMPLETE);
        MessageBoxW(NULL, szMessage, NULL, MB_ICONERROR);
    }
    stub.DestroyWindow();
    return Result;
}

Referenced by SHELL32_OpenPropSheet().

SHELL_CreatePropSheetStubWindow()

static HRESULT SHELL_CreatePropSheetStubWindow ( CStubWindow32 &  stub, PCIDLIST_ABSOLUTE  pidl, const POINT *  pPt  )

static

Definition at line 67 of file propsheet.cpp.

{
    PWSTR Path;
    if (!pidl || FAILED(SHGetNameFromIDList(pidl, SIGDN_DESKTOPABSOLUTEPARSING, &Path)))
        Path = NULL; // If we can't get a path, we simply will not be able to reuse this window
 
    HRESULT hr = stub.CreateStub(CStubWindow32::TYPE_PROPERTYSHEET, Path, pPt);
    SHFree(Path);
    UINT flags = SHGFI_ICON | SHGFI_ADDOVERLAYS;
    SHFILEINFO sfi;
    if (SUCCEEDED(hr) && SHGetFileInfoW((LPWSTR)pidl, 0, &sfi, sizeof(sfi), SHGFI_PIDL | flags))
        stub.SendMessage(WM_SETICON, ICON_BIG, (LPARAM)sfi.hIcon);
    return hr;
}

Referenced by SHELL32_PropertySheet().

SHELL_GetShellExtensionRegCLSID()

static HRESULT SHELL_GetShellExtensionRegCLSID ( HKEY  hKey, LPCWSTR  KeyName, CLSID &  clsid  )

static

Definition at line 13 of file propsheet.cpp.

{
    // First try the key name
    if (SUCCEEDED(SHCLSIDFromStringW(KeyName, &clsid)))
        return S_OK;
    WCHAR buf[42];
    DWORD cb = sizeof(buf);
    // and then the default value
    DWORD err = RegGetValueW(hKey, KeyName, NULL, RRF_RT_REG_SZ, NULL, buf, &cb);
    return !err ? SHCLSIDFromStringW(buf, &clsid) : HRESULT_FROM_WIN32(err);
}

Referenced by SHELL32_OpenPropSheet().

SHELL_InitializeExtension()

static HRESULT SHELL_InitializeExtension ( REFCLSID  clsid, PCIDLIST_ABSOLUTE  pidlFolder, IDataObject *  pDO, HKEY  hkeyProgID, REFIID  riid, void **  ppv  )

static

Definition at line 26 of file propsheet.cpp.

{
    *ppv = NULL;
    IUnknown *pUnk;
    HRESULT hr = SHCoCreateInstance(NULL, &clsid, NULL, riid, (void**)&pUnk);
    if (SUCCEEDED(hr))
    {
        CComPtr<IShellExtInit> Init;
        hr = pUnk->QueryInterface(IID_PPV_ARG(IShellExtInit, &Init));
        if (SUCCEEDED(hr))
            hr = Init->Initialize(pidlFolder, pDO, hkeyProgID);
 
        if (SUCCEEDED(hr))
            *ppv = (void*)pUnk;
        else
            pUnk->Release();
    }
    return hr;
}

Referenced by AddPropSheetHandlerPages().

SHOpenPropSheetW()

EXTERN_C BOOL WINAPI SHOpenPropSheetW	(	_In_opt_ LPCWSTR	pszCaption,
		_In_opt_ HKEY *	ahKeys,
		_In_ UINT	cKeys,
		_In_ const CLSID *	pclsidDefault,
		_In_ IDataObject *	pDataObject,
		_In_opt_ IShellBrowser *	pShellBrowser,
		_In_opt_ LPCWSTR	pszStartPage
	)

Definition at line 169 of file propsheet.cpp.

{
    UNREFERENCED_PARAMETER(pShellBrowser); /* MSDN says "Not used". */
    return SHELL32_OpenPropSheet(pszCaption, ahKeys, cKeys, pclsidDefault, pDataObject, pszStartPage);
}

Referenced by SHOpenPropSheetA(), and ShellPropSheetDialog::Show().

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

shell

)