paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-17 06:29:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - definitions added for CustomTimer.xml

Browse Source 
git-svn-id: trunk@15395 -
This commit is contained in:
kirkpatc 2008-06-12 17:04:24 +00:00
parent e05e391f2b
commit 1ce1166231
1 changed files with 19 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/xml/lcl/customtimer.xml
View File

@ -7,7 +7,8 @@
==================================================================== ====================================================================
--> -->
<module name="CustomTimer"> <module name="CustomTimer">
<short/> <short>Contains definition of base class for <var>TTimer</var>
</short>
<descr/> <descr/>
<!-- unresolved type reference Visibility: default --> <!-- unresolved type reference Visibility: default -->
<element name="Classes"> <element name="Classes">
@ -42,7 +43,8 @@
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TCustomTimer"> <element name="TCustomTimer">
<short> <short>
<var>TCustomTimer</var> - base class for <var>TTimer</var> <var>TCustomTimer</var> - base class for
<var>TTimer</var>
</short> </short>
<descr/> <descr/>
<errors/> <errors/>
@ -87,73 +89,57 @@
<!-- procedure Visibility: private --> <!-- procedure Visibility: private -->
<element name="TCustomTimer.Timer"> <element name="TCustomTimer.Timer">
<short> <short>
<var>Timer</var> - procedure that is called when the timer has expired; calls user's <var>OnTimer </var>function.</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> <descr>Is called when the timer has expired and calls users OnTimer function.</descr>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetEnabled"> <element name="TCustomTimer.SetEnabled">
<short/> <short>Sets the <var>Enabled</var> property to True or False</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomTimer.SetEnabled.Value"> <element name="TCustomTimer.SetEnabled.Value">
<short/> <short>Whether or not enabled</short>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetInterval"> <element name="TCustomTimer.SetInterval">
<short/> <short>Sets the <var>Interval</var> property</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomTimer.SetInterval.Value"> <element name="TCustomTimer.SetInterval.Value">
<short/> <short>The <var>Value</var> of the <var>Interval</var> to be set for the timer</short>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetOnTimer"> <element name="TCustomTimer.SetOnTimer">
<short/> <short>Sets the <var>OnTimer</var> property</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TCustomTimer.SetOnTimer.Value"> <element name="TCustomTimer.SetOnTimer.Value">
<short/> <short>The <var>Value</var> of the <var>TNotifyEvent</var>
</short>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.DoOnTimer"> <element name="TCustomTimer.DoOnTimer">
<short> <short>
<var>DoOnTimer</var> - calls <var>OnTimer</var> event handler</short> <var>DoOnTimer</var> - calls
<var>OnTimer</var> event handler</short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.UpdateTimer"> <element name="TCustomTimer.UpdateTimer">
<short/> <short>Updates the Timer to refleect the current properties</short>
<descr/>
<errors/>
<seealso/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.KillTimer"> <element name="TCustomTimer.KillTimer">
<short/> <short>
<descr/> <var>KillTimer</var> - kills the current timer object</short>
<errors/>
<seealso/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded"> <element name="TCustomTimer.Loaded"/>
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- constructor Visibility: public --> <!-- constructor Visibility: public -->
<element name="TCustomTimer.Create"> <element name="TCustomTimer.Create">
<short/> <short/>