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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
CustomTimer
====================================================================
-->
<module name="CustomTimer">
<short>Contains definition of base class for <var>TTimer</var>
</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLStrConsts">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="LCLType">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="InterfaceBase">
<short/>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomTimer">
<short>
<var>TCustomTimer</var> - base class for
<var>TTimer</var>
</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FInterval">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnStartTimer">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnStopTimer">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FTimerHandle">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FOnTimer">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FEnabled">
<short/>
<descr/>
<seealso/>
</element>
<!-- procedure Visibility: private -->
<element name="TCustomTimer.Timer">
<short>
<var>Timer</var> - procedure that is called when the timer has expired; calls user's
<var>OnTimer </var>function.</short>
<descr>Is called when the timer has expired and calls users OnTimer function.</descr>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetEnabled">
<short>Sets the <var>Enabled</var> property to True or False</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetEnabled.Value">
<short>Whether or not enabled</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetInterval">
<short>Sets the <var>Interval</var> property</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetInterval.Value">
<short>The <var>Value</var> of the <var>Interval</var> to be set for the timer</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetOnTimer">
<short>Sets the <var>OnTimer</var> property</short>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.SetOnTimer.Value">
<short>The <var>Value</var> of the <var>TNotifyEvent</var>
</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.DoOnTimer">
<short>
<var>DoOnTimer</var> - calls
<var>OnTimer</var> event handler</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.UpdateTimer">
<short>Updates the Timer to refleect the current properties</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.KillTimer">
<short>
<var>KillTimer</var> - kills the current timer object</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
<!-- constructor Visibility: public -->
<element name="TCustomTimer.Create">
<short>
<var>Create</var> - constructor for <var>TCustomTimer</var>: calls inherited <var>Create</var>, sets up handle and initialises timer interval</short>
<descr/>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Create"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.Create.AOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomTimer.Destroy">
<short>
<var>Destroy</var>: destructor for <var>TCustomTimer</var>: disables and kills timer then calls inherited <var>Destroy</var>
</short>
<descr/>
<errors/>
<seealso>
<link id="#rtl.Classes.TComponent.Destroy"/>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Enabled">
<short>
<var>Enabled</var> - if True, timer is ready to start</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Interval">
<short>The <var>Interval</var> (in milliseconds) for which the timer is to run</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnTimer">
<short>
<var>OnTimer</var> - event handler for timer interval complete (expired)</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStartTimer">
<short>
<var>OnStartTimer</var> - event handler for starting the timer running</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStopTimer">
<short>
<var>OnStopTimer</var> - event handler for stopping the timer</short>
<descr/>
<seealso/>
</element>
</module>
<!-- CustomTimer -->
</package>
</fpdoc-descriptions>
|
