include/wx/mac/carbon/helpxxxx.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 // RCS-ID:      $Id$
   9 // Copyright:   (c) Stefan Csomor
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 #ifndef _WX_HELPXXXX_H_
  14 #define _WX_HELPXXXX_H_
  15
  16 #include "wx/wx.h"
  17
  18 #include "wx/helpbase.h"
  19
  20 class WXDLLEXPORT wxXXXXHelpController: public wxHelpControllerBase
  21 {
  22   DECLARE_CLASS(wxXXXXHelpController)
  23
  24  public:
  25   wxXXXXHelpController();
  26   ~wxXXXXHelpController();
  27
  28   // Must call this to set the filename and server name
  29   virtual bool Initialize(const wxString& file);
  30
  31   // If file is "", reloads file given  in Initialize
  32   virtual bool LoadFile(const wxString& file = "");
  33   virtual bool DisplayContents();
  34   virtual bool DisplaySection(int sectionNo);
  35   virtual bool DisplayBlock(long blockNo);
  36   virtual bool KeywordSearch(const wxString& k,
  37                              wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
  38
  39   virtual bool Quit();
  40   virtual void OnQuit();
  41
  42   inline wxString GetHelpFile() const { return m_helpFile; }
  43
  44 protected:
  45   wxString m_helpFile;
  46 };
  47
  48 #endif
  49     // _WX_HELPXXXX_H_