]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/hthlpfrm.tex
documented Harm's changes to wxHTML help
[wxWidgets.git] / docs / latex / wx / hthlpfrm.tex
1 %
2 % automatically generated by HelpGen from
3 % helpfrm.h at 24/Oct/99 18:03:10
4 %
5
6
7 \section{\class{wxHtmlHelpFrame}}\label{wxhtmlhelpframe}
8
9 This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
10 to display help.
11 It is internal class and should not be used directly - except for the case
12 you're writing your own HTML help controller.
13
14
15 \wxheading{Derived from}
16
17 \helpref{wxFrame}{wxframe}
18
19 \latexignore{\rtfignore{\wxheading{Members}}}
20
21
22
23 \membersection{wxHtmlHelpFrame::wxHtmlHelpFrame}\label{wxhtmlhelpframewxhtmlhelpframe}
24
25 \func{}{wxHtmlHelpFrame}{\param{wxHtmlHelpData* }{data = NULL}}
26
27 \func{}{wxHtmlHelpFrame}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}, \param{wxHtmlHelpData* }{data = NULL}}
28
29 Constructor.
30
31 {\it style} is combination of these flags:
32
33 \begin{twocollist}
34 \twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
35 \twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
36 \twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
37 \twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
38 \end{twocollist}
39
40
41 \membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate}
42
43 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}}
44
45 Creates the frame.
46
47 {\it style} is combination of these flags:
48
49 \begin{twocollist}
50 \twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
51 \twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
52 \twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
53 \twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
54 \end{twocollist}
55
56
57
58 \membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
59
60 \func{void}{CreateContents}{\param{bool }{show\_progress = FALSE}}
61
62 Creates contents panel. (May take some time.)
63
64
65 \membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
66
67 \func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}}
68
69 Creates index panel. (May take some time.)
70
71
72 \membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch}
73
74 \func{void}{CreateSearch}{\void}
75
76 Creates search panel.
77
78
79 \membersection{wxHtmlHelpFrame::Display}\label{wxhtmlhelpframedisplay}
80
81 \func{bool}{Display}{\param{const wxString\& }{x}}
82
83 \func{bool}{Display}{\param{const int }{id}}
84
85 Displays page x. If not found it will offect the user a choice of
86 searching books.
87 Looking for the page runs in these steps:
88 1. try to locate file named x (if x is for example "doc/howto.htm")
89 2. try to open starting page of book x
90 3. try to find x in contents (if x is for example "How To ...")
91 4. try to find x in index (if x is for example "How To ...")
92
93 The second form takes numeric ID as the parameter.
94 (uses extension to MS format, <param name="ID" value=id>)
95
96 \membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents}
97
98 \func{bool}{DisplayContents}{\void}
99
100 Displays contents panel.
101
102 \membersection{wxHtmlHelpFrame::DisplayIndex}\label{wxhtmlhelpframedisplayindex}
103
104 \func{bool}{DisplayIndex}{\void}
105
106 Displays index panel.
107
108
109 \membersection{wxHtmlHelpFrame::GetData}\label{wxhtmlhelpframegetdata}
110
111 \func{wxHtmlHelpData*}{GetData}{\void}
112
113 Return wxHtmlHelpData object.
114
115 \membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch}
116
117 \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
118
119 Search for given keyword.
120
121
122 \membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
123
124 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
125
126 Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
127
128 \membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
129
130 \func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}}
131
132 Refresh all panels. This is neccessary if new book was added.
133
134 \membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat}
135
136 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
137
138 Sets frame's title format. {\it format} must contain exactly one "\%s"
139 (it will be replaced by page's title).
140
141 \membersection{wxHtmlHelpFrame::UseConfig}\label{wxhtmlhelpframeuseconfig}
142
143 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
144
145 Add books to search choice panel
146
147
148 \membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization}
149
150 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
151
152 Saves user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization})
153
154