📄 windhelplib.html
字号:
<html><head><!-- /vobs/wpwr/docs/tornado-api/guitcl-unix/windHelpLib.html - generated by refgen from ../../resource/doctools/windHelpLib.tcl --> <title> windHelpLib [unix] </title></head><body bgcolor="#FFFFFF"> <hr><a name="top"></a><p align=right><a href="libIndex.html"><i>Tornado API Reference : GUI Tcl Library (UNIX)</i></a></p></blockquote><h1>windHelpLib [unix]</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>windHelpLib [unix]</strong> - Tornado help Tcl library</p></blockquote><h4>TCL PROCEDURES</h4><blockquote><p><p><b><a href="./windHelpLib.html#windHelpInit">windHelpInit</a></b> - initialises the help data base<br><b><a href="./windHelpLib.html#windHelpDisplay">windHelpDisplay</a></b> - displays specified link in a web browser<br><b><a href="./windHelpLib.html#windHelpDocDirGet">windHelpDocDirGet</a></b> - gets the current doc directory<br><b><a href="./windHelpLib.html#windHelpDocDirSet">windHelpDocDirSet</a></b> - sets the current doc directory<br><b><a href="./windHelpLib.html#windHelpEntryLookup">windHelpEntryLookup</a></b> - gets the entry number in entry names list<br><b><a href="./windHelpLib.html#windHelpIndexGet">windHelpIndexGet</a></b> - gets the current complete help index<br><b><a href="./windHelpLib.html#windHelpLinkGet">windHelpLinkGet</a></b> - gets the <i>helpTopic</i> hyper link<br><b><a href="./windHelpLib.html#windHelpListGet">windHelpListGet</a></b> - gets the list of help entries<br><p></blockquote><h4>DESCRIPTION</h4><blockquote><p><p>This library contains all the Wind River Systems help related procedures.Those procedures allow to easily access to the Wind River Systems HTMLreference help<p></blockquote><h4>RESOURCE FILES</h4><blockquote><p><b>fileLib.tcl</b><b>htmlLib.tcl</b><p></blockquote><h4>FILES</h4><blockquote><p><dl><dt><b><i>docDir</i>/INDEX.WRS</b><dd>This is the raw text file containing the whole WRS help data base. Itslocation is <i>docDir</i>. See <b><a href="./windHelpLib.html#windHelpDocDirGet">windHelpDocDirGet</a></b> for more details.<p><dt><b><i>docDir</i>/TREE.WRS</b><dd>This file is a raw text file that contains a description of the WRS helptree as given to a <b><a href="../guitcl-win/UITclDocs.html#controlValuesSet" >controlValuesSet</a></b> function. See <b><a href="./windHelpLib.html#windHelpDocDirGet">windHelpDocDirGet</a></b> formore informations on <i>docDir</i><p></dl><p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./windHelpLib.html#top">windHelpLib</a></b><hr><a name="windHelpInit"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (UNIX) : Tcl Procedures</i></a></p></blockquote><h1>windHelpInit</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>windHelpInit</strong> - initialises the help data base</p></blockquote><h4>SYNOPSIS</h4><blockquote><p>windHelpInit [<i>inDir</i>]<p></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine populates the help data base list with entries got from the LIBand RTN files from the <i>inDir</i> directory.<p><i>inDir</i> default value is set to <b><a href="./windHelpLib.html#windHelpDocDirGet">windHelpDocDirGet</a></b>. If <i>inDir</i> is specified,a <b><a href="./windHelpLib.html#windHelpDocDirSet">windHelpDocDirSet</a></b> is proceeded with <i>path</i> argument set to <i>inDir</i>. Thus,all new calls to <b><a href="./windHelpLib.html#top">windHelpLib</a></b> procedures will refer to that directory fordoc directory<p><p></blockquote><h4>PARAMETERS</h4><blockquote><p><table><tr valign=top><td align=left><b>inDir</b> </td><td align=left> - </td><td align=left> docs subdirectory to look LIB and RTN files in </tr><tr valign=top><td align=left></tr></tr></table><p></blockquote><h4>RETURNS</h4><blockquote><p>N/A<p></blockquote><h4>ERRORS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./windHelpLib.html#top">windHelpLib</a></b><hr><a name="windHelpDisplay"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (UNIX) : Tcl Procedures</i></a></p></blockquote><h1>windHelpDisplay</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>windHelpDisplay</strong> - displays specified link in a web browser</p></blockquote><h4>SYNOPSIS</h4><blockquote><p>windHelpDisplay <i>helpLink</i> [-usetarget | -notarget]<p></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine displays in a navigator the specified <i>helpLink</i>.<p>The default value for <i>option</i> is set to <b>-usetarget</b><p><p></blockquote><h4>PARAMETERS</h4><blockquote><p><table><tr valign=top><td align=left><b>helpLink</b> </td><td align=left> - </td><td align=left> the link to the file to display in the browser</tr><tr valign=top><td align=left><b>option</b> </td><td align=left> - </td><td align=left> either <b>-usetarget</b> or <b>-notarget</b> for calling targetted URL or not </tr><tr valign=top><td align=left></tr></tr></table><p></blockquote><h4>KNOWN PROBLEMS</h4><blockquote><p><p>When htmlBrowser is iexplore 3.0 or less, calling for an URL that containsa target (<i>URLName</i>#<i>targetName</i>) fails. The iexplore 3.0 doesn't supportcall of targeted URL. As far as it is the only browser (Netscape Navigator,Netscape Communicator and iexplore 4.0 do support targetted URL calls), it isthe users responsibility to get rid of the target by using the -noanchoroption if he uses iexplore 3.0 (or any other browser that doesn't supporttargetted URL calls)<p></blockquote><h4>RETURNS</h4><blockquote><p>The execution status. First member of returned list is OK or ERROR.On ERROR, the remaining members of list are the error messages.<p></blockquote><h4>ERRORS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./windHelpLib.html#top">windHelpLib</a></b><hr><a name="windHelpDocDirGet"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (UNIX) : Tcl Procedures</i></a></p></blockquote><h1>windHelpDocDirGet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>windHelpDocDirGet</strong> - gets the current doc directory</p></blockquote><h4>SYNOPSIS</h4><blockquote><p>windHelpDocDirGet<p></blockquote><h4>DESCRIPTION</h4><blockquote><p>This procedure returns the path to the currently used doc directory. Thisdirectory must be set through <b><a href="./windHelpLib.html#windHelpInit">windHelpInit</a></b>, or through <b><a href="./windHelpLib.html#windHelpDocDirSet">windHelpDocDirSet</a></b><p>Its default value is set to <b><a href="../wtxtcl/wtxtclComm.html#wtxPath" >wtxPath</a></b>/docs<p><p></blockquote><h4>PARAMETERS</h4><blockquote><p>N/A<p></blockquote><h4>ERRORS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./windHelpLib.html#top">windHelpLib</a></b>, <b><a href="../wtxtcl/wtxtclComm.html#wtxPath" >wtxPath</a></b><hr><a name="windHelpDocDirSet"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (UNIX) : Tcl Procedures</i></a></p></blockquote><h1>windHelpDocDirSet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>windHelpDocDirSet</strong> - sets the current doc directory</p></blockquote><h4>SYNOPSIS</h4><blockquote><p>windHelpDocDirSet <i>path</i><p></blockquote><h4>DESCRIPTION</h4><blockquote><p>This procedure sets the path to the doc directory to be used. After thatsetting, all the help entries reachable through <b><a href="./windHelpLib.html#windHelpListGet">windHelpListGet</a></b> or through<b><a href="./windHelpLib.html#windHelpLinkGet">windHelpLinkGet</a></b> procedures, will be those visible from the <i>path</i> directory.<p>If operation failed (see ERRORS), then the docDirectory keeps its originalvalue.<p><p></blockquote><h4>PARAMETERS</h4><blockquote><p><table><tr valign=top><td align=left><b>path</b> </td><td align=left> - </td><td align=left> the path to set the doc directory </tr><tr valign=top><td align=left></tr></tr></table><p></blockquote><h4>RETURNS</h4><blockquote><p>a list which first element is OK or ERROR. On ERROR, the remainingelements of list ar the error codes.<p></blockquote><h4>ERRORS</h4><blockquote><p><p>on error, the first element of the returned list is ERROR, next elements areerror codes. The following error codes may happen :<p><dl><dt><b>PATH_IS_NOT_DIR</b><dd>the specified path is not a directory<p><dt><b>PATH_IS_NOT_READABLE</b><dd>the specified <i>path</i> is not a readable directory⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -