summaryrefslogtreecommitdiff
path: root/docs/xml
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graemeg@gmail.com>2014-12-11 06:27:37 +0000
committerGraeme Geldenhuys <graemeg@gmail.com>2014-12-11 06:27:37 +0000
commit64d1042f284a61ad2d02254397f1da3032bc6d6f (patch)
treede870f895f843ed2a56d124c93f243efbb8b1a3c /docs/xml
parent4aa36e052ffe6247ec2118b02edc79317946964b (diff)
downloadfpGUI-64d1042f284a61ad2d02254397f1da3032bc6d6f.tar.xz
docs: Added some documentation on TfpgBaseForm events
Diffstat (limited to 'docs/xml')
-rw-r--r--docs/xml/gui/fpg_form.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/xml/gui/fpg_form.xml b/docs/xml/gui/fpg_form.xml
index 6a3027b1..f54415c3 100644
--- a/docs/xml/gui/fpg_form.xml
+++ b/docs/xml/gui/fpg_form.xml
@@ -25,6 +25,37 @@ horizontally.
</short>
</element>
+<element name="TfpgBaseForm">
+<short>TfpgBaseForm is the base class from which to derive a window such as a form or dialog</short>
+<descr><printshort id="TfpgBaseForm"/>.</descr>
+</element>
+
+<element name="TfpgBaseForm.OnCloseQuery">
+<short>Occurs when close is attempted</short>
+<descr><p><printshort id="TfpgBaseForm.OnCloseQuery"/>. Use OnCloseQuery to specify the conditions
+under which the form can close. An OnCloseQuery event handler returns a Boolean CanClose value
+that determines whether a form is allowed to close. Its default value is True.</p>
+<p>You can use an OnCloseQuery event handler to ask users if they are sure they really want
+the form closed immediately. For example, you can use the handler to display a message box
+that prompts the user to save a file before closing the form.</p></descr>
+<seealso>
+<link id="fpg_form.TfpgBaseForm.OnClose">OnClose</link>
+</seealso>
+</element>
+
+<element name="TfpgBaseForm.OnClose">
+<short>Occurs when the form closes</short>
+<descr><p><printshort id="TfpgBaseForm.OnClose"/>. Use OnClose to perform special processing when
+the form closes. The OnClose event specifies which event handler to call when a form is about
+to close. The handler specified by OnClose might, for example, test to make sure all fields in
+a data-entry form have valid contents before allowing the form to close.</p>
+<p>A form is closed by the Close method or when the user chooses Close from the form's system
+menu.</p>
+<remark>Closing or hiding the main form terminates the application.</remark></descr>
+<seealso>
+<link id="fpg_form.TfpgBaseForm.OnCloseQuery">OnCloseQuery</link>
+</seealso></element>
+
</module>
</package>
</fpdoc-descriptions>