afcaf277af
the filename lookup and URL handling mechanisms with the soon to be created gtk-xmhtml based alternative. Added wxLocale support to allow different translated help files to be used. Tested (no changes to application required) under Solaris. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1405 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
129 lines
4.3 KiB
C++
129 lines
4.3 KiB
C++
/*-*- c++ -*-********************************************************
|
|
* helphtml.h - base class for html based help controllers *
|
|
* *
|
|
* (C) 1999 by Karsten Ballüder (Ballueder@usa.net) *
|
|
* *
|
|
* $Id$
|
|
*******************************************************************/
|
|
#ifndef WXXHELPHTML_H
|
|
#define WXXHELPHTML_H
|
|
|
|
#if wxUSE_HELP
|
|
|
|
#ifdef __GNUG__
|
|
# pragma interface "helphtml.h"
|
|
#endif
|
|
|
|
#include "wx/helpbase.h"
|
|
|
|
/// Name for map file.
|
|
#define WXEXTHELP_MAPFILE "wxhelp.map"
|
|
/// Path separator.
|
|
#define WXEXTHELP_SEPARATOR '/'
|
|
/// Maximum line length in map file.
|
|
#define WXEXTHELP_BUFLEN 512
|
|
/// Character introducing comments/documentation field in map file.
|
|
#define WXEXTHELP_COMMENTCHAR ';'
|
|
|
|
class wxExtHelpMapList;
|
|
|
|
|
|
/**
|
|
This class is the base class for all html help implementations.
|
|
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 wxHTMLHelpControllerBase : public wxHelpControllerBase
|
|
{
|
|
DECLARE_ABSTRACT_CLASS(wxHTMLHelpControllerBase)
|
|
public:
|
|
wxHTMLHelpControllerBase(void);
|
|
virtual ~wxHTMLHelpControllerBase(void);
|
|
|
|
/** 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
|
|
*/
|
|
virtual bool LoadFile(const wxString& file = "");
|
|
|
|
/** 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 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
|
|
*/
|
|
virtual bool KeywordSearch(const wxString& k);
|
|
|
|
/// does nothing
|
|
virtual bool Quit(void);
|
|
/// does nothing
|
|
virtual void OnQuit(void);
|
|
|
|
/// Call the browser using a relative URL.
|
|
virtual bool DisplayHelp(wxString const &) = 0;
|
|
|
|
protected:
|
|
/// 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;
|
|
/// Deletes the list and all objects.
|
|
void DeleteList(void);
|
|
};
|
|
|
|
#endif
|
|
#endif
|