File: RPGHelp.tex

package info (click to toggle)
roleplaying 2.0-8
  • links: PTS
  • area: main
  • in suites: woody
  • size: 16,620 kB
  • ctags: 1,039
  • sloc: tcl: 7,155; cpp: 2,709; ansic: 2,227; makefile: 559; sh: 330; csh: 3
file content (151 lines) | stat: -rw-r--r-- 3,751 bytes parent folder | download
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
% Begin of input file ../../Scripts/RPGHelp.tcl
\chapter{RPGHelp.tcl -- Online Help subsystem}
\label{RPGHelp.tcl}
\typeout{Generated from $Id: RPGHelp.tcl,v 1.2 1999/07/13 01:29:16 heller Rel1 $}
This file contains the code to implement the Online Help subsystem.



\noindent\rule{\textwidth}{0.4pt}
\section{global HelpDir}

This is the path to the help file directory.  It is computed from
the script library directory.
\index{HelpDir!global variable}


\noindent\rule{\textwidth}{0.4pt}
\section{global HLinePattern}

This is the help file pattern to pick up a help header line.


\noindent\rule{\textwidth}{0.4pt}
\section{global HelpHistoryList}

This is the help history list.


\noindent\rule{\textwidth}{0.4pt}
\section{global HelpHistoryListIndex}

This is the help history index.


\noindent\rule{\textwidth}{0.4pt}
\section[proc TkIsLoadedP]{proc TkIsLoadedP \emph{}}

This procedure checks to see  if the Tk package is loaded -- this is only
used to protect the global binding code to allow pkg\_mkIndex to work
properly.


\noindent\rule{\textwidth}{0.4pt}
\section[proc rpgHelpTextHHGoto]{proc rpgHelpTextHHGoto \emph{widget x y}}

Function to implement the g/G key binding.


\noindent\rule{\textwidth}{0.4pt}
\section[proc rpgHelpTextHHSearch]{proc rpgHelpTextHHSearch \emph{widget x y}}

Function to implement the s/S key binding.


\noindent\rule{\textwidth}{0.4pt}
\section[proc rpgHelpTextHHRSearch]{proc rpgHelpTextHHRSearch \emph{widget x y}}

Function to implement the r/R key binding.


\noindent\rule{\textwidth}{0.4pt}
\section[proc helptext]{proc helptext \emph{wname args}}

Create a helptext widget.

\begin{description}
\item [in]  wname -- the name of the widget.
\item [in]  args  -- options.
\end{description}


\noindent\rule{\textwidth}{0.4pt}
\section[proc CreateHelpWindow]{proc CreateHelpWindow \emph{}}

Procedure to create the help window.


\noindent\rule{\textwidth}{0.4pt}
\section[proc dup]{proc dup \emph{str count}}

Function to dup a string.


\noindent\rule{\textwidth}{0.4pt}
\section[proc HelpBackTopic]{proc HelpBackTopic \emph{}}

Procedure to go ``back'' in the history list.


\noindent\rule{\textwidth}{0.4pt}
\section[proc HelpForwardTopic]{proc HelpForwardTopic \emph{}}

Procedure to go ``forward'' in the history list.


\noindent\rule{\textwidth}{0.4pt}
\section[proc HelpTopic]{proc HelpTopic \emph{\{topic \{\}\} \{updateHistory 1\}}}

This procedure pops up a help dialog.
\begin{description}
\item [in]  topic -- the topic to get help on.
\end{description}


\noindent\rule{\textwidth}{0.4pt}
\section[proc HeaderFormat]{proc HeaderFormat \emph{text hline}}

Procedure to format a header line.


\noindent\rule{\textwidth}{0.4pt}
\section[proc BodyFormat]{proc BodyFormat \emph{text body}}

Procedure to format the body.


\noindent\rule{\textwidth}{0.4pt}
\section[proc BindTagsAll]{proc BindTagsAll \emph{}}

Procedure to set up the XmTrackingLocate bind tag.


\noindent\rule{\textwidth}{0.4pt}
\section[proc BindTagsW]{proc BindTagsW \emph{w}}

Helper procedure to set up the XmTrackingLocate bind tag.


\noindent\rule{\textwidth}{0.4pt}
\section[proc XmTrackingLocate]{proc XmTrackingLocate \emph{widget cursor}}

Procedure to implement Motif's XmTrackingLocate function.


\noindent\rule{\textwidth}{0.4pt}
\section[proc XmTrackingLocateClick]{proc XmTrackingLocateClick \emph{tl X Y}}

XmTrackingLocate binding function.


\noindent\rule{\textwidth}{0.4pt}
\section[proc HelpContext]{proc HelpContext \emph{\{widget .\}}}

This procedure pops up an ``On Context'' help dialog.


\noindent\rule{\textwidth}{0.4pt}
\section[proc HelpWindow]{proc HelpWindow \emph{\{widget .\}}}

This procedure pops up help for the current toplevel.
% End of input file ../../Scripts/RPGHelp.tcl