diff options
author | Graeme Geldenhuys <graemeg@gmail.com> | 2015-04-09 08:12:22 +0100 |
---|---|---|
committer | Graeme Geldenhuys <graemeg@gmail.com> | 2015-04-09 08:12:22 +0100 |
commit | db31f06d5e7adf28fad60e36fd9e5d2cf0519e84 (patch) | |
tree | bc7782a4a174ce57836947cec194281651b642e7 /docs/xml/gui/fpg_panel.xml | |
parent | c8acc2c1666015daeb3038c838e5018c0ecd8903 (diff) | |
parent | f37cd9b2a08a41b8d877f64f9d5d5402105ee74a (diff) | |
download | fpGUI-db31f06d5e7adf28fad60e36fd9e5d2cf0519e84.tar.xz |
Merge branch 'release-1.4'
Diffstat (limited to 'docs/xml/gui/fpg_panel.xml')
-rw-r--r-- | docs/xml/gui/fpg_panel.xml | 66 |
1 files changed, 66 insertions, 0 deletions
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> + |