]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/helpchm.cpp
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
wxTinderbox build fix (!PCH support).
[wxWidgets.git] / src / msw / helpchm.cpp
diff --git a/src/msw/helpchm.cpp b/src/msw/helpchm.cpp
index 88dff23aab0bda1c4e7f2a596592199340925fce..2d964b00116c35a8a502db6e852d9b672bd8ada9 100644 (file)
--- a/src/msw/helpchm.cpp
+++ b/src/msw/helpchm.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////
-// Name:        helpchm.cpp
+// Name:        src/msw/helpchm.cpp
 // Purpose:     Help system: MS HTML Help implementation
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     Help system: MS HTML Help implementation
 // Author:      Julian Smart
 // Modified by:
@@ -9,10 +9,6 @@
 // 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"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -20,71 +16,20 @@
     #pragma hdrstop
 #endif
 
     #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/msw/helpchm.h"
 
 
 #include "wx/filefn.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
 
 // ----------------------------------------------------------------------------
 // utility functions to manage the loading/unloading
@@ -93,55 +38,54 @@ struct HH_AKLINK
 
 #ifndef UNICODE
     typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCSTR, UINT, DWORD );
 
 #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 );
 #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;
 #endif
 
 // dll symbol handle
 static HTMLHELP gs_htmlHelp = 0;
-static wxPluginLibrary *gs_libHtmlHelp = NULL;
 
 static bool LoadHtmlHelpLibrary()
 {
 
 static bool LoadHtmlHelpLibrary()
 {
-    gs_libHtmlHelp = wxPluginManager::LoadLibrary( _T("HHCTRL.OCX"), wxDL_DEFAULT | wxDL_VERBATIM );
+    wxPluginLibrary *lib = wxPluginManager::LoadLibrary( _T("HHCTRL.OCX"), wxDL_DEFAULT | wxDL_VERBATIM );
 
 
-    if( !gs_libHtmlHelp )
+    if( !lib )
     {
         wxLogError(_("MS HTML Help functions are unavailable because the MS HTML Help library is not installed on this machine. Please install it."));
     {
         wxLogError(_("MS HTML Help functions are unavailable because the MS HTML Help library is not installed on this machine. Please install it."));
-        return FALSE;
+        return false;
     }
     else
     {
     }
     else
     {
-        gs_htmlHelp = (HTMLHELP)gs_libHtmlHelp->GetSymbol( HTMLHELP_NAME );
+        gs_htmlHelp = (HTMLHELP)lib->GetSymbol( HTMLHELP_NAME );
 
         if( !gs_htmlHelp )
         {
             wxLogError(_("Failed to initialize MS HTML Help."));
 
 
         if( !gs_htmlHelp )
         {
             wxLogError(_("Failed to initialize MS HTML Help."));
 
-            gs_libHtmlHelp->UnrefLib();
-            return FALSE ;
+            lib->UnrefLib();
+            return false ;
         }
     }
 
         }
     }
 
-    return TRUE;
+    return true;
 }
 
 static void UnloadHtmlHelpLibrary()
 {
 }
 
 static void UnloadHtmlHelpLibrary()
 {
-    if( gs_htmlHelp )
+    if ( gs_htmlHelp )
     {
     {
-        wxPluginManager::UnloadLibrary( _T("HHCTRL.OCX") );
-        gs_libHtmlHelp->UnrefLib();
-
-        gs_htmlHelp = 0;
+        if (wxPluginManager::UnloadLibrary( _T("HHCTRL.OCX") ))
+            gs_htmlHelp = 0;
     }
 }
 
     }
 }
 
-static HWND GetSuitableHWND()
+static HWND GetSuitableHWND(wxCHMHelpController* controller)
 {
 {
-    if (wxTheApp->GetTopWindow())
+    if (controller->GetParentWindow())
+        return (HWND) controller->GetParentWindow()->GetHWND();
+    else if (wxTheApp->GetTopWindow())
         return (HWND) wxTheApp->GetTopWindow()->GetHWND();
     else
         return GetDesktopWindow();
         return (HWND) wxTheApp->GetTopWindow()->GetHWND();
     else
         return GetDesktopWindow();
@@ -153,60 +97,60 @@ bool wxCHMHelpController::Initialize(const wxString& filename)
 {
     // warn on failure
     if( !LoadHtmlHelpLibrary() )
 {
     // warn on failure
     if( !LoadHtmlHelpLibrary() )
-        return FALSE;
+        return false;
 
     m_helpFile = filename;
 
     m_helpFile = filename;
-    return TRUE;
+    return true;
 }
 
 bool wxCHMHelpController::LoadFile(const wxString& file)
 {
     if (!file.IsEmpty())
         m_helpFile = file;
 }
 
 bool wxCHMHelpController::LoadFile(const wxString& file)
 {
     if (!file.IsEmpty())
         m_helpFile = file;
-    return TRUE;
+    return true;
 }
 
 bool wxCHMHelpController::DisplayContents()
 {
 }
 
 bool wxCHMHelpController::DisplayContents()
 {
-    if (m_helpFile.IsEmpty()) return FALSE;
+    if (m_helpFile.IsEmpty()) return false;
 
     wxString str = GetValidFilename(m_helpFile);
 
 
     wxString str = GetValidFilename(m_helpFile);
 
-    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, 0L);
-    return TRUE;
+    gs_htmlHelp(GetSuitableHWND(this), (const wxChar*) str, HH_DISPLAY_TOPIC, 0L);
+    return true;
 }
 
 // Use topic or HTML filename
 bool wxCHMHelpController::DisplaySection(const wxString& section)
 {
 }
 
 // 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?
 
     wxString str = GetValidFilename(m_helpFile);
 
     // Is this an HTML file or a keyword?
-    bool isFilename = (section.Find(wxT(".htm")) != -1);
+    bool isFilename = (section.Find(wxT(".htm")) != wxNOT_FOUND);
 
     if (isFilename)
 
     if (isFilename)
-        gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, (DWORD) (const wxChar*) section);
+        gs_htmlHelp(GetSuitableHWND(this), (const wxChar*) str, HH_DISPLAY_TOPIC, (DWORD) (const wxChar*) section);
     else
         KeywordSearch(section);
     else
         KeywordSearch(section);
-    return TRUE;
+    return true;
 }
 
 // Use context number
 bool wxCHMHelpController::DisplaySection(int 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);
 
 
     wxString str = GetValidFilename(m_helpFile);
 
-    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)section);
-    return TRUE;
+    gs_htmlHelp(GetSuitableHWND(this), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)section);
+    return true;
 }
 
 bool wxCHMHelpController::DisplayContextPopup(int contextId)
 {
 }
 
 bool wxCHMHelpController::DisplayContextPopup(int contextId)
 {
-    if (m_helpFile.IsEmpty()) return FALSE;
+    if (m_helpFile.IsEmpty()) return false;
 
     wxString str = GetValidFilename(m_helpFile);
 
 
     wxString str = GetValidFilename(m_helpFile);
 
@@ -225,8 +169,8 @@ bool wxCHMHelpController::DisplayContextPopup(int contextId)
     popup.pszFont = NULL;
     popup.pszText = NULL;
 
     popup.pszFont = NULL;
     popup.pszText = NULL;
 
-    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
-    return TRUE;
+    gs_htmlHelp(GetSuitableHWND(this), (const wxChar*) str, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
+    return true;
 }
 
 bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos)
 }
 
 bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos)
@@ -242,8 +186,8 @@ bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint&
     popup.pszFont = NULL;
     popup.pszText = (const wxChar*) text;
 
     popup.pszFont = NULL;
     popup.pszText = (const wxChar*) text;
 
-    gs_htmlHelp(GetSuitableHWND(), NULL, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
-    return TRUE;
+    gs_htmlHelp(GetSuitableHWND(this), NULL, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
+    return true;
 }
 
 bool wxCHMHelpController::DisplayBlock(long block)
 }
 
 bool wxCHMHelpController::DisplayBlock(long block)
@@ -251,9 +195,10 @@ bool wxCHMHelpController::DisplayBlock(long block)
     return DisplaySection(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);
 
 
     wxString str = GetValidFilename(m_helpFile);
 
@@ -267,15 +212,15 @@ bool wxCHMHelpController::KeywordSearch(const wxString& k)
     link.pszWindow =    NULL ;
     link.fIndexOnFail = TRUE ;
 
     link.pszWindow =    NULL ;
     link.fIndexOnFail = TRUE ;
 
-    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link);
-    return TRUE;
+    gs_htmlHelp(GetSuitableHWND(this), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link);
+    return true;
 }
 
 bool wxCHMHelpController::Quit()
 {
 }
 
 bool wxCHMHelpController::Quit()
 {
-    gs_htmlHelp(GetSuitableHWND(), 0, HH_CLOSE_ALL, 0L);
+    gs_htmlHelp(GetSuitableHWND(this), 0, HH_CLOSE_ALL, 0L);
 
 
-    return TRUE;
+    return true;
 }
 
 // Append extension if necessary.
 }
 
 // Append extension if necessary.
@@ -300,4 +245,3 @@ wxCHMHelpController::~wxCHMHelpController()
 }
 
 #endif // wxUSE_HELP
 }
 
 #endif // wxUSE_HELP
-
wxWidgets (Impactor)