include/wx/msw/wince/helpwce.h

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