#if wxUSE_HELP
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
# pragma interface "helphtml.h"
#endif
#include "wx/helpbase.h"
+#include "wx/frame.h"
-/// Name for map file.
-#define WXEXTHELP_MAPFILE "wxhelp.map"
/// Path separator.
-#define WXEXTHELP_SEPARATOR '/'
-/// Maximum line length in map file.
-#define WXEXTHELP_BUFLEN 512
-/// Character introducing comments/documentation field in map file.
-#define WXEXTHELP_COMMENTCHAR ';'
+#ifdef __WXMSW__
+#define WXEXTHELP_SEPARATOR _T('\\')
+#elif defined(__WXMAC__)
+#define WXEXTHELP_SEPARATOR _T(':')
+#else
+#define WXEXTHELP_SEPARATOR _T('/')
+#endif
class WXDLLEXPORT wxExtHelpMapList;
/** 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 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.