diff options
| author | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2012-03-02 10:32:16 +0200 |
|---|---|---|
| committer | Graeme Geldenhuys <graeme@mastermaths.co.za> | 2012-03-02 10:32:16 +0200 |
| commit | d126fc4dadc86360abcbd27a0ac439f5893ab150 (patch) | |
| tree | 012183942b9271d34b70d4fb28036b9690a27a61 /docs/xml/corelib/fpg_base.xml | |
| parent | ca2c3c557cc936d33291a1c1b40fd5c9172e0ef3 (diff) | |
| download | fpGUI-d126fc4dadc86360abcbd27a0ac439f5893ab150.tar.xz | |
docs: Added more help
Diffstat (limited to 'docs/xml/corelib/fpg_base.xml')
| -rw-r--r-- | docs/xml/corelib/fpg_base.xml | 30 |
1 files changed, 29 insertions, 1 deletions
diff --git a/docs/xml/corelib/fpg_base.xml b/docs/xml/corelib/fpg_base.xml index 31730dbf..f9dfa6b5 100644 --- a/docs/xml/corelib/fpg_base.xml +++ b/docs/xml/corelib/fpg_base.xml @@ -986,7 +986,7 @@ the streets of Manhattan.</p> <element name="TfpgComponent"> <short>A descendant of the FPC TComponent class</short> -<descr><p><printshort id="TfpgComponent"/>. It adds a location where we can extend +<descr><p><printshort id="fpg_base.TfpgComponent"/>. It adds a location where we can extend the TComponent, without having to make changes to each and every class in fpGUI.</p> <p>For example: We added the TagPointer property (which is now largely obsolete) because a while back the Tag property of TComponent could only store a 32bit value. @@ -995,6 +995,34 @@ this was not possible under 64-bit systems. After some time, FPC finally updated the type of the Tag property to support 64-bit addresses too.</p></descr> </element> +<element name="fpgComponent.HelpContext"> +<short>A numeric ID for the widget's context-sensitive help topic</short> +<descr><p>HelpContext supports help systems that use numeric topic IDs. For help +systems that use topic keywords, see <link id="fpg_base.TfpgComponent.HelpKeyword">HelpKeyword</link>.</p> +<p>To enable context-sensitive help for a widget, set <link id="fpg_base.TfpgComponent.HelpType">HelpType</link> to htContext and +set HelpContext to a numeric topic ID. A topic ID of 0 (default) means that no help +topic is provided for the widget. A 0 ID also mean that the help system should +refer to the parent widget, if there is one, for a help topic; refer to the +<link id="fpg_widget.TfpgWidget.InvokeHelp">TfpgWidget.InvokeHelp</link> method +for more information.</p></descr> +</element> + +<element name="TfpgApplicationBase"> +<short>aoeu</short> +<descr></descr> +</element> + +<element name="TfpgApplicationBase.HelpFile"> +<short>Specify a help file for the application</short> +<descr>bla bla bla</descr> +</element> + +<element name="TfpgApplicationBase.InvokeHelp"> +<short>Run the help viewer</short> +<descr>bla bla bla</descr> +</element> + + </module> <!-- fpg_base --> |