Added reparenting helper classes to help apps to grab the windows

[wxWidgets.git] / include / wx / generic / helphtml.h

diff --git a/include/wx/generic/helphtml.h b/include/wx/generic/helphtml.h
index 83c87fd1a13e8091d9b5314e5063ff20f3ef1664..2386ee1c288cc2f12c39a73e2c24dbfe2d81085e 100644 (file)
--- a/include/wx/generic/helphtml.h
+++ b/include/wx/generic/helphtml.h
@@ -16,19 +16,16 @@
 #endif
 
 #include "wx/helpbase.h"
 #endif
 
 #include "wx/helpbase.h"

+#include "wx/frame.h"

 
 

-/// Name for map file.
-#define WXEXTHELP_MAPFILE   "wxhelp.map"

 /// Path separator.
 #ifdef __WXMSW__
 /// Path separator.
 #ifdef __WXMSW__

-#define WXEXTHELP_SEPARATOR '\\'
+#define WXEXTHELP_SEPARATOR _T('\\')
+#elif defined(__WXMAC__)
+#define WXEXTHELP_SEPARATOR _T(':')

 #else
 #else

-#define WXEXTHELP_SEPARATOR '/'
+#define WXEXTHELP_SEPARATOR _T('/')

 #endif
 #endif

-/// Maximum line length in map file.
-#define WXEXTHELP_BUFLEN 512
-/// Character introducing comments/documentation field in map file.
-#define WXEXTHELP_COMMENTCHAR   ';'

 
 class WXDLLEXPORT wxExtHelpMapList;
 
 
 class WXDLLEXPORT wxExtHelpMapList;
 


@@ -102,6 +99,10 @@ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase)
    /** Display help for id sectionNo -- identical with DisplaySection().
        @return true on success
    */
    /** Display help for id sectionNo -- identical with DisplaySection().
        @return true on success
    */

+   virtual bool DisplaySection(const wxString& section);
+   /** Display help for URL (using DisplayHelp) or keyword (using KeywordSearch)
+       @return true on success
+   */

    virtual bool DisplayBlock(long blockNo);
    /** Search comment/documentation fields in map file and present a
        list to chose from.
    virtual bool DisplayBlock(long blockNo);
    /** Search comment/documentation fields in map file and present a
        list to chose from.


@@ -116,7 +117,24 @@ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase)
    virtual void OnQuit(void);
 
    /// Call the browser using a relative URL.
    virtual void OnQuit(void);
 
    /// Call the browser using a relative URL.

-   virtual bool DisplayHelp(wxString const &) = 0;
+   virtual bool DisplayHelp(const wxString &) = 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
+      }

 
  protected:
    /// Filename of currently active map file.
 
  protected:
    /// Filename of currently active map file.