update japanese translation of core module.
[scilab.git] / scilab / modules / graphics / help / ja_JP / xget.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) ENPC - Jean-Philippe Chancelier
8
9  * 
10
11  * This file must be used under the terms of the CeCILL.
12
13  * This source file is licensed as described in the file COPYING, which
14
15  * you should have received as part of this distribution.  The terms
16
17  * are also available at    
18
19  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xget" xml:lang="ja">
26     
27     <refnamediv>
28         
29         <refname>xget</refname>
30         
31         <refpurpose>
32             
33             グラフィックコンテキストのカレントの値を取得. 
34             
35             <emphasis role="bold">この関数は廃止されました.</emphasis>
36             
37         </refpurpose>
38         
39     </refnamediv>
40     
41     <refsynopsisdiv>
42         
43         <title>呼び出し手順</title>
44         
45         <synopsis>[x1]=xget(str,[flag])
46             
47             xget()
48             
49         </synopsis>
50         
51     </refsynopsisdiv>
52     
53     <refsection>
54         
55         <title>パラメータ</title>
56         
57         <variablelist>
58             
59             <varlistentry>
60                 
61                 <term>str</term>
62                 
63                 <listitem>
64                     
65                     <para>文字列.</para>
66                     
67                 </listitem>
68                 
69             </varlistentry>
70             
71             <varlistentry>
72                 
73                 <term>flag</term>
74                 
75                 <listitem>
76                     
77                     <para>オプション. 1を指定すると冗長モード.</para>
78                     
79                 </listitem>
80                 
81             </varlistentry>
82             
83         </variablelist>
84         
85     </refsection>
86     
87     <refsection>
88         
89         <title>説明</title>
90         
91         <para>
92             
93             <warning>
94                 
95                 この関数は廃止されました.
96                 
97             </warning>
98             
99             代わりにScilabグラフィックオブジェクト表現を使用してください
100             
101             (<link linkend="set">set</link>および <link linkend="get">get</link>関数
102             
103             および<link linkend="graphics_entities">graphicsエンティティ</link>を参照).
104             
105         </para>
106         
107         <para>
108             
109             This function is used to get values from the graphics context on the
110             
111             topic specified by the string <literal>str</literal>. When called with no
112             
113             argument, a choice menu is created showing the current values and changes
114             
115             can be performed through toggle buttons.
116             
117         </para>
118         
119         <variablelist>
120             
121             <varlistentry>
122                 
123                 <term>str = xget("auto clear")</term>
124                 
125                 <listitem>
126                     
127                     <para>
128                         
129                         Get the auto clear status (<literal>"on"</literal> or
130                         
131                         <literal>"off"</literal>).
132                         
133                     </para>
134                     
135                 </listitem>
136                 
137             </varlistentry>
138             
139             <varlistentry>
140                 
141                 <term>color = xget("background")</term>
142                 
143                 <listitem>
144                     
145                     <para>
146                         
147                         Get the background color of the current
148                         
149                         <literal>Axes</literal> object. The result is a colormap
150                         
151                         index corresponding to the color.
152                         
153                     </para>
154                     
155                 </listitem>
156                 
157             </varlistentry>
158             
159             <varlistentry>
160                 
161                 <term>rect = xget("clipping")</term>
162                 
163                 <listitem>
164                     
165                     <para>
166                         
167                         Get the clipping zone as a rectangle <literal>rect =
168                             
169                             [x,y,w,h]
170                             
171                         </literal>
172                         
173                         (Upper-Left point, Width, Height).
174                         
175                     </para>
176                     
177                 </listitem>
178                 
179             </varlistentry>
180             
181             <varlistentry>
182                 
183                 <term>c = xget("color")</term>
184                 
185                 <listitem>
186                     
187                     <para>
188                         
189                         Get the default color for filling, line or text drawing
190                         
191                         functions. <literal>c</literal> is an integer projected
192                         
193                         in the interval <literal>[0,whiteid]</literal>. 0 stands
194                         
195                         for black filling and <literal>whiteid</literal> for
196                         
197                         white. The value of <literal>whiteid</literal> can be
198                         
199                         obtained with <code>xget("white")</code>.
200                         
201                     </para>
202                     
203                 </listitem>
204                 
205             </varlistentry>
206             
207             <varlistentry>
208                 
209                 <term>cmap = xget("colormap")</term>
210                 
211                 <listitem>
212                     
213                     <para>
214                         
215                         Get the colormap used for the current graphics window as
216                         
217                         a <literal>m x 3</literal> RGB matrix.
218                         
219                     </para>
220                     
221                 </listitem>
222                 
223             </varlistentry>
224             
225             <varlistentry>
226                 
227                 <term>dash = xget("dashes")</term>
228                 
229                 <listitem>
230                     
231                     <para>
232                         
233                         Get the dash style <literal>dash = [dash_number]</literal>
234                         
235                         where <literal>dash_number</literal> is the id of the
236                         
237                         dash.
238                         
239                         <warning>
240                             
241                             This keyword is obsolete, please use
242                             
243                             <literal>xget("color")</literal> or
244                             
245                             <literal>xget("line style")</literal> instead.
246                             
247                         </warning>
248                         
249                     </para>
250                     
251                 </listitem>
252                 
253             </varlistentry>
254             
255             <varlistentry>
256                 
257                 <term>font = xget("font")</term>
258                 
259                 <listitem>
260                     
261                     <para>
262                         
263                         Get <literal>font = [fontid, fontsize]</literal>, the
264                         
265                         default font and the default value of font size.
266                         
267                     </para>
268                     
269                 </listitem>
270                 
271             </varlistentry>
272             
273             <varlistentry>
274                 
275                 <term>fontsize = xget("font size")</term>
276                 
277                 <listitem>
278                     
279                     <para>Get the default value of font size.</para>
280                     
281                 </listitem>
282                 
283             </varlistentry>
284             
285             <varlistentry>
286                 
287                 <term>color = xget("foreground")</term>
288                 
289                 <listitem>
290                     
291                     <para>
292                         
293                         Get the foreground color of the current
294                         
295                         <literal>Axes</literal> object. The result is a colormap index corresponding to the color.
296                         
297                     </para>
298                     
299                 </listitem>
300                 
301             </varlistentry>
302             
303             <varlistentry>
304                 
305                 <term>str = xget("fpf")</term>
306                 
307                 <listitem>
308                     
309                     <para>
310                         
311                         Get the floating point format for number display in
312                         
313                         contour functions. Note that <literal>str</literal> is <literal>""</literal> when default format is used.
314                         
315                     </para>
316                     
317                 </listitem>
318                 
319             </varlistentry>
320             
321             <varlistentry>
322                 
323                 <term>color = xget("hidden3d")</term>
324                 
325                 <listitem>
326                     
327                     <para>
328                         
329                         Get the color number for hidden faces in <function>plot3d</function>.
330                         
331                     </para>
332                     
333                 </listitem>
334                 
335             </varlistentry>
336             
337             <varlistentry>
338                 
339                 <term>pat = xget("lastpattern")</term>
340                 
341                 <listitem>
342                     
343                     <para>
344                         
345                         Get the id of the last available pattern or color, with
346                         
347                         the current colormap of the current window. In fact
348                         
349                         <literal>pat+1</literal> and <literal>pat+2</literal>
350                         
351                         are also available and stand respectively for black and
352                         
353                         white pattern.
354                         
355                     </para>
356                     
357                 </listitem>
358                 
359             </varlistentry>
360             
361             <varlistentry>
362                 
363                 <term>type = xget("line mode")</term>
364                 
365                 <listitem>
366                     
367                     <para>
368                         
369                         Get the line drawing mode. <literal>type = 1</literal>
370                         
371                         is absolute mode and <literal>type = 0</literal> is
372                         
373                         relative mode.
374                         
375                         <warning>
376                             
377                             The mode <literal>type = 0</literal> has bugs.
378                             
379                         </warning>
380                         
381                     </para>
382                     
383                 </listitem>
384                 
385             </varlistentry>
386             
387             <varlistentry>
388                 
389                 <term>xget("line style")</term>
390                 
391                 <listitem>
392                     
393                     <para>
394                         
395                         Get the default line style (1 for solid line, &gt;1 for
396                         
397                         dashed lines).
398                         
399                     </para>
400                     
401                 </listitem>
402                 
403             </varlistentry>
404             
405             <varlistentry>
406                 
407                 <term>mark = xget("mark")</term>
408                 
409                 <listitem>
410                     
411                     <para>
412                         
413                         Get the default mark id and the default mark size.
414                         
415                         <literal>mark=[markid, marksize]</literal>.
416                         
417                     </para>
418                     
419                 </listitem>
420                 
421             </varlistentry>
422             
423             <varlistentry>
424                 
425                 <term>marksize = xget("mark size")</term>
426                 
427                 <listitem>
428                     
429                     <para>Get the default mark size.</para>
430                     
431                 </listitem>
432                 
433             </varlistentry>
434             
435             <varlistentry>
436                 
437                 <term>pat = xget("pattern")</term>
438                 
439                 <listitem>
440                     
441                     <para>
442                         
443                         Get the current pattern or the current color.
444                         
445                         <literal>pat</literal> is an integer in the range
446                         
447                         <literal>[1, last]</literal>. When one uses black and
448                         
449                         white, 0 is used for black filling and
450                         
451                         <literal>last</literal> for white. The value of
452                         
453                         <literal>last</literal> can be obtained with
454                         
455                         <code>xget("lastpattern")</code>.
456                         
457                     </para>
458                     
459                 </listitem>
460                 
461             </varlistentry>
462             
463             <varlistentry>
464                 
465                 <term>value = xget("thickness")</term>
466                 
467                 <listitem>
468                     
469                     <para>
470                         
471                         Get the thickness of lines in pixel (0 and 1 have the same meaning: 1 pixel thick).
472                         
473                     </para>
474                     
475                 </listitem>
476                 
477             </varlistentry>
478             
479             <varlistentry>
480                 
481                 <term>flag = xget("use color")</term>
482                 
483                 <listitem>
484                     
485                     <para>
486                         
487                         Get the flag 0 (use black and white) or 1 (use colors).
488                         
489                         See <function>xset</function>.
490                         
491                     </para>
492                     
493                 </listitem>
494                 
495             </varlistentry>
496             
497             <varlistentry>
498                 
499                 <term>[x, y] = xget("viewport")</term>
500                 
501                 <listitem>
502                     
503                     <para>
504                         
505                         Get the current position of the visible part of graphics
506                         
507                         in the panner.
508                         
509                     </para>
510                     
511                 </listitem>
512                 
513             </varlistentry>
514             
515             <varlistentry>
516                 
517                 <term>dim = xget("wdim")</term>
518                 
519                 <listitem>
520                     
521                     <para>
522                         
523                         Get the width and the height of the current graphics
524                         
525                         window <literal>dim = [width, height]</literal>.
526                         
527                     </para>
528                     
529                 </listitem>
530                 
531             </varlistentry>
532             
533             <varlistentry>
534                 
535                 <term>win = xget("window")</term>
536                 
537                 <listitem>
538                     
539                     <para>
540                         
541                         Get the current window number <literal>win</literal>.
542                         
543                     </para>
544                     
545                 </listitem>
546                 
547             </varlistentry>
548             
549             <varlistentry>
550                 
551                 <term>pos = xget("wpos")</term>
552                 
553                 <listitem>
554                     
555                     <para>
556                         
557                         Get the position of the upper left point of the graphics
558                         
559                         window <literal>pos = [x, y]</literal>.
560                         
561                     </para>
562                     
563                 </listitem>
564                 
565             </varlistentry>
566             
567         </variablelist>
568         
569     </refsection>
570     
571     <refsection role="see also">
572         
573         <title>参照</title>
574         
575         <simplelist type="inline">
576             
577             <member>
578                 
579                 <link linkend="xset">xset</link>
580                 
581             </member>
582             
583             <member>
584                 
585                 <link linkend="getcolor">getcolor</link>
586                 
587             </member>
588             
589             <member>
590                 
591                 <link linkend="ged">ged</link>
592                 
593             </member>
594             
595             <member>
596                 
597                 <link linkend="set">set</link>
598                 
599             </member>
600             
601             <member>
602                 
603                 <link linkend="graphics_entities">graphics_entities</link>
604                 
605             </member>
606             
607         </simplelist>
608         
609     </refsection>
610     
611     <refsection>
612         
613         <title>履歴</title>
614         
615         <revhistory>
616             
617             <revision>
618                 
619                 <revnumber>5.4.0</revnumber>
620                 
621                 <revremark>
622                     
623                     "alufunction" プロパティはもはやサポートされておらず,
624                     
625                     このプロパティは Scilab 5.0.1の描画では使用されいません.
626                     
627                 </revremark>
628                 
629             </revision>
630             
631         </revhistory>
632         
633     </refsection>
634     
635 </refentry>
636
637
638