From d126fc4dadc86360abcbd27a0ac439f5893ab150 Mon Sep 17 00:00:00 2001
From: Graeme Geldenhuys
Date: Fri, 2 Mar 2012 10:32:16 +0200
Subject: docs: Added more help
---
docs/xml/corelib/fpg_base.xml | 30 +++++++++++++++++++++++++++++-
docs/xml/corelib/fpg_main.xml | 10 +++++++++-
docs/xml/corelib/fpg_widget.xml | 14 ++++++++++++++
3 files changed, 52 insertions(+), 2 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.
A descendant of the FPC TComponent class
-
. It adds a location where we can extend
+
. It adds a location where we can extend
the TComponent, without having to make changes to each and every class in fpGUI.
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.
+
+A numeric ID for the widget's context-sensitive help topic
+
HelpContext supports help systems that use numeric topic IDs. For help
+systems that use topic keywords, see HelpKeyword.
+
To enable context-sensitive help for a widget, set HelpType 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
+TfpgWidget.InvokeHelp method
+for more information.
+
+
+
+aoeu
+
+
+
+
+Specify a help file for the application
+bla bla bla
+
+
+
+Run the help viewer
+bla bla bla
+
+
+
diff --git a/docs/xml/corelib/fpg_main.xml b/docs/xml/corelib/fpg_main.xml
index db07e2e1..0ddbd174 100644
--- a/docs/xml/corelib/fpg_main.xml
+++ b/docs/xml/corelib/fpg_main.xml
@@ -79,10 +79,18 @@ planned.
-
+A concrete class that encapsulates a fpGUI application
+
+fake
+
+
+
+fake
+
+
diff --git a/docs/xml/corelib/fpg_widget.xml b/docs/xml/corelib/fpg_widget.xml
index 0e0950f6..70fced5b 100644
--- a/docs/xml/corelib/fpg_widget.xml
+++ b/docs/xml/corelib/fpg_widget.xml
@@ -51,6 +51,20 @@ triggers the OnClick event, but this behaviour can be overridden by descendant
components.
+
+Display context-sensitive help
+
InvokeHelp is called automatically when the user presses the application
+help key (normally F1) while the widget has the focus. If a help topic is defined
+for this widget (using HelpContext or HelpKeyword, depending on the value of HelpType),
+then InvokeHelp displays the topic by calling the KeywordHelp or ContextHelp method
+of the fpgApplication object. If no help topic is defined, then InvokeHelp attempts
+to call InvokeHelp for its parent. This allows a container widget to specify a
+default help topic for its children.