]> git.saurik.com Git - wxWidgets.git/blob - include/wx/generic/helpwxht.h
warning fix
[wxWidgets.git] / include / wx / generic / helpwxht.h
1 /*-*- c++ -*-********************************************************
2 * helpwxht.h - a help controller using wxHTML *
3 * *
4 * (C) 1999 by Karsten Ballüder (Ballueder@usa.net) *
5 * *
6 * $Id$
7 *******************************************************************/
8
9 #ifndef _WX_HELPWXHT_H_
10 #define _WX_HELPWXHT_H_
11
12 #if wxUSE_HELP
13 #if wxUSE_HTML
14
15 #ifdef __GNUG__
16 # pragma interface "helpwxht.h"
17 #endif
18
19 #include "wx/generic/helphtml.h"
20
21
22 /**
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.
26
27 The map file contains two or three fields per line:
28 numeric_id relative_URL [; comment/documentation]
29
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.
37
38 Lines starting with ';' will be ignored.
39 */
40
41 class WXDLLEXPORT wxHelpControllerHtml : public wxHTMLHelpControllerBase
42 {
43 DECLARE_CLASS(wxHelpControllerHtml)
44 public:
45 wxHelpControllerHtml(void);
46 ~wxHelpControllerHtml(void);
47
48 /// Allows one to override the default settings for the help frame.
49 virtual void SetFrameParameters(const wxString &title,
50 const wxSize &size,
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,
55 wxPoint *pos = NULL,
56 bool *newFrameEachTime = NULL);
57
58
59 private:
60 /// Call the browser using a relative URL.
61 virtual bool DisplayHelp(const wxString &);
62 protected:
63 friend class wxHelpFrame;
64 class wxHelpFrame *m_Frame;
65 wxString m_FrameTitle;
66 wxPoint m_FramePosition;
67 wxSize m_FrameSize;
68 bool m_NewFrameEachTime;
69 size_t m_offset;
70 };
71
72 #endif // wxUSE_HELP
73 #endif // wxUSE_HTML
74
75 #endif // _WX_HELPWXHT_H_