29ea4a2908
wxExtHelpController and fully backwards compatible with the "old" help controller. Docs follow tomorrow. Modified sample to use it if wxHTML is compiled in. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@3035 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
83 lines
3.0 KiB
C++
83 lines
3.0 KiB
C++
/*-*- c++ -*-********************************************************
|
|
* helpext.h - an external help controller for wxWindows *
|
|
* *
|
|
* (C) 1998 by Karsten Ballüder (Ballueder@usa.net) *
|
|
* *
|
|
* $Id$
|
|
*******************************************************************/
|
|
|
|
#ifndef __WX_HELPEXT_H_
|
|
#define __WX_HELPEXT_H_
|
|
|
|
#if wxUSE_HELP
|
|
|
|
#ifdef __GNUG__
|
|
# pragma interface "wxexthlp.h"
|
|
#endif
|
|
|
|
#include "wx/generic/helphtml.h"
|
|
|
|
#ifndef WXEXTHELP_DEFAULTBROWSER
|
|
/// Default browser name.
|
|
# define WXEXTHELP_DEFAULTBROWSER "netscape"
|
|
/// Is default browse a variant of netscape?
|
|
# define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE TRUE
|
|
#endif
|
|
/// Name of environment variable to set help browser.
|
|
#define WXEXTHELP_ENVVAR_BROWSER "WX_HELPBROWSER"
|
|
/// Is browser a netscape browser?
|
|
#define WXEXTHELP_ENVVAR_BROWSERISNETSCAPE "WX_HELPBROWSER_NS"
|
|
|
|
/**
|
|
This class implements help via an external browser.
|
|
It requires the name of a directory containing the documentation
|
|
and a file mapping numerical Section numbers to relative URLS.
|
|
|
|
The map file contains two or three fields per line:
|
|
numeric_id relative_URL [; comment/documentation]
|
|
|
|
The numeric_id is the id used to look up the entry in
|
|
DisplaySection()/DisplayBlock(). The relative_URL is a filename of
|
|
an html file, relative to the help directory. The optional
|
|
comment/documentation field (after a ';') is used for keyword
|
|
searches, so some meaningful text here does not hurt.
|
|
If the documentation itself contains a ';', only the part before
|
|
that will be displayed in the listbox, but all of it used for search.
|
|
|
|
Lines starting with ';' will be ignored.
|
|
*/
|
|
|
|
class WXDLLEXPORT wxExtHelpController : public wxHTMLHelpControllerBase
|
|
{
|
|
DECLARE_CLASS(wxExtHelpController)
|
|
public:
|
|
wxExtHelpController(void);
|
|
|
|
/** 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.
|
|
@param browsername The command to call a browser/html viewer.
|
|
@param isNetscape Set this to TRUE if the browser is some variant of Netscape.
|
|
*/
|
|
// Obsolete form
|
|
void SetBrowser(wxString const & browsername = WXEXTHELP_DEFAULTBROWSER,
|
|
bool isNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE);
|
|
|
|
// Set viewer: new name for SetBrowser
|
|
virtual void SetViewer(const wxString& viewer = WXEXTHELP_DEFAULTBROWSER, long flags = wxHELP_NETSCAPE);
|
|
|
|
private:
|
|
/// How to call the html viewer.
|
|
wxString m_BrowserName;
|
|
/// Is the viewer a variant of netscape?
|
|
bool m_BrowserIsNetscape;
|
|
/// Call the browser using a relative URL.
|
|
virtual bool DisplayHelp(wxString const &);
|
|
};
|
|
|
|
#endif // wxUSE_HELP
|
|
|
|
#endif // __WX_HELPEXT_H_
|