Revision: 121478 https://trac.macports.org/changeset/121478 Author: shasha@macports.org Date: 2014-06-26 12:39:45 -0700 (Thu, 26 Jun 2014) Log Message: ----------- updated to recent changes Modified Paths: -------------- branches/gsoc14-interactive/API Description.txt Modified: branches/gsoc14-interactive/API Description.txt =================================================================== --- branches/gsoc14-interactive/API Description.txt 2014-06-26 16:32:55 UTC (rev 121477) +++ branches/gsoc14-interactive/API Description.txt 2014-06-26 19:39:45 UTC (rev 121478) @@ -14,47 +14,41 @@ time : Time for timeout (with 0 as default value which signifies no timeout) RETURN VALUES: Return a unique value for each case - -1: Timeout occured - 0: Yes + 0: Yes 1: No ui_ask_singlechoice DESC: Displays a question with a list of numbered choices and asks the user to enter a number to specify their choice. -Waits for user input indefinitely unless a timeout is specified. +Waits for user input indefinitely. PARAMETERS: (may change) msg : Message as a string name : Name of the port which triggered the question ports : May contain one or more portnames - def : The default answer for the question - time : Time for timeout (with 0 as default value which signifies no timeout) - + RETURN VALUES: Return a unique value for each case - -1: Timeout occured - i: Index of the list that was initially passed to the function + i: Index of the list that was initially passed to the function ui_ask_multichoice DESC: Displays a question with a list of numbered choices and asks the user to enter a space separated string of numbers to specify their choice. -Waits for user input indefinitely unless a timeout is specified. +Waits for user input indefinitely. PARAMETERS: (may change) msg : Message as a string name : Name of the port which triggered the question ports : May contain one or more portnames - def : The default answer for the question - time : Time for timeout (with 0 as default value which signifies no timeout) - + RETURN VALUES: Return a unique value for each case - -1: Timeout occured - choices : Indices of the list that was initially passed in the form of a list + choices : Indices of the list that was initially passed in the form of a list ui_timeout DESC: Function internal to the client that prints the visualisation for a timeout. Runs for the specified time interval. PARAMETERS: (may change) - time : Time for timeout + time : Time for timeout + def : Default value -RETURN VALUES: Return a unique value for each case - 1: Timeout completed - 0: Timeout aborted +RETURN VALUES: Return a unique value if timeout occurred. Otherwise user can stop execution by pressing Ctrl^C. + def : Timeout completed +