include/wx/helpbase.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        helpbase.h
   3 // Purpose:     Help system base classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_HELPBASEH__
  13 #define _WX_HELPBASEH__
  14
  15 #ifdef __GNUG__
  16 #pragma interface "helpbase.h"
  17 #endif
  18
  19 #include "wx/wx.h"
  20
  21 #if wxUSE_HELP
  22
  23 // Flags for SetViewer
  24 #define wxHELP_NETSCAPE     1
  25
  26 // Defines the API for help controllers
  27 class WXDLLEXPORT wxHelpControllerBase: public wxObject
  28 {
  29   DECLARE_CLASS(wxHelpControllerBase)
  30
  31  public:
  32   inline wxHelpControllerBase(void) {}
  33   inline ~wxHelpControllerBase(void) {};
  34
  35   // Must call this to set the filename and server name.
  36   // server is only required when implementing TCP/IP-based
  37   // help controllers.
  38   virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return FALSE; };
  39   virtual bool Initialize(const wxString& file) = 0;
  40
  41   // Set viewer: only relevant to some kinds of controller
  42   virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
  43
  44   // If file is "", reloads file given  in Initialize
  45   virtual bool LoadFile(const wxString& file = "") = 0;
  46   virtual bool DisplayContents(void) = 0;
  47   virtual bool DisplaySection(int sectionNo) = 0;
  48   virtual bool DisplayBlock(long blockNo) = 0;
  49   virtual bool KeywordSearch(const wxString& k) = 0;
  50
  51   virtual bool Quit(void) = 0;
  52   virtual void OnQuit(void) {};
  53 };
  54
  55
  56 /* By default, if wxHTML is compiled in, use the
  57    wxHelpControllerHtml. If not, use the external help controller. */
  58 #if wxUSE_HTML
  59 #   include "wx/generic/helpwxht.h"
  60 #   define wxHelpController wxHelpControllerHtml
  61 #   define sm_classwxHelpController sm_classwxHelpControllerHtml
  62 #else
  63 #   include "wx/generic/helpext.h"
  64 #   define wxHelpController wxExtHelpController
  65 #   define sm_classwxHelpController sm_classwxExtHelpController
  66 #endif
  67
  68
  69 #endif // wxUSE_HELP
  70 #endif
  71     // _WX_HELPBASEH__