Core Function KeyHook
(→Example) |
(→Example) |
||
| Line 43: | Line 43: | ||
<syntaxhighlight lang="sputnik"> | <syntaxhighlight lang="sputnik"> | ||
// Set a new Keyhook called MyHook | // Set a new Keyhook called MyHook | ||
| − | $hookId = KeyHook("MyHook", 'myKeyHook($ | + | $hookId = KeyHook("MyHook", 'myKeyHook($Arg, $Key, $KeyExtra);'); |
| − | + | ||
// Pressing P will cause the hook to be removed | // Pressing P will cause the hook to be removed | ||
HotKeySet("p", "removeIt();"); | HotKeySet("p", "removeIt();"); | ||
| Line 50: | Line 50: | ||
{ | { | ||
KeyHookKill($hookId); | KeyHookKill($hookId); | ||
| + | println("Deleted Hook ID '$hookId'"); | ||
// OR | // OR | ||
//KeyHook("MyHook"); | //KeyHook("MyHook"); | ||
| + | //println("Deleted Hook Name 'MyHook'"); | ||
} | } | ||
| Line 59: | Line 61: | ||
} | } | ||
| − | Function myKeyHook($ | + | Function myKeyHook($Arg, $Key, $KeyExtra) |
{ | { | ||
| − | my List( $Name, $nCode, $wParam, $lParam ) = $ | + | my List( $Name, $nCode, $wParam, $lParam ) = $Arg; |
if($nCode >= 0) | if($nCode >= 0) | ||
{ | { | ||
if($wParam == 0x0100) // WM_KEYDOWN | if($wParam == 0x0100) // WM_KEYDOWN | ||
{ | { | ||
| − | my List( $ | + | my List( $VkCode, $ScanCode, $Flags, $Time, $DwExtraInfo ) = $Key; |
| − | my | + | my List( $Key, $Control, $Shift, $Alt, $CapsLock ) = $KeyExtra; |
| − | println( "KeyDOWN Hook '$Name' | + | println( "KeyDOWN Hook '$Name' Key '$Key' VKCode '$VkCode'" ); |
// If user presses Q remove the hook! | // If user presses Q remove the hook! | ||
| − | if($ | + | if($Key == "q") |
{ | { | ||
// If true is ever returned the hook will be removed | // If true is ever returned the hook will be removed | ||
println("Deleted Hook Name '$Name'"); | println("Deleted Hook Name '$Name'"); | ||
return true; | return true; | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
} | } | ||
} | } | ||
else if($wParam == 0x0101) // WM_KEYUP | else if($wParam == 0x0101) // WM_KEYUP | ||
{ | { | ||
| − | my List( $ | + | my List( $VkCode, $ScanCode, $Flags, $Time, $DwExtraInfo ) = $Key; |
| − | my | + | my List( $Key, $Control, $Shift, $Alt, $CapsLock ) = $KeyExtra; |
| − | println( "KeyUP Hook '$Name' | + | println( "KeyUP Hook '$Name' Key '$Key' VKCode '$VkCode'" ); |
} | } | ||
} | } | ||
Revision as of 21:50, 17 October 2013
KeyHook( <name>, <command>, <param var> )
Contents |
Description
Places a global system wide Keyhook with callback to a function or command.
Parameters
name
Unique name for the new Keyhook (So it can be removed later!)
If this is the only param used it will try delete a previously made hook by this name.
If a hook already exists with this name it will be replaced with the new code (assuming second param is in use)
command
Optional; A command or function to call etc when the Keyhook event triggers on a keypress up/down etc.
This is similar to Eval().
param var
Optional; A variable to pass inside the keyhook this variable will become $Param this is most useful for attaching a class to the keyhook so you can access its variables, functions natively.
Return Value
Success: Returns a valid pointer to a mouse hook.
Failure: Returns @PTRZero.
Remarks
A keyhook will cause your program to crash if you dont add DoEvents() in your code see below example.
If only the NAME param is used and NOT the command it will add that name to the delete list and the hook of that name (if any exist) will be removed at the earliest opportunity.
Example
// Set a new Keyhook called MyHook $hookId = KeyHook("MyHook", 'myKeyHook($Arg, $Key, $KeyExtra);'); // Pressing P will cause the hook to be removed HotKeySet("p", "removeIt();"); Function removeIt() { KeyHookKill($hookId); println("Deleted Hook ID '$hookId'"); // OR //KeyHook("MyHook"); //println("Deleted Hook Name 'MyHook'"); } while(true) { DoEvents(); } Function myKeyHook($Arg, $Key, $KeyExtra) { my List( $Name, $nCode, $wParam, $lParam ) = $Arg; if($nCode >= 0) { if($wParam == 0x0100) // WM_KEYDOWN { my List( $VkCode, $ScanCode, $Flags, $Time, $DwExtraInfo ) = $Key; my List( $Key, $Control, $Shift, $Alt, $CapsLock ) = $KeyExtra; println( "KeyDOWN Hook '$Name' Key '$Key' VKCode '$VkCode'" ); // If user presses Q remove the hook! if($Key == "q") { // If true is ever returned the hook will be removed println("Deleted Hook Name '$Name'"); return true; } } else if($wParam == 0x0101) // WM_KEYUP { my List( $VkCode, $ScanCode, $Flags, $Time, $DwExtraInfo ) = $Key; my List( $Key, $Control, $Shift, $Alt, $CapsLock ) = $KeyExtra; println( "KeyUP Hook '$Name' Key '$Key' VKCode '$VkCode'" ); } } return false; }
