~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/gui/getvalue.cat

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
getvalue          Scilab Group          Scilab Function            getvalue
2
 
NAME
3
 
   getvalue - xwindow dialog for data acquisition 
4
 
  
5
 
CALLING SEQUENCE
6
 
 [ok,x1,..,x14]=getvalue(desc,labels,typ,ini)
7
 
PARAMETERS
8
 
 desc : column vector of strings, dialog general comment 
9
 
      
10
 
 labels
11
 
       : n column vector of strings, labels(i) is the label of  the ith required
12
 
      value
13
 
      
14
 
 typ  : list(typ1,dim1,..,typn,dimn)
15
 
      
16
 
     typi : defines the type of the ith value, may have the following
17
 
          values:
18
 
          
19
 
         "mat"
20
 
                       : for constant matrix
21
 
              
22
 
         "col"
23
 
                       : for constant column vector
24
 
              
25
 
         "row"
26
 
                       : for constant row vector
27
 
              
28
 
         "vec"
29
 
                       : for  constant vector
30
 
              
31
 
         "str"
32
 
                       : for string
33
 
              
34
 
         "lis"
35
 
                       : for list
36
 
              
37
 
     dimi : defines the size of the ith value it must be a integer or a
38
 
          2-vector of integer, -1 stands for undefined dimension
39
 
          
40
 
 ini  : n column vector of strings, ini(i) gives the suggested response
41
 
      for the ith required value
42
 
      
43
 
 ok   : boolean ,%t if ok button pressed, %f if cancel button pressed
44
 
      
45
 
 xi   : contains the ith value if ok=%t. If left hand side as one more xi
46
 
      than required values the last  xi contains the vector of answered
47
 
      strings.
48
 
      
49
 
DESCRIPTION
50
 
   This function encapsulate x_mdialog function with error checking,
51
 
  evaluation of numerical response, ...
52
 
  
53
 
REMARKS
54
 
   All valid expressions can be used as answers; for matrices  and vectors
55
 
  getvalues automatically adds [ ] around the given answer before numeric
56
 
  evaluation.
57
 
  
58
 
EXAMPLE
59
 
 labels=["magnitude";"frequency";"phase    "];
60
 
 [ok,mag,freq,ph]=getvalue("define sine signal",labels,...
61
 
      list("vec",1,"vec",1,"vec",1),["0.85";"10^2";"%pi/3"])
62
 
SEE ALSO
63
 
   x_mdialog, x_matrix, x_dialog
64
 
  
65
 
AUTHOR
66
 
   S. Steer   
67