Now works when derived from wxTextCtrlBase, using wxScrollHelper.

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

diff --git a/src/msw/helpwin.cpp b/src/msw/helpwin.cpp
index 1a376ba5a6dfb7d5725ceca98b86adfb84e80e6a..a65b579e4c765329026518e3c6eadfa25fdf6149 100644 (file)
--- a/src/msw/helpwin.cpp
+++ b/src/msw/helpwin.cpp
@@ -5,14 +5,10 @@
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifdef __GNUG__
-#pragma implementation "helpwin.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -24,9 +20,11 @@
 #include "wx/defs.h"
 #endif
 
+#if wxUSE_HELP
+
+#include "wx/filefn.h"
 #include "wx/msw/helpwin.h"
 
-#if wxUSE_HELP
 #include <time.h>
 
 #ifdef __WXMSW__
@@ -35,126 +33,97 @@
 
 #include <string.h>
 
-// MAX path length
-#define _MAXPATHLEN 500
-
-// MAX length of Help descriptor
-#define _MAX_HELP_LEN 500
-
-#if !USE_SHARED_LIBRARY
-IMPLEMENT_DYNAMIC_CLASS(wxWinHelpController, wxHelpControllerBase)
-#endif
-
-wxWinHelpController::wxWinHelpController(void)
+static HWND GetSuitableHWND()
 {
-  m_helpFile = "";
+    if (wxTheApp->GetTopWindow())
+        return (HWND) wxTheApp->GetTopWindow()->GetHWND();
+    else
+        return GetDesktopWindow();
 }
 
-wxWinHelpController::~wxWinHelpController(void)
-{
-}
+IMPLEMENT_DYNAMIC_CLASS(wxWinHelpController, wxHelpControllerBase)
 
 bool wxWinHelpController::Initialize(const wxString& filename)
 {
-  m_helpFile = filename;
-  return TRUE;
+    m_helpFile = filename;
+    return true;
 }
 
 bool wxWinHelpController::LoadFile(const wxString& file)
 {
-  m_helpFile = file;
-  return TRUE;
+    if (!file.IsEmpty())
+        m_helpFile = file;
+    return true;
 }
 
 bool wxWinHelpController::DisplayContents(void)
 {
-    if (m_helpFile == wxT("")) return FALSE;
+    if (m_helpFile.IsEmpty()) return false;
 
-    wxString str = m_helpFile;
-    size_t len = str.Length();
-    if (!(str[(size_t)(len-1)] == wxT('p') && str[(size_t)(len-2)] == wxT('l') && str[(size_t)(len-3)] == wxT('h') && str[(size_t)(len-4)] == wxT('.')))
-      str += wxT(".hlp");
+    wxString str = GetValidFilename(m_helpFile);
 
-    if (wxTheApp->GetTopWindow())
-    {
 #if defined(__WIN95__)
-      WinHelp((HWND) wxTheApp->GetTopWindow()->GetHWND(), (const wxChar*) str, HELP_FINDER, 0L);
+    return (WinHelp(GetSuitableHWND(), (const wxChar*) str, HELP_FINDER, 0L) != 0);
 #else
-      WinHelp((HWND) wxTheApp->GetTopWindow()->GetHWND(), (const wxChar*) str, HELP_CONTENTS, 0L);
+    return (WinHelp(GetSuitableHWND(), (const wxChar*) str, HELP_CONTENTS, 0L) != 0);
 #endif
-     return TRUE;
-    }
-       return FALSE;
 }
 
 bool wxWinHelpController::DisplaySection(int section)
 {
     // Use context number
-    if (m_helpFile == wxT("")) return FALSE;
+    if (m_helpFile.IsEmpty()) return false;
 
-    wxString str = m_helpFile;
-    size_t len = str.Length();
-    if (!(str[(size_t)(len-1)] == wxT('p') && str[(size_t)(len-2)] == wxT('l') && str[(size_t)(len-3)] == wxT('h') && str[(size_t)(len-4)] == wxT('.')))
-      str += wxT(".hlp");
+    wxString str = GetValidFilename(m_helpFile);
 
-    if (wxTheApp->GetTopWindow())
-       {
-      WinHelp((HWND) wxTheApp->GetTopWindow()->GetHWND(), (const wxChar*) str, HELP_CONTEXT, (DWORD)section);
-      return TRUE;
-       }
-    return FALSE;
+    return (WinHelp((HWND) wxTheApp->GetTopWindow()->GetHWND(), (const wxChar*) str, HELP_CONTEXT, (DWORD)section) != 0);
 }
 
-bool wxWinHelpController::DisplayBlock(long block)
+bool wxWinHelpController::DisplayContextPopup(int contextId)
 {
-    // Use context number -- a very rough equivalent to block id!
-    if (m_helpFile == wxT("")) return FALSE;
+    if (m_helpFile.IsEmpty()) return false;
 
-    wxString str = m_helpFile;
-    size_t len = str.Length();
-    if (!(str[(size_t)(len-1)] == 'p' && str[(size_t)(len-2)] == 'l' && str[(size_t)(len-3)] == 'h' && str[(size_t)(len-4)] == '.'))
-      str += wxT(".hlp");
+    wxString str = GetValidFilename(m_helpFile);
 
-    if (wxTheApp->GetTopWindow())
-       {
-      WinHelp((HWND) wxTheApp->GetTopWindow()->GetHWND(), (const wxChar*) str, HELP_CONTEXT, (DWORD)block);
-      return TRUE;
-       }
-    return FALSE;
+    return (WinHelp((HWND) wxTheApp->GetTopWindow()->GetHWND(), (const wxChar*) str, HELP_CONTEXTPOPUP, (DWORD) contextId) != 0);
 }
 
-bool wxWinHelpController::KeywordSearch(const wxString& k)
+bool wxWinHelpController::DisplayBlock(long block)
 {
-    if (m_helpFile == wxT("")) return FALSE;
+    DisplaySection(block);
+    return true;
+}
 
-    wxString str = m_helpFile;
-    size_t len = str.Length();
-    if (!(str[(size_t)(len-1)] == wxT('p') && str[(size_t)(len-2)] == wxT('l') && str[(size_t)(len-3)] == wxT('h') && str[(size_t)(len-4)] == wxT('.')))
-      str += wxT(".hlp");
+bool wxWinHelpController::KeywordSearch(const wxString& k,
+                                        wxHelpSearchMode WXUNUSED(mode))
+{
+    if (m_helpFile.IsEmpty()) return false;
 
-    if (wxTheApp->GetTopWindow())
-    {
-      WinHelp((HWND) wxTheApp->GetTopWindow()->GetHWND(), (const wxChar*) str, HELP_PARTIALKEY, (DWORD)(const wxChar*) k);
-      return TRUE;
-    }
-    return FALSE;
+    wxString str = GetValidFilename(m_helpFile);
+
+    return (WinHelp(GetSuitableHWND(), (const wxChar*) str, HELP_PARTIALKEY, (DWORD)(const wxChar*) k) != 0);
 }
 
 // Can't close the help window explicitly in WinHelp
 bool wxWinHelpController::Quit(void)
 {
-  if (wxTheApp->GetTopWindow())
-  {
-    WinHelp((HWND) wxTheApp->GetTopWindow()->GetHWND(), 0, HELP_QUIT, 0L);
-    return TRUE;
-  }
-  else
-    return FALSE;
+    return (WinHelp(GetSuitableHWND(), 0, HELP_QUIT, 0L) != 0);
 }
 
-// Don't get notified of WinHelp quitting
-void wxWinHelpController::OnQuit(void)
+// Append extension if necessary.
+wxString wxWinHelpController::GetValidFilename(const wxString& file) const
 {
+    wxString path, name, ext;
+    wxSplitPath(file, & path, & name, & ext);
+
+    wxString fullName;
+    if (path.IsEmpty())
+        fullName = name + wxT(".hlp");
+    else if (path.Last() == wxT('\\'))
+        fullName = path + name + wxT(".hlp");
+    else
+        fullName = path + wxT("\\") + name + wxT(".hlp");
+    return fullName;
 }
 
 #endif // wxUSE_HELP