Revision: 2013
http://vexi.svn.sourceforge.net/vexi/?rev=2013&view=rev
Author: clrg
Date: 2007-07-31 04:01:19 -0700 (Tue, 31 Jul 2007)
Log Message:
-----------
Update to reference to reflect vexi3
Modified Paths:
--------------
docs/trunk/docbook/src/reference.xml
Modified: docs/trunk/docbook/src/reference.xml
===================================================================
--- docs/trunk/docbook/src/reference.xml 2007-07-30 19:53:48 UTC (rev
2012)
+++ docs/trunk/docbook/src/reference.xml 2007-07-31 11:01:19 UTC (rev
2013)
@@ -18,7 +18,7 @@
Email: <email>[EMAIL PROTECTED]</email></address>
</author>
- <date>16 August 2006</date>
+ <date>31 July 2008</date>
<othercredit>
<surname>This document has been inspired by the XWT Reference authored
@@ -49,8 +49,8 @@
<section>
<title>Box Rendering Properties</title>
- <para>The properties affect the layout of a box, affecting how a box
- react</para>
+ <para>The properties affect the layout of a box, affecting how a box is
+ rendered on-screen.</para>
<table>
<title>Rendering Property Table</title>
@@ -174,8 +174,9 @@
<entry><code>""</code></entry>
- <entry><para>The box's path. The grammar and feature set
- supported are identical to that specified in <ulink
+ <entry><para><emphasis>Not yet
+ implemented</emphasis></para><para>A box's path. The grammar and
+ feature set supported are identical to that specified in <ulink
url="http://www.w3.org/TR/SVG11/paths.html";>SVG 1.1, section
8</ulink>.</para></entry>
</row>
@@ -242,7 +243,10 @@
<entry><code>false</code></entry>
<entry><para>Affects how a box is shrunk in the horizontal
- dimension only.</para></entry>
+ dimension only. A horizontally shrunk box will decline any
+ horizontal slack available to it within a parent box if the
+ parent box has a packed layout strategy and a horizontal
+ orient.</para></entry>
</row>
<row>
@@ -253,7 +257,10 @@
<entry><code>false</code></entry>
<entry><para>Affects how a box is shrunk in the vertical
- dimension only.</para></entry>
+ dimension only. A vertically shrunk box will decline any
+ vertical slack available to it within a parent box if the parent
+ box has a packed layout strategy and a vertical
+ orient.</para></entry>
</row>
<row>
@@ -263,8 +270,8 @@
<entry><emphasis>varies</emphasis></entry>
- <entry><para>If a box is a frame, this is the x- and
- y-coordinate of the frame.</para><para>Otherwise it is the
+ <entry><para>If a box is a surface, this is the (x, y)
+ coordinates of the surface.</para><para>Otherwise it is the
distance between a parent's alignment point and the box's
alignment point.</para><para>If a box is packed, puts to it's x
and y properties are ignored.</para></entry>
@@ -346,35 +353,6 @@
or if the root box is not attached to a surface. Otherwise it is
<code>true</code>.</para></entry>
</row>
-
- <row>
- <entry><property>packed</property></entry>
-
- <entry><type>Boolean</type></entry>
-
- <entry><code>true</code></entry>
-
- <entry><para>The layout strategy for a box within its parent.
- Packed boxes (<property>packed</property> set to
- <code>true</code>) are laid out in a grid according to the cols
- or rows of the parent box. Unpacked boxes
- (<property>packed</property> set to <code>false</code>) are
- positioned absolutely within a parent box, appearing above
- previous siblings and under subsequent sibling
- boxes.</para></entry>
- </row>
-
- <row>
-
<entry><para><property>colspan</property></para><property>rowspan</property></entry>
-
- <entry><type>Number</type></entry>
-
- <entry><para><code>1</code></para><code>1</code></entry>
-
- <entry><para>The number of columns and rows that a box spans
- within its parent. These only have an affect on packed
- boxes.</para></entry>
- </row>
</tbody>
</tgroup>
</table>
@@ -411,48 +389,31 @@
<tbody>
<row>
- <entry><emphasis>numeric properies</emphasis></entry>
+ <entry><property>layout</property></entry>
- <entry><type>Number</type></entry>
+ <entry><type>String</type></entry>
- <entry><emphasis><code>N/A</code></emphasis></entry>
+ <entry><code>"pack"</code></entry>
- <entry><para>The <varname>n</varname>th child of box
- <varname>b</varname> can be accessed by reading from
- <code><varname>b</varname>[<varname>n</varname>]</code>.
- </para><para>The <varname>n</varname>th child can be removed by
- writing <code>null</code> to
- <code><varname>b</varname>[<varname>n</varname>]</code> causing
- the child to become parentless.</para><para>A new child can be
- inserted before the <varname>n</varname>th child by writing it
- to <code><varname>b</varname>[<varname>n</varname>]</code>; if
- the value written is already a child of <varname>b</varname>, it
- will be removed from <varname>b</varname> first. It is important
- to note that this behavior is different from JavaScript arrays;
- for boxes, writing a non-null value to
- <code><varname>b</varname>[<varname>n</varname>]</code> does not
- eliminate the <varname>n</varname>th child but instead shifts it
- over one position.</para><para>Note: Unlike most JavaScript
- objects, enumerating a box's properties with the JavaScript
- <code>for..in</code> construct will enumerate
- <emphasis>only</emphasis> the box's children and
- <emphasis>not</emphasis> any other properties.</para></entry>
+ <entry><para>The layout strategy for a box - how it lays out
+ it's children.</para><para>Valid values are "pack" and
+ "place".</para><para>Packed layout will pack boxes according to
+ the orient setting for the box.</para><para>If placing children,
+ child boxes are positioned absolutely within a parent box, and
+ displayed in order - a child appearing above previous siblings
+ and under subsequent sibling boxes.</para></entry>
</row>
<row>
-
<entry><para><property>cols</property></para><property>rows</property></entry>
+ <entry>orient</entry>
- <entry><type>Number</type></entry>
+ <entry><type>String</type></entry>
- <entry><para><code>1</code></para><code>0</code></entry>
+ <entry><para><code>"horizontal"</code></para></entry>
- <entry><para>The number of columns/rows in which to lay out the
- children of this box. If set to zero, the number of columns or
- rows is unconstrained. One of rows or cols is always
- zero.</para><para>If 0 is written to cols when rows is 0, the
- write is ignored. If a non-zero value is written to cols when
- rows is non-zero, rows is set to 0, and vice
- versa.</para></entry>
+ <entry><para>If a box has a packing layout strategy, this
+ dictates the orientation of the packing.</para><para>Valid
+ values are "horizontal" and "vertical".</para></entry>
</row>
<row>
@@ -462,7 +423,8 @@
<entry><code>true</code></entry>
- <entry><para>The number of children a box has.</para></entry>
+ <entry><para>The number of children a box has. This is a
+ read-only property.</para></entry>
</row>
<row>
@@ -478,18 +440,65 @@
</row>
<row>
- <entry><property>surface</property></entry>
+ <entry><emphasis>numeric properies</emphasis></entry>
- <entry><emphasis><type>Any</type></emphasis></entry>
+ <entry><type>Number</type></entry>
- <entry><code>null</code></entry>
+ <entry><emphasis>N/A</emphasis></entry>
- <entry><para>If a box has a parent, this property returns
- parent.surface; otherwise it returns null. This property is a
- simple building block that the widget library uses to implement
- more complex functionality such as focus control and
- popups.</para></entry>
+ <entry><para>The <varname>n</varname>th child of box
+ <varname>b</varname> can be accessed by reading from
+ <code><varname>b</varname>[<varname>n</varname>]</code>.
+ </para><para>The <varname>n</varname>th child can be removed by
+ writing <code>null</code> to
+ <code><varname>b</varname>[<varname>n</varname>]</code> causing
+ the child to become parentless.</para><para>A new child can be
+ inserted before the <varname>n</varname>th child by writing it
+ to <code><varname>b</varname>[<varname>n</varname>]</code>; if
+ the value written is already a child of <varname>b</varname>, it
+ will be removed from <varname>b</varname> first. It is important
+ to note that this behavior is different from JavaScript arrays;
+ for boxes, writing a non-null value to
+ <code><varname>b</varname>[<varname>n</varname>]</code> does not
+ eliminate the <varname>n</varname>th child but instead shifts it
+ over one position.</para><para>Note: Unlike most JavaScript
+ objects, enumerating a box's properties with the JavaScript
+ <code>for..in</code> construct will enumerate
+ <emphasis>only</emphasis> the box's children and
+ <emphasis>not</emphasis> any other properties.</para></entry>
</row>
+
+ <row>
+ <entry><property>Child</property>ren</entry>
+
+ <entry><type>Box</type></entry>
+
+ <entry><emphasis>N/A</emphasis></entry>
+
+ <entry><para>The Children property is a
+ <emphasis>meta-property</emphasis> representing a gateway for
+ accessing the children of a box.</para><para>Placing a trap on
+ this lets a box receive notification when a child is accessed
+ using a numeric index - see <emphasis>numeric
+ properties</emphasis>.</para><para>In a read or write trap
+ placed on the Children property, the index is accessible as
+ arguments.trapname and modifying this value will cascade a new
+ index up the trap chain.</para><para>In a write trap placed on
+ the Children property, the trap function argument is the child
+ box being assigned. Any existing child at that index is
+ thisbox[arguments.trapname] before the cascade.</para><para>In a
+ read trap placed on the Children property, the child box being
+ read is accessible by reading cascade. To get a different child,
+ modify arguments.trapname before calling
+ cascade.</para><para>Note that if the parent's redirect target
+ is set to another box, these traps will only be invoked when
+ children are manipulated by reading and writing to the parent.
+ Reads and writes directly to the redirect target will not
+ trigger the traps.</para><para>Also note also that these traps
+ are still triggered if a box's redirect target is null. This is
+ useful for boxes that need to accept children and then relocate
+ them elsewhere.</para></entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -610,6 +619,20 @@
</row>
<row>
+ <entry><property>surface</property></entry>
+
+ <entry><emphasis><type>Any</type></emphasis></entry>
+
+ <entry><code>null</code></entry>
+
+ <entry><para>If a box has a parent, this property returns
+ parent.surface; otherwise it returns null. This property is a
+ simple building block that the widget library uses to implement
+ more complex functionality such as focus control and
+ popups.</para></entry>
+ </row>
+
+ <row>
<entry><property>static</property></entry>
<entry><type>Object</type></entry>
@@ -682,26 +705,6 @@
<tbody>
<row>
- <entry><property>ChildAdded</property> /
- <property>ChildRemoved</property></entry>
-
- <entry><type>Box</type></entry>
-
- <entry><para>Placing a trap on these lets a box receive
- notification when a child is added or removed. In either
- situation, the child will be passed as an argument to the trap
- function <emphasis>after</emphasis> the addition or removal has
- been performed.</para><para>Note that if the parent's redirect
- target is set to another box, these traps will only be invoked
- when children are manipulated by reading and writing to the
- parent. Reads and writes directly to the redirect target will
- not trigger the traps.</para><para>Note also that these traps
- are still triggered if a box's redirect target is null. This is
- useful for boxes that need to accept children and then relocate
- them elsewhere.</para></entry>
- </row>
-
- <row>
<entry><property><property>Enter</property></property></entry>
<entry><code>true</code></entry>
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Vexi-svn mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/vexi-svn
