include/wx/msw/wince/helpwce.h

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