Beginning of wxDataViewTreeStore API

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

diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h
index 0fd1148aa32c89191ccf5af1936d5abfed2cb242..614ccae69dce55f9dddf3e5ee8f095839e3d7c4c 100644 (file)
--- a/include/wx/helpbase.h
+++ b/include/wx/helpbase.h
@@ -5,17 +5,13 @@
 // Modified by:
 // Created:     04/01/98
 // RCS-ID:      $Id$
 // 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__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_HELPBASEH__
 #define _WX_HELPBASEH__
 

-#ifdef __GNUG__
-#pragma interface "helpbase.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_HELP
 #include "wx/defs.h"
 
 #if wxUSE_HELP


@@ -28,26 +24,31 @@
 // Flags for SetViewer
 #define wxHELP_NETSCAPE     1
 
 // 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
 {
 // Defines the API for help controllers
 class WXDLLEXPORT wxHelpControllerBase: public wxObject
 {

-    DECLARE_CLASS(wxHelpControllerBase)
-

 public:
 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.
 
     // 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
 
     // 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;
 
     // Displays the contents
     virtual bool DisplayContents(void) = 0;


@@ -56,21 +57,22 @@ public:
     virtual bool DisplaySection(int sectionNo) = 0;
 
     // Display the section using a context id
     virtual bool DisplaySection(int sectionNo) = 0;
 
     // Display the section using a context id

-    virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return FALSE; };
+    virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return false; }

 
     // Display the text in a popup, if possible
 
     // Display the text in a popup, if possible

-    virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return FALSE; };
+    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.
 
     // 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 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,
     /// 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
     }
     {
         // does nothing by default
     }


@@ -80,11 +82,22 @@ public:
         wxPoint *WXUNUSED(pos) = NULL,
         bool *WXUNUSED(newFrameEachTime) = NULL)
     {
         wxPoint *WXUNUSED(pos) = NULL,
         bool *WXUNUSED(newFrameEachTime) = NULL)
     {

-        return (wxFrame*) NULL;// does nothing by default
+        return (wxFrame*) NULL; // does nothing by default

     }
 
     }
 

-    virtual bool Quit(void) = 0;
-    virtual void OnQuit(void) {};
+    virtual bool Quit() = 0;
+    virtual void OnQuit() {}
+
+    /// Set the window that can optionally be used for the help window's parent.
+    virtual void SetParentWindow(wxWindow* win) { m_parentWindow = win; }
+
+    /// Get the window that can optionally be used for the help window's parent.
+    virtual wxWindow* GetParentWindow() const { return m_parentWindow; }
+
+protected:
+    wxWindow* m_parentWindow;
+private:
+    DECLARE_CLASS(wxHelpControllerBase)

 };
 
 #endif // wxUSE_HELP
 };
 
 #endif // wxUSE_HELP