ユーザーインターフェイス記述リファレンス

ユーザーインターフェイスを記述するときのルート要素です。 xvcd:vocabulary要素内に1つだけ記述できます。省略も可能です。この要素内に、ボキャブラリに対応するメニューやツールボックスの設定を記述します。

属性：

version （必須）

ユーザーインターフェイス記述ボキャブラリのバージョン番号を設定する属性です。必ず1.0を設定します。

内容：

ui:ui要素内には、以下の要素から必ず１つ以上を任意の組み合わせで記述します。

• ui:main-menu要素
  必要な数だけ記述できます。省略可能です。
• ui:context-menu要素
  必要な数だけ記述できます。省略可能です。
• ui:tool-bar要素
  必要な数だけ記述できます。省略可能です。
• ui:accelerators要素
  必要な数だけ記述できます。省略可能です。
• ui:import要素
  必要な数だけ記述できます。省略可能です。
• ui:mount要素
  必要な数だけ記述できます。省略可能です。

メインメニューの内容を記述するときに使用する要素です。

属性：

属性はありません。

内容：

ui:main-menu要素内には、以下の要素を必ず１つ以上記述します。

• ui:menu要素

コンテキストメニューの内容を記述するときに使用する要素です。

属性：

属性はありません。

内容：

ui:context-menu要素内には、以下の要素から必ず１つ以上を任意の組み合わせで記述します。

• ui:menu要素
• ui:menu-item要素
• ui:separator要素

選択するとサブメニューが表示されるメニュー項目を記述するときに使用する要素です。

属性：

label

メニューに表示するラベル文字列を指定する属性です。任意の文字列で記述します。 ただし、#ではじまる文字列は内部的に予約されています。そのため、#ではじまる文字列を記述するときは、最初の#を##と記述します。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、resource-key属性で指定した文字列リソースが使われます。

resource-key

メニューに表示するラベル文字列を文字列リソースから取得する場合、取得する文字列のリソースキーを指定する属性です。任意の文字列で記述します。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、label属性で指定した文字列が使われます。

mnemonic

メニューに割り付けるニーモニックを指定する属性です。半角英数字１文字で記述します。

省略された場合、ニーモニックがないメニュー項目が作成されます。

icon

メニューに表示するアイコンを指定する属性です。URL文字列で記述します。

省略された場合、アイコン表示がないメニュー項目が作成されます。

内容：

ui:menu要素内には、以下の要素から必ず１つ以上を任意の組み合わせで記述します。

• ui:menu要素
• ui:menu-item要素
• ui:separator要素

選択するとコマンドが実行されるメニュー項目を記述するときに使用する要素です。

属性：

label

メニューに表示するラベル文字列を指定する属性です。任意の文字列で記述します。 ただし、#ではじまる文字列は内部的に予約されています。そのため、#ではじまる文字列を記述するときは、最初の#を##と記述します。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、resource-key属性で指定した文字列リソースが使われます。

resource-key

メニューに表示するラベル文字列を文字列リソースから取得する場合、取得する文字列のリソースキーを指定する属性です。任意の文字列で記述します。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、label属性で指定した文字列が使われます。

command

メニューを選択されたときに実行するコマンドを指定する属性です。 xvcd:command要素で定義したコマンド名や、プラットフォームが提供するコマンド名をQNameで指定します。

省略された場合、要素内に記述されたコマンドインストラクション列を実行します。command属性とコマンドインストラクション列が同時に記述された場合は、command属性の指定が優先され、コマンドインストラクション列は無視されます。

mnemonic

メニューに割り付けるニーモニックを指定する属性です。半角英数字１文字で記述します。

省略された場合、ニーモニックがないメニュー項目が作成されます。

icon

メニューに表示するアイコンを指定する属性です。URL文字列で記述します。

省略された場合、アイコン表示がないメニュー項目が作成されます。

accelerator

キャンバスでの編集中のキー操作でコマンドを呼び出すときの、アクセラレータキーを指定する属性です。キーの組み合わせを表現する文字列で記述します。 キーの組み合わせは、次の書式で記述します。なお、[ ]で囲まれた部分は、省略可能です。

[Ctrl+][Alt+][Shift+]キー

Ctrl+はキーとCtrlキーを同時に押すときに、Alt+はキーとAltキーを同時に押すときに、Shift+はキーとShiftキーを同時に押すときに、それぞれ記述します。 キーは、文字キーや各種機能キーを表す文字列です。次の文字、または、文字列で記述します。

• 文字キーの場合 数字、または、英大文字で、それぞれ半角１文字で記述します。
• 各種の機能キーの場合 それぞれ、次の文字列で記述します。

キー名	表記文字列
Enter	ENTER
Backspace	BACK_SPACE
Insert	INSERT
Delete	DELETE
Tab	TAB
Pause	PAUSE
CapsLock	CAPS_LOCK
Esc	ESCAPE
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
スペース	SPACE
PageUp	PAGE_UP
PageDown	PAGE_DOWN
Home	HOME
End	END
←	LEFT
↑	UP
→	RIGHT
↓	DOWN
,（カンマ）	COMMA
.（ピリオド）	PERIOD
/（スラッシュ）	SLASH
\（バックスラッシュ）	BACK_SLASH

省略された場合、アクセラレータキーを割り付けていないメニューが作成されます。

open-dialog

メニューから実行するコマンドやコマンドインストラクション列が、使用するパラメータを設定するダイアログボックスを表示するかしないかを指定する属性です。真偽値で記述します。ダイアログボックスを表示する場合は trueを、使用しない場合はfalseを指定します。

省略された場合、falseが指定されたと見なされます。

内容：

ui:menu-item要素内には内容として、以下のいずれか一方のみが記述できます。

• ui:with-param要素
  コマンドへ渡すパラメータを記述できます。 必要に応じて、任意の数だけ記述できます。 省略可能です。
• コマンドインストラクション列
  XML文書編集用のコマンドインストラクション要素や、プラットフォームコマンドインストラクションを記述できます。 XML文書編集用のコマンドインストラクション要素の詳細は、「XML文書編集用のコマンドインストラクション」をご覧ください。 また、プラットフォームコマンドインストラクションの詳細は、「プラットフォームコマンドインストラクションリファレンス」をご覧ください。

ツールバーの内容を記述する要素です。

属性：

属性はありません。

内容：

ui:tool-bar要素内には、以下の要素から必ず１つ以上を任意の組み合わせで記述します。

• ui:tool-list要素
• ui:popup-button要素
• ui:tool-button要素
• ui:separator要素

１つのボタン領域で複数のボタンを保持し、その中から１つを選択して実行するリストボックス形式のボタンを記述するときに使用する要素です。 このリストボックスで表示されるアイコン及びテキストは保持しているボタンのものを使用します。

属性：

label

リストボックス形式のボタンのラベル文字列を指定する属性です。任意の文字列で記述します。ただし、#ではじまる文字列は内部的に予約されています。そのため、#ではじまる文字列を記述するときは、最初の#を##と記述します。このラベル文字列は、リストボックス形式のボタンのツールチップなどに利用されます。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、resource-key属性で指定した文字列リソースが使われます。

resource-key

リストボックス形式のボタンのラベル文字列を文字列リソースから取得する場合、取得する文字列のリソースキーを指定する属性です。任意の文字列で記述します。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、 label 属性で指定した文字列が使われます。

内容：

ui:tool-list要素内に記述できる要素は、以下のとおりです。

• ui:tool-button要素
  必ず１つ以上、任意の数だけ記述します。
• ui:separator要素

１つのボタン領域で複数のボタンを保持し、その中から１つを選択して実行するボタンを記述するときに使用する要素です。ボタンをクリックすることでポップアップメニューが表示されます。 このボタンで表示されるアイコンは保持しているボタンのものを使用します。

属性：

label

ポップアップボタン形式のボタンのラベル文字列を指定する属性です。任意の文字列で記述します。ただし、#ではじまる文字列は内部的に予約されています。そのため、#ではじまる文字列を記述するときは、最初の#を##と記述します。このラベル文字列は、同じ階層にある他の項目との識別に利用され、表示には利用されません。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、resource-key属性で指定した文字列リソースが使われます。

resource-key

ポップアップボタン形式のボタンのラベル文字列を文字列リソースから取得する場合、取得する文字列のリソースキーを指定する属性です。任意の文字列で記述します。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、label属性で指定した文字列が使われます。

内容：

ui:popup-button要素内に記述できる要素は、以下のとおりです。

• ui:tool-button要素
  必ず１つ以上、任意の数だけ記述します。
• ui:separator要素

ツールバーのボタンを記述するときに使用する要素です。

属性：

label

ツールバーのボタンのラベル文字列を指定する属性です。任意の文字列で記述します。 ただし、#ではじまる文字列は内部的に予約されています。そのため、#ではじまる文字列を記述するときは、最初の#を##と記述します。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、resource-key属性で指定した文字列リソースが使われます。

resource-key

ツールバーのボタンのラベル文字列を文字列リソースから取得する場合、取得する文字列のリソースキーを指定する属性です。

label属性とresource-key属性のどちらかは、必ず設定しなければなりません。両方とも設定された場合は、resource-key属性が優先されます。

省略された場合、label属性で指定した文字列が使われます。

command

ボタンをクリックされたときに実行するコマンドを指定する属性です。 xvcd:command要素で定義したコマンド名やプラットフォームが提供するコマンド名をQNameで指定します。

省略された場合、要素内に記述されたコマンドインストラクション列を実行します。 command属性とコマンドインストラクション列が同時に記述された場合は、command属性の指定が優先され、コマンドインストラクション列は無視されます。

icon

ボタンに表示するアイコンを指定する属性です。URL文字列で記述します。

省略された場合、resource-key属性またはlabel属性で指定した文字列が表示されたボタンが作成されます。

内容：

ui:tool-button要素内には内容として、以下のいずれか一方のみが記述できます。

• ui:with-param要素
  コマンドへ渡すパラメータを記述できます。 必要に応じて、任意の数だけ記述できます。 省略可能です。
• コマンドインストラクション列
  XML文書編集用のコマンドインストラクション要素や、プラットフォームコマンドインストラクションを記述できます。 XML文書編集用のコマンドインストラクション要素の詳細は、「XML文書編集用のコマンドインストラクション」をご覧ください。 また、プラットフォームコマンドインストラクションの詳細は、「プラットフォームコマンドインストラクションリファレンス」をご覧ください。

メニューやツールバーに区切り線（セパレータ）を挿入するときに使用する要素です。

属性：

属性はありません。

内容：

ui:separator要素は空要素です。

ui:accelerators要素は、ui:accelerator要素のコンテナとなる要素です。

属性：

属性はありません。

内容：

ui:accelerators要素内に記述できる要素は、以下のとおりです。

• ui:accelerator要素
  キーアクセラレータの設定を記述できます。必要に応じて、任意の数だけ記述できます。省略可能です。

キーアクセラレータの設定を表す要素です。キーの組み合わせと、実行されるコマンドを記述できます。

属性：

key-sequence （必須）

キャンバスでの編集中のキー操作でコマンドを呼び出すときの、アクセラレータキーを指定する属性です。キーの組み合わせを表現する文字列で記述します。 キーの組み合わせは、 ui:menu-item要素のaccelerator属性と同じ書式で指定します。

command

key-sequence属性で指定したキー操作が行われたときに実行するコマンドを指定する属性です。 xvcd:command要素で定義したコマンド名や、プラットフォームが提供するコマンド名をQNameで指定します。

省略された場合、要素内に記述されたコマンドインストラクション列を実行します。command属性とコマンドインストラクション列が同時に記述された場合は、command属性の指定が優先され、コマンドインストラクション列は無視されます。

内容：

ui:accelerator要素内には内容として、以下のいずれか一方のみが記述できます。

• ui:with-param要素
  コマンドへ渡すパラメータを記述できます。 必要に応じて、任意の数だけ記述できます。 省略可能です。
• コマンドインストラクション列
  XML文書編集用のコマンドインストラクション要素や、プラットフォームコマンドインストラクションを記述できます。 XML文書編集用のコマンドインストラクション要素の詳細は、「XML文書編集用のコマンドインストラクション」をご覧ください。 また、プラットフォームコマンドインストラクションの詳細は、「プラットフォームコマンドインストラクションリファレンス」をご覧ください。

ほかのファイルに記述されたユーザーインターフェイスの定義を取り込むときに使用する要素です。

属性：

href （必須）

取り込みたいユーザーインターフェイスの定義が記述されているファイルを指定する属性です。URL文字列で記述します。

内容：

ui:import要素は空要素です。

ユーザーエージェントで定義されているマウントポイントに、ユーザーインターフェイス項目を追加する要素です。

属性：

name （必須）

ユーザーエージェントのユーザーインターフェイス項目を追加する位置に設定されている名前を記述する属性です。QNameで記述します。

内容：

ui:mount要素内には、以下の要素から必ず１つ以上を任意の組み合わせで記述します。

• ui:menu要素
• ui:menu-item要素
• ui:tool-list要素
• ui:popup-button要素
• ui:tool-button要素
• ui:separator要素
• 拡張されたユーザーインターフェイス項目

コマンドに渡すパラメータを指定するときに使用する要素です。

属性：

name （必須）

パラメータ名を指定する属性です。QNameで記述します。 指定するパラメータ名は、 xvcd:command要素内に記述されている instruction:param要素のname属性に設定された名前を記述します。

内容：

ui:with-param要素内には、コマンドにパラメータとして渡す内容を記述できます。 PCDATA文字列で記述します。