paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-12-17 05:20:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

FPDoc - definitions added in CustomTimer.xml

Browse Source 
git-svn-id: trunk@15182 -
This commit is contained in:
kirkpatc 2008-05-19 13:39:09 +00:00
parent 3d2bb7d1e3
commit 5cfa24eb18
1 changed files with 206 additions and 296 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,302 +1,212 @@
<?xml version="1.0" encoding="ISO8859-1"?> <?xml version="1.0"?>
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="lcl"> <package name="lcl">
<!--
<!--
==================================================================== ====================================================================
CustomTimer CustomTimer
==================================================================== ====================================================================
--> -->
<module name="CustomTimer">
<module name="CustomTimer"> <short/>
<short></short> <descr/>
<descr> <!-- unresolved type reference Visibility: default -->
</descr> <element name="Classes">
<short/>
<!-- unresolved type reference Visibility: default --> <descr/>
<element name="Classes"> <seealso/>
<short></short> </element>
<descr> <!-- unresolved type reference Visibility: default -->
</descr> <element name="SysUtils">
<seealso> <short/>
</seealso> <descr/>
</element> <seealso/>
</element>
<!-- unresolved type reference Visibility: default --> <!-- unresolved type reference Visibility: default -->
<element name="SysUtils"> <element name="LCLStrConsts">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso> </element>
</seealso> <!-- unresolved type reference Visibility: default -->
</element> <element name="LCLType">
<short/>
<!-- unresolved type reference Visibility: default --> <descr/>
<element name="LCLStrConsts"> <seealso/>
<short></short> </element>
<descr> <!-- unresolved type reference Visibility: default -->
</descr> <element name="InterfaceBase">
<seealso> <short/>
</seealso> <descr/>
</element> <seealso/>
</element>
<!-- unresolved type reference Visibility: default --> <!-- object Visibility: default -->
<element name="LCLType"> <element name="TCustomTimer">
<short></short> <short>
<descr> <var>TCustomTimer</var> - base class for <var>TTimer</var>
</descr> </short>
<seealso> <descr/>
</seealso> <errors/>
</element> <seealso/>
</element>
<!-- unresolved type reference Visibility: default --> <!-- variable Visibility: private -->
<element name="InterfaceBase"> <element name="TCustomTimer.FInterval">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso> </element>
</seealso> <!-- variable Visibility: private -->
</element> <element name="TCustomTimer.FOnStartTimer">
<short/>
<!-- object Visibility: default --> <descr/>
<element name="TCustomTimer"> <seealso/>
<short></short> </element>
<descr> <!-- variable Visibility: private -->
</descr> <element name="TCustomTimer.FOnStopTimer">
<errors> <short/>
</errors> <descr/>
<seealso> <seealso/>
</seealso> </element>
</element> <!-- variable Visibility: private -->
<element name="TCustomTimer.FTimerHandle">
<!-- variable Visibility: private --> <short/>
<element name="TCustomTimer.FInterval"> <descr/>
<short></short> <seealso/>
<descr> </element>
</descr> <!-- variable Visibility: private -->
<seealso> <element name="TCustomTimer.FOnTimer">
</seealso> <short/>
</element> <descr/>
<seealso/>
<!-- variable Visibility: private --> </element>
<element name="TCustomTimer.FOnStartTimer"> <!-- variable Visibility: private -->
<short></short> <element name="TCustomTimer.FEnabled">
<descr> <short/>
</descr> <descr/>
<seealso> <seealso/>
</seealso> </element>
</element> <!-- procedure Visibility: private -->
<element name="TCustomTimer.Timer">
<!-- variable Visibility: private --> <short>
<element name="TCustomTimer.FOnStopTimer"> <var>Timer</var> - procedure that is called when the timer has expired; calls user's <var>OnTimer </var>function.</short>
<short></short> <descr>Is called when the timer has expired and calls users OnTimer function.</descr>
<descr> <errors/>
</descr> <seealso/>
<seealso> </element>
</seealso> <!-- procedure Visibility: protected -->
</element> <element name="TCustomTimer.SetEnabled">
<short/>
<!-- variable Visibility: private --> <descr/>
<element name="TCustomTimer.FTimerHandle"> <errors/>
<short></short> <seealso/>
<descr> </element>
</descr> <!-- argument Visibility: default -->
<seealso> <element name="TCustomTimer.SetEnabled.Value">
</seealso> <short/>
</element> </element>
<!-- procedure Visibility: protected -->
<!-- variable Visibility: private --> <element name="TCustomTimer.SetInterval">
<element name="TCustomTimer.FOnTimer"> <short/>
<short></short> <descr/>
<descr> <errors/>
</descr> <seealso/>
<seealso> </element>
</seealso> <!-- argument Visibility: default -->
</element> <element name="TCustomTimer.SetInterval.Value">
<short/>
<!-- variable Visibility: private --> </element>
<element name="TCustomTimer.FEnabled"> <!-- procedure Visibility: protected -->
<short></short> <element name="TCustomTimer.SetOnTimer">
<descr> <short/>
</descr> <descr/>
<seealso> <errors/>
</seealso> <seealso/>
</element> </element>
<!-- argument Visibility: default -->
<!-- procedure Visibility: private --> <element name="TCustomTimer.SetOnTimer.Value">
<element name="TCustomTimer.Timer"> <short/>
<short></short> </element>
<descr> <!-- procedure Visibility: protected -->
</descr> <element name="TCustomTimer.DoOnTimer">
<errors> <short>
</errors> <var>DoOnTimer</var> - calls <var>OnTimer</var> event handler</short>
<seealso> <descr/>
</seealso> <errors/>
</element> <seealso/>
</element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.SetEnabled"> <element name="TCustomTimer.UpdateTimer">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors> </element>
<seealso> <!-- procedure Visibility: protected -->
</seealso> <element name="TCustomTimer.KillTimer">
</element> <short/>
<descr/>
<!-- argument Visibility: default --> <errors/>
<element name="TCustomTimer.SetEnabled.Value"> <seealso/>
<short></short> </element>
</element> <!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded">
<!-- procedure Visibility: protected --> <short/>
<element name="TCustomTimer.SetInterval"> <descr/>
<short></short> <errors/>
<descr> <seealso/>
</descr> </element>
<errors> <!-- constructor Visibility: public -->
</errors> <element name="TCustomTimer.Create">
<seealso> <short/>
</seealso> <descr/>
</element> <errors/>
<seealso/>
<!-- argument Visibility: default --> </element>
<element name="TCustomTimer.SetInterval.Value"> <!-- argument Visibility: default -->
<short></short> <element name="TCustomTimer.Create.AOwner">
</element> <short/>
</element>
<!-- procedure Visibility: protected --> <!-- destructor Visibility: public -->
<element name="TCustomTimer.SetOnTimer"> <element name="TCustomTimer.Destroy">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors> </element>
<seealso> <!-- property Visibility: published -->
</seealso> <element name="TCustomTimer.Enabled">
</element> <short>
<var>Enabled</var> - if True, timer is ready to start</short>
<!-- argument Visibility: default --> <descr/>
<element name="TCustomTimer.SetOnTimer.Value"> <seealso/>
<short></short> </element>
</element> <!-- property Visibility: published -->
<element name="TCustomTimer.Interval">
<!-- procedure Visibility: protected --> <short>The <var>Interval</var> for which the timer is to run</short>
<element name="TCustomTimer.DoOnTimer"> <descr/>
<short></short> <seealso/>
<descr> </element>
</descr> <!-- property Visibility: published -->
<errors> <element name="TCustomTimer.OnTimer">
</errors> <short>
<seealso> <var>OnTimer</var> - event handler for timer interval complete (expired)</short>
</seealso> <descr/>
</element> <seealso/>
</element>
<!-- procedure Visibility: protected --> <!-- property Visibility: published -->
<element name="TCustomTimer.UpdateTimer"> <element name="TCustomTimer.OnStartTimer">
<short></short> <short>
<descr> <var>OnStartTimer</var> - event handler for starting the timer running</short>
</descr> <descr/>
<errors> <seealso/>
</errors> </element>
<seealso> <!-- property Visibility: published -->
</seealso> <element name="TCustomTimer.OnStopTimer">
</element> <short>
<var>OnStopTimer</var> - event handler for stopping the timer</short>
<!-- procedure Visibility: protected --> <descr/>
<element name="TCustomTimer.KillTimer"> <seealso/>
<short></short> </element>
<descr> </module>
</descr> <!-- CustomTimer -->
<errors> </package>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomTimer.Create">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.Create.AOwner">
<short></short>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomTimer.Destroy">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Enabled">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Interval">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStartTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStopTimer">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- CustomTimer -->
</package>
</fpdoc-descriptions> </fpdoc-descriptions>