X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e179bd6537b8e3d7543d23db3b6735ea7effe159..65e4e78efb62104d4d0f9ac32e3fff24f9c14b6e:/include/wx/helpbase.h diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h index 0230cfb1c3..9479573ecb 100644 --- a/include/wx/helpbase.h +++ b/include/wx/helpbase.h @@ -20,6 +20,7 @@ #include "wx/object.h" #include "wx/string.h" #include "wx/gdicmn.h" +#include "wx/frame.h" #if wxUSE_HELP @@ -38,8 +39,8 @@ class WXDLLEXPORT wxHelpControllerBase: public wxObject // 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) {} @@ -50,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) {};