Changeset 153 for pykoticon

Show
Ignore:
Timestamp:
06/08/06 18:48:45 (18 years ago)
Author:
jerome
Message:

Finished the documentation for the exposed methods.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • pykoticon/trunk/README

    r151 r153  
    7474 
    7575 
     76==================================================================== 
     77 
     78 
    7679Usage : 
    7780 
    … …  
    129132      - Input : 
    130133       
    131          
     134        - An array of labels, one label per input field in the  
     135          form to be created. Each label in the list is passed as 
     136          a Binary XML-RPC object representing an UTF-8 encoded 
     137          character string. 
     138           
     139        - An array of variables names, one name per input field in 
     140          the form to be created. Each name in the list is passed 
     141          as an ASCII encoded character string. 
     142           
     143        - An array of initial values, one possibly empty value per   
     144          input field in the form to be created. Each initial value 
     145          in the list is passed as a Binary XML-RPC object representing 
     146          an UTF-8 encoded character string. 
    132147       
    133148      - Output : 
     149       
     150        - An associative array (e.g. Python mapping) containing the 
     151          variables names as keys and the variables' contents as 
     152          values in the following format : 
     153           
     154          - Each key is an ASCII encoded character string representing 
     155            the name of a variable to ask which was passed from the  
     156            caller. 
     157             
     158          - Each value is a Binary XML-RPC object representing an UTF-8   
     159            encoded character string, itself being the result of user 
     160            input in the form's field for this particular variable. 
    134161 
     162          - A special key named 'isValid' gives access to a boolean 
     163            value in the associative array. If the value is True, 
     164            then the input fields' contents are valid. If the value 
     165            is False, then was the user typed in the input fields 
     166            has to be discarded because, for example, the user 
     167            closed the form without validing his entries. 
     168            In this case, all the other values are empty strings 
     169            anyway. 
     170             
     171             
    135172==================================================================== 
    136173