プラットフォームイベントのボキャブラリの概要を説明します。
プラットフォームイベントのボキャブラリの概要や、要素・属性を解説します。
プラットフォームイベントのボキャブラリの概要を説明します。
キャンバスでのユーザー操作をXML文書フラグメントとして表現するために使用されるボキャブラリです。XVCDを記述するときに、プラットフォームイベントボキャブラリのXML文書フラグメントを使用することはありません。プラットフォームイベントボキャブラリのXML文書フラグメントは、プラットフォームによって記述されます。
プラットフォームイベントボキャブラリの名前空間URI参照は
http://xmlns.xfy.com/event です。以下の説明で、プラットフォームイベントボキャブラリの要素を記述するときは、event:という名前空間接頭辞を使用します。
このほか、以下の説明中に出現するボキャブラリと、そのボキャブラリに使用している名前空間接頭辞は次のとおりです。
xvcd: を使用します。詳細は、「VC中核リファレンス」をご覧ください。
dtf: を使用します。詳細は、「データ変換リファレンス」をご覧ください。
プラットフォームイベントボキャブラリに属する要素・属性を解説します。
プラットフォームイベントボキャブラリで、マウスイベント記述に使用される要素・属性は以下のとおりです。
event:mouse-entered イベントポインタが、ノードが表示されている領域内に入ったことを表現する要素です。
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
event:mouse-entered要素は空要素です。
event:mouse-exited イベントポインタが、ノードが表示されている領域の外に出たことを表現する要素です。
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
event:mouse-exited要素は空要素です。
event:mouse-pressed イベントノードが表示されている領域内で、マウスのボタンが押されたことを表現する要素です。
button
（必須）
押されたマウスのボタンを表す属性です。マウスのボタンが押されたときの、キーボードのAltキー・Shiftキー・Ctrlキーの状態も表されます。押されたボタンは、次のように表現されます。なお、[ ]で囲まれた部分は、省略可能です。
[Ctrl+][Alt+][Shift+]ボタンの種別
Ctrl+はCtrlキーが押されていることを、Alt+はAltキーが押さえられていることを、Shift+はShiftキーが押さえられていることを、それぞれ表しています。ボタンの種別は、次のように表わされます。
| 1 | １ボタンマウスの場合は、必ずこの値です。２ボタンマウス（ホイール付き／なしとも）、および、３ボタンマウスの場合は、左ボタンを表します。 |
| 2 | １ボタンマウス、および、ホイールなしの２ボタンマウスの場合は、この値は設定されません。 ホイール付きの２ボタンマウスの場合は、ホイールを表します。３ボタンマウスの場合は、中ボタンを表します。 |
| 3 | １ボタンマウスの場合は、この値は設定されません。２ボタンマウス（ホイール付き／なしとも）、および、３ボタンマウスの場合は、右ボタンを表します。 |
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
popup-trigger
イベントがポップアップメニューを表示するトリガーとなっているかいないかを表す属性です。真偽値が設定されます。trueが設定された場合、ポップアップメニューを表示するトリガーとなっています。falseが設定された場合、ポップアップメニューを表示するトリガーとなっていません。
省略された場合、ポップアップメニューを表示するトリガーとなっていません。
event:mouse-pressed要素は空要素です。
event:mouse-released イベントノードが表示されている領域内で、マウスのボタンが離されたことを表現する要素です。
button
（必須）
離されたマウスのボタンを表す属性です。マウスのボタンが離されたときの、キーボードのAltキー・Shiftキー・Ctrlキーの状態も表されます。離されたボタンは、次のように表現されます。なお、[ ]で囲まれた部分は、省略可能です。
[Ctrl+][Alt+][Shift+]ボタンの種別
Ctrl+はCtrlキーが押されていることを、Alt+はAltキーが押さえられていることを、Shift+はShiftキーが押さえられていることを、それぞれ表しています。 ボタンの種別は、次のように表わされます。
| 1 | １ボタンマウスの場合は、必ずこの値です。２ボタンマウス（ホイール付き／なしとも）、および、３ボタンマウスの場合は、左ボタンを表します。 |
| 2 | １ボタンマウス、および、ホイールなしの２ボタンマウスの場合は、この値は設定されません。ホイール付きの２ボタンマウスの場合は、ホイールを表します。３ボタンマウスの場合は、中ボタンを表します。 |
| 3 | １ボタンマウスの場合は、この値は設定されません。２ボタンマウス（ホイール付き／なしとも）、および、３ボタンマウスの場合は、右ボタンを表します。 |
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
popup-trigger
イベントがポップアップメニューを表示するトリガーとなっているかいないかを表す属性です。真偽値が設定されます。trueが設定された場合、ポップアップメニューを表示するトリガーとなっています。falseが設定された場合、ポップアップメニューを表示するトリガーとなっていません。
省略された場合、ポップアップメニューを表示するトリガーとなっていません。
event:mouse-released要素は空要素です。
event:mouse-clicked イベントノードが表示されている領域内で、クリックされたことを表現する要素です。
button
（必須）
クリックされたマウスのボタンを表す属性です。クリックされたときの、キーボードのAltキー・Shiftキー・Ctrlキーの状態も表されます。クリックされたボタンは、次のように表現されます。なお、[ ]で囲まれた部分は、省略可能です。
[Ctrl+][Alt+][Shift+]ボタンの種別
Ctrl+はCtrlキーが押されていることを、Alt+はAltキーが押さえられていることを、Shift+はShiftキーが押さえられていることを、それぞれ表しています。 ボタンの種別は、次のように表わされます。
| 1 | １ボタンマウスの場合は、必ずこの値です。２ボタンマウス（ホイール付き／なしとも）、および、３ボタンマウスの場合は、左ボタンを表します。 |
| 2 | １ボタンマウス、および、ホイールなしの２ボタンマウスの場合は、この値は設定されません。ホイール付きの２ボタンマウスの場合は、ホイールを表します。３ボタンマウスの場合は、中ボタンを表します。 |
| 3 | １ボタンマウスの場合は、この値は設定されません。２ボタンマウス（ホイール付き／なしとも）、および、３ボタンマウスの場合は、右ボタンを表します。 |
click-count
（必須）
ボタンがクリックされた回数を表す属性です。
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
popup-trigger
イベントがポップアップメニューを表示するトリガーとなっているかいないかを表す属性です。真偽値が設定されます。trueが設定された場合、ポップアップメニューを表示するトリガーとなっています。falseが設定された場合、ポップアップメニューを表示するトリガーとなっていません。
省略された場合、ポップアップメニューを表示するトリガーとなっていません。
event:mouse-clicked要素は空要素です。
event:mouse-moved イベントノードが表示されている領域内で、ポインタが移動したことを表現する要素です。
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
event:mouse-moved要素は空要素です。
event:mouse-dragged イベントノードが表示されている領域内で、マウスのドラッグ操作があったことを表現する要素です。
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
event:mouse-dragged要素は空要素です。
event:wheel-down イベントノードが表示されている領域内で、マウスホイールが手前方向へ回転したことを表現する要素です。
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
event:wheel-down要素は空要素です。
event:wheel-up イベントノードが表示されている領域内で、マウスホイールが向こう方向へ回転したことを表現する要素です。
area-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
area-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、文書表示領域の左上からの相対位置で表されます。
component-x
（必須）
イベントが発生したときのポインタのx座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
component-y
（必須）
イベントが発生したときのポインタのy座標を表す属性です。実数値が設定されます。座標は、ボキャブラリコンポーネントの左上からの相対位置で表されます。
event:wheel-up要素は空要素です。
プラットフォームイベントボキャブラリで、キーイベント記述に使用される要素・属性は以下のとおりです。
event:key-pressed イベントキーが押されたことを表現する要素です。
stroke
（必須）
押されたキーの組み合わせを表現する属性です。キーの組み合わせは、次の書式で記述します。なお、[ ]で囲まれた部分は、省略可能です。
[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 |
popup-trigger
イベントがポップアップメニューを表示するトリガーとなっているかいないかを表す属性です。真偽値が設定されます。trueが設定された場合、ポップアップメニューを表示するトリガーとなっています。falseが設定された場合、ポップアップメニューを表示するトリガーとなっていません。
省略された場合、ポップアップメニューを表示するトリガーとなっていません。
event:key-pressed要素は空要素です。
event:key-released イベントキーが離されたことを表現する要素です。
stroke
（必須）
離されたキーの組み合わせを表現する属性です。キーの組み合わせは、次の書式で記述します。なお、[ ]で囲まれた部分は、省略可能です。
[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 |
popup-trigger
イベントがポップアップメニューを表示するトリガーとなっているかいないかを表す属性です。真偽値が設定されます。trueが設定された場合、ポップアップメニューを表示するトリガーとなっています。falseが設定された場合、ポップアップメニューを表示するトリガーとなっていません。
省略された場合、ポップアップメニューを表示するトリガーとなっていません。
event:key-released要素は空要素です。
プラットフォームイベントボキャブラリで、ドラッグ＆ドロップイベント記述に使用される要素・属性は以下のとおりです。
event:drag-source イベントドラッグソースに対するイベントを表現する要素です。
type
（必須）
イベントタイプを表す属性です。イベントタイプは、次の値で表されます。
gesture
drag-enter
drag-over
drag-exit
drop-end
ドラッグ＆ドロップ操作は、type属性がgestureのときに、
xvcd:start-drag要素が呼び出されると開始されます。gestureイベントタイプは、DOMツリーをバブリングして伝播します。そのほかのイベントタイプは、xvcd:start-drag要素が呼び出されたノードだけに発行されます。
action
（必須）
ドラッグ操作のアクションの種類を表す属性です。type属性がgesture、あるいは、drop-endのときに設定されます。type属性がgestureのときは、ドラッグ開始時にユーザーが選択したアクションを表します。drop-endのときは、ドロップターゲットによって実行されるアクションを表します。ともに、次の値が設定されます。
copy
move
link
result
（必須）
ドラッグ＆ドロップ操作の結果を表現する属性です。type属性がdrop-endのときに設定されます。次の値が設定されます。
success
failure
event:drag-source要素は空要素です。
event:drop-target イベントドロップターゲットに対するイベントを表す要素です。
type
（必須）
イベントタイプを表す属性です。イベントタイプは、次の値で表されます。
drag-enter
drag-over
drag-exit
drop
action
（必須）
ドラッグ操作のアクションの種類を表す属性です。次の値が設定されます。
copy
move
link
event:drop-target要素内には、以下の要素が記述されます。
これらの要素は、少なくともどちらか一方が１回以上、任意の組み合わせで任意の回数で記述されます。
プラットフォームイベントボキャブラリで、キャレットイベント記述に使用される要素・属性は以下のとおりです。
event:caret-moved イベントキャレットが、ノードが表示されている領域内で移動したことを表現する要素です。
属性はありません。
event:caret-moved要素は空要素です。
event:caret-entered イベントキャレットが、ノードが表示されている領域内に入ったことを表現する要素です。
属性はありません。
event:caret-entered要素は空要素です。
event:caret-exited イベントキャレットが、ノードが表示されている領域内から出たことを表現する要素です。
属性はありません。
event:caret-exited要素は空要素です。
プラットフォームイベントボキャブラリで、文字入力イベント記述に使用される要素・属性は以下のとおりです。
event:string-inserted イベント文字列が入力されたときに発生するイベントを表現する要素です。
direction
文字列入力後のキャレット移動位置が次の値で指定されます。
forward
backward
forwardが指定されたと見なします。
event:string-inserted要素内には、入力された文字列が記述されます。