summaryrefslogtreecommitdiff
path: root/docs/xml
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graeme@mastermaths.co.za>2010-09-22 17:05:27 +0200
committerGraeme Geldenhuys <graeme@mastermaths.co.za>2010-09-22 17:05:27 +0200
commit8e3dd5465895395d649800f47820ef5e72826a1e (patch)
tree7d2eff6dd4a5b5bcce948b8f93c7c18210df04a7 /docs/xml
parentf4c7cd3cf21a008f18bebc65f9ff3433713413e4 (diff)
downloadfpGUI-8e3dd5465895395d649800f47820ef5e72826a1e.tar.xz
start of fpg_forms documentation
Diffstat (limited to 'docs/xml')
-rw-r--r--docs/xml/gui/fpg_form.xml30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/xml/gui/fpg_form.xml b/docs/xml/gui/fpg_form.xml
new file mode 100644
index 00000000..3dfb01fc
--- /dev/null
+++ b/docs/xml/gui/fpg_form.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<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/>
+
+<element name="TWindowPosition.wpUser">
+<descr>OS or Desktop/Window manager decides the position.</descr>
+</element>
+
+<element name="TWindowPosition.wpAuto">
+<descr>Window gets placed in exact x,y coordinates set by developer.</descr>
+</element>
+
+<element name="TWindowPosition.wpScreenCenter">
+<descr>Window gets centered horizontally and vertically in the current desktop window.</descr>
+</element>
+
+<element name="TWindowPosition.wpOneThirdDown">
+<descr>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.
+</descr>
+</element>
+
+ </module>
+ </package>
+</fpdoc-descriptions>