]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/hthlpfrm.tex
added wxFileType::GetMimeTypes
[wxWidgets.git] / docs / latex / wx / hthlpfrm.tex
CommitLineData
09397bc6
VS
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
9This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
10to display help.
b32c6ff0 11It is internal class and should not be used directly - except for the case
09397bc6
VS
12you'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
29Constructor.
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.}
c914a1a2 38\twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{Help frame has bookmarks controls.}
09397bc6
VS
39\end{twocollist}
40
41
42\membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate}
43
44\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULTSTYLE}}
45
46Creates the frame.
47
48{\it style} is combination of these flags:
49
50\begin{twocollist}
51\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
52\twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
53\twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
54\twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
55\end{twocollist}
56
57
58
59\membersection{wxHtmlHelpFrame::CreateContents}\label{wxhtmlhelpframecreatecontents}
60
61\func{void}{CreateContents}{\param{bool }{show\_progress = FALSE}}
62
63Creates contents panel. (May take some time.)
64
65
66\membersection{wxHtmlHelpFrame::CreateIndex}\label{wxhtmlhelpframecreateindex}
67
68\func{void}{CreateIndex}{\param{bool }{show\_progress = FALSE}}
69
70Creates index panel. (May take some time.)
71
72
73\membersection{wxHtmlHelpFrame::CreateSearch}\label{wxhtmlhelpframecreatesearch}
74
75\func{void}{CreateSearch}{\void}
76
77Creates search panel.
78
79
80\membersection{wxHtmlHelpFrame::Display}\label{wxhtmlhelpframedisplay}
81
82\func{bool}{Display}{\param{const wxString\& }{x}}
83
84\func{bool}{Display}{\param{const int }{id}}
85
86Displays page x. If not found it will offect the user a choice of
87searching books.
88Looking for the page runs in these steps:
891. try to locate file named x (if x is for example "doc/howto.htm")
902. try to open starting page of book x
913. try to find x in contents (if x is for example "How To ...")
924. try to find x in index (if x is for example "How To ...")
93
94The second form takes numeric ID as the parameter.
95(uses extension to MS format, <param name="ID" value=id>)
96
b32c6ff0
RD
97\pythonnote{The second form of this method is named DisplayId in
98wxPython.}
99
09397bc6
VS
100\membersection{wxHtmlHelpFrame::DisplayContents}\label{wxhtmlhelpframedisplaycontents}
101
102\func{bool}{DisplayContents}{\void}
103
104Displays contents panel.
105
106\membersection{wxHtmlHelpFrame::DisplayIndex}\label{wxhtmlhelpframedisplayindex}
107
108\func{bool}{DisplayIndex}{\void}
109
110Displays index panel.
111
112
113\membersection{wxHtmlHelpFrame::GetData}\label{wxhtmlhelpframegetdata}
114
115\func{wxHtmlHelpData*}{GetData}{\void}
116
117Return wxHtmlHelpData object.
118
119\membersection{wxHtmlHelpFrame::KeywordSearch}\label{wxhtmlhelpframekeywordsearch}
120
121\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
122
123Search for given keyword.
124
125
126\membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
127
128\func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
129
130Reads user's settings for this frame (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
131
132\membersection{wxHtmlHelpFrame::RefreshLists}\label{wxhtmlhelpframerefreshlists}
133
134\func{void}{RefreshLists}{\param{bool }{show\_progress = FALSE}}
135
136Refresh all panels. This is neccessary if new book was added.
137
138\membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat}
139
140\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
141
142Sets frame's title format. {\it format} must contain exactly one "\%s"
143(it will be replaced by page's title).
144
145\membersection{wxHtmlHelpFrame::UseConfig}\label{wxhtmlhelpframeuseconfig}
146
147\func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
148
149Add books to search choice panel
150
151
152\membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization}
153
154\func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
155
156Saves user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization})
157
158
b854b7b8
VS
159\membersection{wxHtmlHelpFrame::AddToolbarButtons}\label{wxhtmlhelpframeaddtoolbarbuttons}
160
161\func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}}
162
163You may override this virtual method to add more buttons into help frame's
164toolbar. {\it toolBar} is pointer to the toolbar and {\it style} is style
165flag as passed to Create method.
166
167wxToolBar::Realize is called immediately after returning from this function.
168
169See {\it samples/html/helpview} for an example.