URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [itcl/] [iwidgets3.0.0/] [demos/] [html/] [hyperhelp.n.html] - Blame information for rev 1765

Details | Compare with Previous | View Log


<HTML>
<HEAD>
<TITLE>iwidgets2.2.0 User Commands - hyperhelp</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H1>iwidgets2.2.0 User Commands - hyperhelp</H1>
<HR>
<PRE>
 
</PRE>
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
 
 
</PRE>
<H2>NAME</H2><PRE>
     hyperhelp - Create and manipulate a hyperhelp widget
 
 
</PRE>
<H2>SYNOPSIS</H2><PRE>
     <STRONG>hyperhelp</STRONG> <EM>pathName</EM> ?<EM>options</EM>?
 
 
</PRE>
<H2>INHERITANCE</H2><PRE>
     itk::Toplevel &lt;- shell &lt;- hyperhelp
 
 
</PRE>
<H2>STANDARD OPTIONS</H2><PRE>
     <STRONG>activeBackground</STRONG>    <STRONG>background</STRONG>         <STRONG>borderWidth</STRONG>
     <STRONG>cursor</STRONG>              <STRONG>exportSelection</STRONG>    <STRONG>foreground</STRONG>
     <STRONG>highlightColor</STRONG>      <STRONG>highlightThickness</STRONG> <STRONG>insertBackground</STRONG>
     <STRONG>insertBorderWidth</STRONG>   <STRONG>insertOffTime</STRONG>      <STRONG>insertOnTime</STRONG>
     <STRONG>insertWidth</STRONG>         <STRONG>padX</STRONG>               <STRONG>padY</STRONG>
     <STRONG>relief</STRONG>              <STRONG>repeatDelay</STRONG>        <STRONG>repeatInterval</STRONG>
     <STRONG>selectBackground</STRONG>    <STRONG>selectBorderWidth</STRONG>  <STRONG>selectForeground</STRONG>
     <STRONG>setGrid</STRONG>
 
     See the "options" manual entry for details on  the  standard
     options.
 
 
</PRE>
<H2>ASSOCIATED OPTIONS</H2><PRE>
     <STRONG>hscrollmode</STRONG>     <STRONG>vscrollmode</STRONG>    <STRONG>textbackground</STRONG>  <STRONG>fontname</STRONG>
     <STRONG>fontsize</STRONG>        <STRONG>fixedfont</STRONG>      <STRONG>link</STRONG>            <STRONG>linkhighlight</STRONG>
     <STRONG>width</STRONG>           <STRONG>height</STRONG>         <STRONG>state</STRONG>           <STRONG>wrap</STRONG>
     <STRONG>unknownimage</STRONG>
 
     See the "scrolledhtml" widget manual entry  for  details  on
     the above associated options.
 
 
</PRE>
<H2>INHERITED OPTIONS</H2><PRE>
     <STRONG>modality</STRONG>        <STRONG>title</STRONG>
 
     See the "shell" manual entry for details on the above inher-
     ited options.
 
 
</PRE>
<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>
     Name:   <STRONG>topics</STRONG>
     Class:  <STRONG>Topics</STRONG>
     Command-Line Switch:    <STRONG>-topics</STRONG>
 
          Specifies a list of help topics in  the  form  {?<EM>topic</EM>?
          ...  }. <EM>Topic</EM> may either be a topic name, in which case
          the document associated with the topic should be in the
          file <STRONG>helpdir</STRONG>/<EM>topic</EM>.html, or it may be of the form {<EM>name</EM>
          <EM>file</EM>}. In the latter case, <EM>name</EM>  is  displayed  in  the
          topic  menu, and selecting the name loads <EM>file</EM>. If file
          has a relative path, it is assumed to  be  relative  to
          helpdir.
 
     Name:   <STRONG>helpdir</STRONG>
     Class:  <STRONG>Directory</STRONG>
     Command-Line Switch:    <STRONG>-helpdir</STRONG>
 
          Specifies the directory where help files are located.
 
 
</PRE>
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
 
 
 
</PRE>
<H2>DESCRIPTION</H2><PRE>
     The <STRONG>hyperhelp</STRONG> command creates a shell window with a pulldown
     menu  showing  a list of topics. The topics are displayed by
     importing a HTML formatted  file  named  <STRONG>helpdir</STRONG>/<EM>topic</EM>.html.
     For a list of supported HTML tags, see <STRONG>scrolledhtml(n)</STRONG>.
 
 
 
</PRE>
<H2>METHODS</H2><PRE>
     The <STRONG>hyperhelp</STRONG> command creates a new Tcl command  whose  name
     is  <EM>pathName</EM>.   This  command  may be used to invoke various
     operations on the widget.   It  has  the  following  general
     form:
 
          <EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?
 
     <EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-
     mand.   The following commands are possible for dialog widg-
     ets:
 
 
</PRE>
<H2>INHERITED METHODS</H2><PRE>
     <STRONG>activate</STRONG>        <STRONG>center</STRONG>         <STRONG>childsite</STRONG>       <STRONG>deactivate</STRONG>
 
     See the "shell" manual entry for details on the above inher-
     ited methods.
 
 
 
</PRE>
<H2>WIDGET-SPECIFIC METHODS</H2><PRE>
     <EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>
          Returns the current value of the  configuration  option
          given  by  <EM>option</EM>.   <EM>Option</EM>  may have any of the values
          accepted by the <STRONG>hyperhelp</STRONG> command.
 
     <EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?
          Query  or  modify  the  configuration  options  of  the
          widget.   If  no  <EM>option</EM>  is  specified, returns a list
          describing all of the available  options  for  <EM>pathName</EM>
          (see  <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of
          this list).  If <EM>option</EM> is specified with no <EM>value</EM>, then
          the  command  returns  a  list describing the one named
          option (this list will be identical to the  correspond-
          ing  sublist  of  the  value  returned  if no <EM>option</EM> is
          specified).  If one or more  <EM>option</EM> - <EM>value</EM>  pairs  are
          specified,  then  the command modifies the given widget
          option(s) to have the given value(s);  in this case the
          command  returns  an empty string.  <EM>Option</EM> may have any
          of the values accepted by the <STRONG>hyperhelp</STRONG> command.
 
     <EM>pathName</EM> <STRONG>showtopic</STRONG> <EM>topic</EM>
          Display html file <STRONG>helpdir</STRONG>/<EM>topic</EM>.html. <EM>Topic</EM> may option-
          ally be of the form <EM>topicname</EM>#<EM>anchorname</EM>. In this form,
          either <EM>topicname</EM> or <EM>anchorname</EM> or both may be empty. If
          <EM>topicname</EM>  is  empty,  the current topic is assumed. If
          <EM>anchorname</EM> is empty, the top of the document is assumed
 
     <EM>pathName</EM> <STRONG>followlink</STRONG> <EM>href</EM>
          Display html file <EM>href</EM>. <EM>Href</EM> may be  optionally  be  of
          the  form  <EM>filename</EM>#<EM>anchorname</EM>.  In  this  form, either
          <EM>filename</EM>  or  <EM>anchorname</EM>  or  both  may  be  empty.  If
          <EM>filename</EM>  is empty, the current document is assumed. If
          <EM>anchorname</EM>  is  empty,  the  top  of  the  document  is
          assumed.
 
     <EM>pathName</EM> <STRONG>forward</STRONG>
          Display html file  one  forward  in  history  list,  if
          applicable.
 
     <EM>pathName</EM> <STRONG>back</STRONG>
          Display html file one back in history list, if applica-
          ble.
 
 
 
</PRE>
<H2>EXAMPLE</H2><PRE>
           hyperhelp .h -topics { Intro Help } -helpdir ~/help
           .h showtopic Intro
 
 
 
 
</PRE>
<H2>AUTHOR</H2><PRE>
     Kris Raney
 
 
</PRE>
<H2>KEYWORDS</H2><PRE>
     hyperhelp, html, help, shell, widget
 
 
 
 
 
 
 
 
 
 
 
 
 
</PRE>
</BODY>
</HTML>

Line No.	Rev	Author	Line
1	578	markom	`<HTML>`
2			`<HEAD>`
3			`<TITLE>iwidgets2.2.0 User Commands - hyperhelp</TITLE>`
4			`</HEAD>`
5			`<BODY BGCOLOR="#FFFFFF">`
6			`<H1>iwidgets2.2.0 User Commands - hyperhelp</H1>`
7			`<HR>`
8			`<PRE>`
9
10			`</PRE>`
11			`<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>`
12
13
14			`</PRE>`
15			`<H2>NAME</H2><PRE>`
16			`hyperhelp - Create and manipulate a hyperhelp widget`
17
18
19			`</PRE>`
20			`<H2>SYNOPSIS</H2><PRE>`
21			`<STRONG>hyperhelp</STRONG> <EM>pathName</EM> ?<EM>options</EM>?`
22
23
24			`</PRE>`
25			`<H2>INHERITANCE</H2><PRE>`
26			`itk::Toplevel <- shell <- hyperhelp`
27
28
29			`</PRE>`
30			`<H2>STANDARD OPTIONS</H2><PRE>`
31			`<STRONG>activeBackground</STRONG> <STRONG>background</STRONG> <STRONG>borderWidth</STRONG>`
32			`<STRONG>cursor</STRONG> <STRONG>exportSelection</STRONG> <STRONG>foreground</STRONG>`
33			`<STRONG>highlightColor</STRONG> <STRONG>highlightThickness</STRONG> <STRONG>insertBackground</STRONG>`
34			`<STRONG>insertBorderWidth</STRONG> <STRONG>insertOffTime</STRONG> <STRONG>insertOnTime</STRONG>`
35			`<STRONG>insertWidth</STRONG> <STRONG>padX</STRONG> <STRONG>padY</STRONG>`
36			`<STRONG>relief</STRONG> <STRONG>repeatDelay</STRONG> <STRONG>repeatInterval</STRONG>`
37			`<STRONG>selectBackground</STRONG> <STRONG>selectBorderWidth</STRONG> <STRONG>selectForeground</STRONG>`
38			`<STRONG>setGrid</STRONG>`
39
40			`See the "options" manual entry for details on the standard`
41			`options.`
42
43
44			`</PRE>`
45			`<H2>ASSOCIATED OPTIONS</H2><PRE>`
46			`<STRONG>hscrollmode</STRONG> <STRONG>vscrollmode</STRONG> <STRONG>textbackground</STRONG> <STRONG>fontname</STRONG>`
47			`<STRONG>fontsize</STRONG> <STRONG>fixedfont</STRONG> <STRONG>link</STRONG> <STRONG>linkhighlight</STRONG>`
48			`<STRONG>width</STRONG> <STRONG>height</STRONG> <STRONG>state</STRONG> <STRONG>wrap</STRONG>`
49			`<STRONG>unknownimage</STRONG>`
50
51			`See the "scrolledhtml" widget manual entry for details on`
52			`the above associated options.`
53
54
55			`</PRE>`
56			`<H2>INHERITED OPTIONS</H2><PRE>`
57			`<STRONG>modality</STRONG> <STRONG>title</STRONG>`
58
59			`See the "shell" manual entry for details on the above inher-`
60			`ited options.`
61
62
63			`</PRE>`
64			`<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>`
65			`Name: <STRONG>topics</STRONG>`
66			`Class: <STRONG>Topics</STRONG>`
67			`Command-Line Switch: <STRONG>-topics</STRONG>`
68
69			`Specifies a list of help topics in the form {?<EM>topic</EM>?`
70			`... }. <EM>Topic</EM> may either be a topic name, in which case`
71			`the document associated with the topic should be in the`
72			`file <STRONG>helpdir</STRONG>/<EM>topic</EM>.html, or it may be of the form {<EM>name</EM>`
73			`<EM>file</EM>}. In the latter case, <EM>name</EM> is displayed in the`
74			`topic menu, and selecting the name loads <EM>file</EM>. If file`
75			`has a relative path, it is assumed to be relative to`
76			`helpdir.`
77
78			`Name: <STRONG>helpdir</STRONG>`
79			`Class: <STRONG>Directory</STRONG>`
80			`Command-Line Switch: <STRONG>-helpdir</STRONG>`
81
82			`Specifies the directory where help files are located.`
83
84
85			`</PRE>`
86			`<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>`
87
88
89
90			`</PRE>`
91			`<H2>DESCRIPTION</H2><PRE>`
92			`The <STRONG>hyperhelp</STRONG> command creates a shell window with a pulldown`
93			`menu showing a list of topics. The topics are displayed by`
94			`importing a HTML formatted file named <STRONG>helpdir</STRONG>/<EM>topic</EM>.html.`
95			`For a list of supported HTML tags, see <STRONG>scrolledhtml(n)</STRONG>.`
96
97
98
99			`</PRE>`
100			`<H2>METHODS</H2><PRE>`
101			`The <STRONG>hyperhelp</STRONG> command creates a new Tcl command whose name`
102			`is <EM>pathName</EM>. This command may be used to invoke various`
103			`operations on the widget. It has the following general`
104			`form:`
105
106			`<EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?`
107
108			`<EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-`
109			`mand. The following commands are possible for dialog widg-`
110			`ets:`
111
112
113			`</PRE>`
114			`<H2>INHERITED METHODS</H2><PRE>`
115			`<STRONG>activate</STRONG> <STRONG>center</STRONG> <STRONG>childsite</STRONG> <STRONG>deactivate</STRONG>`
116
117			`See the "shell" manual entry for details on the above inher-`
118			`ited methods.`
119
120
121
122			`</PRE>`
123			`<H2>WIDGET-SPECIFIC METHODS</H2><PRE>`
124			`<EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>`
125			`Returns the current value of the configuration option`
126			`given by <EM>option</EM>. <EM>Option</EM> may have any of the values`
127			`accepted by the <STRONG>hyperhelp</STRONG> command.`
128
129			`<EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?`
130			`Query or modify the configuration options of the`
131			`widget. If no <EM>option</EM> is specified, returns a list`
132			`describing all of the available options for <EM>pathName</EM>`
133			`(see <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of`
134			`this list). If <EM>option</EM> is specified with no <EM>value</EM>, then`
135			`the command returns a list describing the one named`
136			`option (this list will be identical to the correspond-`
137			`ing sublist of the value returned if no <EM>option</EM> is`
138			`specified). If one or more <EM>option</EM> - <EM>value</EM> pairs are`
139			`specified, then the command modifies the given widget`
140			`option(s) to have the given value(s); in this case the`
141			`command returns an empty string. <EM>Option</EM> may have any`
142			`of the values accepted by the <STRONG>hyperhelp</STRONG> command.`
143
144			`<EM>pathName</EM> <STRONG>showtopic</STRONG> <EM>topic</EM>`
145			`Display html file <STRONG>helpdir</STRONG>/<EM>topic</EM>.html. <EM>Topic</EM> may option-`
146			`ally be of the form <EM>topicname</EM>#<EM>anchorname</EM>. In this form,`
147			`either <EM>topicname</EM> or <EM>anchorname</EM> or both may be empty. If`
148			`<EM>topicname</EM> is empty, the current topic is assumed. If`
149			`<EM>anchorname</EM> is empty, the top of the document is assumed`
150
151			`<EM>pathName</EM> <STRONG>followlink</STRONG> <EM>href</EM>`
152			`Display html file <EM>href</EM>. <EM>Href</EM> may be optionally be of`
153			`the form <EM>filename</EM>#<EM>anchorname</EM>. In this form, either`
154			`<EM>filename</EM> or <EM>anchorname</EM> or both may be empty. If`
155			`<EM>filename</EM> is empty, the current document is assumed. If`
156			`<EM>anchorname</EM> is empty, the top of the document is`
157			`assumed.`
158
159			`<EM>pathName</EM> <STRONG>forward</STRONG>`
160			`Display html file one forward in history list, if`
161			`applicable.`
162
163			`<EM>pathName</EM> <STRONG>back</STRONG>`
164			`Display html file one back in history list, if applica-`
165			`ble.`
166
167
168
169			`</PRE>`
170			`<H2>EXAMPLE</H2><PRE>`
171			`hyperhelp .h -topics { Intro Help } -helpdir ~/help`
172			`.h showtopic Intro`
173
174
175
176
177			`</PRE>`
178			`<H2>AUTHOR</H2><PRE>`
179			`Kris Raney`
180
181
182			`</PRE>`
183			`<H2>KEYWORDS</H2><PRE>`
184			`hyperhelp, html, help, shell, widget`
185
186
187
188
189
190
191
192
193
194
195
196
197
198			`</PRE>`
199			`</BODY>`
200			`</HTML>`

Browse

Tools

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [itcl/] [iwidgets3.0.0/] [demos/] [html/] [hyperhelp.n.html] - Blame information for rev 1765