// Purpose: interface of wxExtHelpController
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxExtHelpController
- @wxheader{help.h}
This class implements help via an external browser.
It requires the name of a directory containing the documentation
@see wxHelpController
*/
-class wxExtHelpController : public wxHelpController
+class wxExtHelpController : public wxHelpControllerBase
{
public:
wxExtHelpController(wxWindow* parentWindow = NULL);
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.
@return @true on success
*/
- virtual bool DisplayContents(void);
+ virtual bool DisplayContents();
/**
Display help for id sectionNo.
@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
*/
/**
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.