* Bugs 7724 13766 fixed [doc]: figure_properties/figure fixed/improved
[scilab.git] / scilab / modules / gui / help / ja_JP / figure.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="figure">
6     <refnamediv>
7         <refname>figure</refname>
8         <refpurpose>図を作成する</refpurpose>
9     </refnamediv>
10     <refsynopsisdiv>
11         <title>呼び出し手順</title>
12         <synopsis>
13             f = figure(num);
14             f = figure("PropertyName1", Propertyvalue1, ..., ..., "PropertyNameN", PropertyvalueN);
15         </synopsis>
16     </refsynopsisdiv>
17     <refsection>
18         <title>説明</title>
19         <para>
20             このルーチンは図を作成します. IDが指定された場合,
21             このIDに対応する図が作成されます.
22             それ以外の場合,
23             ウインドウは最初のフリーなID,すなわちウインドウで使用されていない
24             最小の番号で作成されます.
25         </para>
26     </refsection>
27     <refsection role="arguments">
28         <title>引数</title>
29         <variablelist>
30             <varlistentry>
31                 <term>num</term>
32                 <listitem>
33                     <para>作成するウインドウのID.
34                         指定されない場合, 最初のフリーなIDが使用されます.
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>PropertyName{1, ..., N}</term>
40                 <listitem>
41                     <para>
42                         設定するプロパティ名の文字列,
43                         among <link linkend="figure_properties">all existing ones</link>.
44                     </para>
45                     <warning>
46                         <itemizedlist>
47                             <listitem>
48                                 <literal>'dockable'</literal>, <literal>'toolbar'</literal> and
49                                 <literal>'menubar'</literal> properties can be set only at figure's
50                                 creation.
51                             </listitem>
52                             <listitem>
53                                 <literal>'resizefcn'</literal>: when it is set at figure's creation,
54                                 the callback is first executed while building the initial figure.
55                                 Hence it must already be defined and callable.
56                             </listitem>
57                         </itemizedlist>
58                     </warning>
59                 </listitem>
60             </varlistentry>
61             <varlistentry>
62                 <term>PropertyValue{1, ..., N}</term>
63                 <listitem>
64                     <para>
65                         対応するプロパティに指定するscilabオブジェクトの値.
66                     </para>
67                 </listitem>
68             </varlistentry>
69             <varlistentry>
70                 <term>f</term>
71                 <listitem>
72                     <para>新規に作成されたウインドウのハンドル.</para>
73                 </listitem>
74             </varlistentry>
75         </variablelist>
76     </refsection>
77     <refsection>
78         <title>例</title>
79         <programlisting role="example"><![CDATA[
80 // figure_id==3の図を作成します
81 h=figure(3);
82 // 図3にテキストuicontrolを追加します
83 uicontrol(h, "style", "text", ...
84              "string", "This is a figure", ...
85              "position", [50 70 100 100], ...
86              "fontsize",15);
87
88 // figure_id==1の図を作成します
89 figure();
90 // 図1のテキストuicontrolを追加します
91 uicontrol("style", "text", ...
92           "string", "Another figure", ...
93           "position", [50 70 100 100], ...
94           "fontsize", 15);
95
96 // カレントの図(すなわち,図1)を閉じる
97 close();
98 // 図3を閉じる
99 close(h);
100  ]]></programlisting>
101     </refsection>
102     <refsection role="see also">
103         <title>参照</title>
104         <simplelist type="inline">
105             <member>
106                 <link linkend="scf">scf</link>
107             </member>
108             <member>
109                 <link linkend="gcf">gcf</link>
110             </member>
111             <member>
112                 <link linkend="createWindow">createWindow</link>
113             </member>
114             <member>
115                 <link linkend="figure_properties">figure_properties</link>
116             </member>
117             <member>
118                 <link linkend="close">close</link>
119             </member>
120         </simplelist>
121     </refsection>
122 </refentry>