fbf10e027e7d2ff15e9587248eb2c988b4c006dd
[scilab.git] / scilab / modules / graphics / help / ja_JP / property / set.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4
5  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
6
7  * Copyright (C) INRIA - Djalel Abdemouche
8
9  *
10
11
12  * Copyright (C) 2012 - 2016 - Scilab Enterprises
13  *
14  * This file is hereby licensed under the terms of the GNU GPL v2.0,
15  * pursuant to article 5.3.4 of the CeCILL v.2.1.
16  * This file was originally licensed under the terms of the CeCILL v2.1,
17  * and continues to be available under such terms.
18  * For more information, see the COPYING file which you should have received
19  * along with this program.
20
21  *
22
23  -->
24
25 <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="set">
26
27     <refnamediv>
28
29         <refname>set</refname>
30
31         <refpurpose>グラフィックエンティティオブジェクトまたは
32
33             またはユーザインターフェイスオブジェクトのプロパティの値を設定する.
34
35         </refpurpose>
36
37     </refnamediv>
38
39     <refsynopsisdiv>
40
41         <title>呼び出し手順</title>
42
43         <synopsis>
44
45             set(prop,val)
46
47             set(h,prop)
48
49             set(h,prop,val)
50
51             set(handlePath,prop,val[,prop2, val2, ..., propn, valn])
52
53             h.prop=val
54
55         </synopsis>
56
57     </refsynopsisdiv>
58
59     <refsection>
60
61         <title>引数</title>
62
63         <variablelist>
64
65             <varlistentry>
66
67                 <term>h</term>
68
69                 <listitem>
70
71                     <para>名前のあるプロパティを設定するエンティティの
72
73                         グラフィックハンドル.
74
75                         <literal>h</literal> はハンドルのベクトルとすることができ,
76
77                         この場合,プロパティを修正すると,hに含まれる全てのエンティティに
78
79                         適用されます.
80
81                     </para>
82
83                 </listitem>
84
85             </varlistentry>
86
87             <varlistentry>
88
89                 <term>handlePath</term>
90
91                 <listitem>
92
93                     <para>
94
95                         graphicエンティティを指すパスを有する文字列.
96
97                         このパスはgraphicエンティティ<literal>"Tag"</literal> プロパティおよび
98
99                         <literal>"figuretag/entitytag"</literal> (エンティティが図の子の場合)形式による
100
101                         グラフィック階層におけるその親の<literal>"Tag"</literal>プロパティ
102
103                         から構成されます.
104
105                     </para>
106
107                     <para>
108
109                         <literal>"figuretag/entity1tag/entity2tag/entityntag/entitytag"</literal>のように
110
111                         より深い階層レベルも使用できます.
112
113                         複数のパスを検索する際にワイルドカードも使用できます.
114
115                         パスに一致した最初のエンティティが使用されます.
116
117                     </para>
118
119                 </listitem>
120
121             </varlistentry>
122
123             <varlistentry>
124
125                 <term>prop</term>
126
127                 <listitem>
128
129                     <para>文字列, 設定するプロパティの名前.</para>
130
131                 </listitem>
132
133             </varlistentry>
134
135             <varlistentry>
136
137                 <term>val</term>
138
139                 <listitem>
140
141                     <para>プロパティに設定する値.</para>
142
143                 </listitem>
144
145             </varlistentry>
146
147         </variablelist>
148
149     </refsection>
150
151     <refsection>
152
153         <title>説明</title>
154
155         <para>このルーチンはグラフィックエンティティまたはGUIオブジェクトの
156
157             特定のプロパティの値を修正する際に使用できます.
158
159             この場合,ハンドルにドット演算子を使用するのと等価です.
160
161             例えば,<literal>set(h,"background",5)</literal> は <literal>h.background = 5</literal>と等価です.
162
163         </para>
164
165         <para>プロパティの名前は文字列です.
166
167             設定する値はハンドルの型とプロパティに依存します.
168
169         </para>
170
171         <para>存在するプロパティの全リストを取得するには,
172
173             <link linkend="graphics_entities">graphics_entities</link> または
174
175             (ユーザインタフェースオブジェクトについては)<link linkend="uicontrol">uicontrol</link>を
176
177             参照ください.
178
179         </para>
180
181         <para>
182
183             <literal>set</literal> 関数はプロパティと値のみを指定するコールも可能です.
184
185             この場合,プロパティは以下のどれかとします:
186
187         </para>
188
189         <variablelist>
190
191             <varlistentry>
192
193                 <term>current_entity または hdl</term>
194
195                 <listitem>
196
197                     <para>
198
199                         <literal>set('current_entity',h)</literal> または
200
201                         <literal>set('hdl',h)</literal>は新規エンティティをカレントに設定します.
202
203                         この場合,値にはグラフィックハンドルを指定します.
204
205                     </para>
206
207                 </listitem>
208
209             </varlistentry>
210
211             <varlistentry>
212
213                 <term>current_figure</term>
214
215                 <listitem>
216
217                     <para>
218
219                         <literal>set('current_figure',fig)</literal> は新しいグラフィック図を
220
221                         カレントに設定します.
222
223                         これは <link linkend="scf">scf</link>と等価です. この場合,
224
225                         値には図のハンドルを指定します.
226
227                     </para>
228
229                 </listitem>
230
231             </varlistentry>
232
233             <varlistentry>
234
235                 <term>current_axes</term>
236
237                 <listitem>
238
239                     <para>
240
241                         <literal>set('current_axes',axes)</literal> は新しい軸をカレントに
242
243                         設定します.
244
245                         これは,<link linkend="sca">sca</link>と等価です. この場合,
246
247                         値にはAxesハンドルを指定します.
248
249                     </para>
250
251                 </listitem>
252
253             </varlistentry>
254
255         </variablelist>
256
257         <para>
258
259             <literal>set</literal> は引数にグラフィックハンドルとプロパティを指定して
260
261             コールすることも可能です.
262
263             ハンドルにはデフォルト図またはデフォルト軸のエンティティへのハンドルのどちらかを
264
265             指定します.
266
267             プロパティの値は, <literal>"default_values"</literal>とします.
268
269             この場合,デフォルトのエンティティはScilabの起動時にこの値にリセットされます.
270
271             <literal>set("default_values",h)</literal>は
272
273             <link linkend="sda">sda</link> または <link linkend="sdf">sdf</link>と等価です.
274
275         </para>
276
277     </refsection>
278
279     <refsection>
280
281         <title>例</title>
282
283         <para>
284
285             <programlisting role="example"><![CDATA[
286
287 clf()
288
289 set("auto_clear","off") ;
290
291 // Plot 2Dの例
292
293 x=[-.2:0.1:2*%pi]';
294
295 plot2d(x-.3,[sin(x-1) cos(2*x)],[1 2] );
296
297 a=get("current_axes");
298
299 p1=a.children.children(1);
300
301 p2=a.children.children(2);
302
303 // 名前のあるプロパティをオブジェクト固有の値に設定
304
305 set(p2,"foreground",13);
306
307 set(p2,"polyline_style",2);
308
309 set(a,'tight_limits',"on");
310
311 set(a,"box","off");
312
313 set(a,"sub_tics",[ 7 0 ]);
314
315 set(a,"y_location","middle")
316
317 set(p2,'thickness',2);
318
319 set(p1,'mark_mode',"on");
320
321 set(p1,'mark_style',3);
322
323 plot2d(x-2,x.^2/20);
324
325 p3= a.children(1).children;
326
327 set([a p1 p2 p3],"foreground",5)
328
329  ]]></programlisting>
330
331         </para>
332
333         <para>
334
335             <programlisting role="example"><![CDATA[
336
337 // パスを使用
338
339 f = figure("dockable", "off", "menubar", "none", "toolbar", "none", "infobar_visible", "off", "tag", "mainfig");
340
341 frameHandle = uicontrol("parent", f, "style", "frame", "position", [200 200 190 100], "tag", "myframe");
342
343 btnHandle = uicontrol("parent", frameHandle, "position", [20 20 150 30], "string", "button", "tag", "example");
344
345
346
347 set("mainfig/myframe/example", "string", "complete path");
348
349 get("mainfig/myframe/example", "string")
350
351 set("mainfig/*/example", "string", "wildcard path");
352
353 get("mainfig/*/example", "string")
354
355 set("myframe/example", "string", "partial path");
356
357 get("myframe/example", "string")
358
359  ]]></programlisting>
360
361         </para>
362
363     </refsection>
364
365     <refsection role="see also">
366
367         <title>参照</title>
368
369         <simplelist type="inline">
370
371             <member>
372
373                 <link linkend="get">get</link>
374
375             </member>
376
377             <member>
378
379                 <link linkend="delete">delete</link>
380
381             </member>
382
383             <member>
384
385                 <link linkend="copy">copy</link>
386
387             </member>
388
389             <member>
390
391                 <link linkend="move">move</link>
392
393             </member>
394
395             <member>
396
397                 <link linkend="graphics_entities">graphics_entities</link>
398
399             </member>
400
401             <member>
402
403                 <link linkend="uicontrol">uicontrol</link>
404
405             </member>
406
407         </simplelist>
408
409     </refsection>
410
411     <refsection>
412
413         <title>履歴</title>
414
415         <revhistory>
416
417             <revision>
418
419                 <revnumber>5.5.0</revnumber>
420
421                 <revremark>
422
423                     <itemizedlist>
424
425                         <listitem>
426
427                             最初の入力引数をグラフィックエンティティを指すパスとすることが
428
429                             できるようになりました.
430
431                         </listitem>
432
433                         <listitem>
434
435                             複数のプロパティ設定を一度に利用できるようになりました.
436
437                         </listitem>
438
439                     </itemizedlist>
440
441                 </revremark>
442
443             </revision>
444
445         </revhistory>
446
447     </refsection>
448
449 </refentry>
450