X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5100cabffa34c38db26884577113d01f21cda446..950905affdfa9041316f82308e1a11e82c783070:/src/msw/helpchm.cpp diff --git a/src/msw/helpchm.cpp b/src/msw/helpchm.cpp index 71356d4f6f..1114decbd0 100644 --- a/src/msw/helpchm.cpp +++ b/src/msw/helpchm.cpp @@ -1,146 +1,208 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: helpchm.cpp +// Name: src/msw/helpchm.cpp // Purpose: Help system: MS HTML Help implementation // Author: Julian Smart // Modified by: // Created: 16/04/2000 // RCS-ID: $Id$ // Copyright: (c) Julian Smart -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "helpchm.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ -#pragma hdrstop + #pragma hdrstop #endif -#ifndef WX_PRECOMP -#include "wx/defs.h" -#endif +#if wxUSE_HELP && wxUSE_MS_HTML_HELP #include "wx/filefn.h" - -#if wxUSE_HELP && wxUSE_MS_HTML_HELP && defined(__WIN95__) #include "wx/msw/helpchm.h" -// This is found in the HTML Help Workshop installation, -// along with htmlhelp.lib. -#include +#include "wx/dynload.h" -#include +#ifndef WX_PRECOMP + #include "wx/intl.h" + #include "wx/app.h" +#endif -#ifdef __WXMSW__ #include "wx/msw/private.h" +#include "wx/msw/htmlhelp.h" + +// ---------------------------------------------------------------------------- +// utility functions to manage the loading/unloading +// of hhctrl.ocx +// ---------------------------------------------------------------------------- + +#ifndef UNICODE + typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCSTR, UINT, DWORD ); + #define HTMLHELP_NAME wxT("HtmlHelpA") +#else // ANSI + typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCWSTR, UINT, DWORD ); + #define HTMLHELP_NAME wxT("HtmlHelpW") #endif -#include +HTMLHELP GetHtmlHelpFunction() +{ + static HTMLHELP s_htmlHelp = NULL; + + if ( !s_htmlHelp ) + { + static wxDynamicLibrary s_dllHtmlHelp(_T("HHCTRL.OCX"), wxDL_VERBATIM); + + if ( !s_dllHtmlHelp.IsLoaded() ) + { + wxLogError(_("MS HTML Help functions are unavailable because the MS HTML Help library is not installed on this machine. Please install it.")); + } + else + { + s_htmlHelp = (HTMLHELP)s_dllHtmlHelp.GetSymbol(HTMLHELP_NAME); + if ( !s_htmlHelp ) + { + wxLogError(_("Failed to initialize MS HTML Help.")); + } + } + } + + return s_htmlHelp; +} -static HWND GetSuitableHWND() +// find the window to use in HtmlHelp() call: use the given one by default but +// fall back to the top level app window and then the desktop if it's NULL +static HWND GetSuitableHWND(wxWindow *win) { - if (wxTheApp->GetTopWindow()) - return (HWND) wxTheApp->GetTopWindow()->GetHWND(); - else - return GetDesktopWindow(); + if ( !win && wxTheApp ) + win = wxTheApp->GetTopWindow(); + + return win ? GetHwndOf(win) : ::GetDesktopWindow(); +} + +// wrap the real HtmlHelp() but just return false (and not crash) if it +// couldn't be loaded +// +// it also takes a wxWindow instead of HWND +static bool +CallHtmlHelpFunction(wxWindow *win, const wxChar *str, UINT uint, DWORD dword) +{ + HTMLHELP htmlHelp = GetHtmlHelpFunction(); + + return htmlHelp && + htmlHelp(GetSuitableHWND(win), str, uint, dword); } IMPLEMENT_DYNAMIC_CLASS(wxCHMHelpController, wxHelpControllerBase) bool wxCHMHelpController::Initialize(const wxString& filename) { + if ( !GetHtmlHelpFunction() ) + return false; + m_helpFile = filename; - return TRUE; + return true; } bool wxCHMHelpController::LoadFile(const wxString& file) { if (!file.IsEmpty()) m_helpFile = file; - return TRUE; + return true; } bool wxCHMHelpController::DisplayContents() { - if (m_helpFile.IsEmpty()) return FALSE; + if (m_helpFile.IsEmpty()) + return false; wxString str = GetValidFilename(m_helpFile); - HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_FINDER, 0L); - return TRUE; + return CallHtmlHelpFunction(GetParentWindow(), + str.wx_str(), HH_DISPLAY_TOPIC, 0L); } // Use topic or HTML filename bool wxCHMHelpController::DisplaySection(const wxString& section) { - if (m_helpFile.IsEmpty()) return FALSE; + if (m_helpFile.IsEmpty()) + return false; wxString str = GetValidFilename(m_helpFile); // Is this an HTML file or a keyword? - bool isFilename = (section.Find(wxT(".htm")) != -1); - - if (isFilename) - HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, (DWORD) (const wxChar*) section); - else - KeywordSearch(section); - return TRUE; + if ( section.Find(wxT(".htm")) != wxNOT_FOUND ) + { + // interpret as a file name + return CallHtmlHelpFunction(GetParentWindow(), + str.wx_str(), HH_DISPLAY_TOPIC, + wxPtrToUInt(section.c_str())); + } + + return KeywordSearch(section); } // Use context number bool wxCHMHelpController::DisplaySection(int section) { - if (m_helpFile.IsEmpty()) return FALSE; + if (m_helpFile.IsEmpty()) + return false; wxString str = GetValidFilename(m_helpFile); - HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)section); - return TRUE; + return CallHtmlHelpFunction(GetParentWindow(), + str.wx_str(), HH_HELP_CONTEXT, (DWORD)section); } bool wxCHMHelpController::DisplayContextPopup(int contextId) { - if (m_helpFile.IsEmpty()) return FALSE; + if (m_helpFile.IsEmpty()) return false; wxString str = GetValidFilename(m_helpFile); - // TODO: what should this be? - //HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)contextId); + // We also have to specify the popups file (default is cshelp.txt). + // str += wxT("::/cshelp.txt"); + HH_POPUP popup; popup.cbStruct = sizeof(popup); popup.hinst = (HINSTANCE) wxGetInstance(); popup.idString = contextId ; GetCursorPos(& popup.pt); - popup.clrForeground = -1; - popup.clrBackground = -1; + popup.clrForeground = (COLORREF)-1; + popup.clrBackground = (COLORREF)-1; popup.rcMargins.top = popup.rcMargins.left = popup.rcMargins.right = popup.rcMargins.bottom = -1; popup.pszFont = NULL; popup.pszText = NULL; - HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup); - return TRUE; + return CallHtmlHelpFunction(GetParentWindow(), + str.wx_str(), HH_DISPLAY_TEXT_POPUP, + wxPtrToUInt(&popup)); +} + +bool +wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos) +{ + return ShowContextHelpPopup(text, pos, GetParentWindow()); } -bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos) +/* static */ +bool wxCHMHelpController::ShowContextHelpPopup(const wxString& text, + const wxPoint& pos, + wxWindow *window) { HH_POPUP popup; popup.cbStruct = sizeof(popup); popup.hinst = (HINSTANCE) wxGetInstance(); popup.idString = 0 ; popup.pt.x = pos.x; popup.pt.y = pos.y; - popup.clrForeground = -1; - popup.clrBackground = -1; + popup.clrForeground = (COLORREF)-1; + popup.clrBackground = (COLORREF)-1; popup.rcMargins.top = popup.rcMargins.left = popup.rcMargins.right = popup.rcMargins.bottom = -1; popup.pszFont = NULL; - popup.pszText = (const wxChar*) text; + popup.pszText = text.wx_str(); - HtmlHelp(GetSuitableHWND(), NULL, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup); - return TRUE; + return CallHtmlHelpFunction(window, NULL, HH_DISPLAY_TEXT_POPUP, + wxPtrToUInt(&popup)); } bool wxCHMHelpController::DisplayBlock(long block) @@ -148,9 +210,11 @@ bool wxCHMHelpController::DisplayBlock(long block) return DisplaySection(block); } -bool wxCHMHelpController::KeywordSearch(const wxString& k) +bool wxCHMHelpController::KeywordSearch(const wxString& k, + wxHelpSearchMode WXUNUSED(mode)) { - if (m_helpFile.IsEmpty()) return FALSE; + if (m_helpFile.IsEmpty()) + return false; wxString str = GetValidFilename(m_helpFile); @@ -164,14 +228,14 @@ bool wxCHMHelpController::KeywordSearch(const wxString& k) link.pszWindow = NULL ; link.fIndexOnFail = TRUE ; - HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link); - return TRUE; + return CallHtmlHelpFunction(GetParentWindow(), + str.wx_str(), HH_KEYWORD_LOOKUP, + wxPtrToUInt(&link)); } bool wxCHMHelpController::Quit() { - HtmlHelp(GetSuitableHWND(), 0, HH_CLOSE_ALL, 0L); - return TRUE; + return CallHtmlHelpFunction(GetParentWindow(), NULL, HH_CLOSE_ALL, 0L); } // Append extension if necessary.