From 64d1042f284a61ad2d02254397f1da3032bc6d6f Mon Sep 17 00:00:00 2001 From: Graeme Geldenhuys Date: Thu, 11 Dec 2014 06:27:37 +0000 Subject: docs: Added some documentation on TfpgBaseForm events --- docs/xml/gui/fpg_form.xml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) (limited to 'docs') 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. + +TfpgBaseForm is the base class from which to derive a window such as a form or dialog +. + + + +Occurs when close is attempted +

. 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.

+

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.

 + +OnClose + + + + +Occurs when the form closes +

. 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.

+

A form is closed by the Close method or when the user chooses Close from the form's system +menu.

+Closing or hiding the main form terminates the application. + +OnCloseQuery + + -- cgit v1.2.3-70-g09d2