OSX adaptions

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

diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h
index 97e42f6e9a43d9d803173822ad3653d6085ebe91..9a924fd38e2c607d5c1b78cc1a1dfd1aa17b7383 100644 (file)
--- a/include/wx/helpbase.h
+++ b/include/wx/helpbase.h
@@ -1,110 +1,105 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        helpbase.h
+// Name:        wx/helpbase.h
 // Purpose:     Help system base classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     04/01/98
-// RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_HELPBASEH__
 #define _WX_HELPBASEH__
 
-#ifdef __GNUG__
-#pragma interface "helpbase.h"
-#endif
-
 #include "wx/defs.h"
+
+#if wxUSE_HELP
+
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
 #include "wx/frame.h"
 
-#if wxUSE_HELP
-
 // Flags for SetViewer
 #define wxHELP_NETSCAPE     1
 
+// Search modes:
+enum wxHelpSearchMode
+{
+    wxHELP_SEARCH_INDEX,
+    wxHELP_SEARCH_ALL
+};
+
 // Defines the API for help controllers
-class WXDLLEXPORT wxHelpControllerBase: public wxObject
+class WXDLLIMPEXP_CORE wxHelpControllerBase: public wxObject
 {
-    DECLARE_CLASS(wxHelpControllerBase)
-        
 public:
-    inline wxHelpControllerBase() {}
-    inline ~wxHelpControllerBase() {};
-    
+    inline wxHelpControllerBase(wxWindow* parentWindow = NULL) { m_parentWindow = parentWindow; }
+    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; }
-    
+    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;
+    virtual bool LoadFile(const wxString& file = wxEmptyString) = 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 DisplaySection(const wxString& section) { return KeywordSearch(section); }
     virtual bool DisplayBlock(long blockNo) = 0;
-    virtual bool KeywordSearch(const wxString& k) = 0;
+    virtual bool KeywordSearch(const wxString& k,
+                               wxHelpSearchMode mode = wxHELP_SEARCH_ALL) = 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)
+        bool WXUNUSED(newFrameEachTime) = false)
     {
         // does nothing by default
     }
-    /// Obtains the latest settings used by the help frame and the help 
+    /// 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
+        return NULL; // does nothing by default
     }
-    
-    virtual bool Quit(void) = 0;
-    virtual void OnQuit(void) {};
-};
 
-/*
- * wxContextHelp
- * Invokes context-sensitive help. When the user
- * clicks on a window, a wxEVT_HELP event will be sent to that
- * window for the application to display help for.
- */
+    virtual bool Quit() = 0;
+    virtual void OnQuit() {}
 
-class WXDLLEXPORT wxContextHelp: public wxObject
-{
-    DECLARE_DYNAMIC_CLASS(wxContextHelp)
-public:
-    wxContextHelp(wxWindow* win = NULL, bool beginHelp = TRUE);
-    ~wxContextHelp();
+    /// Set the window that can optionally be used for the help window's parent.
+    virtual void SetParentWindow(wxWindow* win) { m_parentWindow = win; }
 
-    bool BeginContextHelp(wxWindow* win);
-    bool EndContextHelp();
-
-    bool EventLoop(const wxCursor& cursor, wxWindow* win);
-    bool DispatchEvent(wxWindow* win, const wxPoint& pt);
-
-#ifdef __WXMSW__
-    bool ProcessHelpMessage(WXMSG* wxmsg, const wxCursor& cursor, wxWindow* win);
-#endif
+    /// Get the window that can optionally be used for the help window's parent.
+    virtual wxWindow* GetParentWindow() const { return m_parentWindow; }
 
 protected:
-
-    bool    m_inHelp;
+    wxWindow* m_parentWindow;
+private:
+    DECLARE_CLASS(wxHelpControllerBase)
 };
 
 #endif // wxUSE_HELP
+
 #endif
 // _WX_HELPBASEH__