2 * Help Viewer Implementation
4 * Copyright 2005 James Hawkins
5 * Copyright 2007 Jacek Caban for CodeWeavers
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
28 #include "wine/debug.h"
32 WINE_DEFAULT_DEBUG_CHANNEL(htmlhelp);
34 static LRESULT Help_OnSize(HWND hWnd);
36 /* Window type defaults */
38 #define WINTYPE_DEFAULT_X 280
39 #define WINTYPE_DEFAULT_Y 100
40 #define WINTYPE_DEFAULT_WIDTH 740
41 #define WINTYPE_DEFAULT_HEIGHT 640
42 #define WINTYPE_DEFAULT_NAVWIDTH 250
44 #define TAB_TOP_PADDING 8
45 #define TAB_RIGHT_PADDING 4
48 static const WCHAR szEmpty[] = {0};
50 /* Loads a string from the resource file */
51 static LPWSTR HH_LoadString(DWORD dwID)
54 LPCWSTR stringresource;
57 iSize = LoadStringW(hhctrl_hinstance, dwID, (LPWSTR)&stringresource, 0);
59 string = heap_alloc((iSize + 2) * sizeof(WCHAR)); /* some strings (tab text) needs double-null termination */
60 memcpy(string, stringresource, iSize*sizeof(WCHAR));
66 static HRESULT navigate_url(HHInfo *info, LPCWSTR surl)
71 TRACE("%s\n", debugstr_w(surl));
74 V_BSTR(&url) = SysAllocString(surl);
76 hres = IWebBrowser2_Navigate2(info->web_browser, &url, 0, 0, 0, 0);
81 TRACE("Navigation failed: %08x\n", hres);
86 BOOL NavigateToUrl(HHInfo *info, LPCWSTR surl)
92 static const WCHAR url_indicator[] = {':', '/', '/', 0};
94 TRACE("%s\n", debugstr_w(surl));
96 if (strstrW(surl, url_indicator)) {
97 hres = navigate_url(info, surl);
100 } /* look up in chm if it doesn't look like a full url */
102 SetChmPath(&chm_path, info->pCHMInfo->szFile, surl);
103 ret = NavigateToChm(info, chm_path.chm_file, chm_path.chm_index);
105 heap_free(chm_path.chm_file);
106 heap_free(chm_path.chm_index);
111 BOOL NavigateToChm(HHInfo *info, LPCWSTR file, LPCWSTR index)
113 WCHAR buf[INTERNET_MAX_URL_LENGTH];
114 WCHAR full_path[MAX_PATH];
117 static const WCHAR url_format[] =
118 {'m','k',':','@','M','S','I','T','S','t','o','r','e',':','%','s',':',':','%','s','%','s',0};
119 static const WCHAR slash[] = {'/',0};
120 static const WCHAR empty[] = {0};
122 TRACE("%p %s %s\n", info, debugstr_w(file), debugstr_w(index));
124 if (!info->web_browser)
127 if(!GetFullPathNameW(file, sizeof(full_path)/sizeof(full_path[0]), full_path, NULL)) {
128 WARN("GetFullPathName failed: %u\n", GetLastError());
132 wsprintfW(buf, url_format, full_path, (!index || index[0] == '/') ? empty : slash, index);
135 if((ptr = strchrW(buf, '#')))
138 return SUCCEEDED(navigate_url(info, buf));
143 #define SIZEBAR_WIDTH 4
145 static const WCHAR szSizeBarClass[] = {
146 'H','H',' ','S','i','z','e','B','a','r',0
149 /* Draw the SizeBar */
150 static void SB_OnPaint(HWND hWnd)
156 hdc = BeginPaint(hWnd, &ps);
158 GetClientRect(hWnd, &rc);
163 FrameRect(hdc, &rc, GetStockObject(GRAY_BRUSH));
165 /* white highlight */
166 SelectObject(hdc, GetStockObject(WHITE_PEN));
167 MoveToEx(hdc, rc.right, 1, NULL);
169 LineTo(hdc, 1, rc.bottom - 1);
172 MoveToEx(hdc, 0, rc.bottom, NULL);
173 LineTo(hdc, rc.right, rc.bottom);
178 static void SB_OnLButtonDown(HWND hWnd, WPARAM wParam, LPARAM lParam)
183 static void SB_OnLButtonUp(HWND hWnd, WPARAM wParam, LPARAM lParam)
185 HHInfo *pHHInfo = (HHInfo *)GetWindowLongPtrW(hWnd, GWLP_USERDATA);
188 pt.x = (short)LOWORD(lParam);
189 pt.y = (short)HIWORD(lParam);
191 /* update the window sizes */
192 pHHInfo->WinType.iNavWidth += pt.x;
198 static void SB_OnMouseMove(HWND hWnd, WPARAM wParam, LPARAM lParam)
200 /* ignore WM_MOUSEMOVE if not dragging the SizeBar */
201 if (!(wParam & MK_LBUTTON))
205 static LRESULT CALLBACK SizeBar_WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
210 SB_OnLButtonDown(hWnd, wParam, lParam);
213 SB_OnLButtonUp(hWnd, wParam, lParam);
216 SB_OnMouseMove(hWnd, wParam, lParam);
222 return DefWindowProcW(hWnd, message, wParam, lParam);
228 static void HH_RegisterSizeBarClass(HHInfo *pHHInfo)
232 wcex.cbSize = sizeof(WNDCLASSEXW);
234 wcex.lpfnWndProc = SizeBar_WndProc;
237 wcex.hInstance = hhctrl_hinstance;
238 wcex.hIcon = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
239 wcex.hCursor = LoadCursorW(NULL, (LPCWSTR)IDC_SIZEWE);
240 wcex.hbrBackground = (HBRUSH)(COLOR_MENU + 1);
241 wcex.lpszMenuName = NULL;
242 wcex.lpszClassName = szSizeBarClass;
243 wcex.hIconSm = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
245 RegisterClassExW(&wcex);
248 static void SB_GetSizeBarRect(HHInfo *info, RECT *rc)
250 RECT rectWND, rectTB, rectNP;
252 GetClientRect(info->WinType.hwndHelp, &rectWND);
253 GetClientRect(info->WinType.hwndToolBar, &rectTB);
254 GetClientRect(info->WinType.hwndNavigation, &rectNP);
256 rc->left = rectNP.right;
257 rc->top = rectTB.bottom;
258 rc->bottom = rectWND.bottom - rectTB.bottom;
259 rc->right = SIZEBAR_WIDTH;
262 static BOOL HH_AddSizeBar(HHInfo *pHHInfo)
265 HWND hwndParent = pHHInfo->WinType.hwndHelp;
266 DWORD dwStyles = WS_CHILDWINDOW | WS_VISIBLE | WS_OVERLAPPED;
267 DWORD dwExStyles = WS_EX_LEFT | WS_EX_LTRREADING | WS_EX_RIGHTSCROLLBAR;
270 SB_GetSizeBarRect(pHHInfo, &rc);
272 hWnd = CreateWindowExW(dwExStyles, szSizeBarClass, szEmpty, dwStyles,
273 rc.left, rc.top, rc.right, rc.bottom,
274 hwndParent, NULL, hhctrl_hinstance, NULL);
278 /* store the pointer to the HH info struct */
279 SetWindowLongPtrW(hWnd, GWLP_USERDATA, (LONG_PTR)pHHInfo);
281 pHHInfo->hwndSizeBar = hWnd;
287 static const WCHAR szChildClass[] = {
288 'H','H',' ','C','h','i','l','d',0
291 static LRESULT Child_OnPaint(HWND hWnd)
297 hdc = BeginPaint(hWnd, &ps);
299 /* Only paint the Navigation pane, identified by the fact
300 * that it has a child window
302 if (GetWindow(hWnd, GW_CHILD))
304 GetClientRect(hWnd, &rc);
306 /* set the border color */
307 SelectObject(hdc, GetStockObject(DC_PEN));
308 SetDCPenColor(hdc, GetSysColor(COLOR_BTNSHADOW));
310 /* Draw the top border */
311 LineTo(hdc, rc.right, 0);
313 SelectObject(hdc, GetStockObject(WHITE_PEN));
314 MoveToEx(hdc, 0, 1, NULL);
315 LineTo(hdc, rc.right, 1);
323 static void ResizeTabChild(HHInfo *info, int tab)
325 HWND hwnd = info->tabs[tab].hwnd;
330 GetClientRect(info->WinType.hwndNavigation, &rect);
331 SendMessageW(info->hwndTabCtrl, TCM_GETITEMRECT, 0, (LPARAM)&tabrc);
332 cnt = SendMessageW(info->hwndTabCtrl, TCM_GETROWCOUNT, 0, 0);
334 rect.left = TAB_MARGIN;
335 rect.top = TAB_TOP_PADDING + cnt*(tabrc.bottom-tabrc.top) + TAB_MARGIN;
336 rect.right -= TAB_RIGHT_PADDING + TAB_MARGIN;
337 rect.bottom -= TAB_MARGIN;
338 width = rect.right-rect.left;
339 height = rect.bottom-rect.top;
341 SetWindowPos(hwnd, NULL, rect.left, rect.top, width, height,
342 SWP_NOZORDER | SWP_NOACTIVATE);
344 /* Resize the tab widget column to perfectly fit the tab window and
345 * leave sufficient space for the scroll widget.
350 int scroll_width = GetSystemMetrics(SM_CXVSCROLL);
351 int border_width = GetSystemMetrics(SM_CXBORDER);
352 int edge_width = GetSystemMetrics(SM_CXEDGE);
354 SendMessageW(info->tabs[TAB_INDEX].hwnd, LVM_SETCOLUMNWIDTH, 0,
355 width-scroll_width-2*border_width-2*edge_width);
362 static LRESULT Child_OnSize(HWND hwnd)
364 HHInfo *info = (HHInfo*)GetWindowLongPtrW(hwnd, GWLP_USERDATA);
367 if(!info || hwnd != info->WinType.hwndNavigation)
370 GetClientRect(hwnd, &rect);
371 SetWindowPos(info->hwndTabCtrl, HWND_TOP, 0, 0,
372 rect.right - TAB_RIGHT_PADDING,
373 rect.bottom - TAB_TOP_PADDING, SWP_NOMOVE);
375 ResizeTabChild(info, TAB_CONTENTS);
376 ResizeTabChild(info, TAB_INDEX);
380 static LRESULT OnTabChange(HWND hwnd)
382 HHInfo *info = (HHInfo*)GetWindowLongPtrW(hwnd, GWLP_USERDATA);
389 if(info->tabs[info->current_tab].hwnd)
390 ShowWindow(info->tabs[info->current_tab].hwnd, SW_HIDE);
392 info->current_tab = SendMessageW(info->hwndTabCtrl, TCM_GETCURSEL, 0, 0);
394 if(info->tabs[info->current_tab].hwnd)
395 ShowWindow(info->tabs[info->current_tab].hwnd, SW_SHOW);
400 static LRESULT OnTopicChange(HHInfo *info, void *user_data)
402 LPCWSTR chmfile = NULL, name = NULL, local = NULL;
406 if(!user_data || !info)
409 switch (info->current_tab)
412 citer = (ContentItem *) user_data;
414 local = citer->local;
416 if(citer->merge.chm_file) {
417 chmfile = citer->merge.chm_file;
420 citer = citer->parent;
424 iiter = (IndexItem *) user_data;
425 if(iiter->nItems == 0) {
426 FIXME("No entries for this item!\n");
429 if(iiter->nItems > 1) {
433 SendMessageW(info->popup.hwndList, LVM_DELETEALLITEMS, 0, 0);
434 for(i=0;i<iiter->nItems;i++) {
435 IndexSubItem *item = &iiter->items[i];
436 WCHAR *name = iiter->keyword;
440 memset(&lvi, 0, sizeof(lvi));
442 lvi.mask = LVIF_TEXT|LVIF_PARAM;
443 lvi.cchTextMax = strlenW(name)+1;
445 lvi.lParam = (LPARAM) item;
446 SendMessageW(info->popup.hwndList, LVM_INSERTITEMW, 0, (LPARAM)&lvi);
448 ShowWindow(info->popup.hwndPopup, SW_SHOW);
451 name = iiter->items[0].name;
452 local = iiter->items[0].local;
453 chmfile = iiter->merge.chm_file;
456 FIXME("Unhandled operation for this tab!\n");
462 FIXME("No help file found for this item!\n");
466 TRACE("name %s loal %s\n", debugstr_w(name), debugstr_w(local));
468 NavigateToChm(info, chmfile, local);
472 static LRESULT CALLBACK Child_WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
477 return Child_OnPaint(hWnd);
479 return Child_OnSize(hWnd);
481 HHInfo *info = (HHInfo*)GetWindowLongPtrW(hWnd, GWLP_USERDATA);
482 NMHDR *nmhdr = (NMHDR*)lParam;
484 switch(nmhdr->code) {
486 return OnTabChange(hWnd);
487 case TVN_SELCHANGEDW:
488 return OnTopicChange(info, (void*)((NMTREEVIEWW *)lParam)->itemNew.lParam);
490 if(info && info->current_tab == TAB_INDEX)
491 return OnTopicChange(info, (void*)((NMITEMACTIVATE *)lParam)->lParam);
493 if(info && info->current_tab == TAB_INDEX)
495 HWND hwndList = info->tabs[TAB_INDEX].hwnd;
498 lvItem.iItem = (int) SendMessageW(hwndList, LVM_GETSELECTIONMARK, 0, 0);
499 lvItem.mask = TVIF_PARAM;
500 ListView_GetItemW(hwndList, &lvItem);
501 OnTopicChange(info, (void*) lvItem.lParam);
508 return DefWindowProcW(hWnd, message, wParam, lParam);
514 static void HH_RegisterChildWndClass(HHInfo *pHHInfo)
518 wcex.cbSize = sizeof(WNDCLASSEXW);
520 wcex.lpfnWndProc = Child_WndProc;
523 wcex.hInstance = hhctrl_hinstance;
524 wcex.hIcon = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
525 wcex.hCursor = LoadCursorW(NULL, (LPCWSTR)IDC_ARROW);
526 wcex.hbrBackground = (HBRUSH)(COLOR_BTNFACE + 1);
527 wcex.lpszMenuName = NULL;
528 wcex.lpszClassName = szChildClass;
529 wcex.hIconSm = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
531 RegisterClassExW(&wcex);
538 static void TB_OnClick(HWND hWnd, DWORD dwID)
540 HHInfo *info = (HHInfo *)GetWindowLongPtrW(hWnd, GWLP_USERDATA);
545 DoPageAction(info, WB_STOP);
548 DoPageAction(info, WB_REFRESH);
551 DoPageAction(info, WB_GOBACK);
554 NavigateToChm(info, info->pCHMInfo->szFile, info->WinType.pszHome);
557 DoPageAction(info, WB_GOFORWARD);
564 case IDTB_BROWSE_FWD:
565 case IDTB_BROWSE_BACK:
576 static void TB_AddButton(TBBUTTON *pButtons, DWORD dwIndex, DWORD dwID)
578 /* FIXME: Load the correct button bitmaps */
579 pButtons[dwIndex].iBitmap = STD_PRINT;
580 pButtons[dwIndex].idCommand = dwID;
581 pButtons[dwIndex].fsState = TBSTATE_ENABLED;
582 pButtons[dwIndex].fsStyle = BTNS_BUTTON;
583 pButtons[dwIndex].dwData = 0;
584 pButtons[dwIndex].iString = 0;
587 static void TB_AddButtonsFromFlags(TBBUTTON *pButtons, DWORD dwButtonFlags, LPDWORD pdwNumButtons)
591 if (dwButtonFlags & HHWIN_BUTTON_EXPAND)
592 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_EXPAND);
594 if (dwButtonFlags & HHWIN_BUTTON_BACK)
595 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_BACK);
597 if (dwButtonFlags & HHWIN_BUTTON_FORWARD)
598 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_FORWARD);
600 if (dwButtonFlags & HHWIN_BUTTON_STOP)
601 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_STOP);
603 if (dwButtonFlags & HHWIN_BUTTON_REFRESH)
604 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_REFRESH);
606 if (dwButtonFlags & HHWIN_BUTTON_HOME)
607 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_HOME);
609 if (dwButtonFlags & HHWIN_BUTTON_SYNC)
610 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_SYNC);
612 if (dwButtonFlags & HHWIN_BUTTON_OPTIONS)
613 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_OPTIONS);
615 if (dwButtonFlags & HHWIN_BUTTON_PRINT)
616 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_PRINT);
618 if (dwButtonFlags & HHWIN_BUTTON_JUMP1)
619 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_JUMP1);
621 if (dwButtonFlags & HHWIN_BUTTON_JUMP2)
622 TB_AddButton(pButtons,(*pdwNumButtons)++, IDTB_JUMP2);
624 if (dwButtonFlags & HHWIN_BUTTON_ZOOM)
625 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_ZOOM);
627 if (dwButtonFlags & HHWIN_BUTTON_TOC_NEXT)
628 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_TOC_NEXT);
630 if (dwButtonFlags & HHWIN_BUTTON_TOC_PREV)
631 TB_AddButton(pButtons, (*pdwNumButtons)++, IDTB_TOC_PREV);
634 static BOOL HH_AddToolbar(HHInfo *pHHInfo)
637 HWND hwndParent = pHHInfo->WinType.hwndHelp;
639 TBBUTTON buttons[IDTB_TOC_PREV - IDTB_EXPAND];
641 DWORD dwStyles, dwExStyles;
642 DWORD dwNumButtons, dwIndex;
644 if (pHHInfo->WinType.fsWinProperties & HHWIN_PARAM_TB_FLAGS)
645 toolbarFlags = pHHInfo->WinType.fsToolBarFlags;
647 toolbarFlags = HHWIN_DEF_BUTTONS;
649 TB_AddButtonsFromFlags(buttons, toolbarFlags, &dwNumButtons);
651 dwStyles = WS_CHILDWINDOW | WS_VISIBLE | TBSTYLE_FLAT |
652 TBSTYLE_WRAPABLE | TBSTYLE_TOOLTIPS | CCS_NODIVIDER;
653 dwExStyles = WS_EX_LEFT | WS_EX_LTRREADING | WS_EX_RIGHTSCROLLBAR;
655 hToolbar = CreateWindowExW(dwExStyles, TOOLBARCLASSNAMEW, NULL, dwStyles,
656 0, 0, 0, 0, hwndParent, NULL,
657 hhctrl_hinstance, NULL);
661 SendMessageW(hToolbar, TB_SETBITMAPSIZE, 0, MAKELONG(ICON_SIZE, ICON_SIZE));
662 SendMessageW(hToolbar, TB_BUTTONSTRUCTSIZE, sizeof(TBBUTTON), 0);
663 SendMessageW(hToolbar, WM_SETFONT, (WPARAM)pHHInfo->hFont, TRUE);
665 /* FIXME: Load correct icons for all buttons */
666 tbAB.hInst = HINST_COMMCTRL;
667 tbAB.nID = IDB_STD_LARGE_COLOR;
668 SendMessageW(hToolbar, TB_ADDBITMAP, 0, (LPARAM)&tbAB);
670 for (dwIndex = 0; dwIndex < dwNumButtons; dwIndex++)
672 LPWSTR szBuf = HH_LoadString(buttons[dwIndex].idCommand);
673 DWORD dwLen = strlenW(szBuf);
674 szBuf[dwLen + 1] = 0; /* Double-null terminate */
676 buttons[dwIndex].iString = (DWORD)SendMessageW(hToolbar, TB_ADDSTRINGW, 0, (LPARAM)szBuf);
680 SendMessageW(hToolbar, TB_ADDBUTTONSW, dwNumButtons, (LPARAM)buttons);
681 SendMessageW(hToolbar, TB_AUTOSIZE, 0, 0);
682 ShowWindow(hToolbar, SW_SHOW);
684 pHHInfo->WinType.hwndToolBar = hToolbar;
688 /* Navigation Pane */
690 static void NP_GetNavigationRect(HHInfo *pHHInfo, RECT *rc)
692 HWND hwndParent = pHHInfo->WinType.hwndHelp;
693 HWND hwndToolbar = pHHInfo->WinType.hwndToolBar;
694 RECT rectWND, rectTB;
696 GetClientRect(hwndParent, &rectWND);
697 GetClientRect(hwndToolbar, &rectTB);
700 rc->top = rectTB.bottom;
701 rc->bottom = rectWND.bottom - rectTB.bottom;
703 if (!(pHHInfo->WinType.fsValidMembers & HHWIN_PARAM_NAV_WIDTH) &&
704 pHHInfo->WinType.iNavWidth == 0)
706 pHHInfo->WinType.iNavWidth = WINTYPE_DEFAULT_NAVWIDTH;
709 rc->right = pHHInfo->WinType.iNavWidth;
712 static DWORD NP_CreateTab(HINSTANCE hInstance, HWND hwndTabCtrl, DWORD index)
715 LPWSTR tabText = HH_LoadString(index);
718 tie.mask = TCIF_TEXT;
719 tie.pszText = tabText;
721 ret = SendMessageW( hwndTabCtrl, TCM_INSERTITEMW, index, (LPARAM)&tie );
727 static BOOL HH_AddNavigationPane(HHInfo *info)
729 HWND hWnd, hwndTabCtrl;
730 HWND hwndParent = info->WinType.hwndHelp;
731 DWORD dwStyles = WS_CHILDWINDOW | WS_VISIBLE;
732 DWORD dwExStyles = WS_EX_LEFT | WS_EX_LTRREADING | WS_EX_RIGHTSCROLLBAR;
735 NP_GetNavigationRect(info, &rc);
737 hWnd = CreateWindowExW(dwExStyles, szChildClass, szEmpty, dwStyles,
738 rc.left, rc.top, rc.right, rc.bottom,
739 hwndParent, NULL, hhctrl_hinstance, NULL);
743 SetWindowLongPtrW(hWnd, GWLP_USERDATA, (LONG_PTR)info);
745 hwndTabCtrl = CreateWindowExW(dwExStyles, WC_TABCONTROLW, szEmpty, dwStyles,
747 rc.right - TAB_RIGHT_PADDING,
748 rc.bottom - TAB_TOP_PADDING,
749 hWnd, NULL, hhctrl_hinstance, NULL);
753 if (*info->WinType.pszToc)
754 info->tabs[TAB_CONTENTS].id = NP_CreateTab(hhctrl_hinstance, hwndTabCtrl, IDS_CONTENTS);
756 if (*info->WinType.pszIndex)
757 info->tabs[TAB_INDEX].id = NP_CreateTab(hhctrl_hinstance, hwndTabCtrl, IDS_INDEX);
759 if (info->WinType.fsWinProperties & HHWIN_PROP_TAB_SEARCH)
760 info->tabs[TAB_SEARCH].id = NP_CreateTab(hhctrl_hinstance, hwndTabCtrl, IDS_SEARCH);
762 if (info->WinType.fsWinProperties & HHWIN_PROP_TAB_FAVORITES)
763 info->tabs[TAB_FAVORITES].id = NP_CreateTab(hhctrl_hinstance, hwndTabCtrl, IDS_FAVORITES);
765 SendMessageW(hwndTabCtrl, WM_SETFONT, (WPARAM)info->hFont, TRUE);
767 info->hwndTabCtrl = hwndTabCtrl;
768 info->WinType.hwndNavigation = hWnd;
774 static void HP_GetHTMLRect(HHInfo *info, RECT *rc)
776 RECT rectTB, rectWND, rectNP, rectSB;
778 GetClientRect(info->WinType.hwndHelp, &rectWND);
779 GetClientRect(info->WinType.hwndToolBar, &rectTB);
780 GetClientRect(info->WinType.hwndNavigation, &rectNP);
781 GetClientRect(info->hwndSizeBar, &rectSB);
783 rc->left = rectNP.right + rectSB.right;
784 rc->top = rectTB.bottom;
785 rc->right = rectWND.right - rc->left;
786 rc->bottom = rectWND.bottom - rectTB.bottom;
789 static BOOL HH_AddHTMLPane(HHInfo *pHHInfo)
792 HWND hwndParent = pHHInfo->WinType.hwndHelp;
793 DWORD dwStyles = WS_CHILDWINDOW | WS_VISIBLE | WS_CLIPCHILDREN;
794 DWORD dwExStyles = WS_EX_LEFT | WS_EX_LTRREADING | WS_EX_RIGHTSCROLLBAR | WS_EX_CLIENTEDGE;
797 HP_GetHTMLRect(pHHInfo, &rc);
799 hWnd = CreateWindowExW(dwExStyles, szChildClass, szEmpty, dwStyles,
800 rc.left, rc.top, rc.right, rc.bottom,
801 hwndParent, NULL, hhctrl_hinstance, NULL);
805 if (!InitWebBrowser(pHHInfo, hWnd))
808 /* store the pointer to the HH info struct */
809 SetWindowLongPtrW(hWnd, GWLP_USERDATA, (LONG_PTR)pHHInfo);
811 ShowWindow(hWnd, SW_SHOW);
814 pHHInfo->WinType.hwndHTML = hWnd;
818 static BOOL AddContentTab(HHInfo *info)
820 if(info->tabs[TAB_CONTENTS].id == -1)
821 return TRUE; /* No "Contents" tab */
822 info->tabs[TAB_CONTENTS].hwnd = CreateWindowExW(WS_EX_CLIENTEDGE, WC_TREEVIEWW,
823 szEmpty, WS_CHILD | WS_BORDER | 0x25, 50, 50, 100, 100,
824 info->WinType.hwndNavigation, NULL, hhctrl_hinstance, NULL);
825 if(!info->tabs[TAB_CONTENTS].hwnd) {
826 ERR("Could not create treeview control\n");
830 ResizeTabChild(info, TAB_CONTENTS);
831 ShowWindow(info->tabs[TAB_CONTENTS].hwnd, SW_SHOW);
836 static BOOL AddIndexTab(HHInfo *info)
838 char hidden_column[] = "Column";
841 if(info->tabs[TAB_INDEX].id == -1)
842 return TRUE; /* No "Index" tab */
843 info->tabs[TAB_INDEX].hwnd = CreateWindowExW(WS_EX_CLIENTEDGE, WC_LISTVIEWW,
844 szEmpty, WS_CHILD | WS_BORDER | LVS_SINGLESEL | LVS_REPORT | LVS_NOCOLUMNHEADER, 50, 50, 100, 100,
845 info->WinType.hwndNavigation, NULL, hhctrl_hinstance, NULL);
846 if(!info->tabs[TAB_INDEX].hwnd) {
847 ERR("Could not create ListView control\n");
850 memset(&lvc, 0, sizeof(lvc));
851 lvc.mask = LVCF_TEXT;
852 lvc.pszText = hidden_column;
853 if(SendMessageW(info->tabs[TAB_INDEX].hwnd, LVM_INSERTCOLUMNA, 0, (LPARAM) &lvc) == -1)
855 ERR("Could not create ListView column\n");
859 ResizeTabChild(info, TAB_INDEX);
860 ShowWindow(info->tabs[TAB_INDEX].hwnd, SW_HIDE);
865 /* The Index tab's sub-topic popup */
867 static void ResizePopupChild(HHInfo *info)
869 int scroll_width = GetSystemMetrics(SM_CXVSCROLL);
870 int border_width = GetSystemMetrics(SM_CXBORDER);
871 int edge_width = GetSystemMetrics(SM_CXEDGE);
878 GetClientRect(info->popup.hwndPopup, &rect);
879 SetWindowPos(info->popup.hwndCallback, HWND_TOP, 0, 0,
880 rect.right, rect.bottom, SWP_NOMOVE);
882 rect.left = TAB_MARGIN;
883 rect.top = TAB_TOP_PADDING + TAB_MARGIN;
884 rect.right -= TAB_RIGHT_PADDING + TAB_MARGIN;
885 rect.bottom -= TAB_MARGIN;
886 width = rect.right-rect.left;
887 height = rect.bottom-rect.top;
889 SetWindowPos(info->popup.hwndList, NULL, rect.left, rect.top, width, height,
890 SWP_NOZORDER | SWP_NOACTIVATE);
892 SendMessageW(info->popup.hwndList, LVM_SETCOLUMNWIDTH, 0,
893 width-scroll_width-2*border_width-2*edge_width);
896 static LRESULT CALLBACK HelpPopup_WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
898 HHInfo *info = (HHInfo *)GetWindowLongPtrW(hWnd, GWLP_USERDATA);
903 ResizePopupChild(info);
909 ShowWindow(hWnd, SW_HIDE);
913 return DefWindowProcW(hWnd, message, wParam, lParam);
919 static LRESULT CALLBACK PopupChild_WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
924 NMHDR *nmhdr = (NMHDR*)lParam;
928 HHInfo *info = (HHInfo*)GetWindowLongPtrW(hWnd, GWLP_USERDATA);
931 if(info == 0 || lParam == 0)
933 iter = (IndexSubItem*) ((NMITEMACTIVATE *)lParam)->lParam;
936 NavigateToChm(info, info->index->merge.chm_file, iter->local);
937 ShowWindow(info->popup.hwndPopup, SW_HIDE);
941 HHInfo *info = (HHInfo*)GetWindowLongPtrW(hWnd, GWLP_USERDATA);
948 lvItem.iItem = (int) SendMessageW(info->popup.hwndList, LVM_GETSELECTIONMARK, 0, 0);
949 lvItem.mask = TVIF_PARAM;
950 ListView_GetItemW(info->popup.hwndList, &lvItem);
951 iter = (IndexSubItem*) lvItem.lParam;
952 NavigateToChm(info, info->index->merge.chm_file, iter->local);
953 ShowWindow(info->popup.hwndPopup, SW_HIDE);
960 return DefWindowProcW(hWnd, message, wParam, lParam);
966 static BOOL AddIndexPopup(HHInfo *info)
968 static const WCHAR szPopupChildClass[] = {'H','H',' ','P','o','p','u','p',' ','C','h','i','l','d',0};
969 static const WCHAR windowCaptionW[] = {'S','e','l','e','c','t',' ','T','o','p','i','c',':',0};
970 static const WCHAR windowClassW[] = {'H','H',' ','P','o','p','u','p',0};
971 HWND hwndList, hwndPopup, hwndCallback;
972 char hidden_column[] = "Column";
976 if(info->tabs[TAB_INDEX].id == -1)
977 return TRUE; /* No "Index" tab */
979 wcex.cbSize = sizeof(WNDCLASSEXW);
980 wcex.style = CS_HREDRAW | CS_VREDRAW;
981 wcex.lpfnWndProc = HelpPopup_WndProc;
984 wcex.hInstance = hhctrl_hinstance;
985 wcex.hIcon = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
986 wcex.hCursor = LoadCursorW(NULL, (LPCWSTR)IDC_ARROW);
987 wcex.hbrBackground = (HBRUSH)(COLOR_MENU + 1);
988 wcex.lpszMenuName = NULL;
989 wcex.lpszClassName = windowClassW;
990 wcex.hIconSm = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
991 RegisterClassExW(&wcex);
993 wcex.cbSize = sizeof(WNDCLASSEXW);
995 wcex.lpfnWndProc = PopupChild_WndProc;
998 wcex.hInstance = hhctrl_hinstance;
999 wcex.hIcon = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
1000 wcex.hCursor = LoadCursorW(NULL, (LPCWSTR)IDC_ARROW);
1001 wcex.hbrBackground = (HBRUSH)(COLOR_BTNFACE + 1);
1002 wcex.lpszMenuName = NULL;
1003 wcex.lpszClassName = szPopupChildClass;
1004 wcex.hIconSm = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
1005 RegisterClassExW(&wcex);
1007 hwndPopup = CreateWindowExW(WS_EX_LEFT | WS_EX_LTRREADING | WS_EX_APPWINDOW
1008 | WS_EX_WINDOWEDGE | WS_EX_RIGHTSCROLLBAR,
1009 windowClassW, windowCaptionW, WS_POPUPWINDOW
1010 | WS_OVERLAPPEDWINDOW | WS_VISIBLE
1011 | WS_CLIPSIBLINGS | WS_CLIPCHILDREN, CW_USEDEFAULT,
1012 CW_USEDEFAULT, 300, 200, info->WinType.hwndHelp,
1013 NULL, hhctrl_hinstance, NULL);
1017 hwndCallback = CreateWindowExW(WS_EX_LEFT | WS_EX_LTRREADING | WS_EX_RIGHTSCROLLBAR,
1018 szPopupChildClass, szEmpty, WS_CHILDWINDOW | WS_VISIBLE,
1020 hwndPopup, NULL, hhctrl_hinstance, NULL);
1024 ShowWindow(hwndPopup, SW_HIDE);
1025 hwndList = CreateWindowExW(WS_EX_CLIENTEDGE, WC_LISTVIEWW, szEmpty,
1026 WS_CHILD | WS_BORDER | LVS_SINGLESEL | LVS_REPORT
1027 | LVS_NOCOLUMNHEADER, 50, 50, 100, 100,
1028 hwndCallback, NULL, hhctrl_hinstance, NULL);
1030 ERR("Could not create popup ListView control\n");
1033 memset(&lvc, 0, sizeof(lvc));
1034 lvc.mask = LVCF_TEXT;
1035 lvc.pszText = hidden_column;
1036 if(SendMessageW(hwndList, LVM_INSERTCOLUMNA, 0, (LPARAM) &lvc) == -1)
1038 ERR("Could not create popup ListView column\n");
1042 info->popup.hwndCallback = hwndCallback;
1043 info->popup.hwndPopup = hwndPopup;
1044 info->popup.hwndList = hwndList;
1045 SetWindowLongPtrW(hwndPopup, GWLP_USERDATA, (LONG_PTR)info);
1046 SetWindowLongPtrW(hwndCallback, GWLP_USERDATA, (LONG_PTR)info);
1048 ResizePopupChild(info);
1049 ShowWindow(hwndList, SW_SHOW);
1056 static LRESULT Help_OnSize(HWND hWnd)
1058 HHInfo *pHHInfo = (HHInfo *)GetWindowLongPtrW(hWnd, GWLP_USERDATA);
1065 NP_GetNavigationRect(pHHInfo, &rc);
1066 SetWindowPos(pHHInfo->WinType.hwndNavigation, HWND_TOP, 0, 0,
1067 rc.right, rc.bottom, SWP_NOMOVE);
1069 SB_GetSizeBarRect(pHHInfo, &rc);
1070 SetWindowPos(pHHInfo->hwndSizeBar, HWND_TOP, rc.left, rc.top,
1071 rc.right, rc.bottom, SWP_SHOWWINDOW);
1073 HP_GetHTMLRect(pHHInfo, &rc);
1074 SetWindowPos(pHHInfo->WinType.hwndHTML, HWND_TOP, rc.left, rc.top,
1075 rc.right, rc.bottom, SWP_SHOWWINDOW);
1077 /* Resize browser window taking the frame size into account */
1078 dwSize = GetSystemMetrics(SM_CXFRAME);
1079 ResizeWebBrowser(pHHInfo, rc.right - dwSize, rc.bottom - dwSize);
1084 static LRESULT CALLBACK Help_WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
1089 if (HIWORD(wParam) == BN_CLICKED)
1090 TB_OnClick(hWnd, LOWORD(wParam));
1093 return Help_OnSize(hWnd);
1095 ReleaseHelpViewer((HHInfo *)GetWindowLongPtrW(hWnd, GWLP_USERDATA));
1103 return DefWindowProcW(hWnd, message, wParam, lParam);
1109 static BOOL HH_CreateHelpWindow(HHInfo *info)
1112 RECT winPos = info->WinType.rcWindowPos;
1114 DWORD dwStyles, dwExStyles;
1115 DWORD x, y, width, height;
1117 static const WCHAR windowClassW[] = {
1118 'H','H',' ', 'P','a','r','e','n','t',0
1121 wcex.cbSize = sizeof(WNDCLASSEXW);
1122 wcex.style = CS_HREDRAW | CS_VREDRAW;
1123 wcex.lpfnWndProc = Help_WndProc;
1124 wcex.cbClsExtra = 0;
1125 wcex.cbWndExtra = 0;
1126 wcex.hInstance = hhctrl_hinstance;
1127 wcex.hIcon = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
1128 wcex.hCursor = LoadCursorW(NULL, (LPCWSTR)IDC_ARROW);
1129 wcex.hbrBackground = (HBRUSH)(COLOR_MENU + 1);
1130 wcex.lpszMenuName = NULL;
1131 wcex.lpszClassName = windowClassW;
1132 wcex.hIconSm = LoadIconW(NULL, (LPCWSTR)IDI_APPLICATION);
1134 RegisterClassExW(&wcex);
1136 /* Read in window parameters if available */
1137 if (info->WinType.fsValidMembers & HHWIN_PARAM_STYLES)
1138 dwStyles = info->WinType.dwStyles | WS_OVERLAPPEDWINDOW;
1140 dwStyles = WS_OVERLAPPEDWINDOW | WS_VISIBLE |
1141 WS_CLIPSIBLINGS | WS_CLIPCHILDREN;
1143 if (info->WinType.fsValidMembers & HHWIN_PARAM_EXSTYLES)
1144 dwExStyles = info->WinType.dwExStyles;
1146 dwExStyles = WS_EX_LEFT | WS_EX_LTRREADING | WS_EX_APPWINDOW |
1147 WS_EX_WINDOWEDGE | WS_EX_RIGHTSCROLLBAR;
1149 if (info->WinType.fsValidMembers & HHWIN_PARAM_RECT)
1153 width = winPos.right - x;
1154 height = winPos.bottom - y;
1158 x = WINTYPE_DEFAULT_X;
1159 y = WINTYPE_DEFAULT_Y;
1160 width = WINTYPE_DEFAULT_WIDTH;
1161 height = WINTYPE_DEFAULT_HEIGHT;
1164 hWnd = CreateWindowExW(dwExStyles, windowClassW, info->WinType.pszCaption,
1165 dwStyles, x, y, width, height, NULL, NULL, hhctrl_hinstance, NULL);
1169 ShowWindow(hWnd, SW_SHOW);
1172 /* store the pointer to the HH info struct */
1173 SetWindowLongPtrW(hWnd, GWLP_USERDATA, (LONG_PTR)info);
1175 info->WinType.hwndHelp = hWnd;
1179 static void HH_CreateFont(HHInfo *pHHInfo)
1183 GetObjectW(GetStockObject(ANSI_VAR_FONT), sizeof(LOGFONTW), &lf);
1184 lf.lfWeight = FW_NORMAL;
1185 lf.lfItalic = FALSE;
1186 lf.lfUnderline = FALSE;
1188 pHHInfo->hFont = CreateFontIndirectW(&lf);
1191 static void HH_InitRequiredControls(DWORD dwControls)
1193 INITCOMMONCONTROLSEX icex;
1195 icex.dwSize = sizeof(INITCOMMONCONTROLSEX);
1196 icex.dwICC = dwControls;
1197 InitCommonControlsEx(&icex);
1200 /* Creates the whole package */
1201 static BOOL CreateViewer(HHInfo *pHHInfo)
1203 HH_CreateFont(pHHInfo);
1205 if (!HH_CreateHelpWindow(pHHInfo))
1208 HH_InitRequiredControls(ICC_BAR_CLASSES);
1210 if (!HH_AddToolbar(pHHInfo))
1213 HH_RegisterChildWndClass(pHHInfo);
1215 if (!HH_AddNavigationPane(pHHInfo))
1218 HH_RegisterSizeBarClass(pHHInfo);
1220 if (!HH_AddSizeBar(pHHInfo))
1223 if (!HH_AddHTMLPane(pHHInfo))
1226 if (!AddContentTab(pHHInfo))
1229 if (!AddIndexTab(pHHInfo))
1232 if (!AddIndexPopup(pHHInfo))
1235 InitContent(pHHInfo);
1241 void ReleaseHelpViewer(HHInfo *info)
1243 TRACE("(%p)\n", info);
1248 /* Free allocated strings */
1249 heap_free(info->pszType);
1250 heap_free(info->pszCaption);
1251 heap_free(info->pszToc);
1252 heap_free(info->pszIndex);
1253 heap_free(info->pszFile);
1254 heap_free(info->pszHome);
1255 heap_free(info->pszJump1);
1256 heap_free(info->pszJump2);
1257 heap_free(info->pszUrlJump1);
1258 heap_free(info->pszUrlJump2);
1261 CloseCHM(info->pCHMInfo);
1263 ReleaseWebBrowser(info);
1264 ReleaseContent(info);
1267 if(info->WinType.hwndHelp)
1268 DestroyWindow(info->WinType.hwndHelp);
1274 HHInfo *CreateHelpViewer(LPCWSTR filename)
1276 HHInfo *info = heap_alloc_zero(sizeof(HHInfo));
1279 /* Set the invalid tab ID (-1) as the default value for all
1280 * of the tabs, this matches a failed TCM_INSERTITEM call.
1282 for(i=0;i<sizeof(info->tabs)/sizeof(HHTab);i++)
1283 info->tabs[i].id = -1;
1285 OleInitialize(NULL);
1287 info->pCHMInfo = OpenCHM(filename);
1288 if(!info->pCHMInfo) {
1289 ReleaseHelpViewer(info);
1293 if (!LoadWinTypeFromCHM(info)) {
1294 ReleaseHelpViewer(info);
1298 if(!CreateViewer(info)) {
1299 ReleaseHelpViewer(info);