include/wx/stubs/helpxxxx.h

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