Changeset 150

Show
Ignore:
Timestamp:
06/08/06 14:39:30 (18 years ago)
Author:
jerome
Message:

Added some documentation about the available XML-RPC calls (not finished).

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • pykoticon/trunk/README

    r145 r150  
    7373    the screen. 
    7474 
     75 
     76Usage : 
     77 
     78  PyKotIcon is often used as a client side companion for the PyKota 
     79  print accounting solution, but in reality PyKotIcon is completely 
     80  independant of PyKota, and can be used from any application 
     81  which can do remote procedure calls over XML-RPC. 
     82   
     83  PyKotIcon exposes 4 of its methods over XML-RPC, here they are : 
     84   
     85    - nop : 
     86     
     87      This methods does exactly nothing :) 
     88       
     89      - Input : No argument. 
     90       
     91      - Output : returns the True boolean value. 
     92       
     93    - quitApplication :   
     94     
     95      This method causes the PyKotIcon application to exit. 
     96       
     97      - Input : No argument. 
     98       
     99      - Output : returns the True boolean value. 
     100           
     101    - showDialog :   
     102    
     103      This methods displays an informational message, and returns 
     104      the choice the user made, if any. 
     105        
     106      - Input :  
     107         
     108        - message : a Binary XML-RPC object representing an UTF-8 encoded  
     109          character string which will be displayed to the end user.  
     110          This string can contain literal "\n" sequences which will  
     111          be automatically expanded into a line break by PyKotIcon. 
     112           
     113        - confirmation : a boolean value indicating if the user will   
     114          be given the choice to valid or cancel (True), or only 
     115          to valid (False) the dialog box. 
     116             
     117      - Output :       
     118       
     119        - the literal string "OK" if the user clicked on the OK button, 
     120          else the literal string "CANCEL". The latter is only possible 
     121          if the method was called with its second parameter set to 
     122          True. 
     123         
     124    - askDatas :       
     125     
     126      This method can generate an input form and return what the user 
     127      entered in the different fields. 
     128       
     129      - Input : 
     130       
     131         
     132       
     133      - Output : 
     134 
    75135==================================================================== 
    76136