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 defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16 #pragma interface "helpchm.h"
  17 #endif
  18
  19 #if wxUSE_MS_HTML_HELP
  20
  21 #include "wx/helpbase.h"
  22
  23 class WXDLLEXPORT wxCHMHelpController : public wxHelpControllerBase
  24 {
  25 public:
  26     wxCHMHelpController() { }
  27     virtual ~wxCHMHelpController();
  28
  29     // Must call this to set the filename
  30     virtual bool Initialize(const wxString& file);
  31     virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); }
  32
  33     // If file is "", reloads file given in Initialize
  34     virtual bool LoadFile(const wxString& file = wxEmptyString);
  35     virtual bool DisplayContents();
  36     virtual bool DisplaySection(int sectionNo);
  37     virtual bool DisplaySection(const wxString& section);
  38     virtual bool DisplayBlock(long blockNo);
  39     virtual bool DisplayContextPopup(int contextId);
  40     virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos);
  41     virtual bool KeywordSearch(const wxString& k,
  42                                wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
  43     virtual bool Quit();
  44
  45     wxString GetHelpFile() const { return m_helpFile; }
  46
  47 protected:
  48     // Append extension if necessary.
  49     wxString GetValidFilename(const wxString& file) const;
  50
  51 protected:
  52     wxString m_helpFile;
  53
  54     DECLARE_CLASS(wxCHMHelpController)
  55 };
  56
  57 #endif // wxUSE_MS_HTML_HELP
  58
  59 #endif
  60 // _WX_HELPCHM_H_