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