X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/generic/helpext.h?ds=sidebyside diff --git a/interface/wx/generic/helpext.h b/interface/wx/generic/helpext.h index 72b08a5121..2ad0ebc377 100644 --- a/interface/wx/generic/helpext.h +++ b/interface/wx/generic/helpext.h @@ -2,8 +2,7 @@ // Name: helpext.h // Purpose: interface of wxExtHelpController // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -32,7 +31,7 @@ @see wxHelpController */ -class wxExtHelpController : public wxHelpController +class wxExtHelpController : public wxHelpControllerBase { public: wxExtHelpController(wxWindow* parentWindow = NULL); @@ -52,22 +51,6 @@ public: virtual void SetViewer(const wxString& viewer = wxEmptyString, long flags = wxHELP_NETSCAPE); - /** - This must be called to tell the controller where to find the - documentation. - If a locale is set, look in file/localename, i.e. - If passed "/usr/local/myapp/help" and the current wxLocale is - set to be "de", then look in "/usr/local/myapp/help/de/" - first and fall back to "/usr/local/myapp/help" if that - doesn't exist. - - @param file - NOT a filename, but a directory name. - - @return @true on success - */ - virtual bool Initialize(const wxString& dir, int server); - /** This must be called to tell the controller where to find the documentation. @@ -99,7 +82,7 @@ public: @return @true on success */ - virtual bool DisplayContents(void); + virtual bool DisplayContents(); /** Display help for id sectionNo. @@ -128,6 +111,10 @@ public: @param k string to search for, empty string will list all entries + + @param mode + optional parameter allows the search the index (wxHELP_SEARCH_INDEX) + but this currently only supported by the wxHtmlHelpController. @return @true on success */ @@ -147,12 +134,12 @@ public: /** Call the browser using a relative URL. */ - virtual bool DisplayHelp(const wxString &) ; + virtual bool DisplayHelp(const wxString& relativeURL) ; /** Allows one to override the default settings for the help frame. */ - virtual void SetFrameParameters(const wxString& title, + virtual void SetFrameParameters(const wxString& titleFormat, const wxSize& size, const wxPoint& pos = wxDefaultPosition, bool newFrameEachTime = false);