/docs/xml/lcl/customtimer.xml

  1<?xml version="1.0" encoding="UTF-8"?>
  2<fpdoc-descriptions>
  3  <package name="lcl">
  4    <!--
  5  ====================================================================
  6    CustomTimer
  7  ====================================================================
  8-->
  9    <module name="CustomTimer">
 10      <short>Contains definition of base class for <var>TTimer</var>
 11      </short>
 12      <descr/>
 13      <!-- unresolved type reference Visibility: default -->
 14      <element name="Classes">
 15        <short/>
 16        <descr/>
 17        <seealso/>
 18      </element>
 19      <!-- unresolved type reference Visibility: default -->
 20      <element name="SysUtils">
 21        <short/>
 22        <descr/>
 23        <seealso/>
 24      </element>
 25      <!-- unresolved type reference Visibility: default -->
 26      <element name="LCLStrConsts">
 27        <short/>
 28        <descr/>
 29        <seealso/>
 30      </element>
 31      <!-- unresolved type reference Visibility: default -->
 32      <element name="LCLType">
 33        <short/>
 34        <descr/>
 35        <seealso/>
 36      </element>
 37      <!-- unresolved type reference Visibility: default -->
 38      <element name="InterfaceBase">
 39        <short/>
 40        <descr/>
 41        <seealso/>
 42      </element>
 43      <!-- object Visibility: default -->
 44      <element name="TCustomTimer">
 45        <short>
 46          <var>TCustomTimer</var> - base class for 
 47          <var>TTimer</var>
 48        </short>
 49        <descr/>
 50        <errors/>
 51        <seealso/>
 52      </element>
 53      <!-- variable Visibility: private -->
 54      <element name="TCustomTimer.FInterval">
 55        <short/>
 56        <descr/>
 57        <seealso/>
 58      </element>
 59      <!-- variable Visibility: private -->
 60      <element name="TCustomTimer.FOnStartTimer">
 61        <short/>
 62        <descr/>
 63        <seealso/>
 64      </element>
 65      <!-- variable Visibility: private -->
 66      <element name="TCustomTimer.FOnStopTimer">
 67        <short/>
 68        <descr/>
 69        <seealso/>
 70      </element>
 71      <!-- variable Visibility: private -->
 72      <element name="TCustomTimer.FTimerHandle">
 73        <short/>
 74        <descr/>
 75        <seealso/>
 76      </element>
 77      <!-- variable Visibility: private -->
 78      <element name="TCustomTimer.FOnTimer">
 79        <short/>
 80        <descr/>
 81        <seealso/>
 82      </element>
 83      <!-- variable Visibility: private -->
 84      <element name="TCustomTimer.FEnabled">
 85        <short/>
 86        <descr/>
 87        <seealso/>
 88      </element>
 89      <!-- procedure Visibility: private -->
 90      <element name="TCustomTimer.Timer">
 91        <short>
 92          <var>Timer</var> - procedure that is called when the timer has expired; calls user's 
 93          <var>OnTimer </var>function.</short>
 94        <descr>Is called when the timer has expired and calls users OnTimer function.</descr>
 95        <errors/>
 96        <seealso/>
 97      </element>
 98      <!-- procedure Visibility: protected -->
 99      <element name="TCustomTimer.SetEnabled">
100        <short>Sets the <var>Enabled</var> property to True or False</short>
101      </element>
102      <!-- argument Visibility: default -->
103      <element name="TCustomTimer.SetEnabled.Value">
104        <short>Whether or not enabled</short>
105      </element>
106      <!-- procedure Visibility: protected -->
107      <element name="TCustomTimer.SetInterval">
108        <short>Sets the <var>Interval</var> property</short>
109      </element>
110      <!-- argument Visibility: default -->
111      <element name="TCustomTimer.SetInterval.Value">
112        <short>The <var>Value</var> of the <var>Interval</var> to be set for the timer</short>
113      </element>
114      <!-- procedure Visibility: protected -->
115      <element name="TCustomTimer.SetOnTimer">
116        <short>Sets the <var>OnTimer</var> property</short>
117      </element>
118      <!-- argument Visibility: default -->
119      <element name="TCustomTimer.SetOnTimer.Value">
120        <short>The <var>Value</var> of the <var>TNotifyEvent</var>
121        </short>
122      </element>
123      <!-- procedure Visibility: protected -->
124      <element name="TCustomTimer.DoOnTimer">
125        <short>
126          <var>DoOnTimer</var> - calls 
127          <var>OnTimer</var> event handler</short>
128        <descr/>
129        <errors/>
130        <seealso/>
131      </element>
132      <!-- procedure Visibility: protected -->
133      <element name="TCustomTimer.UpdateTimer">
134        <short>Updates the Timer to refleect the current properties</short>
135      </element>
136      <!-- procedure Visibility: protected -->
137      <element name="TCustomTimer.KillTimer">
138        <short>
139          <var>KillTimer</var> - kills the current timer object</short>
140      </element>
141      <!-- procedure Visibility: protected -->
142      <element name="TCustomTimer.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
143      <!-- constructor Visibility: public -->
144      <element name="TCustomTimer.Create">
145        <short>
146          <var>Create</var> - constructor for <var>TCustomTimer</var>: calls inherited <var>Create</var>, sets up handle and initialises timer interval</short>
147        <descr/>
148        <errors/>
149        <seealso>
150          <link id="#rtl.Classes.TComponent.Create"/>
151        </seealso>
152      </element>
153      <!-- argument Visibility: default -->
154      <element name="TCustomTimer.Create.AOwner">
155        <short/>
156      </element>
157      <!-- destructor Visibility: public -->
158      <element name="TCustomTimer.Destroy">
159        <short>
160          <var>Destroy</var>: destructor for <var>TCustomTimer</var>: disables and kills timer then calls inherited <var>Destroy</var>
161        </short>
162        <descr/>
163        <errors/>
164        <seealso>
165          <link id="#rtl.Classes.TComponent.Destroy"/>
166        </seealso>
167      </element>
168      <!-- property Visibility: published -->
169      <element name="TCustomTimer.Enabled">
170        <short>
171          <var>Enabled</var> - if True, timer is ready to start</short>
172        <descr/>
173        <seealso/>
174      </element>
175      <!-- property Visibility: published -->
176      <element name="TCustomTimer.Interval">
177        <short>The <var>Interval</var> (in milliseconds) for which the timer is to run</short>
178        <descr/>
179        <seealso/>
180      </element>
181      <!-- property Visibility: published -->
182      <element name="TCustomTimer.OnTimer">
183        <short>
184          <var>OnTimer</var> - event handler for timer interval complete (expired)</short>
185        <descr/>
186        <seealso/>
187      </element>
188      <!-- property Visibility: published -->
189      <element name="TCustomTimer.OnStartTimer">
190        <short>
191          <var>OnStartTimer</var> - event handler for starting the timer running</short>
192        <descr/>
193        <seealso/>
194      </element>
195      <!-- property Visibility: published -->
196      <element name="TCustomTimer.OnStopTimer">
197        <short>
198          <var>OnStopTimer</var> - event handler for stopping the timer</short>
199        <descr/>
200        <seealso/>
201      </element>
202    </module>
203    <!-- CustomTimer -->
204  </package>
205</fpdoc-descriptions>