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