paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-12-25 00:10:34 +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

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