r6465 - trunk/gnue-appserver/doc/api

[kilo]

Author: kilo
Date: 2004-10-08 06:06:11 -0500 (Fri, 08 Oct 2004)
New Revision: 6465

Modified:
   trunk/gnue-appserver/doc/api/api.texi
Log:
Updated AppServer API doc

Modified: trunk/gnue-appserver/doc/api/api.texi
===================================================================
--- trunk/gnue-appserver/doc/api/api.texi       2004-10-08 08:00:31 UTC (rev 
6464)
+++ trunk/gnue-appserver/doc/api/api.texi       2004-10-08 11:06:11 UTC (rev 
6465)
@@ -417,7 +417,7 @@
 @subsection Special procedures
 
 Procedures having a @code{gnue_name} starting with "@code{get}" and without any
-parameters but a result are automatically treaten as "calculated properties".
+parameters but a result are automatically treated as "calculated properties".
 A procedure called "@code{getfoobar}" in a module named "@code{address}" could
 be accessed as a property called "@code{address_foobar}". Appserver will
 implicitly call the procedure "address_getfoobar".
@@ -496,24 +496,64 @@
 
 @c ----------------------------------------------------------------------------
 
address@hidden @code{gnue_useraccess}
address@hidden @code{gnue_label}
 
-Note: This class is only preliminary and will most probably disappear in
-future and be replaced by a more flexible access control system.
address@hidden Property gnue_label gnue_property gnue_property
+The name attribute of the property this label is attached to.
address@hidden defcv
 
address@hidden Property gnue_useraccess gnue_username string(20)
address@hidden Property gnue_label gnue_procedure gnue_procedure
+The name attribute of the procedure this label is attached to.
 @end defcv
 
address@hidden Property gnue_useraccess gnue_password string(20)
address@hidden Property gnue_label gnue_language string(5)
+The language in which the labels are defined.
 @end defcv
 
address@hidden Property gnue_useraccess gnue_classlist string(100)
-A list of the fully qualified names of all classes the user should have access
-to, seperated by blanks.
address@hidden Property gnue_label gnue_page string(35)
+
 @end defcv
 
address@hidden Property gnue_label gnue_label string(35)
+The label's text to display in the given language.
address@hidden defcv
+
address@hidden Property gnue_label gnue_position number(6)
+Designates the Y order of the label and the property/procedure it refers to.
address@hidden defcv
+
address@hidden Property gnue_label gnue_search number(6)
+If present, it makes the property referred a dropdown search field in
+a referring form.
address@hidden defcv
+
address@hidden Property gnue_label gnue_info number(6)
+If present, it makes the property referred a label info field in pair
+with the search field in a referring form.
address@hidden defcv
+
 @c ----------------------------------------------------------------------------
 
address@hidden @code{gnue_message}
+
address@hidden Property gnue_message gnue_module gnue_module
+The module that defines the message.
address@hidden defcv
+
address@hidden Property gnue_message gnue_language string(5)
+The language in which the messages are defined.
address@hidden defcv
+
address@hidden Property gnue_message gnue_name string(35)
+
address@hidden defcv
+
address@hidden Property gnue_message gnue_text string
+
address@hidden defcv
+
address@hidden 
----------------------------------------------------------------------------
+
 @raisesections
 
 @c ----------------------------------------------------------------------------