1 /*-*- c++ -*-********************************************************
2 * helpwxht.h - a help controller using wxHTML *
4 * (C) 1999 by Karsten Ballüder (Ballueder@usa.net) *
7 *******************************************************************/
9 #ifndef _WX_HELPWXHT_H_
10 #define _WX_HELPWXHT_H_
16 # pragma interface "helpwxht.h"
19 #include "wx/generic/helphtml.h"
23 This class implements help via wxHTML.
24 It requires the name of a directory containing the documentation
25 and a file mapping numerical Section numbers to relative URLS.
27 The map file contains two or three fields per line:
28 numeric_id relative_URL [; comment/documentation]
30 The numeric_id is the id used to look up the entry in
31 DisplaySection()/DisplayBlock(). The relative_URL is a filename of
32 an html file, relative to the help directory. The optional
33 comment/documentation field (after a ';') is used for keyword
34 searches, so some meaningful text here does not hurt.
35 If the documentation itself contains a ';', only the part before
36 that will be displayed in the listbox, but all of it used for search.
38 Lines starting with ';' will be ignored.
41 class WXDLLEXPORT wxHelpControllerHtml
: public wxHTMLHelpControllerBase
43 DECLARE_CLASS(wxHelpControllerHtml
)
45 wxHelpControllerHtml(void);
46 ~wxHelpControllerHtml(void);
48 /// Allows one to override the default settings for the help frame.
49 virtual void SetFrameParameters(const wxString
&title
,
51 const wxPoint
&pos
= wxDefaultPosition
,
52 bool newFrameEachTime
= FALSE
);
53 /// Obtains the latest settings used by the help frame.
54 virtual wxFrame
* GetFrameParameters(wxSize
*size
= NULL
,
56 bool *newFrameEachTime
= NULL
);
60 /// Call the browser using a relative URL.
61 virtual bool DisplayHelp(const wxString
&);
63 friend class wxHelpFrame
;
64 class wxHelpFrame
*m_Frame
;
65 wxString m_FrameTitle
;
66 wxPoint m_FramePosition
;
68 bool m_NewFrameEachTime
;
75 #endif // _WX_HELPWXHT_H_