helpwin.h 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. /////////////////////////////////////////////////////////////////////////////
  2. // Name: wx/os2/helpwin.h
  3. // Purpose: Help system: native implementation for your system.
  4. // Author: David Webster
  5. // Modified by:
  6. // Created: 10/09/99
  7. // Copyright: (c) David Webster
  8. // Licence: wxWindows licence
  9. /////////////////////////////////////////////////////////////////////////////
  10. #ifndef _WX_HELPWIN_H_
  11. #define _WX_HELPWIN_H_
  12. #include "wx/wx.h"
  13. #if wxUSE_HELP
  14. #include "wx/helpbase.h"
  15. class WXDLLIMPEXP_CORE wxWinHelpController: public wxHelpControllerBase
  16. {
  17. DECLARE_CLASS(wxWinHelpController)
  18. public:
  19. wxWinHelpController();
  20. virtual ~wxWinHelpController();
  21. // Must call this to set the filename and server name
  22. virtual bool Initialize(const wxString& file);
  23. // If file is "", reloads file given in Initialize
  24. virtual bool LoadFile(const wxString& file = wxEmptyString);
  25. virtual bool DisplayContents();
  26. virtual bool DisplaySection(int sectionNo);
  27. virtual bool DisplayBlock(long blockNo);
  28. virtual bool KeywordSearch(const wxString& k,
  29. wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
  30. virtual bool Quit();
  31. virtual void OnQuit();
  32. inline wxString GetHelpFile() const { return m_helpFile; }
  33. protected:
  34. wxString m_helpFile;
  35. private:
  36. // virtual function hiding supression :: do not use
  37. bool Initialize(const wxString& rFile, int WXUNUSED(nServer) ) { return(Initialize(rFile)); }
  38. bool DisplaySection(const wxString& rSection) { return wxHelpControllerBase::DisplaySection(rSection); }
  39. };
  40. #endif //wxUSE_HELP
  41. #endif
  42. // _WX_HELPWIN_H_