* Bug 16008 fixed [doc]: uimenu_properties was not up-to-date
[scilab.git] / scilab / modules / gui / help / ja_JP / menus / uimenu_properties.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  *
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2019 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="uimenu_properties" xml:lang="ja">
20     <refnamediv>
21         <refname>uimenuプロパティ</refname>
22         <refpurpose>uimenuプロパティの説明.</refpurpose>
23     </refnamediv>
24     <refsection>
25         <title>説明</title>
26         <para>このページはScilab GUIのメニューで利用可能な全プロパティの
27             一覧を示します.
28         </para>
29         <para>
30             これらのプロパティは <link linkend="uimenu">uimenu</link>
31             関数により作成をする際に設定できます.
32         </para>
33         <para>
34             これらの値は <link linkend="set">set</link>  関数により変更でき,
35             <link linkend="get">get</link> 関数により読み込めます.
36         </para>
37     </refsection>
38     <refsection>
39         <title>プロパティ</title>
40         <variablelist>
41             <varlistentry>
42                 <term>Callback</term>
43                 <listitem>
44                     <para>文字列</para>
45                     <para>
46                         メニューが有効な場合にScilabインタプリタにより
47                         評価される命令.
48                         Mac OSXでは,"button menu"(子のないメニュー)の場合に
49                         コールバックは実行されないため,
50                         子を一つ以上指定する必要があります.
51                     </para>
52                 </listitem>
53             </varlistentry>
54             <varlistentry>
55                 <term>Callback_Type</term>
56                 <listitem>
57                     <para>
58                         Scalar. Integer code setting the way the callback string must be
59                         interpreted to perform the action:
60                     </para>
61                     <table>
62                         <tr>
63                             <th>-1</th><td>:</td>
64                             <td>callback disabled.</td>
65                         </tr>
66                         <tr>
67                             <th>0</th><td>:</td>
68                             <td>
69                                 (default) non prioritary (or interruptible) Scilab instructions.
70                                 Example: .callback = "help(""uimenu"")"
71                             </td>
72                         </tr>
73                         <tr>
74                             <th>1</th><td>:</td>
75                             <td>Fortran function</td>
76                         </tr>
77                         <tr>
78                             <th>2</th><td>:</td>
79                             <td>non prioritary (or interruptible) Scilab function.</td>
80                         </tr>
81                         <tr>
82                             <th>3</th><td>:</td>
83                             <td>
84                                 Java reference. Example:
85                                 .callback = "org.scilab.modules.gui.editor.EditorManager.start([SCILAB_FIGURE_ID])"
86                             </td>
87                         </tr>
88                         <tr>
89                             <th>10</th><td>:</td>
90                             <td>prioritary (or non-interruptible) Scilab instructions.</td>
91                         </tr>
92                         <tr>
93                             <th>12</th><td>:</td>
94                             <td>prioritary (or non-interruptible) Scilab function</td>
95                         </tr>
96                     </table>
97                     <para/>
98                 </listitem>
99             </varlistentry>
100             <varlistentry>
101                 <term>Checked</term>
102                 <listitem>
103                     <para>on | {off}</para>
104                     <para>
105                         要素チェックインジケータ.
106                         このプロパティに "on"を指定すると,
107                         チェックボックスを最初に表示した際に
108                         この要素のラベルの先頭にチェックボックスが
109                         表示され,それがチェックされます.
110                         "off"を指定するとチェックボックスは表示されたままで
111                         チェックが外されます.
112                         このプロパティは特定のオプションの状態を示す
113                         要素を表示する際に使用できます.
114                     </para>
115                     <para>注意:
116                         <itemizedlist>
117                             <listitem>
118                                 作成後にチェックボックスを削除する手段はありませんが,
119                                 要素を削除することはできます.
120                             </listitem>
121                             <listitem>
122                                 デフォルトで,対話的にチェックをしたり,チェックを外すことは
123                                 できません.
124                                 このような処理はCallbackプロパティにより実装できます.
125                             </listitem>
126                             <listitem>
127                                 このプロパティは親メニューでは無視されます.
128                             </listitem>
129                         </itemizedlist>
130                     </para>
131                 </listitem>
132             </varlistentry>
133             <varlistentry>
134                 <term>Children</term>
135                 <listitem>
136                     <para>vector of handles</para>
137                     <para>
138                         If the current uimenu item is a menu listing subitems, their handles are
139                         gathered in this Children property. All of them should be of type "uimenu".
140                         Otherwise, .Children is the empty matrix [].
141                     </para>
142                 </listitem>
143             </varlistentry>
144             <varlistentry>
145                 <term>Enable</term>
146                 <listitem>
147                     <para>{on} | off</para>
148                     <para>
149                         メニューを有効または無効にします.
150                         このプロパティに <literal>"on"</literal> (デフォルト)
151                         を指定した場合,メニューは有効となり,
152                         このプロパティに<literal>"off"</literal>を
153                         指定した場合,メニューはマウスのアクションに反応せず,
154                         グレイアウトされます.
155                     </para>
156                 </listitem>
157             </varlistentry>
158             <varlistentry>
159                 <term>ForegroundColor</term>
160                 <listitem>
161                     <para>[1 3] 実数ベクトルまたは文字列</para>
162                     <para>
163                         uimenuの表面色(フォントの色).
164                         色は赤,緑および青の値として指定されます.
165                         これらの色は[0,1]の範囲の実数です.
166                         色は実数ベクトル,すなわち [R,G,B]または
167                         "R|G|B"のように
168                         各値を "|" で区切った文字列で指定できます.
169                     </para>
170                 </listitem>
171             </varlistentry>
172             <varlistentry>
173                 <term>Handle_visible</term>
174                 <listitem>
175                     <para>on | {off}</para>
176                     <para>
177                         Setting it to "on" forces the uimenu handle to be visible in the list of
178                         its parent children, even if get(0).showhiddenhandles == "off".
179                     </para>
180                     <para>
181                         Setting it to "off" does NOT force it to be hidden:
182                         get(0).showhiddenhandles == "on" is stronger.
183                     </para>
184                 </listitem>
185             </varlistentry>
186             <varlistentry>
187                 <term>Icon</term>
188                 <listitem>
189                     <para>文字列.</para>
190                     <para>
191                         このプロパティは,メニューのアイコンとして使用される画像ファイルの
192                         (<link linkend="pwd">Scilabワーキングディレクトリ</link>に対する)
193                         相対パスまたは絶対パスを表します.
194                     </para>
195                 </listitem>
196             </varlistentry>
197             <varlistentry>
198                 <term>Label</term>
199                 <listitem>
200                     <para>文字列.</para>
201                     <para>
202                         このプロパティはメニューに表示するテキストを表します.
203                         テキストが2つの $ (ドル記号)で括られた場合,
204                         LaTeX式とみなされ,
205                         &lt; および &gt; で括られた場合, MathML式とみなされます.
206                     </para>
207                     <para>
208                         If the text value starts with <literal>&lt;html></literal>, then
209                         all HTML-4 tags used in the label afterward are interpreted.
210                         This allows for instance to use HTML styling tags like &lt;b>..&lt;/>
211                         for bold, &lt;span color="red">..&lt;/span> to use a red font, etc.
212                     </para>
213                 </listitem>
214             </varlistentry>
215             <varlistentry>
216                 <term>Tag</term>
217                 <listitem>
218                     <para>文字列</para>
219                     <para>
220                         このプロパティは,
221                         一般にメニューを特定する際に使用されます.
222                         これにより"名前"を指定することができます.
223                         主に<literal>findobj()</literal>で指定する
224                         際に使用されます.
225                     </para>
226                 </listitem>
227             </varlistentry>
228             <varlistentry>
229                 <term>User_data</term>
230                 <listitem>
231                     <para>Any type of data</para>
232                     <para>
233                         This property can be used to store any scilab user or application data.
234                         In order to be easily extensible and portable, using a structure with
235                         fields is advised. [] is set by default.
236                     </para>
237                 </listitem>
238             </varlistentry>
239             <varlistentry>
240                 <term>Visible</term>
241                 <listitem>
242                     <para>{on} | off</para>
243                     <para>
244                         uimenuの可視性を設定します.
245                         このプロパティに<literal>"on"</literal>(デフォルト)が
246                         設定された場合, uimenuは可視となりますが,
247                         このプロパティに<literal>"off"</literal>が指定された場合,
248                         uimenuは親の図に表示されません.
249                     </para>
250                 </listitem>
251             </varlistentry>
252         </variablelist>
253     </refsection>
254     <refsection role="see also">
255         <title>参照</title>
256         <simplelist type="inline">
257             <member>
258                 <link linkend="uimenu">uimenu</link>
259             </member>
260             <member>
261                 <link linkend="uicontextmenu">uicontextmenu</link>
262             </member>
263             <member>
264                 <link linkend="uicontrol">uicontrol</link>
265             </member>
266             <member>
267                 <link linkend="console_properties">showHiddenHandles</link>
268             </member>
269             <member>
270                 <link linkend="set">set</link>
271             </member>
272             <member>
273                 <link linkend="math_rendering_features_in_graphic">LaTeX および MathML</link>
274             </member>
275         </simplelist>
276     </refsection>
277     <refsection>
278         <title>履歴</title>
279         <revhistory>
280             <revision>
281                 <revnumber>5.4.0</revnumber>
282                 <revremark>
283                     <literal>Handle_visible</literal> property added.
284                 </revremark>
285             </revision>
286             <revision>
287                 <revnumber>5.5.0</revnumber>
288                 <revremark>
289                     <literal>Icon</literal> プロパティが追加されました.
290                 </revremark>
291             </revision>
292         </revhistory>
293     </refsection>
294 </refentry>