include/wx/msw/helpchm.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpchm.h
   3 // Purpose:     Help system: MS HTML Help implementation
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     16/04/2000
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_HELPCHM_H_
  13 #define _WX_HELPCHM_H_
  14
  15 #if wxUSE_MS_HTML_HELP
  16
  17 #include "wx/helpbase.h"
  18
  19 class WXDLLEXPORT wxCHMHelpController : public wxHelpControllerBase
  20 {
  21 public:
  22     wxCHMHelpController(wxWindow* parentWindow = NULL): wxHelpControllerBase(parentWindow) { }
  23     virtual ~wxCHMHelpController();
  24
  25     // Must call this to set the filename
  26     virtual bool Initialize(const wxString& file);
  27     virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); }
  28
  29     // If file is "", reloads file given in Initialize
  30     virtual bool LoadFile(const wxString& file = wxEmptyString);
  31     virtual bool DisplayContents();
  32     virtual bool DisplaySection(int sectionNo);
  33     virtual bool DisplaySection(const wxString& section);
  34     virtual bool DisplayBlock(long blockNo);
  35     virtual bool DisplayContextPopup(int contextId);
  36     virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos);
  37     virtual bool KeywordSearch(const wxString& k,
  38                                wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
  39     virtual bool Quit();
  40
  41     wxString GetHelpFile() const { return m_helpFile; }
  42
  43 protected:
  44     // Append extension if necessary.
  45     wxString GetValidFilename(const wxString& file) const;
  46
  47 protected:
  48     wxString m_helpFile;
  49
  50     DECLARE_CLASS(wxCHMHelpController)
  51 };
  52
  53 #endif // wxUSE_MS_HTML_HELP
  54
  55 #endif
  56 // _WX_HELPCHM_H_