help: fix minor typos and warnings on Scilab code colorization
[scilab.git] / scilab / modules / xcos / help / ja_JP / scilab_data_structures / scicos_graphics.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4  * Scicos
5  *
6  * Copyright (C) INRIA - METALAU Project <scicos@inria.fr> (HTML version)
7  * Copyright (C) DIGITEO - Scilab Consortium (XML Docbook version)
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  *  (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * See the file ./license.txt
24  -->
25
26 <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="scicos_graphics">
27
28     <refnamediv>
29
30         <refname>scicos_graphics</refname>
31
32         <refpurpose>graphics構造体を定義</refpurpose>
33
34     </refnamediv>
35
36     <refsect1 id="graphics_scicos_graphics">
37
38         <title>graphics</title>
39
40         <para>
41
42             ブロックの機能に関するグラフィック情報を有するScilabオブジェクト.
43
44         </para>
45         <para>
46             Type : scilab tlist of type <code>"graphics"</code> with fields :
47             <link linkend="scicos_block_graphics_orig">orig</link>,
48             <link linkend="scicos_block_graphics_sz">sz</link>,
49             <link linkend="scicos_block_graphics_flip">flip</link>,
50             <link linkend="scicos_block_graphics_theta">theta</link>,
51             <link linkend="scicos_block_graphics_exprs">exprs</link>,
52             <link linkend="scicos_block_graphics_pin">pin</link>,
53             <link linkend="scicos_block_graphics_pout">pout</link>,
54             <link linkend="scicos_block_graphics_pein">pein</link>,
55             <link linkend="scicos_block_graphics_peout">peout</link>,
56             <link linkend="scicos_block_graphics_gr_i">gr_i</link>,
57             <link linkend="scicos_block_graphics_id">id</link>,
58             <link linkend="scicos_block_graphics_in_implicit">in_implicit</link>,
59             <link linkend="scicos_block_graphics_out_implicit">out_implicit</link>,
60             <link linkend="scicos_block_graphics_in_style">in_style</link>,
61             <link linkend="scicos_block_graphics_out_style">out_style</link>,
62             <link linkend="scicos_block_graphics_in_label">in_label</link>,
63             <link linkend="scicos_block_graphics_out_label">out_label</link> and
64             <link linkend="scicos_block_graphics_style">style</link>.
65         </para>
66         <refsect2 id="scicos_block_graphics_orig">
67             <title>orig</title>
68             <para>
69                 Vector <code>[xo,yo]</code>, where <varname>xo</varname> is the x coordinate of the block origin and <varname>yo</varname> is the y coordinate of the block origin.
70             </para>
71             <para>
72                 <code>[xo,yo]</code> is the coordinate of down-left point of
73                 the block shape.
74             </para>
75             <para>
76                 Size : 2.
77             </para>
78             <para>
79                 Type : row vector of real.
80             </para>
81         </refsect2>
82         <refsect2 id="scicos_block_graphics_sz">
83             <title>sz</title>
84             <para>
85                 Vector <code>[w,h]</code>, where w is the block width and h the block height.
86             </para>
87             <para>
88                 Size : 2.
89             </para>
90             <para>
91                 Type : row vector of real.
92             </para>
93         </refsect2>
94         <refsect2 id="scicos_block_graphics_flip">
95             <title>flip</title>
96             <para> Set the block orientation. If true the input ports are on the left of the box and output ports are on the right.</para>
97             <para> If false the input ports are on the right of the box and output ports are on the left.</para>
98             <para>
99                 Size : 1.
100             </para>
101             <para>
102                 Type : boolean.
103             </para>
104         </refsect2>
105         <refsect2 id="scicos_block_graphics_theta">
106             <title>theta</title>
107             <para> Set the angle of the Scicos object.</para>
108             <para> This value is in degree and is included in [-360,360].</para>
109             <para>
110                 Size : 1.
111             </para>
112             <para>
113                 Type : real.
114             </para>
115         </refsect2>
116         <refsect2 id="scicos_block_graphics_exprs">
117             <title>exprs</title>
118             <para>Strings including formal expressions used in the dialog box of the block.</para>
119             <para>
120                 Size : number of formal expressions.
121             </para>
122             <para>
123                 Type : column vector of strings.
124             </para>
125         </refsect2>
126         <refsect2 id="scicos_block_graphics_pin">
127             <title>pin</title>
128             <para>
129                 Vector. <code>pin(i)</code> is the number of the link connected to the <code>i</code>th regular input port (counting from one), or <code>0</code> if this port is not connected.
130             </para>
131             <para>
132                 Size : number of regular input ports.
133             </para>
134             <para>
135                 Type : column vector of integers.
136             </para>
137         </refsect2>
138         <refsect2 id="scicos_block_graphics_pout">
139             <title>pout</title>
140             <para>
141                 Vector. <code>pout(i)</code> is the number of the link connected to the <code>i</code>th regular output port (counting from one), or <code>0</code> if this port is not connected.
142             </para>
143             <para>
144                 Size : number of regular output ports.
145             </para>
146             <para>
147                 Type : column vector of integers.
148             </para>
149         </refsect2>
150         <refsect2 id="scicos_block_graphics_pein">
151             <title>pein</title>
152             <para>
153                 Vector. <code>pein(i)</code> is the number of the link connected to the <code>i</code>th event input port (counting from one), or <code>0</code> if this port is not connected.
154             </para>
155             <para>
156                 Size : number of events input ports.
157             </para>
158             <para>
159                 Type : column vector of integers.
160             </para>
161         </refsect2>
162         <refsect2 id="scicos_block_graphics_peout">
163             <title>peout</title>
164             <para>
165                 Vector. <code>peout(i)</code> is the number of the link connected to the ith event output port (counting from one), or <code>0</code> if this port is not connected.
166             </para>
167             <para>
168                 Size : number of events output ports.
169             </para>
170             <para>
171                 Type : column vector of integers.
172             </para>
173         </refsect2>
174         <refsect2 id="scicos_block_graphics_gr_i">
175             <title>gr_i</title>
176             <para>Not used</para>
177             <para>
178                 Size : -.
179             </para>
180             <para>
181                 Type : column vector of strings.
182             </para>
183         </refsect2>
184         <refsect2 id="scicos_block_graphics_id">
185             <title>id</title>
186             <para> A string to ease the identification of the block.</para>
187             <para>
188                 Size : 1.
189             </para>
190             <para>
191                 Type : string.
192             </para>
193         </refsect2>
194         <refsect2 id="scicos_block_graphics_in_implicit">
195             <title>in_implicit</title>
196             <para>
197                 A vector of strings including <code>'E'</code> or <code>'I'</code>.
198             </para>
199             <para>
200                 <code>'E'</code> and <code>'I'</code> stand respectively for explicit and implicit port, and this vector indicates the nature of each input port. For regular blocks (not implicit), this vector is empty or contains only <code>"E"</code>.
201             </para>
202             <para>
203                 Size : nul or number of regular input ports.
204             </para>
205             <para>
206                 Type : column vector of strings.
207             </para>
208         </refsect2>
209         <refsect2 id="scicos_block_graphics_out_implicit">
210             <title>out_implicit</title>
211             <para>
212                 A vector of strings including <code>'E'</code> or <code>'I'</code>.
213             </para>
214             <para>
215                 <code>'E'</code> and <code>'I'</code> stand respectively for explicit and implicit port, and this vector indicates the nature of each output port. For regular blocks (not implicit), this vector is empty or contains only <code>"E"</code>.
216             </para>
217             <para>
218                 Size : nul or number of regular output ports.
219             </para>
220             <para>
221                 Type : column vector of strings.
222             </para>
223         </refsect2>
224         <refsect2 id="scicos_block_graphics_in_style">
225             <title>in_style</title>
226             <para>A vector of strings including JGraphX key values style properties.</para>
227             <para>
228                 These style can be used to place text or to change port aspect (eg. round, green port). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=green"</literal> for a round and green port
229             </para>
230             <para>
231                 Size : nul or number of regular input ports.
232             </para>
233             <para>
234                 Type : column vector of strings.
235             </para>
236         </refsect2>
237         <refsect2 id="scicos_block_graphics_out_style">
238             <title>out_style</title>
239             <para> A vector of strings including JGraphX key values style properties.</para>
240             <para>
241                 These style can be used to place text or to change port aspect (eg. round, green port). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=green"</literal> for a round and green port
242             </para>
243             <para>
244                 Size : nul or number of regular output ports.
245             </para>
246             <para>
247                 Type : column vector of strings.
248             </para>
249         </refsect2>
250         <refsect2 id="scicos_block_graphics_in_label">
251             <title>in_label</title>
252             <para> A vector of strings including ports labels.</para>
253             <para>These labels can be used to update text or to trace information.</para>
254             <para>
255                 Size : nul or number of regular input ports.
256             </para>
257             <para>
258                 Type : column vector of strings.
259             </para>
260         </refsect2>
261         <refsect2 id="scicos_block_graphics_out_label">
262             <title>out_label</title>
263             <para> A vector of strings including ports labels.</para>
264             <para>These labels can be used to update text or to trace information.</para>
265             <para>
266                 Size : nul or number of regular output ports.
267             </para>
268             <para>
269                 Type : column vector of strings.
270             </para>
271         </refsect2>
272         <refsect2 id="scicos_block_graphics_style">
273             <title>style</title>
274             <para> A string.</para>
275             <para> A vector of strings including JGraphX key values style properties.</para>
276             <para>
277                 These style can be used to place text or to change block aspect (eg. shape, image, text). This is set in semicolon separated key=value set. For example <literal>"shape=ellipse;fillColor=red"</literal> for a round and green block
278             </para>
279             <para>
280                 Size : nul or 1.
281             </para>
282             <para>
283                 Type : a string.
284             </para>
285         </refsect2>
286     </refsect1>
287 </refentry>