[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / gui / help / ru_RU / 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="ru" 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                        вектор-столбец строковых значений, общий комментарий диалога.
22                        Любой "&lt;" символ должен быть заменён на "&amp;lt;".
23                     </para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>labels</term>
28                 <listitem>
29                     <para>
30                         n-вектор-столбец строковых значений, <literal>labels(i)</literal> - это
31                         метка <literal>i</literal>-го требуемого значения.
32                     </para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>typ</term>
37                 <listitem>
38                     <para>
39                         <literal>list(typ_1,dim_1,..,typ_n,dim_n)</literal>
40                     </para>
41                     <variablelist>
42                         <varlistentry>
43                             <term>typ_i</term>
44                             <listitem>
45                                 <para>
46                                     определяем тип <literal>i</literal>-го значения. По умолчанию
47                                     входные значения интерпретируются десятичными числами.
48                                     Столбцы (строки) значений должны быть разделены <literal>";"</literal>.
49                                     <varname>typ_i</varname> может иметь следующие значения:
50                                 </para>
51                                 <table>
52                                   <tr><th>"mat"</th><td>матрица</td></tr>
53                                   <tr><th>"col"</th><td>вектор-столбец</td></tr>
54                                   <tr><th>"row"</th><td>вектор-строка</td></tr>
55                                   <tr><th>"vec"</th><td>вектор (свободная ориентация)</td></tr>
56                                   <tr><th>"intvec"</th><td>скаляр, вектор или матрица целых чисел.</td></tr>
57                                   <tr><th>"str"</th><td>скаляр, вектор или матрица текстов, разделённых с помощью <literal>".."</literal></td></tr>
58                                   <tr><th>"lis"</th><td>список: не реализовано.</td></tr>
59                                 </table>
60                             </listitem>
61                         </varlistentry>
62                         <varlistentry>
63                             <term>dim_i</term>
64                             <listitem>
65                                 <para>
66                                     определяет размер <literal>i</literal>-го значения, который
67                                     должен быть целым числом или двухэлементным вектором целых
68                                     чисел, <literal>-1</literal> стоит для неопределённого
69                                     размера.
70                                 </para>
71                             </listitem>
72                         </varlistentry>
73                     </variablelist>
74                 </listitem>
75             </varlistentry>
76             <varlistentry>
77                 <term>ini</term>
78                 <listitem>
79                     <para>
80                         n-вектор-столбец строковых значений, <literal>ini(i)</literal> даёт
81                         подсказанный ответ для <literal>i</literal>-го запрошенного значения
82                     </para>
83                 </listitem>
84             </varlistentry>
85             <varlistentry>
86                 <term>ok</term>
87                 <listitem>
88                     <para>
89                         логическое значение, <literal>%t</literal>, если нажата кнопка
90                         <literal>ok</literal>, <literal>%f</literal>, если нажата кнопка
91                         <literal>cancel</literal>
92                     </para>
93                 </listitem>
94             </varlistentry>
95             <varlistentry>
96                 <term>xi</term>
97                 <listitem>
98                     <para>
99                         содержит <literal>i</literal>-тое значение, если
100                         <literal>ok=%t</literal>. Если левая сторона имеет больше
101                         <literal>xi</literal>, чем требуемых значений, то последний
102                         <literal>xi</literal> содержит вектор ответных строковых значений.
103                     </para>
104                 </listitem>
105             </varlistentry>
106         </variablelist>
107     </refsection>
108     <refsection>
109         <title>Описание</title>
110         <para>
111             Эта функция заключает в себе функцию <literal>x_mdialog</literal> с проверкой ошибок,
112             вычислением числового ответа, ...
113         </para>
114         <note>
115           <para>
116               Все корректные выражения могут использоваться в качестве входных. Для матриц и
117               векторов <literal>getvalues()</literal> автоматически добавляет <literal>[ ]</literal>
118               вокруг каждой группы входных значений перед их вычислением.
119           </para>
120         </note>
121     </refsection>
122     <refsection>
123         <title>Примеры</title>
124         <programlisting role="example"><![CDATA[
125 labels=["magnitude" ; "frequency" ; "phase    "];
126 [ok,mag,Freq,ph] = getvalue("define sine signal",labels,...
127      list("vec",1,"vec",1,"vec",1), ["0.85";"10^2";"%pi/3"])
128  ]]></programlisting>
129     </refsection>
130     <refsection role="see also">
131         <title>Смотрите также</title>
132         <simplelist type="inline">
133             <member>
134                 <link linkend="x_mdialog">x_mdialog</link>
135             </member>
136             <member>
137                 <link linkend="x_matrix">x_matrix</link>
138             </member>
139             <member>
140                 <link linkend="x_dialog">x_dialog</link>
141             </member>
142         </simplelist>
143     </refsection>
144 </refentry>