X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/33b64e6f8b7cf372a569e61d7eee879217945043..ed58dbeab64d18a0f869ea8e1610a0a88ad7b22c:/include/wx/helpbase.h diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h index b93771f806..32ed2987b0 100644 --- a/include/wx/helpbase.h +++ b/include/wx/helpbase.h @@ -16,7 +16,11 @@ #pragma interface "helpbase.h" #endif -#include "wx/wx.h" +#include "wx/defs.h" +#include "wx/object.h" +#include "wx/string.h" +#include "wx/gdicmn.h" +#include "wx/frame.h" #if wxUSE_HELP @@ -29,8 +33,8 @@ class WXDLLEXPORT wxHelpControllerBase: public wxObject DECLARE_CLASS(wxHelpControllerBase) public: - inline wxHelpControllerBase(void) {} - inline ~wxHelpControllerBase(void) {}; + inline wxHelpControllerBase() {} + inline ~wxHelpControllerBase() {}; // Must call this to set the filename and server name. // server is only required when implementing TCP/IP-based @@ -47,11 +51,44 @@ class WXDLLEXPORT wxHelpControllerBase: public wxObject virtual bool DisplaySection(int sectionNo) = 0; virtual bool DisplayBlock(long blockNo) = 0; virtual bool KeywordSearch(const wxString& k) = 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 and the help + /// frame. + virtual wxFrame *GetFrameParameters(wxSize *size = NULL, + wxPoint *pos = NULL, + bool *newFrameEachTime = NULL) + { + return (wxFrame*) NULL;// does nothing by default + } virtual bool Quit(void) = 0; virtual void OnQuit(void) {}; }; + +/* By default, if wxHTML is compiled in, use the + wxHelpControllerHtml. If not, use the external help controller. + (of course, we shouldn't do it for wxMSW) +*/ +#ifndef __WXMSW__ +#if wxUSE_HTML +# include "wx/generic/helpwxht.h" +# define wxHelpController wxHelpControllerHtml +# define sm_classwxHelpController sm_classwxHelpControllerHtml +#else +# include "wx/generic/helpext.h" +# define wxHelpController wxExtHelpController +# define sm_classwxHelpController sm_classwxExtHelpController +#endif +#endif // wxMSW + #endif // wxUSE_HELP #endif // _WX_HELPBASEH__