1998-11-10 16:17:35 -05:00
|
|
|
|
/*-*- c++ -*-********************************************************
|
2004-11-22 15:28:28 -05:00
|
|
|
|
* helpext.h - an external help controller for wxWidgets *
|
1998-11-10 16:17:35 -05:00
|
|
|
|
* *
|
|
|
|
|
* (C) 1998 by Karsten Ball<EFBFBD>der (Ballueder@usa.net) *
|
2004-11-22 15:28:28 -05:00
|
|
|
|
* License: wxWindows licence *
|
1998-11-10 16:17:35 -05:00
|
|
|
|
* *
|
|
|
|
|
* $Id$
|
|
|
|
|
*******************************************************************/
|
1999-06-01 11:32:12 -04:00
|
|
|
|
|
|
|
|
|
#ifndef __WX_HELPEXT_H_
|
|
|
|
|
#define __WX_HELPEXT_H_
|
1998-11-10 16:17:35 -05:00
|
|
|
|
|
|
|
|
|
#if wxUSE_HELP
|
|
|
|
|
|
2003-05-24 07:20:39 -04:00
|
|
|
|
#include "wx/helpbase.h"
|
|
|
|
|
|
1998-11-10 16:17:35 -05:00
|
|
|
|
#ifndef WXEXTHELP_DEFAULTBROWSER
|
|
|
|
|
/// Default browser name.
|
2002-01-28 11:03:50 -05:00
|
|
|
|
# define WXEXTHELP_DEFAULTBROWSER _T("netscape")
|
1998-11-10 16:17:35 -05:00
|
|
|
|
/// Is default browse a variant of netscape?
|
2004-06-17 12:22:36 -04:00
|
|
|
|
# define WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE true
|
1998-11-10 16:17:35 -05:00
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
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.
|
|
|
|
|
*/
|
|
|
|
|
|
2003-08-01 21:04:55 -04:00
|
|
|
|
class WXDLLIMPEXP_ADV wxExtHelpController : public wxHelpControllerBase
|
2004-06-17 12:22:36 -04:00
|
|
|
|
{
|
2006-03-27 12:28:51 -05:00
|
|
|
|
public:
|
2005-10-26 05:32:10 -04:00
|
|
|
|
wxExtHelpController(wxWindow* parentWindow = NULL);
|
2003-05-24 07:20:39 -04:00
|
|
|
|
~wxExtHelpController();
|
1998-11-10 16:17:35 -05:00
|
|
|
|
|
|
|
|
|
/** 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
|
2004-06-17 12:22:36 -04:00
|
|
|
|
window.
|
1998-11-10 16:17:35 -05:00
|
|
|
|
@param browsername The command to call a browser/html viewer.
|
2004-06-17 12:22:36 -04:00
|
|
|
|
@param isNetscape Set this to true if the browser is some variant of Netscape.
|
1998-11-10 16:17:35 -05:00
|
|
|
|
*/
|
1999-02-18 09:55:34 -05:00
|
|
|
|
// Obsolete form
|
2003-05-24 07:20:39 -04:00
|
|
|
|
void SetBrowser(const wxString & browsername = WXEXTHELP_DEFAULTBROWSER,
|
1998-11-10 16:17:35 -05:00
|
|
|
|
bool isNetscape = WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE);
|
1999-02-18 09:55:34 -05:00
|
|
|
|
|
|
|
|
|
// Set viewer: new name for SetBrowser
|
|
|
|
|
virtual void SetViewer(const wxString& viewer = WXEXTHELP_DEFAULTBROWSER, long flags = wxHELP_NETSCAPE);
|
|
|
|
|
|
2003-05-24 07:20:39 -04:00
|
|
|
|
/** 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 WXUNUSED(server))
|
|
|
|
|
{ return Initialize(dir); }
|
|
|
|
|
|
|
|
|
|
/** 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 dir - directory name where to fine the help files
|
|
|
|
|
@return true on success
|
|
|
|
|
*/
|
|
|
|
|
virtual bool Initialize(const wxString& dir);
|
|
|
|
|
|
|
|
|
|
/** If file is "", reloads file given in Initialize.
|
|
|
|
|
@file Name of help directory.
|
|
|
|
|
@return true on success
|
|
|
|
|
*/
|
2004-06-17 12:22:36 -04:00
|
|
|
|
virtual bool LoadFile(const wxString& file = wxEmptyString);
|
2003-05-24 07:20:39 -04:00
|
|
|
|
|
|
|
|
|
/** Display list of all help entries.
|
|
|
|
|
@return true on success
|
|
|
|
|
*/
|
|
|
|
|
virtual bool DisplayContents(void);
|
|
|
|
|
/** Display help for id sectionNo.
|
|
|
|
|
@return true on success
|
|
|
|
|
*/
|
|
|
|
|
virtual bool DisplaySection(int sectionNo);
|
|
|
|
|
/** Display help for id sectionNo -- identical with DisplaySection().
|
|
|
|
|
@return true on success
|
|
|
|
|
*/
|
|
|
|
|
virtual bool DisplaySection(const wxString& section);
|
|
|
|
|
/** Display help for URL (using DisplayHelp) or keyword (using KeywordSearch)
|
|
|
|
|
@return true on success
|
|
|
|
|
*/
|
|
|
|
|
virtual bool DisplayBlock(long blockNo);
|
|
|
|
|
/** Search comment/documentation fields in map file and present a
|
|
|
|
|
list to chose from.
|
|
|
|
|
@key k string to search for, empty string will list all entries
|
|
|
|
|
@return true on success
|
|
|
|
|
*/
|
2003-09-19 19:53:56 -04:00
|
|
|
|
virtual bool KeywordSearch(const wxString& k,
|
|
|
|
|
wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
|
2003-05-24 07:20:39 -04:00
|
|
|
|
|
|
|
|
|
/// does nothing
|
|
|
|
|
virtual bool Quit(void);
|
|
|
|
|
/// does nothing
|
|
|
|
|
virtual void OnQuit(void);
|
|
|
|
|
|
|
|
|
|
/// Call the browser using a relative URL.
|
|
|
|
|
virtual bool DisplayHelp(const wxString &) ;
|
|
|
|
|
|
|
|
|
|
/// 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,
|
2004-06-17 12:22:36 -04:00
|
|
|
|
bool WXUNUSED(newFrameEachTime) = false)
|
2003-05-24 07:20:39 -04:00
|
|
|
|
{
|
|
|
|
|
// does nothing by default
|
|
|
|
|
}
|
2004-06-17 12:22:36 -04:00
|
|
|
|
/// Obtains the latest settings used by the help frame and the help
|
2003-05-24 07:20:39 -04:00
|
|
|
|
/// frame.
|
|
|
|
|
virtual wxFrame *GetFrameParameters(wxSize *WXUNUSED(size) = NULL,
|
|
|
|
|
wxPoint *WXUNUSED(pos) = NULL,
|
|
|
|
|
bool *WXUNUSED(newFrameEachTime) = NULL)
|
|
|
|
|
{
|
|
|
|
|
return (wxFrame*) NULL;// does nothing by default
|
|
|
|
|
}
|
|
|
|
|
|
2006-03-27 12:28:51 -05:00
|
|
|
|
protected:
|
2003-05-24 07:20:39 -04:00
|
|
|
|
/// Filename of currently active map file.
|
|
|
|
|
wxString m_MapFile;
|
|
|
|
|
/// How many entries do we have in the map file?
|
|
|
|
|
int m_NumOfEntries;
|
|
|
|
|
/// A list containing all id,url,documentation triples.
|
|
|
|
|
wxList *m_MapList;
|
2006-03-27 12:28:51 -05:00
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
// parse a single line of the map file (called by LoadFile())
|
|
|
|
|
//
|
|
|
|
|
// return true if the line was valid or false otherwise
|
|
|
|
|
bool ParseMapFileLine(const wxString& line);
|
|
|
|
|
|
2003-05-24 07:20:39 -04:00
|
|
|
|
/// Deletes the list and all objects.
|
|
|
|
|
void DeleteList(void);
|
|
|
|
|
|
2006-03-27 12:28:51 -05:00
|
|
|
|
|
1998-11-10 16:17:35 -05:00
|
|
|
|
/// How to call the html viewer.
|
|
|
|
|
wxString m_BrowserName;
|
|
|
|
|
/// Is the viewer a variant of netscape?
|
|
|
|
|
bool m_BrowserIsNetscape;
|
2006-03-27 12:28:51 -05:00
|
|
|
|
|
|
|
|
|
DECLARE_CLASS(wxExtHelpController)
|
1998-11-10 16:17:35 -05:00
|
|
|
|
};
|
|
|
|
|
|
1999-06-01 11:32:12 -04:00
|
|
|
|
#endif // wxUSE_HELP
|
|
|
|
|
|
|
|
|
|
#endif // __WX_HELPEXT_H_
|