diff options
author | Graeme Geldenhuys <graemeg@gmail.com> | 2015-02-22 12:20:14 +0000 |
---|---|---|
committer | Graeme Geldenhuys <graemeg@gmail.com> | 2015-02-22 12:20:14 +0000 |
commit | 4ae9804a1eea5d4219f1a79f71e2dc0563df8d02 (patch) | |
tree | b2b6700377b530155a8c6b60b13cdc5a813ea332 | |
parent | aefc00c620ffaa5485f182aff7fc6bb75a1a1ec8 (diff) | |
download | fpGUI-4ae9804a1eea5d4219f1a79f71e2dc0563df8d02.tar.xz |
docs: fpg_panel.pas unit
-rw-r--r-- | docs/fpgui-docs-project.xml | 5 | ||||
-rw-r--r-- | docs/xml/gui/fpg_panel.xml | 58 |
2 files changed, 61 insertions, 2 deletions
diff --git a/docs/fpgui-docs-project.xml b/docs/fpgui-docs-project.xml index 48395aba..83309a7e 100644 --- a/docs/fpgui-docs-project.xml +++ b/docs/fpgui-docs-project.xml @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> <docproject> <packages> - <!-- Multiple packages can be entered. - If only one is specified, it is selected. + <!-- Multiple packages can be entered. + If only one is specified, it is selected. "name" is a mandatory attribute a "units" tag is required, and a "descriptions" tag as well --> @@ -131,6 +131,7 @@ <description file="xml/gui/fpg_basegrid.xml"/> <description file="xml/gui/fpg_form.xml"/> <description file="xml/gui/fpg_grid.xml"/> + <description file="xml/gui/fpg_panel.xml"/> </descriptions> </package> </packages> diff --git a/docs/xml/gui/fpg_panel.xml b/docs/xml/gui/fpg_panel.xml new file mode 100644 index 00000000..54ece496 --- /dev/null +++ b/docs/xml/gui/fpg_panel.xml @@ -0,0 +1,58 @@ +<?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> + + +</module> +</package> +</fpdoc-descriptions> + |