home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / wxos2240.zip / wxWindows-2.4.0 / include / wx / os2 / helpwin.h < prev    next >
C/C++ Source or Header  |  2000-10-25  |  2KB  |  56 lines
  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: HELPWIN.H,v 1.4 2000/10/25 04:18:04 dwebster Exp $
  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. #if wxUSE_HELP
  18.  
  19. #include "wx/helpbase.h"
  20.  
  21. class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase
  22. {
  23.   DECLARE_CLASS(wxWinHelpController)
  24.  
  25.  public:
  26.   wxWinHelpController();
  27.   ~wxWinHelpController();
  28.  
  29.   // Must call this to set the filename and server name
  30.   virtual bool Initialize(const wxString& file);
  31.  
  32.   // If file is "", reloads file given  in Initialize
  33.   virtual bool LoadFile(const wxString& file = "");
  34.   virtual bool DisplayContents();
  35.   virtual bool DisplaySection(int sectionNo);
  36.   virtual bool DisplayBlock(long blockNo);
  37.   virtual bool KeywordSearch(const wxString& k);
  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. private:
  47.     // virtual function hiding supression :: do not use
  48.     bool Initialize(const wxString& rFile, int WXUNUSED(nServer) ) { return(Initialize(rFile)); }
  49.     bool DisplaySection(const wxString& rSection) { return wxHelpControllerBase::DisplaySection(rSection); }
  50. };
  51.  
  52. #endif //wxUSE_HELP
  53.  
  54. #endif
  55.     // _WX_HELPWIN_H_
  56.