XUL:key

key 要素はキーボードショートカットを定義します。割り当てられたキーが押された時に応答するにはイベントハンドラを使用します。key 要素は keyset 要素内に置かれなければなりません。

key 要素上の属性と一致するキーが押された時、command が key 要素上で実行されます。押されたキーは、key 属性 (または keycode 属性) および key 要素を活性化し command イベントを実行するための modifiers 属性と一致しなければなりません。

例えば、次のようなキーを考えます:

<key key="r" modifiers="shift"/>

この key は Shift キーが R キーと共に押された時のみ一致します。他の key の組み合わせでは一致しません。つまり、Shift および Control, R キーが同時に押されても、key は一致しません。

修飾 (modifier) キーが任意に押されることを示すには、'any' を任意の修飾キーの後に羅列します。例えば:

<key key="r" modifiers="shift any control"/>

この例では、shift キーの押下は任意ですが、control キーは押さなければなりません。関連性のない修飾キーについては key の一致がより大雑把になりますが、特定の修飾キーを必要とすることも可能です。

modifiers 属性が指定されていないときは、key と一致させるために修飾キーを押しません。

key または keycode 属性が使用されていないときは、key 要素がすべての key イベントを扱います。しかし、属性の一つに空の文字列が設定されていると、要素はどの key イベントも扱いません。例えば:

<!-- この要素はすべての key イベントを扱います -->
<key/>

<!-- これらの要素はどの key イベントも扱いません -->
<key key="" modifiers="control"/>
<key keycode="" modifiers="control"/>

詳しい情報は、XUL チュートリアルをご覧ください。

[編集] 例

(例が必要)

disabled: 型: 真偽値; 要素が無効化されているかどうかを示します。ある要素が true に設定されていたら、その要素は無効化されています。無効化された要素は通常グレイ表示のテキストで描画されます。要素が無効化されていると、ユーザのアクションには応答せず、フォーカスもあてられず、command イベントも発生しません。

keycode: 型: string key code; Enter キーやファンクションキーなど表示可能な文字を持たないキーには、この属性を key 属性の代わりに使用します。適切なキーの一覧はここにあります。

keytext: 型: string; キーボードショートカットのラベル。このテキストは、menuitem が key 属性を通して key 要素と関連付けられているとき、menuitem ラベルの次に現れます。

modifiers: 型: スペースで区切られた以下の値のリスト; キーボードショートカットを呼び出すために押下する修飾キーのリスト。複数のキーはスペースやカンマで区切られます。プラットフォーム上に無いキーは、他のキーに割り当てられます。

shift: Shift キー。
alt: Alt キー。Macintosh 上では Option キーです。Macintosh 上では特別な文字をテキストに入力するために Alt+Letter の組み合わせが予約されているため、他の modifier と連結して使用されます。
meta: Meta キー。Macintosh 上では Command キーです。
control: Control キー。
accel: ユーザのプラットフォーム上のキーボードショートカットに使用されるキー。通常はあなたが使用する値になります。
access: menu や他の要素を活性化するためのアクセスキー。Windows 上では Alt キーです。要素の accesskey と連結して使用されます。
any: 上記のすべての modifier は任意であることを示します。

oncommand: 型: script code; このイベントハンドラは command が活性化した時、呼び出されます。これは、ユーザがメニュー項目を選択したり command に割り当てられたキーボードショートカットが押したりした場合に起こります。

phase: 型: string; ハンドラが呼び出される場所のイベントフェーズ。この値は、イベント取得フェーズであることを示すには capturing に、またはターゲット要素にあることを示すには target に設定します。揮発フェーズ (bubbling phase) では、この値全体を取り除きます。