include/wx/osx/helpxxxx.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/osx/helpxxxx.h
   3 // Purpose:     Help system: native implementation for your system. Replace
   4 //              XXXX with suitable name.
   5 // Author:      Stefan Csomor
   6 // Modified by:
   7 // Created:     1998-01-01
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_HELPXXXX_H_
  13 #define _WX_HELPXXXX_H_
  14
  15 #include "wx/wx.h"
  16
  17 #include "wx/helpbase.h"
  18
  19 class WXDLLIMPEXP_CORE wxXXXXHelpController: public wxHelpControllerBase
  20 {
  21   DECLARE_CLASS(wxXXXXHelpController)
  22
  23  public:
  24   wxXXXXHelpController();
  25   virtual ~wxXXXXHelpController();
  26
  27   // Must call this to set the filename and server name
  28   virtual bool Initialize(const wxString& file);
  29
  30   // If file is "", reloads file given  in Initialize
  31   virtual bool LoadFile(const wxString& file = "");
  32   virtual bool DisplayContents();
  33   virtual bool DisplaySection(int sectionNo);
  34   virtual bool DisplayBlock(long blockNo);
  35   virtual bool KeywordSearch(const wxString& k,
  36                              wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
  37
  38   virtual bool Quit();
  39   virtual void OnQuit();
  40
  41   inline wxString GetHelpFile() const { return m_helpFile; }
  42
  43 protected:
  44   wxString m_helpFile;
  45 };
  46
  47 #endif
  48     // _WX_HELPXXXX_H_