]> git.saurik.com Git - wxWidgets.git/blame_incremental - samples/help/doc/wxExtHelpController.html
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
more wxFD_XXX renamings (patch 1488371)
[wxWidgets.git] / samples / help / doc / wxExtHelpController.html
... / ...
CommitLineData
1<html><head><TITLE>wxExtHelpController</TITLE></head>
2<body>
3<H2><A HREF ="#DOC.DOCU" > <IMG BORDER=0 SRC=down.gif></A> class wxExtHelpController </H2><BLOCKQUOTE>
4
5This class implements help via an external browser
6</BLOCKQUOTE>
7<hr>
8
9<DL>
10<DL>
11<DT><h3>Public Methods</h3><DD><DT><A HREF="#DOC.8.6"> <IMG BORDER=0 SRC=icon1.gif></A> virtual bool <B>DisplayBlock</B>(long blockNo) </B>
12 <DD><I>Display help for id sectionNo -- identical with DisplaySection()</I>
13<DT><A HREF="#DOC.8.4"> <IMG BORDER=0 SRC=icon1.gif></A> virtual bool <B>DisplayContents</B>(void) </B>
14 <DD><I>Display list of all help entries</I>
15<DT><A HREF="#DOC.8.5"> <IMG BORDER=0 SRC=icon1.gif></A> virtual bool <B>DisplaySection</B>(int sectionNo) </B>
16 <DD><I>Display help for id sectionNo</I>
17<DT><A HREF="#DOC.8.1"> <IMG BORDER=0 SRC=icon1.gif></A> virtual bool <B>Initialize</B>(const wxString&amp; file, int WXUNUSED(server)) </B>
18 <DD><I>This must be called to tell the controller where to find the
19documentation</I>
20<DT><A HREF="#DOC.8.2"> <IMG BORDER=0 SRC=icon1.gif></A> virtual bool <B>Initialize</B>(const wxString&amp; file) </B>
21 <DD><I>This must be called to tell the controller where to find the
22documentation</I>
23<DT><A HREF="#DOC.8.7"> <IMG BORDER=0 SRC=icon1.gif></A> virtual bool <B>KeywordSearch</B>(const wxString&amp; k) </B>
24 <DD><I>Search comment/documentation fields in map file and present a
25list to chose from</I>
26<DT><A HREF="#DOC.8.3"> <IMG BORDER=0 SRC=icon1.gif></A> virtual bool <B>LoadFile</B>(const wxString&amp; file = "") </B>
27 <DD><I>If file is "", reloads file given in Initialize</I>
28<DT><A HREF="#DOC.8.10"> <IMG BORDER=0 SRC=icon1.gif></A> virtual void <B>OnQuit</B>(void) </B>
29 <DD><I>does nothing</I>
30<DT><A HREF="#DOC.8.9"> <IMG BORDER=0 SRC=icon1.gif></A> virtual bool <B>Quit</B>(void) </B>
31 <DD><I>does nothing</I>
32<DT><A HREF="#DOC.8.8"> <IMG BORDER=0 SRC=icon1.gif></A> void <B>SetBrowser</B>(wxString const &amp; browsername = <!2><A HREF="#DOC.4">WXEXTHELP_DEFAULTBROWSER</A>, bool isNetscape = <!2><A HREF="#DOC.5">WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE</A>) </B>
33 <DD><I>Tell it which browser to use</I>
34</DL><DL>
35<DT><h3>Private Fields</h3><DD><DT><A HREF="#DOC.8.15"> <IMG BORDER=0 SRC=icon1.gif></A> bool <B>m_BrowserIsNetscape</B> </B>
36 <DD><I>Is the viewer a variant of netscape?</I>
37<DT><A HREF="#DOC.8.14"> <IMG BORDER=0 SRC=icon1.gif></A> wxString <B>m_BrowserName</B> </B>
38 <DD><I>How to call the html viewer</I>
39<DT><A HREF="#DOC.8.11"> <IMG BORDER=0 SRC=icon1.gif></A> wxString <B>m_MapFile</B> </B>
40 <DD><I>Filename of currently active map file</I>
41<DT><A HREF="#DOC.8.13"> <IMG BORDER=0 SRC=icon1.gif></A> wxExtHelpMapList* <B>m_MapList</B> </B>
42 <DD><I>A list containing all id,url,documentation triples</I>
43<DT><A HREF="#DOC.8.12"> <IMG BORDER=0 SRC=icon1.gif></A> int <B>m_NumOfEntries</B> </B>
44 <DD><I>How many entries do we have in the map file?</I>
45</DL><DL>
46<DT><h3>Private Methods</h3><DD><DT><A HREF="#DOC.8.16"> <IMG BORDER=0 SRC=icon1.gif></A> bool <B>CallBrowser</B>(wxString const &amp;) </B>
47 <DD><I>Call the browser using a relative URL</I>
48</DL></DL>
49<A NAME="DOC.DOCU">
50<hr>
51 <h2> Documentation </h2>
52<BLOCKQUOTE>
53
54This class implements help via an external browser.
55It requires the name of a directory containing the documentation
56and a file mapping numerical Section numbers to relative URLS.<P>The map file contains two or three fields per line:
57numeric_id relative_URL [; comment/documentation]<P>The numeric_id is the id used to look up the entry in
58DisplaySection()/DisplayBlock(). The relative_URL is a filename of
59an html file, relative to the help directory. The optional
60comment/documentation field (after a ';') is used for keyword
61searches, so some meaningful text here does not hurt.
62If the documentation itself contains a ';', only the part before
63that will be displayed in the listbox, but all of it used for search.<P>Lines starting with ';' will be ignored.<P>This confuses DOC++, so I leave it out for now:
64<TT>ifdef USE_HELP</TT>: public wxHelpControllerBase
65{
66DECLARE_CLASS(wxExtHelpController)
67<TT>else</TT>{
68<TT>endif
69
70</BLOCKQUOTE>
71<DL>
72
73<A NAME="Initialize">
74<A NAME ="DOC.8.1">
75<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual bool Initialize(const wxString&amp; file, int WXUNUSED(server))</B></TT>
76<DD>This must be called to tell the controller where to find the
77documentation
78<DL><DT><B>Returns:</B><DD>true on success
79<DT><B>Parameters:</B><DD><B>file</B> - - NOT a filename, but a directory name.
80<br></DL><P>
81<A NAME="Initialize">
82<A NAME ="DOC.8.2">
83<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual bool Initialize(const wxString&amp; file)</B></TT>
84<DD>This must be called to tell the controller where to find the
85documentation
86<DL><DT><B>Returns:</B><DD>true on success
87<DT><B>Parameters:</B><DD><B>file</B> - - NOT a filename, but a directory name.
88<br></DL><P>
89<A NAME="LoadFile">
90<A NAME ="DOC.8.3">
91<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual bool LoadFile(const wxString&amp; file = "")</B></TT>
92<DD>If file is "", reloads file given in Initialize.
93@file Name of help directory.
94
95<DL><DT><B>Returns:</B><DD>true on success
96</DL><P>
97<A NAME="DisplayContents">
98<A NAME ="DOC.8.4">
99<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual bool DisplayContents(void)</B></TT>
100<DD>Display list of all help entries
101<DL><DT><B>Returns:</B><DD>true on success
102</DL><P>
103<A NAME="DisplaySection">
104<A NAME ="DOC.8.5">
105<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual bool DisplaySection(int sectionNo)</B></TT>
106<DD>Display help for id sectionNo
107<DL><DT><B>Returns:</B><DD>true on success
108</DL><P>
109<A NAME="DisplayBlock">
110<A NAME ="DOC.8.6">
111<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual bool DisplayBlock(long blockNo)</B></TT>
112<DD>Display help for id sectionNo -- identical with DisplaySection()
113<DL><DT><B>Returns:</B><DD>true on success
114</DL><P>
115<A NAME="KeywordSearch">
116<A NAME ="DOC.8.7">
117<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual bool KeywordSearch(const wxString&amp; k)</B></TT>
118<DD>Search comment/documentation fields in map file and present a
119list to chose from.
120@key k string to search for, empty string will list all entries
121
122<DL><DT><B>Returns:</B><DD>true on success
123</DL><P>
124<A NAME="Quit">
125<A NAME ="DOC.8.9">
126<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual bool Quit(void)</B></TT>
127<DD>does nothing
128<DL></DL><P>
129<A NAME="OnQuit">
130<A NAME ="DOC.8.10">
131<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> virtual void OnQuit(void)</B></TT>
132<DD>does nothing
133<DL></DL><P>
134<A NAME="SetBrowser">
135<A NAME ="DOC.8.8">
136<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> void SetBrowser(wxString const &amp; browsername = <!2><A HREF="#DOC.4">WXEXTHELP_DEFAULTBROWSER</A>, bool isNetscape = <!2><A HREF="#DOC.5">WXEXTHELP_DEFAULTBROWSER_IS_NETSCAPE</A>)</B></TT>
137<DD>Tell it which browser to use.
138The Netscape support will check whether Netscape is already
139running (by looking at the .netscape/lock file in the user's
140home directory) and tell it to load the page into the existing
141window.
142
143<DL><DT><B>Parameters:</B><DD><B>browsername</B> - The command to call a browser/html viewer.
144<br><B>isNetscape</B> - Set this to TRUE if the browser is some variant of Netscape.<br></DL><P>
145<A NAME="m_MapFile">
146<A NAME ="DOC.8.11">
147<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> wxString m_MapFile</B></TT>
148<DD>Filename of currently active map file
149<DL></DL><P>
150<A NAME="m_NumOfEntries">
151<A NAME ="DOC.8.12">
152<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> int m_NumOfEntries</B></TT>
153<DD>How many entries do we have in the map file?
154<DL></DL><P>
155<A NAME="m_MapList">
156<A NAME ="DOC.8.13">
157<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> wxExtHelpMapList* m_MapList</B></TT>
158<DD>A list containing all id,url,documentation triples
159<DL></DL><P>
160<A NAME="m_BrowserName">
161<A NAME ="DOC.8.14">
162<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> wxString m_BrowserName</B></TT>
163<DD>How to call the html viewer
164<DL></DL><P>
165<A NAME="m_BrowserIsNetscape">
166<A NAME ="DOC.8.15">
167<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> bool m_BrowserIsNetscape</B></TT>
168<DD>Is the viewer a variant of netscape?
169<DL></DL><P>
170<A NAME="CallBrowser">
171<A NAME ="DOC.8.16">
172<DT><IMG BORDER=0 SRC=icon2.gif><TT><B> bool CallBrowser(wxString const &amp;)</B></TT>
173<DD>Call the browser using a relative URL
174<DL></DL><P></DL>
175<hr>
176 <DL><DT><B>This class has no child classes.</B></DL>
177<DL></DL><P><I><A HREF="aindex.html"> alphabetic index</A></I> <I><A HREF="HIER.html"> hierarchy of classes</A></I><P></BODY><hr>
178<A HREF="http://www.zib.de/Visual/software/doc++/index.html"><IMG BORDER=0 ALIGN=RIGHT SRC=logo.gif></A>
179<P Align=Center><I>this page has been generated automatically by doc++
180<P Align=Center>(c)opyright by <A HREF="http://www.zib.de/zoeckler/"> Malte Z&oumlckler</A>, <A HREF="mailto:wunderling@zib.de"> Roland Wunderling </A><br>contact: <A HREF="mailto:doc++@zib.de"> doc++@zib.de </a>
wxWidgets (Impactor)