2 * Win32 5.1 Theme system
4 * Copyright (C) 2003 Kevin Koltzau
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
34 #include "uxthemedll.h"
37 #include "wine/debug.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(uxtheme);
41 /***********************************************************************
42 * Defines and global variables
45 static const WCHAR szThemeManager[] = {
46 'S','o','f','t','w','a','r','e','\\',
47 'M','i','c','r','o','s','o','f','t','\\',
48 'W','i','n','d','o','w','s','\\',
49 'C','u','r','r','e','n','t','V','e','r','s','i','o','n','\\',
50 'T','h','e','m','e','M','a','n','a','g','e','r','\0'
52 static const WCHAR szThemeActive[] = {'T','h','e','m','e','A','c','t','i','v','e','\0'};
53 static const WCHAR szSizeName[] = {'S','i','z','e','N','a','m','e','\0'};
54 static const WCHAR szColorName[] = {'C','o','l','o','r','N','a','m','e','\0'};
55 static const WCHAR szDllName[] = {'D','l','l','N','a','m','e','\0'};
57 static const WCHAR szIniDocumentation[] = {'d','o','c','u','m','e','n','t','a','t','i','o','n','\0'};
61 DWORD dwThemeAppProperties = STAP_ALLOW_NONCLIENT | STAP_ALLOW_CONTROLS;
66 BOOL bThemeActive = FALSE;
67 WCHAR szCurrentTheme[MAX_PATH];
68 WCHAR szCurrentColor[64];
69 WCHAR szCurrentSize[64];
71 /***********************************************************************/
73 /***********************************************************************
76 * Set the current active theme from the registry
78 void UXTHEME_LoadTheme()
86 /* Get current theme configuration */
87 if(!RegOpenKeyW(HKEY_CURRENT_USER, szThemeManager, &hKey)) {
88 TRACE("Loading theme config\n");
89 buffsize = sizeof(tmp)/sizeof(tmp[0]);
90 if(!RegQueryValueExW(hKey, szThemeActive, NULL, NULL, (LPBYTE)tmp, &buffsize)) {
91 bThemeActive = (tmp[0] != '0');
95 TRACE("Failed to get ThemeActive: %ld\n", GetLastError());
97 buffsize = sizeof(szCurrentColor)/sizeof(szCurrentColor[0]);
98 if(RegQueryValueExW(hKey, szColorName, NULL, NULL, (LPBYTE)szCurrentColor, &buffsize))
99 szCurrentColor[0] = '\0';
100 buffsize = sizeof(szCurrentSize)/sizeof(szCurrentSize[0]);
101 if(RegQueryValueExW(hKey, szSizeName, NULL, NULL, (LPBYTE)szCurrentSize, &buffsize))
102 szCurrentSize[0] = '\0';
103 if(SHRegGetPathW(hKey, NULL, szDllName, szCurrentTheme, 0))
104 szCurrentTheme[0] = '\0';
108 TRACE("Failed to open theme registry key\n");
111 /* Make sure the theme requested is actually valid */
112 hr = MSSTYLES_OpenThemeFile(szCurrentTheme,
113 szCurrentColor[0]?szCurrentColor:NULL,
114 szCurrentSize[0]?szCurrentSize:NULL,
117 bThemeActive = FALSE;
118 szCurrentTheme[0] = '\0';
119 szCurrentColor[0] = '\0';
120 szCurrentSize[0] = '\0';
123 /* Make sure the global color & size match the theme */
124 lstrcpynW(szCurrentColor, pt->pszSelectedColor, sizeof(szCurrentColor)/sizeof(szCurrentColor[0]));
125 lstrcpynW(szCurrentSize, pt->pszSelectedSize, sizeof(szCurrentSize)/sizeof(szCurrentSize[0]));
127 MSSTYLES_SetActiveTheme(pt);
128 TRACE("Theme active: %s %s %s\n", debugstr_w(szCurrentTheme),
129 debugstr_w(szCurrentColor), debugstr_w(szCurrentSize));
130 MSSTYLES_CloseThemeFile(pt);
134 MSSTYLES_SetActiveTheme(NULL);
135 TRACE("Themeing not active\n");
139 /***********************************************************************
140 * UXTHEME_SetActiveTheme
142 * Change the current active theme
144 HRESULT UXTHEME_SetActiveTheme(PTHEME_FILE tf)
150 hr = MSSTYLES_SetActiveTheme(tf);
155 GetModuleFileNameW(tf->hTheme, szCurrentTheme, sizeof(szCurrentTheme)/sizeof(szCurrentTheme[0]));
156 lstrcpynW(szCurrentColor, tf->pszSelectedColor, sizeof(szCurrentColor)/sizeof(szCurrentColor[0]));
157 lstrcpynW(szCurrentSize, tf->pszSelectedSize, sizeof(szCurrentSize)/sizeof(szCurrentSize[0]));
160 bThemeActive = FALSE;
161 szCurrentTheme[0] = '\0';
162 szCurrentColor[0] = '\0';
163 szCurrentSize[0] = '\0';
164 return MSSTYLES_SetActiveTheme(NULL);
167 TRACE("Writing theme config to registry\n");
168 if(!RegCreateKeyW(HKEY_CURRENT_USER, szThemeManager, &hKey)) {
169 tmp[0] = bThemeActive?'1':'0';
171 RegSetValueExW(hKey, szThemeActive, 0, REG_SZ, (const BYTE*)tmp, sizeof(WCHAR)*2);
172 RegSetValueExW(hKey, szColorName, 0, REG_SZ, (const BYTE*)szCurrentColor, lstrlenW(szCurrentColor)+1);
173 RegSetValueExW(hKey, szSizeName, 0, REG_SZ, (const BYTE*)szCurrentSize, lstrlenW(szCurrentSize)+1);
174 RegSetValueExW(hKey, szDllName, 0, REG_SZ, (const BYTE*)szCurrentTheme, lstrlenW(szCurrentTheme)+1);
178 TRACE("Failed to open theme registry key\n");
182 /***********************************************************************
185 void UXTHEME_InitSystem(HINSTANCE hInst)
187 const WCHAR szWindowTheme[] = {
188 'u','x','_','t','h','e','m','e','\0'
190 const WCHAR szSubAppName[] = {
191 'u','x','_','s','u','b','a','p','p','\0'
193 const WCHAR szSubIdList[] = {
194 'u','x','_','s','u','b','i','d','l','s','t','\0'
199 atWindowTheme = GlobalAddAtomW(szWindowTheme);
200 atSubAppName = GlobalAddAtomW(szSubAppName);
201 atSubIdList = GlobalAddAtomW(szSubIdList);
206 /***********************************************************************
207 * IsAppThemed (UXTHEME.@)
209 BOOL WINAPI IsAppThemed(void)
211 return IsThemeActive();
214 /***********************************************************************
215 * IsThemeActive (UXTHEME.@)
217 BOOL WINAPI IsThemeActive(void)
223 /***********************************************************************
224 * EnableTheming (UXTHEME.@)
227 * This is a global and persistent change
229 HRESULT WINAPI EnableTheming(BOOL fEnable)
232 WCHAR szEnabled[] = {'0','\0'};
234 TRACE("(%d)\n", fEnable);
236 if(fEnable != bThemeActive) {
237 bThemeActive = fEnable;
238 if(bThemeActive) szEnabled[0] = '1';
239 if(!RegOpenKeyW(HKEY_CURRENT_USER, szThemeManager, &hKey)) {
240 RegSetValueExW(hKey, szThemeActive, 0, REG_SZ, (LPBYTE)szEnabled, sizeof(WCHAR));
243 PostMessageW(HWND_BROADCAST, WM_THEMECHANGED, 0, 0);
248 /***********************************************************************
249 * UXTHEME_SetWindowProperty
251 * I'm using atoms as there may be large numbers of duplicated strings
252 * and they do the work of keeping memory down as a cause of that quite nicely
254 HRESULT UXTHEME_SetWindowProperty(HWND hwnd, ATOM aProp, LPCWSTR pszValue)
256 ATOM oldValue = (ATOM)(size_t)RemovePropW(hwnd, MAKEINTATOMW(aProp));
258 DeleteAtom(oldValue);
260 ATOM atValue = AddAtomW(pszValue);
262 || !SetPropW(hwnd, MAKEINTATOMW(aProp), (LPWSTR)MAKEINTATOMW(atValue))) {
263 HRESULT hr = HRESULT_FROM_WIN32(GetLastError());
264 if(atValue) DeleteAtom(atValue);
271 LPWSTR UXTHEME_GetWindowProperty(HWND hwnd, ATOM aProp, LPWSTR pszBuffer, int dwLen)
273 ATOM atValue = (ATOM)(size_t)GetPropW(hwnd, MAKEINTATOMW(aProp));
275 if(GetAtomNameW(atValue, pszBuffer, dwLen))
277 TRACE("property defined, but unable to get value\n");
282 /***********************************************************************
283 * OpenThemeData (UXTHEME.@)
285 HTHEME WINAPI OpenThemeData(HWND hwnd, LPCWSTR pszClassList)
287 WCHAR szAppBuff[256];
288 WCHAR szClassBuff[256];
290 LPCWSTR pszUseClassList;
292 TRACE("(%p,%s)\n", hwnd, debugstr_w(pszClassList));
296 pszAppName = UXTHEME_GetWindowProperty(hwnd, atSubAppName, szAppBuff, sizeof(szAppBuff)/sizeof(szAppBuff[0]));
297 /* If SetWindowTheme was used on the window, that overrides the class list passed to this function */
298 pszUseClassList = UXTHEME_GetWindowProperty(hwnd, atSubIdList, szClassBuff, sizeof(szClassBuff)/sizeof(szClassBuff[0]));
300 pszUseClassList = pszClassList;
302 hTheme = MSSTYLES_OpenThemeClass(pszAppName, pszUseClassList);
304 SetPropW(hwnd, MAKEINTATOMW(atWindowTheme), hTheme);
308 /***********************************************************************
309 * GetWindowTheme (UXTHEME.@)
311 * Retrieve the last theme opened for a window
313 HTHEME WINAPI GetWindowTheme(HWND hwnd)
315 TRACE("(%p)\n", hwnd);
316 return GetPropW(hwnd, MAKEINTATOMW(atWindowTheme));
319 /***********************************************************************
320 * SetWindowTheme (UXTHEME.@)
322 * Persistent through the life of the window, even after themes change
324 HRESULT WINAPI SetWindowTheme(HWND hwnd, LPCWSTR pszSubAppName,
325 LPCWSTR pszSubIdList)
328 TRACE("(%p,%s,%s)\n", hwnd, debugstr_w(pszSubAppName),
329 debugstr_w(pszSubIdList));
330 hr = UXTHEME_SetWindowProperty(hwnd, atSubAppName, pszSubAppName);
332 hr = UXTHEME_SetWindowProperty(hwnd, atSubIdList, pszSubIdList);
334 PostMessageW(hwnd, WM_THEMECHANGED, 0, 0);
338 /***********************************************************************
339 * GetCurrentThemeName (UXTHEME.@)
341 HRESULT WINAPI GetCurrentThemeName(LPWSTR pszThemeFileName, int dwMaxNameChars,
342 LPWSTR pszColorBuff, int cchMaxColorChars,
343 LPWSTR pszSizeBuff, int cchMaxSizeChars)
346 return E_PROP_ID_UNSUPPORTED;
347 if(pszThemeFileName) lstrcpynW(pszThemeFileName, szCurrentTheme, dwMaxNameChars);
348 if(pszColorBuff) lstrcpynW(pszColorBuff, szCurrentColor, cchMaxColorChars);
349 if(pszSizeBuff) lstrcpynW(pszSizeBuff, szCurrentSize, cchMaxSizeChars);
353 /***********************************************************************
354 * GetThemeAppProperties (UXTHEME.@)
356 DWORD WINAPI GetThemeAppProperties(void)
358 return dwThemeAppProperties;
361 /***********************************************************************
362 * SetThemeAppProperties (UXTHEME.@)
364 void WINAPI SetThemeAppProperties(DWORD dwFlags)
366 TRACE("(0x%08lx)\n", dwFlags);
367 dwThemeAppProperties = dwFlags;
370 /***********************************************************************
371 * CloseThemeData (UXTHEME.@)
373 HRESULT WINAPI CloseThemeData(HTHEME hTheme)
375 TRACE("(%p)\n", hTheme);
378 return MSSTYLES_CloseThemeClass(hTheme);
381 /***********************************************************************
382 * HitTestThemeBackground (UXTHEME.@)
384 HRESULT WINAPI HitTestThemeBackground(HTHEME hTheme, HDC hdc, int iPartId,
385 int iStateId, DWORD dwOptions,
386 const RECT *pRect, HRGN hrgn,
387 POINT ptTest, WORD *pwHitTestCode)
389 FIXME("%d %d 0x%08lx: stub\n", iPartId, iStateId, dwOptions);
392 return ERROR_CALL_NOT_IMPLEMENTED;
395 /***********************************************************************
396 * IsThemePartDefined (UXTHEME.@)
398 BOOL WINAPI IsThemePartDefined(HTHEME hTheme, int iPartId, int iStateId)
400 TRACE("(%p,%d,%d)\n", hTheme, iPartId, iStateId);
401 if(MSSTYLES_FindPartState(hTheme, iPartId, iStateId, NULL))
406 /***********************************************************************
407 * GetThemeDocumentationProperty (UXTHEME.@)
409 * Try and retrieve the documentation property from string resources
410 * if that fails, get it from the [documentation] section of themes.ini
412 HRESULT WINAPI GetThemeDocumentationProperty(LPCWSTR pszThemeName,
413 LPCWSTR pszPropertyName,
417 const WORD wDocToRes[] = {
418 TMT_DISPLAYNAME,5000,
432 TRACE("(%s,%s,%p,%d)\n", debugstr_w(pszThemeName), debugstr_w(pszPropertyName),
433 pszValueBuff, cchMaxValChars);
435 hr = MSSTYLES_OpenThemeFile(pszThemeName, NULL, NULL, &pt);
436 if(FAILED(hr)) return hr;
438 /* Try to load from string resources */
439 hr = E_PROP_ID_UNSUPPORTED;
440 if(MSSTYLES_LookupProperty(pszPropertyName, NULL, &iDocId)) {
441 for(i=0; i<sizeof(wDocToRes)/sizeof(wDocToRes[0]); i+=2) {
442 if(wDocToRes[i] == iDocId) {
443 if(LoadStringW(pt->hTheme, wDocToRes[i+1], pszValueBuff, cchMaxValChars)) {
450 /* If loading from string resource failed, try getting it from the theme.ini */
452 PUXINI_FILE uf = MSSTYLES_GetThemeIni(pt);
453 if(UXINI_FindSection(uf, szIniDocumentation)) {
456 if(UXINI_FindValue(uf, pszPropertyName, &lpValue, &dwLen)) {
457 lstrcpynW(pszValueBuff, lpValue, min(dwLen+1,cchMaxValChars));
464 MSSTYLES_CloseThemeFile(pt);
468 /**********************************************************************
469 * Undocumented functions
472 /**********************************************************************
473 * QueryThemeServices (UXTHEME.1)
476 * some kind of status flag
478 DWORD WINAPI QueryThemeServices()
481 return 3; /* This is what is returned under XP in most cases */
485 /**********************************************************************
486 * OpenThemeFile (UXTHEME.2)
488 * Opens a theme file, which can be used to change the current theme, etc
491 * pszThemeFileName Path to a msstyles theme file
492 * pszColorName Color defined in the theme, eg. NormalColor
493 * pszSizeName Size defined in the theme, eg. NormalSize
494 * hThemeFile Handle to theme file
496 HRESULT WINAPI OpenThemeFile(LPCWSTR pszThemeFileName, LPCWSTR pszColorName,
497 LPCWSTR pszSizeName, HTHEMEFILE *hThemeFile,
500 TRACE("(%s,%s,%s,%p,%ld)\n", debugstr_w(pszThemeFileName),
501 debugstr_w(pszColorName), debugstr_w(pszSizeName),
502 hThemeFile, unknown);
503 return MSSTYLES_OpenThemeFile(pszThemeFileName, pszColorName, pszSizeName, (PTHEME_FILE*)hThemeFile);
506 /**********************************************************************
507 * CloseThemeFile (UXTHEME.3)
509 * Releases theme file handle returned by OpenThemeFile
512 * hThemeFile Handle to theme file
514 HRESULT WINAPI CloseThemeFile(HTHEMEFILE hThemeFile)
516 TRACE("(%p)\n", hThemeFile);
517 MSSTYLES_CloseThemeFile(hThemeFile);
521 /**********************************************************************
522 * ApplyTheme (UXTHEME.4)
524 * Set a theme file to be the currently active theme
527 * hThemeFile Handle to theme file
529 * hWnd Window requesting the theme change
532 * I'm not sure what the second parameter is (the datatype is likely wrong), other then this:
535 * the theme is applied with the screen redrawing really badly (flickers)
536 * char b[] = "\0"; where \0 can be one or more of any character, makes no difference
537 * the theme is applied smoothly (screen does not flicker)
538 * char *b = "\0" or NULL; where \0 can be zero or more of any character, makes no difference
539 * the function fails returning invalid parameter...very strange
541 HRESULT WINAPI ApplyTheme(HTHEMEFILE hThemeFile, char *unknown, HWND hWnd)
544 TRACE("(%p,%s,%p)\n", hThemeFile, unknown, hWnd);
545 hr = UXTHEME_SetActiveTheme(hThemeFile);
546 PostMessageW(HWND_BROADCAST, WM_THEMECHANGED, 0, 0);
550 /**********************************************************************
551 * GetThemeDefaults (UXTHEME.7)
553 * Get the default color & size for a theme
556 * pszThemeFileName Path to a msstyles theme file
557 * pszColorName Buffer to receive the default color name
558 * dwColorNameLen Length, in characters, of color name buffer
559 * pszSizeName Buffer to receive the default size name
560 * dwSizeNameLen Length, in characters, of size name buffer
562 HRESULT WINAPI GetThemeDefaults(LPCWSTR pszThemeFileName, LPWSTR pszColorName,
563 DWORD dwColorNameLen, LPWSTR pszSizeName,
568 TRACE("(%s,%p,%ld,%p,%ld)\n", debugstr_w(pszThemeFileName),
569 pszColorName, dwColorNameLen,
570 pszSizeName, dwSizeNameLen);
572 hr = MSSTYLES_OpenThemeFile(pszThemeFileName, NULL, NULL, &pt);
573 if(FAILED(hr)) return hr;
575 lstrcpynW(pszColorName, pt->pszSelectedColor, dwColorNameLen);
576 lstrcpynW(pszSizeName, pt->pszSelectedSize, dwSizeNameLen);
578 MSSTYLES_CloseThemeFile(pt);
582 /**********************************************************************
583 * EnumThemes (UXTHEME.8)
585 * Enumerate available themes, calls specified EnumThemeProc for each
586 * theme found. Passes lpData through to callback function.
589 * pszThemePath Path containing themes
590 * callback Called for each theme found in path
591 * lpData Passed through to callback
593 HRESULT WINAPI EnumThemes(LPCWSTR pszThemePath, EnumThemeProc callback,
596 FIXME("%s: stub\n", debugstr_w(pszThemePath));
597 return ERROR_CALL_NOT_IMPLEMENTED;
601 /**********************************************************************
602 * EnumThemeColors (UXTHEME.9)
604 * Enumerate theme colors available with a particular size
607 * pszThemeFileName Path to a msstyles theme file
608 * pszSizeName Theme size to enumerate available colors
609 * If NULL the default theme size is used
610 * dwColorNum Color index to retrieve, increment from 0
611 * pszColorName Output color name
615 * E_PROP_ID_UNSUPPORTED when dwColorName does not refer to a color
616 * or when pszSizeName does not refer to a valid size
619 * XP fails with E_POINTER when pszColorName points to a buffer smaller then 605
622 * Not very efficient that I'm opening & validating the theme every call, but
623 * this is undocumented and almost never called..
624 * (and this is how windows works too)
626 HRESULT WINAPI EnumThemeColors(LPWSTR pszThemeFileName, LPWSTR pszSizeName,
627 DWORD dwColorNum, LPWSTR pszColorName)
632 TRACE("(%s,%s,%ld)\n", debugstr_w(pszThemeFileName),
633 debugstr_w(pszSizeName), dwColorNum);
635 hr = MSSTYLES_OpenThemeFile(pszThemeFileName, NULL, pszSizeName, &pt);
636 if(FAILED(hr)) return hr;
638 tmp = pt->pszAvailColors;
639 while(dwColorNum && *tmp) {
641 tmp += lstrlenW(tmp)+1;
643 if(!dwColorNum && *tmp) {
644 TRACE("%s\n", debugstr_w(tmp));
645 lstrcpyW(pszColorName, tmp);
648 hr = E_PROP_ID_UNSUPPORTED;
650 MSSTYLES_CloseThemeFile(pt);
654 /**********************************************************************
655 * EnumThemeSizes (UXTHEME.10)
657 * Enumerate theme colors available with a particular size
660 * pszThemeFileName Path to a msstyles theme file
661 * pszColorName Theme color to enumerate available sizes
662 * If NULL the default theme color is used
663 * dwSizeNum Size index to retrieve, increment from 0
664 * pszSizeName Output size name
668 * E_PROP_ID_UNSUPPORTED when dwSizeName does not refer to a size
669 * or when pszColorName does not refer to a valid color
672 * XP fails with E_POINTER when pszSizeName points to a buffer smaller then 605
675 * Not very efficient that I'm opening & validating the theme every call, but
676 * this is undocumented and almost never called..
677 * (and this is how windows works too)
679 HRESULT WINAPI EnumThemeSizes(LPWSTR pszThemeFileName, LPWSTR pszColorName,
680 DWORD dwSizeNum, LPWSTR pszSizeName)
685 TRACE("(%s,%s,%ld)\n", debugstr_w(pszThemeFileName),
686 debugstr_w(pszColorName), dwSizeNum);
688 hr = MSSTYLES_OpenThemeFile(pszThemeFileName, pszColorName, NULL, &pt);
689 if(FAILED(hr)) return hr;
691 tmp = pt->pszAvailSizes;
692 while(dwSizeNum && *tmp) {
694 tmp += lstrlenW(tmp)+1;
696 if(!dwSizeNum && *tmp) {
697 TRACE("%s\n", debugstr_w(tmp));
698 lstrcpyW(pszSizeName, tmp);
701 hr = E_PROP_ID_UNSUPPORTED;
703 MSSTYLES_CloseThemeFile(pt);
707 /**********************************************************************
708 * ParseThemeIniFile (UXTHEME.11)
710 * Enumerate data in a theme INI file.
713 * pszIniFileName Path to a theme ini file
714 * pszUnknown Cannot be NULL, L"" is valid
715 * callback Called for each found entry
716 * lpData Passed through to callback
720 * 0x800706488 (Unknown property) when enumeration is canceled from callback
723 * When pszUnknown is NULL the callback is never called, the value does not seem to surve
726 HRESULT WINAPI ParseThemeIniFile(LPCWSTR pszIniFileName, LPWSTR pszUnknown,
727 ParseThemeIniFileProc callback, LPVOID lpData)
729 FIXME("%s %s: stub\n", debugstr_w(pszIniFileName), debugstr_w(pszUnknown));
730 return ERROR_CALL_NOT_IMPLEMENTED;