gnue/gnuef/doc techref.lyx

[James Thompson]

CVSROOT:        /cvs
Module name:    gnue
Changes by:     James Thompson <address@hidden> 01/11/04 21:23:37

Modified files:
        gnuef/doc      : techref.lyx 

Log message:
        Some doc updates

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnuef/doc/techref.lyx.diff?cvsroot=OldCVS&tr1=1.9&tr2=1.10&r1=text&r2=text

Patches:
Index: gnue/gnuef/doc/techref.lyx
diff -u gnue/gnuef/doc/techref.lyx:1.9 gnue/gnuef/doc/techref.lyx:1.10
--- gnue/gnuef/doc/techref.lyx:1.9      Mon Jul 16 23:09:41 2001
+++ gnue/gnuef/doc/techref.lyx  Sun Nov  4 21:23:37 2001
@@ -29,7 +29,7 @@
 Technical Reference
 \layout Abstract
 
-This is version 0.1.3 of the Technical Reference it covers GNUe Forms 0.0.8
+This is version 0.1.4 of the Technical Reference it covers GNUe Forms 0.1.0
 \layout Abstract
 
 The current copy is maintained as a LyX 1.1.6 file.
@@ -770,7 +770,7 @@
 The form /usr/local/gnue/forms/contacts.gfd will now be displayed
 \layout Chapter
 
-GNUE Forms Designer
+GNUE Designer
 \layout Standard
 
 
@@ -871,163 +871,6 @@
 End of document - GNUE-Form
 \layout Section
 
-Attributes
-\layout Subsection
-
-Specifing Attributes
-\layout Standard
-
-The gfd file supports 2 different methods of specifing tag attributes.
- You can use either method to define any object's attributes.
- You can use both methods in the same gfd file without issues.
- The examples below will typically show the first method as it's less typing
- :) 
-\layout Comment
-
-[TODO: This is no longer true as this method is not XML compliant and 
complicate
-s/confuses design]
-\layout Subsubsection
-
-Attributes inside the tag
-\layout Standard
-
-The first method allows you to specify the attributes within the tags.
- This is the most convient when dealing with simple tags.
- A good example of which would be a <label> tag.
-\layout Quotation
-
-<label text="City" x="1" y="1"/>
-\layout Subsubsection
-
-The <options> tag
-\layout Standard
-
-The second method is by using embeded <options> tags.
- Here is our previous example rewritten to take advantage of the <options>
- tag.
-\layout Standard
-
-<label>
-\layout Standard
-
-\SpecialChar ~
-\SpecialChar ~
-<options>
-\layout Standard
-
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-<option name=
-\begin_inset Quotes erd
-\end_inset 
-
-text
-\begin_inset Quotes erd
-\end_inset 
-
->City</option>
-\layout Standard
-
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-<option name=
-\begin_inset Quotes erd
-\end_inset 
-
-x
-\begin_inset Quotes erd
-\end_inset 
-
->1</option>
-\layout Standard
-
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-\SpecialChar ~
-<option name=
-\begin_inset Quotes erd
-\end_inset 
-
-y
-\begin_inset Quotes erd
-\end_inset 
-
->1</option>
-\layout Standard
-
-\SpecialChar ~
-\SpecialChar ~
-</options>
-\layout Standard
-
-</label>
-\layout Standard
-
-As you can see this is much more verbose and using it for the label doesn't
- make much sense.
- However it is very usefull when wanting to visually seperate infomation
- within the gfd file.
- Or when defining multi-line triggers.
-\layout Subsection
-
-Object Attributes and You
-\layout Standard
-
-At the current time GNUe Forms deals with attributes in a dynamic fashion.
- So if you wanted to add an additional attribute to an object for use in
- a trigger, well, add it :) Lets say I want to add an attributes named 
-\emph on 
-foo
-\emph default 
- to my entry object.
- So in my gfd file I put the following:
-\layout Standard
-
-<entry width="30"> 
-\layout Standard
-
-\SpecialChar ~
-\SpecialChar ~
-<option name=
-\begin_inset Quotes erd
-\end_inset 
-
-foo
-\begin_inset Quotes erd
-\end_inset 
-
->bar</option>
-\layout Standard
-
-</entry>
-\layout Standard
-
-Now, when that specific object instance is created a foo attribute with
- a value of bar will be added 
-\layout Subsubsection
-
-Caveats
-\layout Standard
-
-Since we are currently building .gfd files by hand make sure you don't do
- <form height="1" widht="30"> as it'll happily accept it and create the
- widht attribute when width is probably what you really wanted.
- Then you'll be left wondering what the address@hidden@# is wrong with the 
program
- :)
-\layout Standard
-
-
-\series bold 
-Note: 
-\series default 
-Eventually we'll provide a DTD with an optional validator.
-\layout Section
-
 Tags
 \layout Subsection
 
@@ -1657,7 +1500,7 @@
 
 
 \begin_inset  Tabular
-<lyxtabular version="2" rows="9" columns="4">
+<lyxtabular version="2" rows="7" columns="4">
 <features rotate="false" islongtable="false" endhead="0" endfirsthead="0" 
endfoot="0" endlastfoot="0">
 <column alignment="center" valignment="top" leftline="true" rightline="false" 
width="" special="">
 <column alignment="center" valignment="top" leftline="true" rightline="false" 
width="" special="">
@@ -1841,93 +1684,6 @@
 
 \layout Standard
 
-
-\lang english
-master
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-string
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-none
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-If this block is a detail block then this attribute contains a link to it's
- master's field.
- The link is presented in the form block.field.
-\end_inset 
-</cell>
-</row>
-<row topline="true" bottomline="false" newpage="false">
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-detail
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-string
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-none
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-If this block is a detail block then thes attribute contains the name of
- this block's field that references the field given in the master attribute
-\end_inset 
-</cell>
-</row>
-<row topline="true" bottomline="false" newpage="false">
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
 transparentBlock
 \end_inset 
 </cell>
@@ -2068,7 +1824,7 @@
 
 
 \begin_inset  Tabular
-<lyxtabular version="2" rows="8" columns="4">
+<lyxtabular version="2" rows="9" columns="4">
 <features rotate="false" islongtable="false" endhead="0" endfirsthead="0" 
endfoot="0" endlastfoot="0">
 <column alignment="center" valignment="top" leftline="true" rightline="false" 
width="" special="">
 <column alignment="center" valignment="top" leftline="true" rightline="false" 
width="" special="">
@@ -2295,9 +2051,7 @@
 
 \layout Standard
 
-
-\lang english
-justification
+alignment
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
@@ -2364,11 +2118,11 @@
 \layout Standard
 
 Overrides the rows setting defined at the block level.
- The replacement for the old visibleCount attribute.
+ 
 \end_inset 
 </cell>
 </row>
-<row topline="true" bottomline="true" newpage="false">
+<row topline="true" bottomline="false" newpage="false">
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
 \begin_inset Text
 
@@ -2402,6 +2156,48 @@
 \end_inset 
 </cell>
 </row>
+<row topline="true" bottomline="true" newpage="false">
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+
+\lang english
+name
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+
+\lang english
+string
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+
+\lang english
+none
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+
+\lang english
+The unique ID of the label.
+\end_inset 
+</cell>
+</row>
 </lyxtabular>
 
 \end_inset 
@@ -2423,7 +2219,7 @@
 
 
 \begin_inset  Tabular
-<lyxtabular version="2" rows="21" columns="4">
+<lyxtabular version="2" rows="24" columns="4">
 <features rotate="false" islongtable="false" endhead="0" endfirsthead="0" 
endfoot="0" endlastfoot="0">
 <column alignment="center" valignment="top" leftline="true" rightline="false" 
width="" special="">
 <column alignment="center" valignment="top" leftline="true" rightline="false" 
width="" special="">
@@ -2733,7 +2529,7 @@
 
 
 \lang english
-lowerCase
+case
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
@@ -2743,17 +2539,15 @@
 
 
 \lang english
-boolean
+string
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
 \begin_inset Text
 
 \layout Standard
-
 
-\lang english
-none
+mixed
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
@@ -2763,7 +2557,8 @@
 
 
 \lang english
-If defined then the entry widget converts all input to lowercase.
+The entry widget converts all input based upon this setting.
+ Possible values are lower, upper, or mixed
 \end_inset 
 </cell>
 </row>
@@ -2772,10 +2567,8 @@
 \begin_inset Text
 
 \layout Standard
-
 
-\lang english
-upperCase
+typecase
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
@@ -2785,17 +2578,15 @@
 
 
 \lang english
-boolean
+string
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
 \begin_inset Text
 
 \layout Standard
-
 
-\lang english
-none
+text
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
@@ -2803,9 +2594,8 @@
 
 \layout Standard
 
-
-\lang english
-If defined then the entry widget converts all input to uppercase.
+The type of data the entry widget will accept.
+ Possible values are text, number, date
 \end_inset 
 </cell>
 </row>
@@ -2817,7 +2607,7 @@
 
 
 \lang english
-numeric
+readonly
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
@@ -2847,7 +2637,8 @@
 
 
 \lang english
-If defined then the entry widget will not accept any input unless it's numeric
+It defined the user will be unable to alter the contents of this entry.
+ Triggers can still alter the value.
 \end_inset 
 </cell>
 </row>
@@ -2856,10 +2647,8 @@
 \begin_inset Text
 
 \layout Standard
-
 
-\lang english
-readonly
+required
 \end_inset 
 </cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
@@ -2867,8 +2656,6 @@
 
 \layout Standard
 
-
-\lang english
 boolean
 \end_inset 
 </cell>
@@ -2877,8 +2664,6 @@
 
 \layout Standard
 
-
-\lang english
 none
 \end_inset 
 </cell>
@@ -2887,10 +2672,7 @@
 
 \layout Standard
 
-
-\lang english
-It defined the user will be unable to alter the contents of this entry.
- Triggers can still alter the value.
+If defined the entry widget must contain data before you can leave the field.
 \end_inset 
 </cell>
 </row>
@@ -2944,52 +2726,6 @@
 
 \layout Standard
 
-
-\lang english
-visibleCount
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-int
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\lang english
-1
-\end_inset 
-</cell>
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
-
-\series bold 
-\lang english
-Deprecated
-\series default 
- - The number of entry widgets displayed at one time in a verticle column.
- Simulates a very crude grid entry system.
-\end_inset 
-</cell>
-</row>
-<row topline="true" bottomline="false" newpage="false">
-<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
-\begin_inset Text
-
-\layout Standard
-
 rows
 \end_inset 
 </cell>
@@ -3218,11 +2954,7 @@
 
 \layout Standard
 
-
-\series bold 
-NOT IMPLEMENTED YET:
-\series default 
- The default value for any new records created.
+The default value for any new records created.
  If the field is visible the user can override the value.
 \end_inset 
 </cell>
@@ -3263,12 +2995,47 @@
 \end_inset 
 </cell>
 </row>
-<row topline="true" bottomline="true" newpage="false">
+<row topline="true" bottomline="false" newpage="false">
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+ignoreCaseOnQuery
+\end_inset 
+</cell>
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
 \begin_inset Text
 
 \layout Standard
 
+boolean
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+none
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+If defined the entry widget ignores the case of the information entered
+ into the query mask.
+\end_inset 
+</cell>
+</row>
+<row topline="true" bottomline="false" newpage="false">
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
 sloppyQuery
 \end_inset 
 </cell>
@@ -3299,6 +3066,108 @@
 \end_inset 
 </cell>
 </row>
+<row topline="true" bottomline="false" newpage="false">
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+editOnNull
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+boolean
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+false
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+Only allow this object to be edited if it is currently empty
+\end_inset 
+</cell>
+</row>
+<row topline="true" bottomline="false" newpage="false">
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+no_ltrim
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+boolean
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+false
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+Suppress trimming of extraneous space at beginning of user input.
+\end_inset 
+</cell>
+</row>
+<row topline="true" bottomline="true" newpage="false">
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+no_rtrim
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+boolean
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+false
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+Suppress trimming of extraneous space at end of user input.
+\end_inset 
+</cell>
+</row>
 </lyxtabular>
 
 \end_inset 
@@ -4555,7 +4424,7 @@
 
 
 \begin_inset  Tabular
-<lyxtabular version="2" rows="4" columns="4">
+<lyxtabular version="2" rows="5" columns="4">
 <features rotate="false" islongtable="false" endhead="0" endfirsthead="0" 
endfoot="0" endlastfoot="0">
 <column alignment="center" valignment="top" leftline="true" rightline="false" 
width="" special="">
 <column alignment="center" valignment="top" leftline="true" rightline="false" 
width="" special="">
@@ -4688,7 +4557,7 @@
 \end_inset 
 </cell>
 </row>
-<row topline="true" bottomline="true" newpage="false">
+<row topline="true" bottomline="false" newpage="false">
 <cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
 \begin_inset Text
 
@@ -4719,6 +4588,40 @@
 \layout Standard
 
 Used to call named triggers.
+\end_inset 
+</cell>
+</row>
+<row topline="true" bottomline="true" newpage="false">
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+language
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+string
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="false" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+python
+\end_inset 
+</cell>
+<cell multicolumn="0" alignment="center" valignment="top" topline="true" 
bottomline="false" leftline="true" rightline="true" rotate="false" 
usebox="none" width="" special="">
+\begin_inset Text
+
+\layout Standard
+
+Only supported language at this time.
 \end_inset 
 </cell>
 </row>