include/wx/os2/helpwin.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpxxxx.h
   3 // Purpose:     Help system: native implementation for your system.
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:      10/09/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_HELPWIN_H_
  13 #define _WX_HELPWIN_H_
  14
  15 #include "wx/wx.h"
  16
  17 #include "wx/helpbase.h"
  18
  19 class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase
  20 {
  21   DECLARE_CLASS(wxWinHelpController)
  22
  23  public:
  24   wxWinHelpController();
  25   ~wxWinHelpController();
  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
  37   virtual bool Quit();
  38   virtual void OnQuit();
  39
  40   inline wxString GetHelpFile() const { return m_helpFile; }
  41
  42 protected:
  43   wxString m_helpFile;
  44 private:
  45     // virtual function hiding supression :: do not use
  46     bool Initialize(const wxString& rFile, int WXUNUSED(nServer) ) { return(Initialize(rFile)); }
  47     bool DisplaySection(const wxString& rSection) { return wxHelpControllerBase::DisplaySection(rSection); }
  48 };
  49
  50 #endif
  51     // _WX_HELPWIN_H_