include/wx/helpbase.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/helpbase.h
   3 // Purpose:     Help system base classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // Copyright:   (c) Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_HELPBASEH__
  12 #define _WX_HELPBASEH__
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_HELP
  17
  18 #include "wx/object.h"
  19 #include "wx/string.h"
  20 #include "wx/gdicmn.h"
  21 #include "wx/frame.h"
  22
  23 // Flags for SetViewer
  24 #define wxHELP_NETSCAPE     1
  25
  26 // Search modes:
  27 enum wxHelpSearchMode
  28 {
  29     wxHELP_SEARCH_INDEX,
  30     wxHELP_SEARCH_ALL
  31 };
  32
  33 // Defines the API for help controllers
  34 class WXDLLIMPEXP_CORE wxHelpControllerBase: public wxObject
  35 {
  36 public:
  37     inline wxHelpControllerBase(wxWindow* parentWindow = NULL) { m_parentWindow = parentWindow; }
  38     inline ~wxHelpControllerBase() {}
  39
  40     // Must call this to set the filename and server name.
  41     // server is only required when implementing TCP/IP-based
  42     // help controllers.
  43     virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return false; }
  44     virtual bool Initialize(const wxString& WXUNUSED(file)) { return false; }
  45
  46     // Set viewer: only relevant to some kinds of controller
  47     virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
  48
  49     // If file is "", reloads file given  in Initialize
  50     virtual bool LoadFile(const wxString& file = wxEmptyString) = 0;
  51
  52     // Displays the contents
  53     virtual bool DisplayContents(void) = 0;
  54
  55     // Display the given section
  56     virtual bool DisplaySection(int sectionNo) = 0;
  57
  58     // Display the section using a context id
  59     virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return false; }
  60
  61     // Display the text in a popup, if possible
  62     virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return false; }
  63
  64     // By default, uses KeywordSection to display a topic. Implementations
  65     // may override this for more specific behaviour.
  66     virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }
  67     virtual bool DisplayBlock(long blockNo) = 0;
  68     virtual bool KeywordSearch(const wxString& k,
  69                                wxHelpSearchMode mode = wxHELP_SEARCH_ALL) = 0;
  70     /// Allows one to override the default settings for the help frame.
  71     virtual void SetFrameParameters(const wxString& WXUNUSED(title),
  72         const wxSize& WXUNUSED(size),
  73         const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
  74         bool WXUNUSED(newFrameEachTime) = false)
  75     {
  76         // does nothing by default
  77     }
  78     /// Obtains the latest settings used by the help frame and the help
  79     /// frame.
  80     virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
  81         wxPoint *WXUNUSED(pos) = NULL,
  82         bool *WXUNUSED(newFrameEachTime) = NULL)
  83     {
  84         return NULL; // does nothing by default
  85     }
  86
  87     virtual bool Quit() = 0;
  88     virtual void OnQuit() {}
  89
  90     /// Set the window that can optionally be used for the help window's parent.
  91     virtual void SetParentWindow(wxWindow* win) { m_parentWindow = win; }
  92
  93     /// Get the window that can optionally be used for the help window's parent.
  94     virtual wxWindow* GetParentWindow() const { return m_parentWindow; }
  95
  96 protected:
  97     wxWindow* m_parentWindow;
  98 private:
  99     DECLARE_CLASS(wxHelpControllerBase)
 100 };
 101
 102 #endif // wxUSE_HELP
 103
 104 #endif
 105 // _WX_HELPBASEH__