~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/graphics/help/ja_JP/property/get.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
 *
13
13
 -->
14
14
<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" version="5.0-subset Scilab" xml:lang="ja" xml:id="get">
15
 
  <refnamediv>
16
 
    <refname>get</refname>
17
 
    <refpurpose>グラフィックエンティティまたはユーザーインターフェイスオブジェクト
18
 
      からプロパティの値を取得する.
19
 
    </refpurpose>
20
 
  </refnamediv>
21
 
  <refsynopsisdiv>
22
 
    <title>呼び出し手順</title>
23
 
    <synopsis>h=get(prop)
24
 
      val=get(h,prop)
25
 
      val=h.prop
26
 
    </synopsis>
27
 
  </refsynopsisdiv>
28
 
  <refsection>
29
 
    <title>パラメータ</title>
30
 
    <variablelist>
31
 
      <varlistentry>
32
 
        <term>h</term>
33
 
        <listitem>
34
 
          <para>ハンドル, プロパティを取得するエンティティのハンドル.
35
 
            <literal>h</literal> はハンドルのベクトルとすることができ,この場合,
36
 
            h に含まれる全てのオブジェクトに関するプロパティの値を返します.
37
 
            <literal>h</literal> に<emphasis>0</emphasis> を指定することができ,
38
 
            この場合,ルートオブジェクトのプロパティが取得されます..
39
 
          </para>
40
 
        </listitem>
41
 
      </varlistentry>
42
 
      <varlistentry>
43
 
        <term>prop</term>
44
 
        <listitem>
45
 
          <para>プロパティ名を表す文字列.</para>
46
 
        </listitem>
47
 
      </varlistentry>
48
 
      <varlistentry>
49
 
        <term>val</term>
50
 
        <listitem>
51
 
          <para>プロパティの値.</para>
52
 
        </listitem>
53
 
      </varlistentry>
54
 
    </variablelist>
55
 
  </refsection>
56
 
  <refsection>
57
 
    <title>説明</title>
58
 
    <para>このルーチンはグラフィクエンティティまたはGUIオブジェクトから指定したプロパティの
59
 
      値を取得するために使用されます.
60
 
      この場合,ハンドルのドット演算子を使用することと等価です.
61
 
      例えば,  <literal>get(h,"background")</literal> は <literal>h.background</literal>と等価です.
62
 
    </para>
63
 
    <para>
64
 
      プロパティ名は文字列です.存在する全てのプロパティの一覧を得るには,
65
 
      <link linkend="graphics_entities">graphics_entities</link>,もしくは
66
 
      ユーザインターフェイスオブジェクトについては<link linkend="uicontrol">uicontrol</link>
67
 
      を参照ください.
68
 
    </para>
69
 
    <para>
70
 
      <literal>get</literal> 関数はプロパティのみを引数に指定してコールすることも
71
 
      可能です.この場合,そのプロパティは以下のどれかとする必要がありますg:
72
 
    </para>
73
 
    <variablelist>
74
 
      <varlistentry>
75
 
        <term>current_entity or hdl</term>
76
 
        <listitem>
77
 
          <para>直近に作成された(そしてまだ存在する)エンティティのハンドルを返します.
78
 
            <literal>get('current_entity')</literal> および <literal>get('hdl')</literal> 
79
 
            は<link linkend="gce">gce</link>と等価です.
80
 
          </para>
81
 
        </listitem>
82
 
      </varlistentry>
83
 
      <varlistentry>
84
 
        <term>current_figure</term>
85
 
        <listitem>
86
 
          <para>カレントのグラフィック図のハンドルを返します.
87
 
            <literal>get('current_figure')</literal> は <link linkend="gcf">gcf</link>と等価です.
88
 
          </para>
89
 
        </listitem>
90
 
      </varlistentry>
91
 
      <varlistentry>
92
 
        <term>current_axes</term>
93
 
        <listitem>
94
 
          <para>カレントの軸のハンドルを返します.
95
 
            <literal>get('current_axes')</literal> は <link linkend="gca">gca</link>と等価です.
96
 
          </para>
97
 
        </listitem>
98
 
      </varlistentry>
99
 
      <varlistentry>
100
 
        <term>default_figure</term>
101
 
        <listitem>
102
 
          <para>デフォルトの図のエンティティのハンドルを返します.
103
 
            <literal>get('default_figure')</literal> は <link linkend="gdf">gdf</link>と等価です.
104
 
          </para>
105
 
        </listitem>
106
 
      </varlistentry>
107
 
      <varlistentry>
108
 
        <term>default_axes</term>
109
 
        <listitem>
110
 
          <para>デフォルトの軸のエンティティのハンドルを返します.
111
 
            <literal>get('default_axes')</literal> は <link linkend="gda">gda</link>と等価です.
112
 
          </para>
113
 
        </listitem>
114
 
      </varlistentry>
115
 
      <varlistentry>
116
 
        <term>figures_id</term>
117
 
        <listitem>
118
 
          <para>オープンした全てのグラフィク図のIDを有する行ベクトルを返します.
119
 
            <literal>get('figures_id')</literal> は <link linkend="winsid">winsid</link>と等価です.
120
 
          </para>
121
 
        </listitem>
122
 
      </varlistentry>
123
 
    </variablelist>
124
 
  </refsection>
125
 
  <refsection>
126
 
    <title>例</title>
127
 
    <programlisting role="example"><![CDATA[ 
 
15
    <refnamediv>
 
16
        <refname>get</refname>
 
17
        <refpurpose>グラフィックエンティティまたはユーザーインターフェイスオブジェクト
 
18
            からプロパティの値を取得する.
 
19
        </refpurpose>
 
20
    </refnamediv>
 
21
    <refsynopsisdiv>
 
22
        <title>呼び出し手順</title>
 
23
        <synopsis>h=get(prop)
 
24
            val=get(h,prop)
 
25
            val=h.prop
 
26
        </synopsis>
 
27
    </refsynopsisdiv>
 
28
    <refsection>
 
29
        <title>パラメータ</title>
 
30
        <variablelist>
 
31
            <varlistentry>
 
32
                <term>h</term>
 
33
                <listitem>
 
34
                    <para>ハンドル, プロパティを取得するエンティティのハンドル.
 
35
                        <literal>h</literal> はハンドルのベクトルとすることができ,この場合,
 
36
                        h に含まれる全てのオブジェクトに関するプロパティの値を返します.
 
37
                        <literal>h</literal> に<emphasis>0</emphasis> を指定することができ,
 
38
                        この場合,ルートオブジェクトのプロパティが取得されます..
 
39
                    </para>
 
40
                </listitem>
 
41
            </varlistentry>
 
42
            <varlistentry>
 
43
                <term>prop</term>
 
44
                <listitem>
 
45
                    <para>プロパティ名を表す文字列.</para>
 
46
                </listitem>
 
47
            </varlistentry>
 
48
            <varlistentry>
 
49
                <term>val</term>
 
50
                <listitem>
 
51
                    <para>プロパティの値.</para>
 
52
                </listitem>
 
53
            </varlistentry>
 
54
        </variablelist>
 
55
    </refsection>
 
56
    <refsection>
 
57
        <title>説明</title>
 
58
        <para>このルーチンはグラフィクエンティティまたはGUIオブジェクトから指定したプロパティの
 
59
            値を取得するために使用されます.
 
60
            この場合,ハンドルのドット演算子を使用することと等価です.
 
61
            例えば,  <literal>get(h,"background")</literal> は <literal>h.background</literal>と等価です.
 
62
        </para>
 
63
        <para>
 
64
            プロパティ名は文字列です.存在する全てのプロパティの一覧を得るには,
 
65
            <link linkend="graphics_entities">graphics_entities</link>,もしくは
 
66
            ユーザインターフェイスオブジェクトについては<link linkend="uicontrol">uicontrol</link>
 
67
            を参照ください.
 
68
        </para>
 
69
        <para>
 
70
            <literal>get</literal> 関数はプロパティのみを引数に指定してコールすることも
 
71
            可能です.この場合,そのプロパティは以下のどれかとする必要がありますg:
 
72
        </para>
 
73
        <variablelist>
 
74
            <varlistentry>
 
75
                <term>current_entity or hdl</term>
 
76
                <listitem>
 
77
                    <para>直近に作成された(そしてまだ存在する)エンティティのハンドルを返します.
 
78
                        <literal>get('current_entity')</literal> および <literal>get('hdl')</literal> 
 
79
                        は<link linkend="gce">gce</link>と等価です.
 
80
                    </para>
 
81
                </listitem>
 
82
            </varlistentry>
 
83
            <varlistentry>
 
84
                <term>current_figure</term>
 
85
                <listitem>
 
86
                    <para>カレントのグラフィック図のハンドルを返します.
 
87
                        <literal>get('current_figure')</literal> は <link linkend="gcf">gcf</link>と等価です.
 
88
                    </para>
 
89
                </listitem>
 
90
            </varlistentry>
 
91
            <varlistentry>
 
92
                <term>current_axes</term>
 
93
                <listitem>
 
94
                    <para>カレントの軸のハンドルを返します.
 
95
                        <literal>get('current_axes')</literal> は <link linkend="gca">gca</link>と等価です.
 
96
                    </para>
 
97
                </listitem>
 
98
            </varlistentry>
 
99
            <varlistentry>
 
100
                <term>default_figure</term>
 
101
                <listitem>
 
102
                    <para>デフォルトの図のエンティティのハンドルを返します.
 
103
                        <literal>get('default_figure')</literal> は <link linkend="gdf">gdf</link>と等価です.
 
104
                    </para>
 
105
                </listitem>
 
106
            </varlistentry>
 
107
            <varlistentry>
 
108
                <term>default_axes</term>
 
109
                <listitem>
 
110
                    <para>デフォルトの軸のエンティティのハンドルを返します.
 
111
                        <literal>get('default_axes')</literal> は <link linkend="gda">gda</link>と等価です.
 
112
                    </para>
 
113
                </listitem>
 
114
            </varlistentry>
 
115
            <varlistentry>
 
116
                <term>figures_id</term>
 
117
                <listitem>
 
118
                    <para>オープンした全てのグラフィク図のIDを有する行ベクトルを返します.
 
119
                        <literal>get('figures_id')</literal> は <link linkend="winsid">winsid</link>と等価です.
 
120
                    </para>
 
121
                </listitem>
 
122
            </varlistentry>
 
123
        </variablelist>
 
124
    </refsection>
 
125
    <refsection>
 
126
        <title>例</title>
 
127
        <programlisting role="example"><![CDATA[ 
128
128
// グラフィックエンティティ用
129
129
 clf()
130
130
    
161
161
disp('Button width: ' + string(p(3))); // ボタンの幅を出力
162
162
close(); // close figure
163
163
 ]]></programlisting>
164
 
  </refsection>
165
 
  <refsection>
166
 
    <title>参考</title>
167
 
    <simplelist type="inline">
168
 
      <member>
169
 
        <link linkend="uicontrol">uicontrol</link>
170
 
      </member>
171
 
      <member>
172
 
        <link linkend="root_properties">root_properties</link>
173
 
      </member>
174
 
      <member>
175
 
        <link linkend="graphics_entities">graphics_entities</link>
176
 
      </member>
177
 
      <member>
178
 
        <link linkend="set">set</link>
179
 
      </member>
180
 
    </simplelist>
181
 
  </refsection>
 
164
    </refsection>
 
165
    <refsection>
 
166
        <title>参考</title>
 
167
        <simplelist type="inline">
 
168
            <member>
 
169
                <link linkend="uicontrol">uicontrol</link>
 
170
            </member>
 
171
            <member>
 
172
                <link linkend="root_properties">root_properties</link>
 
173
            </member>
 
174
            <member>
 
175
                <link linkend="graphics_entities">graphics_entities</link>
 
176
            </member>
 
177
            <member>
 
178
                <link linkend="set">set</link>
 
179
            </member>
 
180
        </simplelist>
 
181
    </refsection>
182
182
</refentry>