Added expose event compression.

[wxWidgets.git] / src / msw / helpchm.cpp

diff --git a/src/msw/helpchm.cpp b/src/msw/helpchm.cpp
index 71356d4f6ffe23501a2718b139305b36ddc43f31..4a6148671fee468dbc230a987def791e8d21fcc2 100644 (file)
--- a/src/msw/helpchm.cpp
+++ b/src/msw/helpchm.cpp
@@ -6,7 +6,7 @@
 // Created:     16/04/2000
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart
 // Created:     16/04/2000
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__


@@ -29,6 +29,12 @@
 #if wxUSE_HELP && wxUSE_MS_HTML_HELP && defined(__WIN95__)
 #include "wx/msw/helpchm.h"
 
 #if wxUSE_HELP && wxUSE_MS_HTML_HELP && defined(__WIN95__)
 #include "wx/msw/helpchm.h"
 

+#include "wx/dynlib.h"
+
+#ifndef WX_PRECOMP
+#include <windows.h>
+#endif
+

 // This is found in the HTML Help Workshop installation,
 // along with htmlhelp.lib.
 #include <htmlhelp.h>
 // This is found in the HTML Help Workshop installation,
 // along with htmlhelp.lib.
 #include <htmlhelp.h>


@@ -41,6 +47,52 @@
 
 #include <string.h>
 
 
 #include <string.h>
 

+// utility functions to manage the loading/unloading
+// of hhctrl.ocx
+#ifndef UNICODE
+typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCSTR, UINT, DWORD );
+#define HTMLHELP_NAME "HtmlHelpA"
+#else
+typedef HWND ( WINAPI * HTMLHELP )( HWND, LPCWSTR, UINT, DWORD );
+#define HTMLHELP_NAME "HtmlHelpW"
+#endif
+// dll symbol handle
+static HTMLHELP gs_htmlHelp = 0;
+
+static bool LoadHtmlHelpLibrary()
+{
+    wxPluginLibrary *lib = wxPluginManager::LoadLibrary( _T("HHCTRL.OCX"), wxDL_DEFAULT | wxDL_VERBATIM );
+
+    if( !lib->IsLoaded() )
+    {
+        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
+    {
+        gs_htmlHelp = (HTMLHELP)lib->GetSymbol( HTMLHELP_NAME );
+
+        if( !gs_htmlHelp )
+        {
+            wxLogError(_("Failed to initialize MS HTML Help."));
+
+            lib->UnrefLib();
+            return FALSE ;
+        }
+    }
+
+    return TRUE;
+}
+
+static void UnloadHtmlHelpLibrary()
+{
+    if( gs_htmlHelp )
+    {
+        wxPluginManager::UnloadLibrary( _T("HHCTRL.OCX") );
+        gs_htmlHelp = 0;
+    }
+}
+

 static HWND GetSuitableHWND()
 {
     if (wxTheApp->GetTopWindow())
 static HWND GetSuitableHWND()
 {
     if (wxTheApp->GetTopWindow())


@@ -53,6 +105,10 @@ IMPLEMENT_DYNAMIC_CLASS(wxCHMHelpController, wxHelpControllerBase)
 
 bool wxCHMHelpController::Initialize(const wxString& filename)
 {
 
 bool wxCHMHelpController::Initialize(const wxString& filename)
 {

+    // warn on failure
+    if( !LoadHtmlHelpLibrary() )
+        return FALSE;
+

     m_helpFile = filename;
     return TRUE;
 }
     m_helpFile = filename;
     return TRUE;
 }


@@ -70,7 +126,7 @@ bool wxCHMHelpController::DisplayContents()
 
     wxString str = GetValidFilename(m_helpFile);
 
 
     wxString str = GetValidFilename(m_helpFile);
 

-    HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_FINDER, 0L);
+    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_FINDER, 0L);

     return TRUE;
 }
 
     return TRUE;
 }
 


@@ -85,7 +141,7 @@ bool wxCHMHelpController::DisplaySection(const wxString& section)
     bool isFilename = (section.Find(wxT(".htm")) != -1);
 
     if (isFilename)
     bool isFilename = (section.Find(wxT(".htm")) != -1);
 
     if (isFilename)

-        HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, (DWORD) (const wxChar*) section);
+        gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, (DWORD) (const wxChar*) section);

     else
         KeywordSearch(section);
     return TRUE;
     else
         KeywordSearch(section);
     return TRUE;


@@ -98,7 +154,7 @@ bool wxCHMHelpController::DisplaySection(int section)
 
     wxString str = GetValidFilename(m_helpFile);
 
 
     wxString str = GetValidFilename(m_helpFile);
 

-    HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)section);
+    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)section);

     return TRUE;
 }
 
     return TRUE;
 }
 


@@ -108,21 +164,22 @@ bool wxCHMHelpController::DisplayContextPopup(int contextId)
 
     wxString str = GetValidFilename(m_helpFile);
 
 
     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);
     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;
 
     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);
+    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);

     return TRUE;
 }
 
     return TRUE;
 }
 


@@ -133,13 +190,13 @@ bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint&
     popup.hinst = (HINSTANCE) wxGetInstance();
     popup.idString = 0 ;
     popup.pt.x = pos.x; popup.pt.y = pos.y;
     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.rcMargins.top = popup.rcMargins.left = popup.rcMargins.right = popup.rcMargins.bottom = -1;
     popup.pszFont = NULL;
     popup.pszText = (const wxChar*) text;
 

-    HtmlHelp(GetSuitableHWND(), NULL, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
+    gs_htmlHelp(GetSuitableHWND(), NULL, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);

     return TRUE;
 }
 
     return TRUE;
 }
 


@@ -164,13 +221,15 @@ bool wxCHMHelpController::KeywordSearch(const wxString& k)
     link.pszWindow =    NULL ;
     link.fIndexOnFail = TRUE ;
 
     link.pszWindow =    NULL ;
     link.fIndexOnFail = TRUE ;
 

-    HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link);
+    gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link);

     return TRUE;
 }
 
 bool wxCHMHelpController::Quit()
 {
     return TRUE;
 }
 
 bool wxCHMHelpController::Quit()
 {

-    HtmlHelp(GetSuitableHWND(), 0, HH_CLOSE_ALL, 0L);
+    gs_htmlHelp(GetSuitableHWND(), 0, HH_CLOSE_ALL, 0L);
+    UnloadHtmlHelpLibrary();
+

     return TRUE;
 }
 
     return TRUE;
 }
 


@@ -191,3 +250,5 @@ wxString wxCHMHelpController::GetValidFilename(const wxString& file) const
 }
 
 #endif // wxUSE_HELP
 }
 
 #endif // wxUSE_HELP

+
+// vi:sts=4:sw=4:et