82163e26deece33469048abc402db966415a8313
[scilab.git] / scilab / modules / gui / help / ja_JP / getvalue.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="getvalue">
3     <refnamediv>
4         <refname>getvalue</refname>
5         <refpurpose>データ取得用のxwindowダイアログ</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>呼び出し手順</title>
9         <synopsis>[ok,x1,..,x14]=getvalue(desc,labels,typ,ini)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>引数</title>
13         <variablelist>
14             <varlistentry>
15                 <term>desc</term>
16                 <listitem>
17                     <para>文字列の列ベクトル, ダイアログ用のコメント</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>labels</term>
22                 <listitem>
23                     <para>
24                         文字列の列ベクトル,
25                         <literal>labels(i)</literal> は
26                         取得する値のi番目のラベル
27                     </para>
28                 </listitem>
29             </varlistentry>
30             <varlistentry>
31                 <term>typ</term>
32                 <listitem>
33                     <para>
34                         <literal>list(typ_1,dim_1,..,typ_n,dim_n)</literal>
35                     </para>
36                     <variablelist>
37                         <varlistentry>
38                             <term>typ_i</term>
39                             <listitem>
40                                 <para>i番目の値の型を定義します.
41                                     以下の値のどれかとなります:
42                                 </para>
43                                 <variablelist>
44                                     <varlistentry>
45                                         <term>"mat"  </term>
46                                         <listitem>
47                                             <para>:定数行列の場合</para>
48                                         </listitem>
49                                     </varlistentry>
50                                     <varlistentry>
51                                         <term>"col"  </term>
52                                         <listitem>
53                                             <para>:定数列ベクトルの場合</para>
54                                         </listitem>
55                                     </varlistentry>
56                                     <varlistentry>
57                                         <term>"row"  </term>
58                                         <listitem>
59                                             <para>:定数行ベクトルの場合</para>
60                                         </listitem>
61                                     </varlistentry>
62                                     <varlistentry>
63                                         <term>"vec"  </term>
64                                         <listitem>
65                                             <para>:定数ベクトルの場合</para>
66                                         </listitem>
67                                     </varlistentry>
68                                     <varlistentry>
69                                         <term>"intvec"  </term>
70                                         <listitem>
71                                             <para>:整数値を有する定数ベクトル,
72                                                 すなわち int(x) == x の場合
73                                             </para>
74                                         </listitem>
75                                     </varlistentry>
76                                     <varlistentry>
77                                         <term>"str"  </term>
78                                         <listitem>
79                                             <para>:文字列の場合</para>
80                                         </listitem>
81                                     </varlistentry>
82                                     <varlistentry>
83                                         <term>"lis"  </term>
84                                         <listitem>
85                                             <para>:リストの場合</para>
86                                         </listitem>
87                                     </varlistentry>
88                                 </variablelist>
89                             </listitem>
90                         </varlistentry>
91                         <varlistentry>
92                             <term>dim_i</term>
93                             <listitem>
94                                 <para>i番目の値の大きさを定義します.
95                                     整数または整数ベクトル(要素数2)とする
96                                     必要があります.-1 は次元を定義しないことを意味します.
97                                 </para>
98                             </listitem>
99                         </varlistentry>
100                     </variablelist>
101                 </listitem>
102             </varlistentry>
103             <varlistentry>
104                 <term>ini</term>
105                 <listitem>
106                     <para>
107                         文字列のn列ベクトル,
108                         <literal>ini(i)</literal>はi番目の必要な値に関する
109                         デフォルトの応答を指定します.
110                     </para>
111                 </listitem>
112             </varlistentry>
113             <varlistentry>
114                 <term>ok</term>
115                 <listitem>
116                     <para>論理値 ,okボタンが押された場合は %t,
117                         キャンセルボタンが押された場合は %f
118                     </para>
119                 </listitem>
120             </varlistentry>
121             <varlistentry>
122                 <term>xi</term>
123                 <listitem>
124                     <para>
125                         ok=%t の場合,i番目の値を有します.
126                         左辺に必要な数よりも1つ多い<literal>xi</literal>が
127                         指定された場合,最後の<literal>xi</literal>には
128                         答の文字列ベクトルが代入されます.
129                     </para>
130                 </listitem>
131             </varlistentry>
132         </variablelist>
133     </refsection>
134     <refsection>
135         <title>説明</title>
136         <para>
137             この関数は,エラーチェック,
138             数値応答の評価,などを指定して
139             <literal>x_mdialog</literal>をカプセル化したものです.
140         </para>
141     </refsection>
142     <refsection>
143         <title>注意</title>
144         <para>
145             有効な式を答として使用できます;
146             行列およびベクトルの場合,
147             <literal>getvalues</literal>は数値評価の前に指定した答に
148             自動的に [ ]を追加します.
149         </para>
150     </refsection>
151     <refsection>
152         <title>例</title>
153         <programlisting role="example"><![CDATA[
154 labels=["magnitude";"frequency";"phase    "];
155 [ok,mag,Freq,ph]=getvalue("define sine signal",labels,...
156      list("vec",1,"vec",1,"vec",1),["0.85";"10^2";"%pi/3"])
157  ]]></programlisting>
158     </refsection>
159     <refsection role="see also">
160         <title>参照</title>
161         <simplelist type="inline">
162             <member>
163                 <link linkend="x_mdialog">x_mdialog</link>
164             </member>
165             <member>
166                 <link linkend="x_matrix">x_matrix</link>
167             </member>
168             <member>
169                 <link linkend="x_dialog">x_dialog</link>
170             </member>
171         </simplelist>
172     </refsection>
173 </refentry>