diff options
Diffstat (limited to 'docs/xml/gui')
-rw-r--r-- | docs/xml/gui/fpg_form.xml | 35 | ||||
-rw-r--r-- | docs/xml/gui/fpg_panel.xml | 66 |
2 files changed, 101 insertions, 0 deletions
diff --git a/docs/xml/gui/fpg_form.xml b/docs/xml/gui/fpg_form.xml index 6a3027b1..c6c2e3d7 100644 --- a/docs/xml/gui/fpg_form.xml +++ b/docs/xml/gui/fpg_form.xml @@ -25,6 +25,41 @@ 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> diff --git a/docs/xml/gui/fpg_panel.xml b/docs/xml/gui/fpg_panel.xml new file mode 100644 index 00000000..ee376026 --- /dev/null +++ b/docs/xml/gui/fpg_panel.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<fpdoc-descriptions> +<package name="fpGUI"> + +<module name="fpg_panel"> +<short>This unit defines various panel and frame widgets</short> +<descr><printshort id="#fpgui.fpg_panel"/>. More specifically, it defines +a Panel, Bevel, Frame, ImagePanel and GroupBox control.</descr> + +<element name="TfpgAbstractPanel"> +<short>Base class for a Panel, Bevel etc</short> +<descr><printshort id="TfpgAbstractPanel"/>.</descr> +</element> + +<element name="TfpgBevel"> +<short>Draws a panel with various borders</short> +<descr><printshort id="TfpgBevel"/>. This widget doesn't have a text +label though, unlike TfpgPanel.</descr> +<seealso> + <link id="TfpgPanel"/> +</seealso> +</element> + +<element name="TfpgPanel"> +<short>Draws a panel with various borders and has a text label</short> +<descr><printshort id="TfpgPanel"/>. If you don't need the text label, +then it is recommended that you rather use the TfpgBevel widget.</descr> +<seealso> + <link id="TfpgBevel"/> +</seealso> +</element> + +<element name="TfpgGroupBox"> +<short>Draws a panel width a caption</short> +<descr><p><printshort id="TfpgGroupBox"/>. This is similar in functionality +to the TfpgPanel, but the Text label is drawn in the border of the panel, whereas +in the TfpgPanel in is drawn within the client area.</p> +<p>This widget is frequently used to hold radiobutton groups.</p></descr> +<seealso> + <link id="TfpgPanel"/> +</seealso> +</element> + +<element name="TfpgFrame"> +<short>A panel that acts like an embedded Form</short> +<descr><printshort id="TfpgFrame"/>. This widget should be used (instead of TfpgForm), +if you want to embed a reusable "form" inside other forms. You are able to +design such frames with the UI designer too.</descr> +<seealso> + <link id="#fpgui.fpg_form.TfpgForm">fpg_form.TfpgForm</link> +</seealso> +</element> + +<element name="TfpgImagePanel"> +<short>A panel to display an image</short> +<descr><printshort id="TfpgImagePanel"/>. This was previously done by simply using a +TfpgWidget and implementing the image painting in the OnPaint event. But this class +just saves you a bit of time.</descr> +</element> + + + +</module> +</package> +</fpdoc-descriptions> + |