made AdjustForParentClientOrigin const

[wxWidgets.git] / include / wx / helpbase.h

diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h
index 24557948d1654a1a8b751ab23cf2277b479feb48..0fd1148aa32c89191ccf5af1936d5abfed2cb242 100644 (file)
--- a/include/wx/helpbase.h
+++ b/include/wx/helpbase.h
@@ -9,42 +9,85 @@
 // Licence:    wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __HELPBASEH__
-#define __HELPBASEH__
+#ifndef _WX_HELPBASEH__
+#define _WX_HELPBASEH__
 
 #ifdef __GNUG__
 #pragma interface "helpbase.h"
 #endif
 
-#include "wx/wx.h"
+#include "wx/defs.h"
 
-#if USE_HELP
+#if wxUSE_HELP
+
+#include "wx/object.h"
+#include "wx/string.h"
+#include "wx/gdicmn.h"
+#include "wx/frame.h"
+
+// Flags for SetViewer
+#define wxHELP_NETSCAPE     1
 
 // Defines the API for help controllers
 class WXDLLEXPORT wxHelpControllerBase: public wxObject
 {
-  DECLARE_CLASS(wxHelpControllerBase)
-
- public:
-  inline wxHelpControllerBase(void) {}
-  inline ~wxHelpControllerBase(void) {};
-
-  // Must call this to set the filename and server name.
-  // server is only required when implementing TCP/IP-based
-  // help controllers.
-  virtual bool Initialize(const wxString& file, int server = -1) = 0;
-
-  // If file is "", reloads file given  in Initialize
-  virtual bool LoadFile(const wxString& file = "") = 0;
-  virtual bool DisplayContents(void) = 0;
-  virtual bool DisplaySection(int sectionNo) = 0;
-  virtual bool DisplayBlock(long blockNo) = 0;
-  virtual bool KeywordSearch(const wxString& k) = 0;
-
-  virtual bool Quit(void) = 0;
-  virtual void OnQuit(void) {};
+    DECLARE_CLASS(wxHelpControllerBase)
+
+public:
+    inline wxHelpControllerBase() {}
+    inline ~wxHelpControllerBase() {};
+
+    // Must call this to set the filename and server name.
+    // server is only required when implementing TCP/IP-based
+    // help controllers.
+    virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return FALSE; }
+    virtual bool Initialize(const wxString& WXUNUSED(file)) { return FALSE; }
+
+    // Set viewer: only relevant to some kinds of controller
+    virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
+
+    // If file is "", reloads file given  in Initialize
+    virtual bool LoadFile(const wxString& file = "") = 0;
+
+    // Displays the contents
+    virtual bool DisplayContents(void) = 0;
+
+    // Display the given section
+    virtual bool DisplaySection(int sectionNo) = 0;
+
+    // Display the section using a context id
+    virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return FALSE; };
+
+    // Display the text in a popup, if possible
+    virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return FALSE; };
+
+    // By default, uses KeywordSection to display a topic. Implementations
+    // may override this for more specific behaviour.
+    virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); };
+    virtual bool DisplayBlock(long blockNo) = 0;
+    virtual bool KeywordSearch(const wxString& k) = 0;
+    /// Allows one to override the default settings for the help frame.
+    virtual void SetFrameParameters(const wxString& WXUNUSED(title),
+        const wxSize& WXUNUSED(size),
+        const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
+        bool WXUNUSED(newFrameEachTime) = FALSE)
+    {
+        // does nothing by default
+    }
+    /// Obtains the latest settings used by the help frame and the help
+    /// frame.
+    virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
+        wxPoint *WXUNUSED(pos) = NULL,
+        bool *WXUNUSED(newFrameEachTime) = NULL)
+    {
+        return (wxFrame*) NULL;// does nothing by default
+    }
+
+    virtual bool Quit(void) = 0;
+    virtual void OnQuit(void) {};
 };
 
-#endif // USE_HELP
+#endif // wxUSE_HELP
+
 #endif
-    // __HELPBASEH__
+// _WX_HELPBASEH__