// Created: 16/04/2000
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "helpchm.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+ #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 && defined(__WIN95__)
#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 <htmlhelp.h>
+#include "wx/dynload.h"
-#include <time.h>
+#ifndef WX_PRECOMP
+ #include "wx/intl.h"
+ #include "wx/app.h"
+#endif
-#ifdef __WXMSW__
#include "wx/msw/private.h"
+#include "wx/msw/missing.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 <string.h>
+// dll symbol handle
+static HTMLHELP gs_htmlHelp = 0;
+
+static bool LoadHtmlHelpLibrary()
+{
+ wxPluginLibrary *lib = wxPluginManager::LoadLibrary( _T("HHCTRL.OCX"), wxDL_DEFAULT | wxDL_VERBATIM );
+
+ 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
+ {
+ 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 )
+ {
+ if (wxPluginManager::UnloadLibrary( _T("HHCTRL.OCX") ))
+ gs_htmlHelp = 0;
+ }
+}
static HWND GetSuitableHWND()
{
bool wxCHMHelpController::Initialize(const wxString& filename)
{
+ // warn on failure
+ if( !LoadHtmlHelpLibrary() )
+ 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;
+ gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TOPIC, 0L);
+ return true;
}
// 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);
+ bool isFilename = (section.Find(wxT(".htm")) != wxNOT_FOUND);
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;
+ return true;
}
// 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;
+ gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_HELP_CONTEXT, (DWORD)section);
+ return true;
+}
+
+bool wxCHMHelpController::DisplayContextPopup(int contextId)
+{
+ 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.pszFont = NULL;
+ popup.pszText = NULL;
+
+ gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
+ return true;
+}
+
+bool wxCHMHelpController::DisplayTextPopup(const wxString& text, const wxPoint& pos)
+{
+ 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;
+
+ gs_htmlHelp(GetSuitableHWND(), NULL, HH_DISPLAY_TEXT_POPUP, (DWORD) & popup);
+ return true;
}
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);
link.pszWindow = NULL ;
link.fIndexOnFail = TRUE ;
- HtmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link);
- return TRUE;
+ gs_htmlHelp(GetSuitableHWND(), (const wxChar*) str, HH_KEYWORD_LOOKUP, (DWORD)& link);
+ return true;
}
bool wxCHMHelpController::Quit()
{
- HtmlHelp(GetSuitableHWND(), 0, HH_CLOSE_ALL, 0L);
- return TRUE;
+ gs_htmlHelp(GetSuitableHWND(), 0, HH_CLOSE_ALL, 0L);
+
+ return true;
}
// Append extension if necessary.
return fullName;
}
+wxCHMHelpController::~wxCHMHelpController()
+{
+ UnloadHtmlHelpLibrary();
+}
+
#endif // wxUSE_HELP
+
projects / wxWidgets.git / blobdiff