/*-*- c++ -*-********************************************************
- * helpext.h - an external help controller for wxWindows *
+ * helpext.h - an external help controller for wxWidgets *
* *
* (C) 1998 by Karsten Ballüder (Ballueder@usa.net) *
+ * License: wxWindows licence *
* *
* $Id$
*******************************************************************/
#if wxUSE_HELP
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-# pragma interface "wxexthlp.h"
-#endif
-
#include "wx/helpbase.h"
/// Path separator.
/// Default browser name.
# define WXEXTHELP_DEFAULTBROWSER _T("netscape")
/// Is default browse a variant of netscape?
-# define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE TRUE
+# define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE true
#endif
/**
*/
class WXDLLIMPEXP_ADV wxExtHelpController : public wxHelpControllerBase
-{
+{
DECLARE_CLASS(wxExtHelpController)
public:
- wxExtHelpController();
+ wxExtHelpController(wxWindow* parentWindow = NULL);
~wxExtHelpController();
/** Tell it which browser to use.
The Netscape support will check whether Netscape is already
running (by looking at the .netscape/lock file in the user's
home directory) and tell it to load the page into the existing
- window.
+ window.
@param browsername The command to call a browser/html viewer.
- @param isNetscape Set this to TRUE if the browser is some variant of Netscape.
+ @param isNetscape Set this to true if the browser is some variant of Netscape.
*/
// Obsolete form
void SetBrowser(const wxString & browsername = WXEXTHELP_DEFAULTBROWSER,
@file Name of help directory.
@return true on success
*/
- virtual bool LoadFile(const wxString& file = wxT(""));
+ virtual bool LoadFile(const wxString& file = wxEmptyString);
/** Display list of all help entries.
@return true on success
@key k string to search for, empty string will list all entries
@return true on success
*/
- virtual bool KeywordSearch(const wxString& k);
+ virtual bool KeywordSearch(const wxString& k,
+ wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
/// does nothing
virtual bool Quit(void);
virtual void SetFrameParameters(const wxString& WXUNUSED(title),
const wxSize& WXUNUSED(size),
const wxPoint& WXUNUSED(pos) = wxDefaultPosition,
- bool WXUNUSED(newFrameEachTime) = FALSE)
+ bool WXUNUSED(newFrameEachTime) = false)
{
// does nothing by default
}
- /// Obtains the latest settings used by the help frame and the help
+ /// Obtains the latest settings used by the help frame and the help
/// frame.
virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
wxPoint *WXUNUSED(pos) = NULL,