X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/88ac883a0d005437c97a60d8195bd5e4719b1154..14dd645ee16eb022afb19f35d0c8cfdf2d3cdee9:/include/wx/generic/helphtml.h diff --git a/include/wx/generic/helphtml.h b/include/wx/generic/helphtml.h index dc16448f21..44a5cbc4a2 100644 --- a/include/wx/generic/helphtml.h +++ b/include/wx/generic/helphtml.h @@ -16,11 +16,16 @@ #endif #include "wx/helpbase.h" +#include "wx/frame.h" /// Name for map file. #define WXEXTHELP_MAPFILE "wxhelp.map" /// Path separator. +#ifdef __WXMSW__ +#define WXEXTHELP_SEPARATOR '\\' +#else #define WXEXTHELP_SEPARATOR '/' +#endif /// Maximum line length in map file. #define WXEXTHELP_BUFLEN 512 /// Character introducing comments/documentation field in map file. @@ -98,6 +103,10 @@ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase) /** 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. @@ -112,7 +121,24 @@ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase) 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.