X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/afcaf277afb7a5f9f31cfd6c425dd9c3a68dd2ba..cd25b18c8e7e8d77b1a5847f289afec6e114fbd5:/include/wx/generic/helphtml.h?ds=inline diff --git a/include/wx/generic/helphtml.h b/include/wx/generic/helphtml.h index 05bfbd947f..647d54549c 100644 --- a/include/wx/generic/helphtml.h +++ b/include/wx/generic/helphtml.h @@ -5,8 +5,9 @@ * * * $Id$ *******************************************************************/ -#ifndef WXXHELPHTML_H -#define WXXHELPHTML_H + +#ifndef __WX_HELPHTML_H_ +#define __WX_HELPHTML_H_ #if wxUSE_HELP @@ -19,13 +20,17 @@ /// 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. #define WXEXTHELP_COMMENTCHAR ';' -class wxExtHelpMapList; +class WXDLLEXPORT wxExtHelpMapList; /** @@ -47,8 +52,8 @@ class wxExtHelpMapList; Lines starting with ';' will be ignored. */ -class wxHTMLHelpControllerBase : public wxHelpControllerBase -{ +class WXDLLEXPORT wxHTMLHelpControllerBase : public wxHelpControllerBase +{ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase) public: wxHTMLHelpControllerBase(void); @@ -67,7 +72,7 @@ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase) */ virtual bool Initialize(const wxString& dir, int WXUNUSED(server)) { return Initialize(dir); } - + /** This must be called to tell the controller where to find the documentation. If a locale is set, look in file/localename, i.e. @@ -79,7 +84,7 @@ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase) @return true on success */ virtual bool Initialize(const wxString& dir); - + /** If file is "", reloads file given in Initialize. @file Name of help directory. @return true on success @@ -113,6 +118,22 @@ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase) /// Call the browser using a relative URL. virtual bool DisplayHelp(wxString const &) = 0; + /// Allows one to override the default settings for the help frame. + virtual void SetFrameParameters(const wxString &title, + const wxSize &size, + const wxPoint &pos = wxDefaultPosition, + bool newFrameEachTime = FALSE) + { + // does nothing by default + } + /// Obtains the latest settings used by the help frame. + virtual void GetFrameParameters(wxSize *size = NULL, + wxPoint *pos = NULL, + bool *newFrameEachTime = NULL) + { + // does nothing by default + } + protected: /// Filename of currently active map file. wxString m_MapFile; @@ -124,5 +145,6 @@ DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase) void DeleteList(void); }; -#endif -#endif +#endif // wxUSE_HELP + +#endif // __WX_HELPHTML_H_