X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cd560c961a09a8ae80b9c32856e195ed784cc547..74a8f67d96591cec101def2a7d47c64072aff7fd:/src/msw/helpchm.cpp diff --git a/src/msw/helpchm.cpp b/src/msw/helpchm.cpp index 4f26427f28..cdb46e21af 100644 --- a/src/msw/helpchm.cpp +++ b/src/msw/helpchm.cpp @@ -1,18 +1,14 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: helpchm.cpp +// Name: src/msw/helpchm.cpp // Purpose: Help system: MS HTML Help implementation // Author: Julian Smart -// Modified by: +// Modified by: Vadim Zeitlin at 2008-03-01: refactoring, simplification // Created: 16/04/2000 // RCS-ID: $Id$ // Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ - #pragma implementation "helpchm.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -20,71 +16,20 @@ #pragma hdrstop #endif -#if wxUSE_HELP && wxUSE_MS_HTML_HELP && defined(__WIN95__) +#if wxUSE_HELP && wxUSE_MS_HTML_HELP -#include "wx/filefn.h" +#include "wx/filename.h" #include "wx/msw/helpchm.h" -#include "wx/dynlib.h" - -#include "wx/msw/private.h" +#include "wx/dynload.h" -// instead of including htmlhelp.h, duplicate the things from it we need here +#ifndef WX_PRECOMP + #include "wx/intl.h" + #include "wx/app.h" +#endif -enum -{ - HH_DISPLAY_TOPIC, - HH_DISPLAY_TOC, - HH_DISPLAY_INDEX, - HH_DISPLAY_SEARCH, - HH_SET_WIN_TYPE, - HH_GET_WIN_TYPE, - HH_GET_WIN_HANDLE, - HH_ENUM_INFO_TYPE, - HH_SET_INFO_TYPE, - HH_SYNC, - HH_RESERVED1, - HH_RESERVED2, - HH_RESERVED3, - HH_KEYWORD_LOOKUP, - HH_DISPLAY_TEXT_POPUP, - HH_HELP_CONTEXT, - HH_TP_HELP_CONTEXTMENU, - HH_TP_HELP_WM_HELP, - HH_CLOSE_ALL, - HH_ALINK_LOOKUP, - HH_GET_LAST_ERROR, - HH_ENUM_CATEGORY, - HH_ENUM_CATEGORY_IT, - HH_RESET_IT_FILTER, - HH_SET_INCLUSIVE_FILTER, - HH_SET_EXCLUSIVE_FILTER -}; - -struct HH_POPUP -{ - int cbStruct; - HINSTANCE hinst; - UINT idString; - LPCTSTR pszText; - POINT pt; - COLORREF clrForeground; - COLORREF clrBackground; - RECT rcMargins; - LPCTSTR pszFont; -}; - -struct HH_AKLINK -{ - int cbStruct; - BOOL fReserved; - LPCTSTR pszKeywords; - LPCTSTR pszUrl; - LPCTSTR pszMsgText; - LPCTSTR pszMsgTitle; - LPCTSTR pszWindow; - BOOL fIndexOnFail; -}; +#include "wx/msw/private.h" +#include "wx/msw/htmlhelp.h" // ---------------------------------------------------------------------------- // utility functions to manage the loading/unloading @@ -93,155 +38,153 @@ struct HH_AKLINK #ifndef UNICODE typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCSTR, UINT, DWORD ); - #define HTMLHELP_NAME "HtmlHelpA" + #define HTMLHELP_NAME wxT("HtmlHelpA") #else // ANSI typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCWSTR, UINT, DWORD ); - #define HTMLHELP_NAME "HtmlHelpW" + #define HTMLHELP_NAME wxT("HtmlHelpW") #endif -// dll symbol handle -static HTMLHELP gs_htmlHelp = 0; - -static bool LoadHtmlHelpLibrary() +HTMLHELP GetHtmlHelpFunction() { - wxPluginLibrary *lib = wxPluginManager::LoadLibrary( _T("HHCTRL.OCX"), wxDL_DEFAULT | wxDL_VERBATIM ); + static HTMLHELP s_htmlHelp = NULL; - if( !lib ) - { - wxLogError(_("MS HTML Help functions are unavailable because the MS HTML Help library is not installed on this machine. Please install it.")); - return FALSE; - } - else + if ( !s_htmlHelp ) { - gs_htmlHelp = (HTMLHELP)lib->GetSymbol( HTMLHELP_NAME ); + static wxDynamicLibrary s_dllHtmlHelp(wxT("HHCTRL.OCX"), wxDL_VERBATIM); - if( !gs_htmlHelp ) + if ( !s_dllHtmlHelp.IsLoaded() ) { - wxLogError(_("Failed to initialize MS HTML Help.")); - - lib->UnrefLib(); - return FALSE ; + 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 TRUE; + return s_htmlHelp; } -static void UnloadHtmlHelpLibrary() +// 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 ( gs_htmlHelp ) - { - wxPluginManager::UnloadLibrary( _T("HHCTRL.OCX") ); + if ( !win && wxTheApp ) + win = wxTheApp->GetTopWindow(); - gs_htmlHelp = 0; - } + return win ? GetHwndOf(win) : ::GetDesktopWindow(); } -static HWND GetSuitableHWND() -{ - if (wxTheApp->GetTopWindow()) - return (HWND) wxTheApp->GetTopWindow()->GetHWND(); - else - return GetDesktopWindow(); -} IMPLEMENT_DYNAMIC_CLASS(wxCHMHelpController, wxHelpControllerBase) bool wxCHMHelpController::Initialize(const wxString& filename) { - // warn on failure - if( !LoadHtmlHelpLibrary() ) - return FALSE; + 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() +/* static */ bool +wxCHMHelpController::CallHtmlHelp(wxWindow *win, + const wxChar *str, + unsigned cmd, + WXWPARAM param) { - if (m_helpFile.IsEmpty()) return FALSE; + HTMLHELP htmlHelp = GetHtmlHelpFunction(); + + return htmlHelp && htmlHelp(GetSuitableHWND(win), str, cmd, param); +} - wxString str = GetValidFilename(m_helpFile); +bool wxCHMHelpController::DisplayContents() +{ + if (m_helpFile.IsEmpty()) + return false; - gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, 0L); - return TRUE; + return CallHtmlHelp(HH_DISPLAY_TOPIC); } // Use topic or HTML filename bool wxCHMHelpController::DisplaySection(const wxString& section) { - if (m_helpFile.IsEmpty()) return FALSE; - - wxString str = GetValidFilename(m_helpFile); + if (m_helpFile.IsEmpty()) + return false; // Is this an HTML file or a keyword? - bool isFilename = (section.Find(wxT(".htm")) != -1); + if ( section.Find(wxT(".htm")) != wxNOT_FOUND ) + { + // interpret as a file name + return CallHtmlHelp(HH_DISPLAY_TOPIC, section.wx_str()); + } - if (isFilename) - gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, (DWORD) (const wxChar*) section); - else - KeywordSearch(section); - return TRUE; + 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); - - gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)section); - return TRUE; + return CallHtmlHelp(HH_HELP_CONTEXT, section); } -bool wxCHMHelpController::DisplayContextPopup(int contextId) +/* static */ +bool +wxCHMHelpController::DoDisplayTextPopup(const wxChar *text, + const wxPoint& pos, + int contextId, + wxWindow *window) { - if (m_helpFile.IsEmpty()) return FALSE; - - wxString str = GetValidFilename(m_helpFile); - - // 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 = (COLORREF)-1; - popup.clrBackground = (COLORREF)-1; - popup.rcMargins.top = popup.rcMargins.left = popup.rcMargins.right = popup.rcMargins.bottom = -1; + popup.idString = contextId; + popup.pszText = text; + popup.pt.x = pos.x; + popup.pt.y = pos.y; + popup.clrForeground = ::GetSysColor(COLOR_INFOTEXT); + popup.clrBackground = ::GetSysColor(COLOR_INFOBK); + popup.rcMargins.top = + popup.rcMargins.left = + popup.rcMargins.right = + popup.rcMargins.bottom = -1; popup.pszFont = NULL; - popup.pszText = NULL; - gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup); - return TRUE; + return CallHtmlHelp(window, NULL, HH_DISPLAY_TEXT_POPUP, &popup); } -bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos) +bool wxCHMHelpController::DisplayContextPopup(int contextId) { - 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 = (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; + return DoDisplayTextPopup(NULL, wxGetMousePosition(), contextId, + GetParentWindow()); +} - gs_htmlHelp(GetSuitableHWND(), NULL, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup); - return TRUE; +bool +wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos) +{ + return ShowContextHelpPopup(text, pos, GetParentWindow()); +} + +/* static */ +bool wxCHMHelpController::ShowContextHelpPopup(const wxString& text, + const wxPoint& pos, + wxWindow *window) +{ + return DoDisplayTextPopup(text.wx_str(), pos, 0, window); } bool wxCHMHelpController::DisplayBlock(long block) @@ -249,38 +192,34 @@ 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; - - wxString str = GetValidFilename(m_helpFile); + if (m_helpFile.IsEmpty()) + return false; HH_AKLINK link; - link.cbStruct = sizeof(HH_AKLINK) ; - link.fReserved = FALSE ; - link.pszKeywords = k.c_str() ; - link.pszUrl = NULL ; - link.pszMsgText = NULL ; - link.pszMsgTitle = NULL ; - link.pszWindow = NULL ; - link.fIndexOnFail = TRUE ; - - gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link); - return TRUE; + link.cbStruct = sizeof(HH_AKLINK); + link.fReserved = FALSE; + link.pszKeywords = k.wx_str(); + link.pszUrl = NULL; + link.pszMsgText = NULL; + link.pszMsgTitle = NULL; + link.pszWindow = NULL; + link.fIndexOnFail = TRUE; + + return CallHtmlHelp(HH_KEYWORD_LOOKUP, &link); } bool wxCHMHelpController::Quit() { - gs_htmlHelp(GetSuitableHWND(), 0, HH_CLOSE_ALL, 0L); - - return TRUE; + return CallHtmlHelp(NULL, NULL, HH_CLOSE_ALL); } -// Append extension if necessary. -wxString wxCHMHelpController::GetValidFilename(const wxString& file) const +wxString wxCHMHelpController::GetValidFilename() const { wxString path, name, ext; - wxSplitPath(file, & path, & name, & ext); + wxFileName::SplitPath(m_helpFile, &path, &name, &ext); wxString fullName; if (path.IsEmpty()) @@ -292,10 +231,4 @@ wxString wxCHMHelpController::GetValidFilename(const wxString& file) const return fullName; } -wxCHMHelpController::~wxCHMHelpController() -{ - UnloadHtmlHelpLibrary(); -} - #endif // wxUSE_HELP -