1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<HTML>
<HEAD>
<TITLE>class toHelp</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class toHelp</h1>
</TD>
<TD valign="top" align="right" colspan="1">
Display a help browser. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Definition</TH><TD><code>#include <<A HREF="tohelp_h.html">tohelp.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="/usr/lib/qt3/doc/html/qdialog.html">QDialog</A> <small>(qt)</small> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-toHelp.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref15">toHelp</A></b> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent,const char *name,bool modal=true)
</LI>
<LI>virtual <b><A HREF="#ref17">~toHelp</A></b> ()
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <b><A HREF="#ref16">path</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &path=QString::null)
</LI>
<LI>static void <b><A HREF="#ref18">displayHelp</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &context,<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent=NULL)
</LI>
<LI>static void <b><A HREF="#ref19">displayHelp</A></b> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent=NULL)
</LI>
<LI>static void <b><A HREF="#ref20">connectDialog</A></b> (<A HREF="/usr/lib/qt3/doc/html/qdialog.html">QDialog</A> *dialog)
</LI>
</ul><h4>Public Members</h4><ul><LI>friend class <b><A HREF="#ref21">toHelpPrefs</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Display a help browser. A help manual consists of HTML pages where at least
two pages are mandatory.
</p>
<p> The first one is toc.htm which is parsed for links which are added to the left
pane tree view. Indentation is handled with the tag dl which open and close a
tree branch.
</p>
<p> The following file would result in two main headings with the first one having
one leaf widget as well.
</p>
<p></p><table border="0" width="100%">
<tr>
<td bgcolor="#BEEAE0">
<pre>
<A HREF="first.html">1 Head</A><BR>
<DL>
<A HREF="second.html>1.1 Head Head</A></BR>
</DL>
<A HREF="third.html">2 Foot</A><BR>
</pre>
</td></tr>
</table> <p>
</p>
<p> The second file which is optional and should be called index.htm if it exists
should contain a file with links to keywords in the manual. This must be present
for search to be possible in the manual. Keywords are indicated by the <dd> tag
in these files as well as a link to where the keyword is described. Indentation
is possible using the <dl> tag is possible here as well.
</p>
<p> The following will make the keywords "Head", "Head, Head Head" and "Foot" available.
</p><table border="0" width="100%">
<tr>
<td bgcolor="#BEEAE0">
<pre>
<DD><A HREF="first.html">Head</A><BR>
<DL>
<DD><A HREF="second.html">Head Head</A><BR>
</DL>
<DD><A HREF="third.html">Foot</A>
</pre>
</td></tr>
</table> <p>
The reason the files look this way is that this way they are compatible with
the Oracle manuals from Oracle Corporation and these can be browsed as well in
this help viewer.
</p>
<A NAME="toHelp"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>toHelp</strong> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent,const char *name,bool modal=true)
<br></td><td align="right"><h3><strong>toHelp</strong></h3></td></tr></table><p></p><p>
Create help widget.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">Parent widget.
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of widget.
</TD></TR>
<TR><TD align="left" valign="top"><i>modal</i></TD><TD align="left" valign="top">If dialog is for a modal dialog or not
</TD></TR>
</TABLE></P>
<A NAME="path"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> <strong>path</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &path=QString::null)
<br></td><td align="right"><h3><strong>path</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Help function to get a clean path from a path string. Strips trailing / etc.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>path</i></TD><TD align="left" valign="top">Path to strip.
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Stripped path in string.
</p>
<A NAME="~toHelp"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~toHelp</strong> ()
<br></td><td align="right"><h3><strong>~toHelp</strong></h3></td></tr></table><p> <small>[virtual]</small></p><A NAME="displayHelp"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>displayHelp</strong> (const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &context,<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent=NULL)
<br></td><td align="right"><h3><strong>displayHelp</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Display a specific help context in the internal manual. Pops up a help window that
displays the selected topic.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>context</i></TD><TD align="left" valign="top">Context to diaplay.
</TD></TR>
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">If NULL use modal dialog and main window.
</TD></TR>
</TABLE></P>
<A NAME="displayHelp"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>displayHelp</strong> (<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent=NULL)
<br></td><td align="right"><h3><strong>displayHelp</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Display a specific help context in the internal manual. The context is derived from
the widget that currently holds the focus.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>parent</i></TD><TD align="left" valign="top">If NULL use modal dialog and main window.
</TD></TR>
</TABLE></P>
<A NAME="connectDialog"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>connectDialog</strong> (<A HREF="/usr/lib/qt3/doc/html/qdialog.html">QDialog</A> *dialog)
<br></td><td align="right"><h3><strong>connectDialog</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Connect the F1 key to display help for a modal dialog. Don't use this directly,
instead call displayHelp directly and bind Key_F1 to that call. This is because the
help in modal dialogs are cludgy at best and should be avoided if possible.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>dialog</i></TD><TD align="left" valign="top">Dialog to connect accelerator to.
</TD></TR>
</TABLE></P>
<A NAME="toHelpPrefs"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td>friend class <strong>toHelpPrefs</strong>
</td><td align="right"><h3><strong>toHelpPrefs</strong></h3></td></tr></table><p></p><HR>
<table>
<tr><td><small>Generated by: nneul on skyhawk on Wed Feb 23 19:49:58 2005, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|