Custom:Input Actions
From Unified Remote
Contents |
Keyboard
KeyDown
Performs a key down action.
Extras:
- One or more key names
Example (single key):
<Actions>
<Action Name="foo">
<ActionRef Name="KeyDown" Target="Input" Extra="RETURN" />
</Action>
</Actions>
Example (multiple keys):
<Actions>
<Action Name="bar">
<ActionRef Name="KeyDown" Target="Input">
<Extra>RETURN</Extra>
<Extra>BACK</Extra>
</ActionRef>
</Action>
</Actions>
KeyUp
Performs a key up action.
Extras:
- One or more key names
Example (single key):
<Actions>
<Action Name="foo">
<ActionRef Name="KeyUp" Target="Input" Extra="RETURN" />
</Action>
</Actions>
Example (multiple keys):
<Actions>
<Action Name="bar">
<ActionRef Name="KeyUp" Target="Input">
<Extra>RETURN</Extra>
<Extra>BACK</Extra>
</ActionRef>
</Action>
</Actions>
Press
Performs a key press (down and up).
Extras:
- One or more key names
Example (single key):
<Actions>
<Action Name="foo">
<ActionRef Name="Press" Target="Input" Extra="RETURN" />
</Action>
</Actions>
Example (multiple keys):
<Actions>
<Action Name="bar">
<ActionRef Name="Press" Target="Input">
<Extra>RETURN</Extra>
<Extra>BACK</Extra>
</ActionRef>
</Action>
</Actions>
Stroke
Performs a key stroke.
Extras:
- One or more key names
Example (single key):
<Actions>
<Action Name="foo">
<ActionRef Name="Stroke" Target="Input" Extra="RETURN" />
</Action>
</Actions>
Example (multiple keys):
<Actions>
<Action Name="bar">
<ActionRef Name="Stroke" Target="Input">
<Extra>RETURN</Extra>
<Extra>BACK</Extra>
</ActionRef>
</Action>
</Actions>
Text
Types out the specified text.
Extras:
- Text: text string
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="Text" Target="Input" Extra="type this text" />
</Action>
</Actions>
Mouse
MouseDown
Performs a mouse down action.
Extras:
- One or more button names
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="MouseDown" Target="Input">
<Extra>Left</Extra>
<Extra>Right</Extra>
</ActionRef>
</Action>
</Actions>
MouseUp
Performs a mouse upaction.
Extras:
- One or more button names
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="MouseUp" Target="Input">
<Extra>Left</Extra>
<Extra>Right</Extra>
</ActionRef>
</Action>
</Actions>
Click
Performs a mouse click action.
Extras:
- One or more button names
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="Click" Target="Input">
<Extra>Left</Extra>
<Extra>Right</Extra>
</ActionRef>
</Action>
</Actions>
DblClick
Performs a mouse double click action.
Extras:
- One or more button names
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="DblClick" Target="Input">
<Extra>Left</Extra>
<Extra>Right</Extra>
</ActionRef>
</Action>
</Actions>
Left
Performs a left mouse click. Example:
<Actions>
<Action Name="foo">
<ActionRef Name="Left" Target="Input"/>
</Action>
</Actions>
MoveBy
Moves the mouse cursor by the specified amount of pixels.
Extras:
- X: pixels in X direction
- Y: pixels in Y direction
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="MoveBy" Target="Input">
<Extra Name="X">200</Extra>
<Extra Name="Y">200</Extra>
</ActionRef>
</Action>
</Actions>
MoveTo
Moves the mouse cursor to the specified location in normalized coordinates.
Extras:
- X: location in X direction
- Y: location in Y direction
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="MoveTo" Target="Input">
<Extra Name="X">200</Extra>
<Extra Name="Y">200</Extra>
</ActionRef>
</Action>
</Actions>
MoveToPx
Moves the mouse cursor to the specified location in pixels.
Extras:
- X: pixel in X direction
- Y: pixel in Y direction
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="MoveToPx" Target="Input">
<Extra Name="X">200</Extra>
<Extra Name="Y">200</Extra>
</ActionRef>
</Action>
</Actions>
Vert
Performs a vertical mouse scroll.
Extras:
- V: scroll amount
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="Vert" Target="Input">
<Extra Name="V">200</Extra>
</ActionRef>
</Action>
</Actions>
Horz
Performs a horizontal mouse scroll.
Extras:
- H: scroll amount
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="Horz" Target="Input">
<Extra Name="H">200</Extra>
</ActionRef>
</Action>
</Actions>
State (in 2.1.2+)
ScrollLock
Gets or sets the scroll lock state.
Extras:
- Enable: true/false
If no extras are provided, the state is returned.
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="ScrollLock" Target="Input">
<Extra Name="Enable">true</Extra>
</ActionRef>
</Action>
</Actions>
Example (get state):
<Actions>
<Action Name="foo">
<ActionRef Name="ScrollLock" Target="Input" />
<ActionRef Name="Msg" Target="Util" Extra="State: $res" />
</Action>
</Actions>
CapsLock
Gets or sets the caps lock state.
Extras:
- Enable: true/false
If no extras are provided, the state is returned.
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="CapsLock" Target="Input">
<Extra Name="Enable">true</Extra>
</ActionRef>
</Action>
</Actions>
Example (get state):
<Actions>
<Action Name="foo">
<ActionRef Name="CapsLock" Target="Input" />
<ActionRef Name="Msg" Target="Util" Extra="State: $res" />
</Action>
</Actions>
NumLock
Gets or sets the num lock state.
Extras:
- Enable: true/false
If no extras are provided, the state is returned.
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="NumLock" Target="Input">
<Extra Name="Enable">true</Extra>
</ActionRef>
</Action>
</Actions>
Example (get state):
<Actions>
<Action Name="foo">
<ActionRef Name="NumLock" Target="Input" />
<ActionRef Name="Msg" Target="Util" Extra="State: $res" />
</Action>
</Actions>
IsKeyDown
Gets whether or not the specified key is down.
Extras:
- Key: the key name
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="IsKeyDown" Target="Input">
<Extra Name="Key">TAB</Extra>
</ActionRef>
<ActionRef Name="Msg" Target="Util" Extra="State: $res" />
</Action>
</Actions>
IsKeyUp
Gets whether or not the specified key is up.
Extras:
- Key: the key name
Example:
<Actions>
<Action Name="foo">
<ActionRef Name="IsKeyDown" Target="Input">
<Extra Name="Key">TAB</Extra>
</ActionRef>
<ActionRef Name="Msg" Target="Util" Extra="State: $res" />
</Action>
</Actions>
