summaryrefslogtreecommitdiff
path: root/docs/xml
diff options
context:
space:
mode:
authorGraeme Geldenhuys <graeme@mastermaths.co.za>2010-06-08 12:39:06 +0200
committerGraeme Geldenhuys <graeme@mastermaths.co.za>2010-06-08 12:39:06 +0200
commit8c2650fabb5f1edcbc4cfea08c8b8374f17f2776 (patch)
tree22c6166dcb34fe881d04cc00955bfa70582eff9e /docs/xml
parent8169769868792bc4cb85ae948a2fd49709d41a73 (diff)
downloadfpGUI-8c2650fabb5f1edcbc4cfea08c8b8374f17f2776.tar.xz
Some new docs for fpg_widget.pas unit.
Important point is the explanation for the Anchors property and how fpGUI uses it.
Diffstat (limited to 'docs/xml')
-rw-r--r--docs/xml/corelib/fpg_widget.xml27
1 files changed, 26 insertions, 1 deletions
diff --git a/docs/xml/corelib/fpg_widget.xml b/docs/xml/corelib/fpg_widget.xml
index 733de946..935054cf 100644
--- a/docs/xml/corelib/fpg_widget.xml
+++ b/docs/xml/corelib/fpg_widget.xml
@@ -1,7 +1,6 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="CoreLib">
-
<module name="fpg_widget">
<short/>
<descr/>
@@ -10,6 +9,32 @@
<short>Sets the position and size of the component.</short>
<descr>Sets the position and size of the component. It also fires the Resize message. If you are setting up a component like a button on a form, you don't really want the resize event to fire for the button, before the form is displayed (visible). In that case, rather use the components Top, Left, Width and Height properties.</descr>
</element>
+ <element name="TfpgWidget.FormDesigner">
+ <short>If assigned, then this widget is being editing in the Form Designer</short>
+ </element>
+ <element name="TfpgWidget.Parent">
+ <short>An alias for Owner.</short>
+ <descr>Unlike Delphi or Lazarus, fpGUI treats Owner and Parent as the same thing. Owner or Parent manages the life of children, and the parent/child hierarchy defines the visual aspect as well.</descr>
+ </element>
+ <element name="TfpgWidget.IsContainer">
+ <short>Can this component managed child components.</short>
+ <descr>This is mainly used in fpGUI UI Designer, to know if you can drop on widget inside another widget.</descr>
+ </element>
+ <element name="TfpgWidget.Focusable">
+ <short>This determines if the widget is allowed to received keyboard focus.</short>
+ </element>
+ <element name="TfpgWidget.Anchors">
+ <short>Allows the component to resize or reposition based on its Parent.</short>
+ <descr>
+ <p>By default Anchors are set to Top Left.</p>
+ <p>
+ <b>NOTE</b>
+ </p>
+ <p>Anchoring only takes affect <i>after</i> the component is visible on the screen (when the component has a window handle assigned). So if you create a Button in the constructor and set its Anchor property to Bottom/Right, and then set the size of the Form, the Button will <i>not</i> be repositioned.
+</p>
+ <p>This is by design. fpGUI allows you to setup a window layout without triggering unnecesary events as you set property values for each widget. Only when csLoading is not in ComponentState, then anchoring events will be triggered. This allows the developer or the fpGUI UI Designer to setup a window layout undisturbed.</p>
+ </descr>
+ </element>
</module>
</package>
</fpdoc-descriptions>