X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/29ea4a290850e9ae79c258774fa22153a951ff7f..a6aa9b1ee8aaecdf0ca4618c2e6cccfb011f4599:/include/wx/helpbase.h?ds=sidebyside diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h index 2594d10f46..9479573ecb 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,14 +33,14 @@ 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 // help controllers. - virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return FALSE; }; - virtual bool Initialize(const wxString& file) = 0; + virtual bool Initialize(const wxString& WXUNUSED(file), int WXUNUSED(server) ) { return FALSE; } + virtual bool Initialize(const wxString& WXUNUSED(file)) { return FALSE; } // Set viewer: only relevant to some kinds of controller virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {} @@ -47,6 +51,22 @@ 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& 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 + } virtual bool Quit(void) = 0; virtual void OnQuit(void) {}; @@ -54,7 +74,10 @@ class WXDLLEXPORT wxHelpControllerBase: public wxObject /* By default, if wxHTML is compiled in, use the - wxHelpControllerHtml. If not, use the external help controller. */ + 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 @@ -64,7 +87,7 @@ class WXDLLEXPORT wxHelpControllerBase: public wxObject # define wxHelpController wxExtHelpController # define sm_classwxHelpController sm_classwxExtHelpController #endif - +#endif // wxMSW #endif // wxUSE_HELP #endif