blob: c6c2e3d731ae3229812dd7edb419054a78c460d1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="fpGUI">
<module name="fpg_form">
<short>This unit contains the class implementation representing a Form/Window on the screen</short>
<descr><printshort id="fpg_form"/>.</descr>
<element name="TWindowPosition.wpUser">
<short>OS or Desktop/Window manager decides the position.</short>
</element>
<element name="TWindowPosition.wpAuto">
<short>Window gets placed in exact x,y coordinates set by developer.</short>
</element>
<element name="TWindowPosition.wpScreenCenter">
<short>Window gets centered horizontally and vertically in the current desktop window.</short>
</element>
<element name="TWindowPosition.wpOneThirdDown">
<short>Following the "golden ratio 1.618" rules or ideas as to what is
pleasing to the eye. The window is positioned one third from
the top of the screen, using the desktop height to calculate, and centered
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>
<!-- inherited docs -->
<element name="TfpgForm.OnCloseQuery" link="#fpgui.fpg_form.TfpgBaseForm.OnCloseQuery"></element>
<element name="TfpgForm.OnClose" link="#fpgui.fpg_form.TfpgBaseForm.OnClose"></element>
</module>
</package>
</fpdoc-descriptions>
|
