X-Git-Url: http://gitweb.scilab.org/?p=scilab.git;a=blobdiff_plain;f=scilab%2Fmodules%2Fgui%2Fhelp%2Fen_US%2Fgetvalue.xml;h=f9c185a11733eda2d67a892e98f10afac0f5cffb;hp=4b84e6f52c597b05f6a28bcd388f12d417ff8c04;hb=f67bfcb30c3617bb487fb1f36ddd856434bb9f94;hpb=ea94d2dcf5e6856d24b6d86ee15f43ceb3b1085c diff --git a/scilab/modules/gui/help/en_US/getvalue.xml b/scilab/modules/gui/help/en_US/getvalue.xml index 4b84e6f..f9c185a 100644 --- a/scilab/modules/gui/help/en_US/getvalue.xml +++ b/scilab/modules/gui/help/en_US/getvalue.xml @@ -1,12 +1,15 @@ - + getvalue xwindow dialog for data acquisition Syntax - [ok,x1,..,x14]=getvalue(desc,labels,typ,ini) + [ok, x1,..,x14] = getvalue(desc, labels, typ, ini) Arguments @@ -14,14 +17,18 @@ desc - column vector of strings, dialog general comment + + column vector of strings, dialog general comment. Any "<" character + must be replaced with "&lt;". + labels - n column vector of strings, labels(i) is the label of the ith required value + n column vector of strings, labels(i) is the label of + the ith required value. @@ -35,57 +42,27 @@ typ_i - defines the type of the ith value, may have the following values: - - - "mat" - - for constant matrix - - - - "col" - - for constant column vector - - - - "row" - - for constant row vector - - - - "vec" - - for constant vector - - - - "intvec" - - for constant vector with integer values i.e int(x) == x - - - - "str" - - for string - - - - "lis" - - for list - - - + defines the type of the ith value. By default, inputs are + interpreted as decimal numbers. Columns of (rows of) values must + be separated with ";". typ_i may have the following values: + + + + + + + + +
"mat"matrix
"col"column vector
"row"row vector
"vec"vector (free orientation)
"intvec"scalar, vector or matrix of integers.
"str"scalar, vector or matrix of texts, delimited with ".."
"lis"list: not implemented.
 dim_i - defines the size of the ith value it must be an integer or a 2-vector of integer, -1 stands for undefined dimension + + defines the size of the ith value it must be an integer or + a 2-vector of integer, -1 stands for undefined dimension. + @@ -95,7 +72,8 @@ ini - n column vector of strings, ini(i) gives the suggested response for the ith required value + n column vector of strings, ini(i) gives the suggested + response for the ith required value @@ -109,7 +87,9 @@ xi - contains the ith value if ok=%t. If left hand side has one more xi than required values the last xi contains the vector of answered strings. + contains the ith value if ok=%t. If left hand side has one more + xi than required values the last xi + contains the vector of answered strings. @@ -121,19 +101,20 @@ This function encapsulate x_mdialog function with error checking, evaluation of numerical response, ... - - - Remarks - - All valid expressions can be used as answers; for matrices and vectors getvalues automatically adds [ ] around the given answer before numeric evaluation. - + + + All valid expressions can be used as inputs. For matrices and vectors, + getvalues() automatically adds [ ] around each group of input + before their evaluation. + + Examples