ファイル定義

Page creation date :

The page you are currently viewing does not support the selected display language.

ボードコンテナ定義ファイル (.setting ファイル)

ボード上のキーのレイアウトや処理などを定義したファイルです。実行ファイルのあるフォルダの「Boards」フォルダ内の各種ボードパッケージフォルダに配置されています。

このファイルを独自に定義することによって自由なキーのレイアウトをカスタマイズすることができます。各種記号やテキストなどは JSON のフォーマットに従っています。

拡張子 .setting
ファイルフォーマット JSON
エンコード UTF-8 (BOM あり)

構成

データは以下の階層で構成されています。(以下のレイアウトはイメージです。実際のファイルは自動出力によって並び順が異なる場合があります)

("{}"はオブジェクト、"[]"は配列です。)

BoardContainerInfo {
  Borads [
    BoardInfo {
      Keys [
        KeyInfo {
          Processes [
            KeyProcessInfo {
            }
          ]
          Decorates [
            KeyDecorateInfo {
            }
          ]
        }
      ]
      BoardDecorates [
        BoardDecorateInfo {
        }
      }
      KeyDecorates [
        KeyDecorateInfo {
        }
      }
    }
  ]
}

BoardContainerInfo オブジェクト

ボードコンテナの各種設定を持つオブジェクトです。

キー 内容 初期値 未設定許可 対応アプリVer.
IdentityName string

ボードコンテナを識別する名前です。ボード指定切り替えなどに使用されます。

【例】

"IdentityName": "010_Normal_1_00_Ja"
0.01~
Author string

ボードコンテナの製作者の名前を入れます。製作者名の表示に使用されます。(予定)

【例】

"Author": "Onodera"
0.01~
Version double

ボードコンテナ定義ファイルのバージョンを入れます。対応するアプリケーションのバージョンではありません。バージョンの表示に使用されます。(予定)

【例】

"Version": 1.00
0.01~
IsExcludeNextBoard bool

このボードコンテナを「⇐⇒」キーによるボードの切り替えによる選択の対象外にするかどうかを指定します。対象外に指定した場合はボード指定切り替えでのみ選択可能になります。

【例】

"IsExcludeNextBoard": false
FALSE 0.31~
Order int

ボードを切り替える際の並び順に使用されます。数値が大きいほど優先されます。

【例】

"Order": 10
0 0.01~
KeyReleaseTimingWhenActiveWindowChange bool

アクティブなウィンドウが切り替わった時にトグルキーを自動的に解除するかどうか、またはそのパターンを指定します。他のウィンドウに切り替わった時にトグルキーの動作がそのまま適用されてしまうのを防ぎます。

None
アクティブウィンドウが切り替わってもトグルキーを解除しません。
Process
別プロセスのウィンドウに切り替わった時にトグルキーを解除します。例えば、同じアプリケーションでモーダルダイアログが表示された場合はトグルキーは解除されません。
Window
別ウィンドウに切り替わった時にトグルキーを解除します。

【例】

"KeyReleaseTimingWhenActiveWindowChange": "Window"
None 0.30~
GeneratorIdentityName string

ボードコンテナ定義ファイルをなんらかのツールで生成した場合にそのツールの識別名を設定します。この値が他に使用されることはありません。

【例】

"GeneratorIdentityName": "TiitanBoardCreator"
1.00~
GeneratorVersion double

ボードコンテナ定義ファイルをなんらかのツールで生成した場合にそのツールのバージョンを設定します。この値が他に使用されることはありません。

【例】

"GeneratorVersion": 1.00
1.00~
Boards BoardInfo[] ボードを定義します。複数のボードを表示する場合はボードを複数定義します。 0.01~

BoardInfo オブジェクト

ボードの各種設定を持つオブジェクトです。ボードはウィンドウ一つ分を指します。

キー 内容 初期値 未設定許可 対応アプリVer.
IdentityName string

ボードの識別名です。現在用途は未定です。

【例】

"IdentityName": "NormalBoard"
0.01~
Position Rectangle

ボードの位置とサイズを指定します。パラメータはそれぞれ「X, Y (デスクトップ上の位置)」と「Width, Height (ボードのサイズ)」からなります。実際にボードが表示される位置とサイズが DPI を考慮した論理サイズになることに注意してください。また、開始位置については StartPositionType パラメータに依存します。位置(X, Y)が使用されない場合はサイズのみが使用されます。

【例】

"Position": {
"X": 0,
"Y": 26.27,
"Width": 86,
"Height": 57.93
}
0.01~
StartPositionType string

ボードの初期位置の種類を指定します。前回のボードの位置を記憶するように設定されている場合、この設定は初回表示のみ有効です。指定できるパラメータは以下の通りです。

Manual
表示位置を Position の X, Y に指定します。
Top
画面中央上部に表示します。
TopLeft
画面左上に表示します。
Left
画面左中央に表示します。
BottomLeft
画面左下に表示します。
Bottom
画面下中央に表示します。
BottomRight
画面右下に表示します。
Right
画面右中央に表示します。
TopRight
画面右上に表示します。

【例】

"StartPositionType": "BottomRight"
Manual 0.01~
NextBoardPositionType string

ほかのボードから切り替えられたときに表示する位置を指定します。前回のボードの位置を記憶するように設定されている場合、この設定は初回切り替えのみ有効です。

(未設定)
StartPositionType で指定した位置に表示します。
CenterPosition
切り替え前のボードの中心位置と切り替え後のボードの中心位置が合うように表示します。

【例】

"NextBoardPositionType": "CenterPosition"
0.01~
CenterPosition Point

「X」「Y」で指定するボードの中心位置です。NextBoardPositionType パラメータで CenterPosition が指定された際に使用されます。指定しなかった場合はボードのサイズ÷2が中心位置となります。

【例】

"CenterPosition": {
"X": 200,
"Y": 100,
}
0.01~
PositionOffset Point

「Position」「StartPositionType」「NextBoardPositionType」「CenterPosition」で指定された表示位置からの相対位置を指定できます。パラメータは「X」「Y」で指定します。

【例】

"PositionOffset": {
"X": -200,
"Y": -100,
}
0.30~
FontSizeScale double

対象ボードのフォントのサイズを 1 を基準とした倍率で指定します。

【例】

"FontSizeScale": 1.5
1 0.01~
BoardScale double

対象ボードのサイズを 1 を基準とした倍率で指定します。配置されているキーの大きさや位置、文字の大きさなどすべてがスケーリングされます。

【例】

"BoardScale": 1.5
1 0.01~
ImageName string

ボードに表示する画像の名前を指定します。対応している画像形式は「.png」のみで、ボードコンテナ定義ファイルのあるフォルダの「Images」フォルダ内に配置された画像のファイル名に一致するものを読み込みます。

たとえば、ImageName に「Back」と指定した場合、「Images/Back.png」ファイルを読み込みます。

【例】

"ImageName": "BoardMove"
0.01~
ImageStretchMode string

画像を配置する際のスケーリング方法について設定します。

None
画像原寸のままボードの中央に配置します。
Fill
画像全体がボード内に収まるようにスケーリングされます。縦横比はボードサイズに依存します。
Uniform
画像全体がボード内に収まるようにスケーリングされます。縦横比は画像に依存します。
UniformToFill
画像の縦横比を維持したままボード全体に表示されるようにスケーリングされます。

【例】

"ImageStretchMode": "Uniform"
Uniform 1.00~
ImageRenderMode string

※ このパラメータは互換性のために残されており今後のバージョンで廃止される予定です。

画像を配置する際のスケーリング方法について設定します。

None
画像原寸のままボードの中央に配置します。
Fill
画像全体がボード内に収まるようにスケーリングされます。縦横比はボードサイズに依存します。
Uniform
画像全体がボード内に収まるようにスケーリングされます。縦横比は画像に依存します。
UniformToFill
画像の縦横比を維持したままボード全体に表示されるようにスケーリングされます。
Uniform 0.30~
ImageRenderMode (0.01~0.23) string

※ このパラメータは互換性のために残されており今後のバージョンで廃止される予定です。

画像を配置する際のスケーリング方法について設定します。

(未設定)
画像原寸のままボードの中央に配置します。
Fill
画像全体がボード内に収まるようにスケーリングされます。縦横比は画像に依存します。
0.01~0.23
Keys KeyInfo[] ボード上に配置するキーの一覧を設定します。 0.01~
KeyDecorates KeyDecorateInfo[] ボードに配置されているキーすべてに対しての装飾情報を設定します。 1.00~
BoardDecorates BoardDecorateInfo[] ボードの詳細な装飾情報を設定します。 1.00~

KeyInfo オブジェクト

キーの各種設定を持つオブジェクトです。

キー 内容 初期値 未設定許可 対応アプリVer.
KeyType string

キー押下時の基本動作を定義します。指定できる文字は「KeyType 列挙」のいずれかになります。Processes パラメータを指定した場合はこのパラメータは無視されます。

【例】

"KeyType": "S"
0.01~
Position Rectangle

ボード上のキーの位置とサイズを指定します。パラメータはそれぞれ「X, Y (ボード上の位置)」と「Width, Height (キーのサイズ)」からなります。指定する数値はボードから見たクライアント論理座標系になり、DPI や ボードのスケーリングによって実際に表示されるサイズが決定されます。

【例】

"Position": {
"X": 0,
"Y": 26.27,
"Width": 24,
"Height": 24
}
0.01~
DisplayText string

キーに表示されるテキストを指定します。改行などの特殊文字は JSON の仕様に基づきます。テキストは画像よりも前面に表示されます。

【例】

"DisplayText": "Space"
0.01~
FontSize double

キーに表示されるテキストのフォントサイズを指定します。倍率1、DPI 96 の時の pixel サイズになりますが、実際の大きさはフォントの種類に依存します。

【例】

"FontSize": 12
(システムフォントサイズに依存) 0.01~
ImageName string

キーの背景に表示する画像の名前を指定します。対応している画像形式は「.png」のみで、ボードコンテナ定義ファイルのあるフォルダの「Images」フォルダ内に配置された画像のファイル名に一致するものを読み込みます。

たとえば、ImageName に「Back」と指定した場合、「Images/Back.png」ファイルを読み込みます。

【例】

"ImageName": "BoardMove"
0.01~
ImageStretchMode string

画像を配置する際のスケーリング方法について設定します。

None
画像原寸のままキーの中央に配置します。画像がキーの範囲をはみ出る部分は表示されません。
Fill
画像全体がキー範囲内に収まるようにスケーリングされます。縦横比はキーサイズに依存します。
Uniform
画像全体がキー範囲内に収まるようにスケーリングされます。縦横比は画像に依存します。
UniformToFill
画像の縦横比を維持したままキー全体に表示されるようにスケーリングされます。

【例】

"ImageStretchMode": "Uniform"
Uniform 1.00~
ImageRenderMode string

※ このパラメータは互換性のために残されており今後のバージョンで廃止される予定です。

画像を配置する際のスケーリング方法について設定します。

【例】

None
画像原寸のままキーの中央に配置します。画像がキーの範囲をはみ出る部分は表示されません。
Fill
画像全体がキー範囲内に収まるようにスケーリングされます。縦横比はキーサイズに依存します。
Uniform
画像全体がキー範囲内に収まるようにスケーリングされます。縦横比は画像に依存します。
UniformToFill
画像の縦横比を維持したままキー全体に表示されるようにスケーリングされます。
Uniform 0.30~
ImageRenderMode (0.01~0.23) string

※ このパラメータは互換性のために残されており今後のバージョンで廃止される予定です。

画像を配置する際のスケーリング方法について設定します。

(未設定)
画像原寸のままキーの中央に配置します。
Fill
画像全体がキー内に収まるようにスケーリングされます。縦横比は画像に依存します。
0.01~0.23
IsToggle bool

キーを押すたびに「押している状態」「離している状態」を切り替えます。同時押しに使用される Shift キーや Ctrl キーなどで使用します。

【例】

"IsToggle": true
(KeyType に依存) 0.01~
IsOneClickToggleRelease bool

true の場合、キーがトグル状態の時にほかのキーを押すと自動的にトグルが解除されるようになります。false の場合は同じキーを再度押さない限りトグルが解除されることはありません。

【例】

"IsOneClickToggleRelease": true
(KeyType に依存) 0.01~
Options Key(string), Value(string)

指定した KeyType の追加パラメータの一覧を指定できます。KeyType によってはこのパラメータでのみ設定できる値もあります。指定できるパラメータは「キー追加パラメータ」を参照してください。

【例】

{
"DisplayText": "",
"ImageName": "MousePadx2",
"ImageRenderMode": "Fill",
"KeyType": "MouseMovePad",
"Options": {"MoveScale":"2"},
"Position": {
"Height": 122,
"Width": 122,
"X": 64,
"Y": 30
},
},
0.22~
Parameters string

※ このパラメータは Options に置き変わるため、今後サポートされなくなります。

指定した KeyType の追加パラメータの一覧を指定できます。KeyType によってはこのパラメータでのみ設定できる値もあります。指定できるパラメータは「キー追加パラメータ」を参照してください。パラメータは KeyValue 形式の JSON を文字列化して設定してください。

【例】

{
"DisplayText": "",
"ImageName": "MousePadx2",
"ImageRenderMode": "Fill",
"KeyType": "MouseMovePad",
"Parameters": "{"MoveScale":"2"}",
"Position": {
"Height": 122,
"Width": 122,
"X": 64,
"Y": 30
},
},
0.01~
Processes KeyProcessInfo[]

キーの基本処理を上書きできます。複数の処理を定義できるため、キーを1回押すだけで複数のキーの押下処理を実現できます。例えば「Ctrl」+「C」のような定義をすることができます。処理順は配列の並び順に依存します。

【例】

{
"DisplayText": "元に戻す",
"KeyType": "Undo",
"Position": {
"Height": 60,
"Width": 60,
"X": 64,
"Y": 278
},
"Processes": [
{
"KeyType": "LeftCtrl"
},
{
"KeyType": "Z"
}
]
},
0.01~
Decorates KeyDecorateInfo[] キーの詳細な装飾情報を設定します。 1.00~

KeyProcessInfo オブジェクト

キー押下時の処理を定義するオブジェクトです。

キー 内容 初期値 未設定許可 対応アプリVer.
KeyType string

キー押下時の基本動作を定義します。指定できる文字は「KeyType 列挙」のいずれかになります。

【例】

"KeyType": "A"
0.01~
ExecuteTiming string

キーを押したときに処理するか離した時に処理するかを指定します。キーの種類によってはこの設定が無視される場合があります。KeyInfo.IsToggle を true にしている場合は自動的に「PressedAndReleased」が適用されます。

PressedAndReleased
キーを押したときに押下処理、離したときにリリース処理を行います。
Pressed
キーを押したときに押下処理、リリース処理を行います。
Released
キーを離したときに押下処理、リリース処理を行います。

【例】

"ExecuteTiming": "Pressed"
(KeyType に依存) 0.30~
ExecuteTiming (0.01~0.23) string

キーを押したときに処理するか離した時に処理するかを指定します。キーの種類によってはこの設定が無視される場合があります。

Pressed
キーを押したときに処理されます。
Released
キーを離したときに処理されます。
(KeyType に依存) 0.01~0.23
PressRepeat string

キーを押しっぱなしにしたときに繰り返し処理する動作を設定します。「Once」以外を指定した場合、ExecuteTiming パラメータは自動的に「PressedAndReleased」なります。

Once
押したタイミング、または離したタイミングでのみ処理されます。
OneWaitRepeat
押したタイミングと押下した一定時間後に繰り返しキー処理を行います。
ImmediateRepeat
押した瞬間から繰り返しキー処理を行います。

【例】

"PressRepeat": "OneWaitRepeat"
(KeyType に依存) 0.01~
IsModifier (0.01~0.23) bool

※ このパラメータは最新版で廃止されています。

Shift や Ctrl キーなどの修飾キーであるかどうか指定します。

(KeyType に依存) 0.01~0.23
Options Key(string), Value(string)

指定した KeyType の追加パラメータの一覧を指定できます。KeyType によってはこのパラメータでのみ設定できる値もあります。指定できるパラメータは「キー追加パラメータ」を参照してください。

【例】

{
"DisplayText": "",
"ImageName": "MousePadx2",
"ImageRenderMode": "Fill",
"KeyType": "MouseMovePad",
"Options": {"MoveScale":"2","TapAction":"None"},
"Position": {
"Height": 122,
"Width": 122,
"X": 64,
"Y": 30
},
},
0.22~
Parameters string

※ このパラメータは Options に置き変わるため、今後サポートされなくなります。

指定した KeyType の追加パラメータの一覧を指定できます。KeyType によってはこのパラメータでのみ設定できる値もあります。指定できるパラメータは「キー追加パラメータ」を参照してください。パラメータは KeyValue 形式の JSON を文字列化して設定してください。

【例】

{
"DisplayText": "",
"ImageName": "MousePadx2",
"ImageRenderMode": "Fill",
"KeyType": "MouseMovePad",
"Parameters":
"{"MoveScale":"2","TapAction":"None"}",
"Position": {
"Height": 122,
"Width": 122,
"X": 64,
"Y": 30
},
},
0.01~

BoardDecorateInfo オブジェクト

ボードの装飾を定義するオブジェクトです。

キー 内容 初期値 未設定許可 対応アプリVer.
IdentityName string

装飾の識別名です。現在使用用途は未定です。

【例】

"IdentityName": "Normal"
1.00~
ImeStatus string

IME がどの状態の時に装飾を適用するかを指定します。IME は以下のいずれかから指定します。

(未設定)
すべての IME の状態を対象とします。個別に指定した IME 状態より優先度は低くなります。
On
IME が ON になっているすべての状態を対象とします。個別に指定した IME 状態より優先度は低くなります。
KanaInputAlphaHalf
IME がかな入力の半角英数の状態を対象とします。これは IME が OFF の状態と同じです。
KanaInputKatakanaHalf
IME がかな入力の半角カナの状態を対象とします。
KanaInputAlphaFull
IME がかな入力の全角英数の状態を対象とします。
KanaInputHiraganaFull
IME がかな入力の全角ひらがなの状態を対象とします。
KanaInputKatakanaFull
IME がかな入力の全角カタカナの状態を対象とします。
RomanInputAlphaHalf
IME がローマ字入力の半角英数の状態を対象とします。これは IME が OFF の状態と同じです。
RomanInputKatakanaHalf
IME がローマ字入力の半角カタカナの状態を対象とします。
RomanInputAlphaFull
IME がローマ字入力の全角英数の状態を対象とします。
RomanInputHiraganaFull
IME がローマ字入力の全角ひらがなの状態を対象とします。
RomanInputKatakanaFull
IME がローマ字入力の全角カタカナの状態を対象とします。

【例】

"ImeStatus": "KanaInputHiraganaFull"
1.00~
ImeStatuses string[]

IME がどの状態の時に装飾を適用するかを指定します。ImeStatus は一つの IME の状態しか指定できませんが、こちらは複数定義することが可能です。ImeStatus と ImeStatuses 両方定義されていた場合は、ImeStatuses が優先されます。指定できる値は ImeStatus と同じです。

【例】

"ImeStatuses": [
"RomanInputKatakanaHalf",
"RomanInputKatakanaFull"
]
1.00~
PressKey string

指定したキーが押されているときの装飾を適用できます。

例えば、通常は背景が黒であるが、Shift キーを押すと背景が青に変わるような動作を行うことができます。

【例】

"PressKey": "LeftControl"
1.00~
PressKeys string[]

複数のキーを押下したときに装飾を適用させる場合に使用します。例えば「Shift」と「Ctrl」が同時に押されたときに表示を変更したい場合などです。PressKey と PressKeys が両方指定されている場合は PressKeys が優先されます。両方指定しなかった場合は、PressKey で指定されていないすべてのパターンで適用されます。

【例】

"PressKeys": [
"LeftShift",
"LeftControl"
]
1.00~
BackgroundColor Color

ボードの背景色を 0~1 で指定できます。Alpha を 1 未満にすることによってボードを半透明にできます。また Alpha を 0 にすると完全な透過となり、ボードに対しての押下判定がなくなり裏に配置されているウィンドウを操作できます。例えば、ボードを透過にしキーに背景色を付けることによってキーだけを浮かせたボードを作成することもできます。

【例】

"BackgroundColor": {
"Alpha": 1,
"Red": 0.752941176470588,
"Green": 0.752941176470588,
"Blue": 0.752941176470588
}
(アプリケーションに依存) 1.00~
ImageName string

ボードに表示する画像の名前を指定します。対応している画像形式は「.png」のみで、ボードコンテナ定義ファイルのあるフォルダの「Images」フォルダ内に配置された画像のファイル名に一致するものを読み込みます。

たとえば、ImageName に「Back」と指定した場合、「Images/Back.png」ファイルを読み込みます。

また、ボードの背景色を透明にし、完全に透明なエリアのある切り抜き画像を指定することによって矩形以外のボードを作成することもできます。

【例】

"ImageName": "BoardMove"
1.00~
ImageStretchMode string

画像を配置する際のスケーリング方法について設定します。

None
画像原寸のままキーの中央に配置します。画像がキーの範囲をはみ出る部分は表示されません。
Fill
画像全体がキー範囲内に収まるようにスケーリングされます。縦横比はキーサイズに依存します。
Uniform
画像全体がキー範囲内に収まるようにスケーリングされます。縦横比は画像に依存します。
UniformToFill
画像の縦横比を維持したままキー全体に表示されるようにスケーリングされます。

【例】

"ImageStretchMode": "Uniform"
Uniform 1.00~
BorderColor Color

背景の枠線の色を 0~1 で指定できます。Alpha を 1 未満にして半透明、透明にすることもできます。

【例】

"BorderColor": {
"Alpha": 1,
"Red": 0.752941176470588,
"Green": 0.752941176470588,
"Blue": 0.752941176470588
}
(アプリケーションに依存) 1.00~
BorderThickness double

背景の枠線の太さを指定できます。0 にすると枠線は見えなくなります。

【例】

"BorderThickness": 3
1 1.00~

KeyDecorateInfo オブジェクト

ボードの装飾を定義するオブジェクトです。

キー 内容 初期値 未設定許可 対応アプリVer.
IdentityName string

装飾の識別名です。現在使用用途は未定です。

【例】

"IdentityName": "Normal_A"
1.00~
ImeStatus string

IME がどの状態の時に装飾を適用するかを指定します。IME は以下のいずれかから指定します。

(未設定)
すべての IME の状態を対象とします。個別に指定した IME 状態より優先度は低くなります。
On
IME が ON になっているすべての状態を対象とします。個別に指定した IME 状態より優先度は低くなります。
KanaInputAlphaHalf
IME がかな入力の半角英数の状態を対象とします。これは IME が OFF の状態と同じです。
KanaInputKatakanaHalf
IME がかな入力の半角カナの状態を対象とします。
KanaInputAlphaFull
IME がかな入力の全角英数の状態を対象とします。
KanaInputHiraganaFull
IME がかな入力の全角ひらがなの状態を対象とします。
KanaInputKatakanaFull
IME がかな入力の全角カタカナの状態を対象とします。
RomanInputAlphaHalf
IME がローマ字入力の半角英数の状態を対象とします。これは IME が OFF の状態と同じです。
RomanInputKatakanaHalf
IME がローマ字入力の半角カタカナの状態を対象とします。
RomanInputAlphaFull
IME がローマ字入力の全角英数の状態を対象とします。
RomanInputHiraganaFull
IME がローマ字入力の全角ひらがなの状態を対象とします。
RomanInputKatakanaFull
IME がローマ字入力の全角カタカナの状態を対象とします。

【例】

"ImeStatus": "KanaInputHiraganaFull"
1.00~
ImeStatuses string[]

IME がどの状態の時に装飾を適用するかを指定します。ImeStatus は一つの IME の状態しか指定できませんが、こちらは複数定義することが可能です。ImeStatus と ImeStatuses 両方定義されていた場合は、ImeStatuses が優先されます。指定できる値は ImeStatus と同じです。

【例】

"ImeStatuses": [
"RomanInputKatakanaHalf",
"RomanInputKatakanaFull"
]
1.00~
PressKey string

指定したキーが押されているときの装飾を適用できます。

例えば、通常はキーに「1」が表示されているときに Shift キーを押すと、表示されているテキストが「!」に変わるなどのような変化を起こすことができます。

【例】

"PressKey": "LeftControl"
1.00~
PressKeys string[]

複数のキーを押下したときに装飾を適用させる場合に使用します。例えば「Shift」と「Ctrl」が同時に押されたときに表示を変更したい場合などです。PressKey と PressKeys が両方指定されている場合は PressKeys が優先されます。両方指定しなかった場合は、PressKey で指定されていないすべてのパターンで適用されます。

【例】

"PressKeys": [
"LeftShift",
"LeftControl"
]
1.00~
IsPressed bool

自身のキーが押下中の場合の装飾を指定できます。例えば、キーを押下中はそのキーの枠線を光らせるなどの動作を行うことができます。

【例】

"IsPressed": true
FALSE 1.00~
DisplayText string

キーに表示されるテキストを指定します。改行などの特殊文字は JSON の仕様に基づきます。テキストは画像よりも前面に表示されます。

【例】

"DisplayText": "Enter"
1.00~
FontName string

キーテキストのフォントを指定できます。使用できるフォントは OS にインストールされているもののみです。

【例】

"FontName": "メイリオ"
(アプリケーションに依存) 1.00~
FontSize double

キーに表示されるテキストのフォントサイズを指定します。倍率1、DPI 96 の時の pixel サイズになりますが、実際の大きさはフォントの種類に依存します。

【例】

"FontSize": 24
(アプリケーションに依存) 1.00~
TextBold string

文字の太さを指定できます。現在使用できる太さは「Bold」のみで、それ以外を指定した場合は通常の太さになります。

【例】

"TextBold": "Bold"
Normal 1.00~
TextColor Color

キーテキストの色を指定できます。Alpha を 1 未満にして半透明にすることもできます。指定できる範囲はそれぞれ 0~1 になります。

【例】

"TextColor": {
"Alpha": 1,
"Red": 0.752941176470588,
"Green": 0.752941176470588,
"Blue": 0.752941176470588
}
(アプリケーションに依存) 1.00~
BackgroundColor Color

キーの背景の色を 0~1 で指定できます。Alpha を 1 未満にして半透明、透明にすることもできます。ただし、キーの背景を透明にしつつボードの背景も透明になるとキーの押下判定がなくなりますので注意してください。

【例】

"BackgroundColor": {
"Alpha": 1,
"Red": 0.752941176470588,
"Green": 0.752941176470588,
"Blue": 0.752941176470588
}
(アプリケーションに依存) 1.00~
ImageName string

ボードに表示する画像の名前を指定します。対応している画像形式は「.png」のみで、ボードコンテナ定義ファイルのあるフォルダの「Images」フォルダ内に配置された画像のファイル名に一致するものを読み込みます。

たとえば、ImageName に「Back」と指定した場合、「Images/Back.png」ファイルを読み込みます。

【例】

"ImageName": "BoardMove"
1.00~
ImageStretchMode string

画像を配置する際のスケーリング方法について設定します。

None
画像原寸のままキーの中央に配置します。画像がキーの範囲をはみ出る部分は表示されません。
Fill
画像全体がキー範囲内に収まるようにスケーリングされます。縦横比はキーサイズに依存します。
Uniform
画像全体がキー範囲内に収まるようにスケーリングされます。縦横比は画像に依存します。
UniformToFill
画像の縦横比を維持したままキー全体に表示されるようにスケーリングされます。

【例】

"ImageStretchMode": "Uniform"
Uniform 1.00~
BorderColor Color

背景の枠線の色を 0~1 で指定できます。Alpha を 1 未満にして半透明、透明にすることもできます。

【例】

"BorderColor": {
"Alpha": 1,
"Red": 0.752941176470588,
"Green": 0.752941176470588,
"Blue": 0.752941176470588
}
(アプリケーションに依存) 1.00~
BorderThickness double

背景の枠線の太さを指定できます。0 にすると枠線は見えなくなります。

【例】

"BorderThickness": 3
1 1.00~

KeyType 列挙

キーの基本処理を定義する一覧です。

キーの名称とキーコードの関連は日本語キーボードに基づいています。この一覧に存在しないキーコードを指定したい場合は KeyType「VirtualKeyCode」を使用してください。

識別名・名称 仮想キーコード 補足
A 65
B 66
C 67
D 68
E 69
F 70
G 71
H 72
I 73
J 74
K 75
L 76
M 77
N 78
O 79
P 80
Q 81
R 82
S 83
T 84
U 85
V 86
W 87
X 88
Y 89
Z 90
D0 49 キーボード上段にある数字キーです。
D1 50 キーボード上段にある数字キーです。
D2 51 キーボード上段にある数字キーです。
D3 52 キーボード上段にある数字キーです。
D4 53 キーボード上段にある数字キーです。
D5 54 キーボード上段にある数字キーです。
D6 55 キーボード上段にある数字キーです。
D7 56 キーボード上段にある数字キーです。
D8 57 キーボード上段にある数字キーです。
D9 58 キーボード上段にある数字キーです。
NumPad0 96 テンキーの数字キーです。
NumPad1 97 テンキーの数字キーです。
NumPad2 98 テンキーの数字キーです。
NumPad3 99 テンキーの数字キーです。
NumPad4 100 テンキーの数字キーです。
NumPad5 101 テンキーの数字キーです。
NumPad6 102 テンキーの数字キーです。
NumPad7 103 テンキーの数字キーです。
NumPad8 104 テンキーの数字キーです。
NumPad9 105 テンキーの数字キーです。
F1 113
F2 114
F3 115
F4 116
F5 117
F6 118
F7 119
F8 120
F9 121
F10 122
F11 123
F12 124
F13 125
F14 126
F15 127
F16 128
F17 129
F18 130
F19 131
F20 132
F21 133
F22 134
F23 135
F24 136
LeftCtrl 162
RightCtrl 163
LeftShift 160
RightShift 161
LeftWindows 91
RightWindows 92
LeftAlt 164
RightAlt 165
Up 38 ↑キーです。
Down 40 ↓キーです。
Left 37 ←キーです。
Right 39 →キーです。
Add 107 テンキーの「+」です。
Subtract 109 テンキーの「-」です。
Divide 111 テンキーの「/」です。
Multiply 106 テンキーの「*」です。
Decimal 110 テンキーの「.」です。
Separator 108
Enter 13
BackSpace 8
Space 32
Tab 9
Esc 27
OemMinus 189
OemTilde 222
Yen 220
OemBackslash 226
At 192 日本語配列キーボードの「@」キーです。
OemOpenBrackets 219
OemCloseBrackets 221
Colon 186
OemSemicolon 187
OemPlus 187
OemComma 188
OemPeriod 190
Slash 191
OemQuestion 191
Backslash 226
OemQuotes 222
Kanji 25 半角/全角キーです。
NonConvert 29 無変換キーです。
Convert 28 変換キーです。
Kana 21 カタカナひらがなキーです。
CapsLock 20
Apps 93
Insert 45
Delete 46
Home 36
End 35
PageUp 33
PageDown 34
Pause 19
ScrollLock 145
Scroll 145
PrintScreen 44
NumLock 144 このキーはハードに依存するため、押しても効果がない場合があります。
Attn 246
BrowserBack 166
BrowserFavorites 171
BrowserForward 167
BrowserHome 172
BrowserRefresh 168
BrowserSearch 170
BrowserStop 169
ChatPadGreen 使用できません。
ChatPadOrange 使用できません。
Crsel 247
EraseEof 使用できません。
Exsel 248
Execute 43
Help 47
LaunchApplication1 182
LaunchApplication2 183
LaunchMail 180
MediaNextTrack 176
MediaPlayPause 179
MediaPreviousTrack 177
MediaStop 178
None 使用できません。
Oem8 223
OemAuto 243
OemClear 254
OemCopy 242
OemEnlW 244
OemPipe 使用できません。
Pa1 253
Play 250
Print 42
ProcessKey 229
Select 41
SelectMedia 181
Sleep 95
VolumeDown 174 ボリュームコントロールが表示される場合がありますが、動作は OS 依存です。
VolumeMute 173 ボリュームコントロールが表示される場合がありますが、動作は OS 依存です。
VolumeUp 175 ボリュームコントロールが表示される場合がありますが、動作は OS 依存です。
Zoom 251
BoardNext 次のボードに切り替えます。
BoardPrev 前のボードに切り替えます。
BoardJump 指定されている名前のボードに切り替えます。
BoardMove ボードをドラッグして移動します。
BoardMinimize ボードを最小化します。
Exit ちーたんタッチボードを終了します。
ConfigMenu 設定メニューを表示します。
MouseMovePad タッチして指を動かした分マウスカーソルを移動させるマウスパッドです。
MouseMoveJoystick タッチして指を動かした方向にマウスカーソルを移動させ続けるマウススティックです。
MouseLeftClick マウスの左ボタンです。
MouseRightClick マウスの右ボタンです。
MouseMiddleClick マウスの中央ボタンです。
MouseX1Click マウスの X1 ボタンです。
MouseX2Click マウスの X2 ボタンです。
MouseWheel マウスのホイールです。タッチして上下に指を動かすことによってホイールの回転をエミュレートします。
VirtualKeyCode 指定した仮想キーコードを送信します。
DPad 上下左右のキーをひとつにした D-Pad です。

キー追加パラメータ

KeyType ごとの追加パラメータの一覧です。KeyInfo オブジェクト、KeyProcessInfo オブジェクトの Options に KeyValue の一覧として追加してください。

設定例

{
  "DisplayText": "", 
  "ImageName": "MousePadx2", 
  "ImageRenderMode": "Fill", 
  "KeyType": "MouseMovePad", 
  "Options": {"MoveScale":"2","TapAction":"MouseLeftButtonWhenSingleTap"}, 
  "Position": {
    "Height": 122, 
    "Width": 122, 
    "X": 64, 
    "Y": 30
  }, 
},

BoardNext

キー 内容 初期値 未設定許可 対応アプリVer.
NextBoardPositionType string

ほかのボードから切り替える際の表示する位置を指定します。

(未設定)
指定したボードの StartPositionType で指定されている位置に表示します。
CenterPosition
切り替え前のボードの中心位置と切り替え後のボードの中心位置が合うように表示します。

【例】

"NextBoardPositionType": "CenterPosition"
0.01~

BoardPrev

キー 内容 初期値 未設定許可 対応アプリVer.
NextBoardPositionType string

ほかのボードから切り替える際の表示する位置を指定します。

(未設定)
指定したボードの StartPositionType で指定されている位置に表示します。
CenterPosition
切り替え前のボードの中心位置と切り替え後のボードの中心位置が合うように表示します。

【例】

"NextBoardPositionType": "CenterPosition"
0.01~

BoardJump

キー 内容 初期値 未設定許可 対応アプリVer.
JumpBoardIdentityName string

指定した名前のボードコンテナに切り替えます。

【例】

"JumpBoardIdentityName": "010_Normal_1_00_Ja"
0.20~
NextBoardPositionType string

ほかのボードから切り替える際の表示する位置を指定します。

(未設定)
指定したボードの StartPositionType で指定されている位置に表示します。
CenterPosition
切り替え前のボードの中心位置と切り替え後のボードの中心位置が合うように表示します。

【例】

"NextBoardPositionType": "CenterPosition"
0.20~

MouseMovePad

キー 内容 初期値 未設定許可 対応アプリVer.
MoveScale double

マウスカーソルの移動スピードを 1 を基準とした倍率で指定します。

【例】

"MoveScale": 2
1 0.01~
TapAction string

キーをタップしたときの左クリックの動作をエミュレートする方法について指定します。

None
タップによるマウスボタンのエミュレートは行いません。
MouseLeftButtonWhenSingleTap
シングルタップ時にマウスボタンの左クリックをエミュレートします。ダブルタップを行った際はダブルクリックをエミュレートします。
MouseLeftButtonWhenDoubleTap
ダブルタップ時にマウスボタンの左クリックをエミュレートします。トリプルタップを行った際はダブルクリックをエミュレートします。

【例】

"TapAction": "MouseLeftButtonWhenDoubleTap"
MouseLeftButtonWhenDoubleTap 0.01~
TapPressInterval double

タップと判定されるキー押下最大時間です。この時間よりも長くキーを押しているとタップと判定されません。単位はミリ秒です。

【例】

"TapPressInterval": 500
250 0.01~
NextTapConnectInterval double

ダブルタップ以降と判定されるまでのタップの間隔時間。この時間よりも次のタップまでの時間が長いと、ダブルタップと認識されません。単位はミリ秒です。

【例】

"NextTapConnectInterval": 500
250 0.01~
TapEnableAreaRange double

ダブルタップと認識されるための、タップ位置最大許容ずれ幅です。前回のタップの位置と次回のタップの位置がこの数値以上に離れるとダブルタップとして認識されません。単位はボード上の論理ピクセル距離です。

【例】

"TapEnableAreaRange": 10
5 0.01~
PadMoveMode string

指を動かしたときのマウスカーソルの移動スピードの挙動を設定します。

Normal
等倍速度の場合、指の移動量とマウスカーソルの移動量が同じになります。
Accelerate
指を早く動かすとマウスカーソルの移動量が加速的にあがり、遅く動かすと指の移動よりもカーソルの移動が小さくなります。

【例】

"PadMoveMode": "Accelerate"
Accelerate 0.01~

MouseMoveJoystick

キー 内容 初期値 未設定許可 対応アプリVer.
StickMode string

スティックの中心点をキーの中央にするかタッチポイントにするかを指定します。

PanelCenter
スティックの中心点をキーの中央にします。そのため、キーの端をタッチすると即座にマウスカーソルの移動が始まります。
TouchCenter
スティックの中心点をタッチポイントにします。これにより、タッチ位置を気にせずにタッチした位置から指を動かした方向にマウスカーソルを移動できます。

【例】

"StickMode": "TouchCenter"
TouchCenter 0.01~
MaxSpeedPerSecond double

スティックを大きく倒したときのマウスカーソルの最大移動スピードです。移動スピードは「1秒間あたりのデスクトップ上のpixel数」です。

【例】

"MaxSpeedPerSecond": 500
1000 0.01~
TipAreaLength double

スティックを倒し切る最大距離です。距離はボード上の論理pixelになります。この設定は StickMode が TouchCenter の時のみ有効です。PanelCenter の場合はキーのサイズに依存します。

【例】

"TipAreaLength": 50
100 0.01~
TapAction string

キーをタップしたときの左クリックの動作をエミュレートする方法について指定します。

None
タップによるマウスボタンのエミュレートは行いません。
MouseLeftButtonWhenSingleTap
シングルタップ時にマウスボタンの左クリックをエミュレートします。ダブルタップを行った際はダブルクリックをエミュレートします。
MouseLeftButtonWhenDoubleTap
ダブルタップ時にマウスボタンの左クリックをエミュレートします。トリプルタップを行った際はダブルクリックをエミュレートします。

【例】

"TapAction": "MouseLeftButtonWhenDoubleTap"
MouseLeftButtonWhenDoubleTap 0.20~
TapPressInterval double

タップと判定されるキー押下最大時間です。この時間よりも長くキーを押しているとタップと判定されません。単位はミリ秒です。

【例】

"TapPressInterval": 500
250 0.20~
NextTapConnectInterval double

ダブルタップ以降と判定されるまでのタップの間隔時間。この時間よりも次のタップまでの時間が長いと、ダブルタップと認識されません。単位はミリ秒です。

【例】

"NextTapConnectInterval": 500
250 0.20~
TapEnableAreaRange double

ダブルタップと認識されるための、タップ位置最大許容ずれ幅です。前回のタップの位置と次回のタップの位置がこの数値以上に離れるとダブルタップとして認識されません。単位はボード上の論理ピクセル距離です。

【例】

"TapEnableAreaRange": 10
5 0.20~

DPad

キー 内容 初期値 未設定許可 対応アプリVer.
UpKey string

↑キーを押したときに送信するキーを指定します。

【例】

"UpKey": "Up"
Up 0.20~
DownKey string

↓キーを押したときに送信するキーを指定します。

【例】

"DownKey": "Down"
Down 0.20~
LeftKey string

←キーを押したときに送信するキーを指定します。

【例】

"LeftKey": "Left"
Left 0.20~
RightKey string

→キーを押したときに送信するキーを指定します。

【例】

"RightKey": "Right"
Right 0.20~

VirtualKeyCode

キー 内容 初期値 未設定許可 対応アプリVer.
VirtualKeyCode int

Windows の仮想キーコード(数値)を直接送信することができます。

【例】

"VirtualKeyCode": 33
0.22~