diff options
| author | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2012-04-02 15:50:31 +0200 |
|---|---|---|
| committer | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2012-04-02 15:50:31 +0200 |
| commit | a43ab23223b5f3e7540635ca0cc3e296774340d6 (patch) | |
| tree | d8a6b6398d8d3aed13f833bc36b0f9f763c0c0a4 /docs/xml | |
| parent | ef75b3c7a91199cc4eb0c0cd6ba087cb1d5eb9ea (diff) | |
| download | fpGUI-a43ab23223b5f3e7540635ca0cc3e296774340d6.tar.xz | |
docs: adds some TfpgTimer and TfpgBaseTimer API documentation
Diffstat (limited to 'docs/xml')
| -rw-r--r-- | docs/xml/corelib/fpg_base.xml | 7 | ||||
| -rw-r--r-- | docs/xml/corelib/fpg_main.xml | 17 |
2 files changed, 24 insertions, 0 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml index f9dfa6b5..2b6cd0f5 100644 --- a/docs/xml/corelib/fpg_base.xml +++ b/docs/xml/corelib/fpg_base.xml @@ -1023,6 +1023,13 @@ for more information.</p></descr> </element> +<element name="TfpgBaseTimer.Enabled"> +<short>Allows you to enable or disable the timer</short> +<descr><printshort id="TfpgBaseTimer.Enabled"/>. The timer will not function until you +set the Enabled property to True. Later you can disable the timer by setting the +Enabled property to False.</descr> +</element> + </module> <!-- fpg_base --> diff --git a/docs/xml/corelib/fpg_main.xml b/docs/xml/corelib/fpg_main.xml index 0ddbd174..87cd0630 100644 --- a/docs/xml/corelib/fpg_main.xml +++ b/docs/xml/corelib/fpg_main.xml @@ -92,6 +92,23 @@ planned.</p></descr> </element> +<element name="TfpgTimer"> +<short>A timer component for fpGUI applications</short> +<descr><printshort id="TfpgTimer"/>.</descr> +</element> + +<element name="TfpgTimer.Create"> +<short>Use this method to create a timer component instance</short> +<descr><printshort id="TfpgTimer.Create"/>. The AInterval parameter is a value in +milliseconds. The timer will fire the OnTimer event every AInterval milliseconds or +until the timer is disabled when the Enabled property is set to False.</descr> +</element> + +<element name="TfpgTimer.Enabled" link="#fpgui.fpg_base.TfpgBaseTimer.Enabled"> +</element> + + + </module> <!-- fpg_main --> </package> |