MouseOnEvent UDF!

[malu05]

So...

how can i see if i use MouseWheel down or MouseWhell up?

[Spogie]

Oh, this is perfect! This should be added to the include library!!

This is really useful, will certainly add this to my autoit directory on my desktop

[Zohar]

definitely..

it should be included with the built in lib.

highly useful!!

thank you mr creator

Edited June 11, 2009 by Zohar

[Zohar]

MrCreator, 1 thing I must ask.

Inside MouseSetOnEvent_UDF.au3, you have a Func OnAutoItExit().

Won't it collide with the OnAutoItExit() function that the user might already have in his script?

[KaFu]

Won't it collide with the OnAutoItExit() function that the user might already have in his script?

Yes it will. But in SciTE you'll see a corresponding error message .

Nice UDF, will use it for COP ... but one thing I notice, is it possible that this function changes the mouse speed? Remember a post where default mouse speed was read... have to search for it ...

[Yorn]

I get the error below. Also, as has been mentioned, You should be using $MOUSE_WHEELUP_EVENT and $MOUSE_WHEELDOWN_EVENT as WHELL is not a word.

D:\Downloads\AutoIT\MouseSetOnEvent_UDF.au3 (3) : ==> Can not redeclare a constant.:
Global Const $WH_MOUSE_LL                   = 14
Global Const ^ ERROR

I'd love to be able to use this script as I don't know of any other way to set up hotkeys on mouse events.

[MrCreatoR]

is it possible that this function changes the mouse speed?

Perhaps yes, but it's not the purpose of that UDF

---

Update...

History version:

v1.4 [30.09.2009]

+ Added UDF header to the function.

+ Now the original events-messages (such as $WM_MOUSEMOVE) can be used as well.

+ Added missing events (althought i am not sure if they are still supported)

$MOUSE_PRIMARYDBLCLK_EVENT - Primary mouse button double click.
$MOUSE_SECONDARYDBLCLK_EVENT - Secondary mouse button double click.
$MOUSE_WHEELDBLCLK_EVENT - Wheel mouse button double click.
$MOUSE_EXTRABUTTONDBLCLK_EVENT - Side mouse button double click.

* Changed global vars and internal functions names to be more unique.

* Fixed variables declaration and misspelling.

Edited September 29, 2009 by MrCreatoR

[MrCreatoR]

Update...

History version:

v1.5 [09.10.2009]

+ [Finally!] Added wheel button up/down *scrolling* event recognition. Thanks to JRowe (http://www.autoitscript.com/forum/index.php?showtopic=103362).

* Fixed an issue with returning value from __MouseSetOnEvent_MainHandler - should call _WinAPI_CallNextHookEx before return (thanks to Yashied).

* Constants starting with MOUSE_EXTRABUTTON* renamed to MOUSE_XBUTTON*, as it should be in the first place.

* Few examples updated.

[wraithdu]

Thanks for the update. But I found a problem, and it could have been goofy for a while now and I just never noticed for whatever reason. In your OnAutoItExit() function, your tests are both wrong. First, $__MouseSetOnEvent_hMouseHook is never an array, it is a Ptr. Second $__MouseSetOnEvent_hMouseProc is an Int32, not a Ptr. This was causing things never to be unset/unregistered. To make things worse, comparisons with Ptr variants don't seem to work right. See my topic HERE. Here is what I changed to fix it:

Func OnAutoItExit()
    If IsPtr($__MouseSetOnEvent_hMouseHook) Then
        $ret = DllCall("user32.dll", "int", "UnhookWindowsHookEx", "ptr", $__MouseSetOnEvent_hMouseHook)
        $__MouseSetOnEvent_hMouseHook = 0
    EndIf

    If $__MouseSetOnEvent_hMouseProc > 0 Then
        DllCallbackFree($__MouseSetOnEvent_hMouseProc)
        $__MouseSetOnEvent_hMouseProc = 0
    EndIf
EndFunc

You might also want to put up a warning not to unset a mouse event in the hook function, it will cause a crash. This never happened before cause the event was never unregistered. But after I fixed that function, I started getting crashes for that reason.

Edited October 12, 2009 by wraithdu

[MrCreatoR]

$__MouseSetOnEvent_hMouseHook is never an array

Oops, it was in the last version

$__MouseSetOnEvent_hMouseProc is an Int32, not a Ptr. This was causing things never to be unset/unregistered. To make things worse, comparisons with Ptr variants don't seem to work right. See my topic HERE. Here is what I changed to fix it:

But it's crashing for me that way. Here is a fix that work for me:

Func OnAutoItExit()
    If $__MouseSetOnEvent_hMouseHook <> -1 Then
        _WinAPI_UnhookWindowsHookEx($__MouseSetOnEvent_hMouseHook)
        $__MouseSetOnEvent_hMouseHook = -1
    EndIf
    
    If $__MouseSetOnEvent_hMouseProc <> -1 Then
        DllCallbackFree($__MouseSetOnEvent_hMouseProc)
        $__MouseSetOnEvent_hMouseProc = -1
    EndIf
EndFunc

You might also want to put up a warning not to unset a mouse event in the hook function, it will cause a crash

And what if the unset event is the last event?

[MrCreatoR]

Small Update...

History version:

v1.6 [13.10.2009]

* Fixed an issue with releasing the resources of mouse hook. Thanks to wraithdu.

[wraithdu]

@MrCreatoR

Can you post the example you tried that was crashing? I don't see it should make any difference how the detection is done as long as it works. Perhaps a different version of AutoIt does my version a bit different?

Let me clarify the other thing a bit more. Care should be taken not to unset the *last* event inside the hook function. Otherwise you freeing a callback before you return from it, and that *will* cause a crash. I suppose unsetting anything but the last event would be OK since that doesn't trigger the callback to be freed.

[MrCreatoR]

Can you post the example you tried that was crashing?

It's the basic example from the archive («MouseSetOnEvent Examples»).

Care should be taken not to unset the *last* event inside the hook function. Otherwise you freeing a callback before you return from it, and that *will* cause a crash.

You are right, i do release the callback before it return, but it's not crashing for me with the last update i made (using last comparision method). But i could do it using Adlib to call sub function after the callback is done, but only in the environment a current beta, due to adlib new format (i don't want to disable potential user's adlib set in his script).

[MrCreatoR]

wraithdu

Oh you mean this (in __MouseSetOnEvent_MainHandler):

If $__MouseSetOnEvent_aEvents[0][0] < 1 Then
        OnAutoItExit()
        Return 0
    EndIf

Ok, will remove that.

Edited October 13, 2009 by MrCreatoR

[wraithdu]

I think you are safe to just remove these lines from the handler:

If $__MouseSetOnEvent_aEvents[0][0] < 1 Then
    OnAutoItExit()
    Return 0
EndIf

The _MouseSetOnEvent() function takes care of removing the hook when the event count reaches zero regardless if there are messages left in the queue. I assume these leftover messages would just be ignored and not cause a crash, whereas unregistering the callback in the handler the way it is now will definitely cause a crash.

[wraithdu]

Yeah, we're on the same train of thought. But I also mean it would be a good idea to caution users no to unset their last event inside a function called by the hook, as that would also cause a crash for the same reason. Ex. -

_MouseSetOnEvent($MOUSE_PRIMARYDOWN_EVENT, "_CrashMe")

While 1
    Sleep(1000)
WEnd

Func _CrashMe()
    _MouseSetOnEvent($MOUSE_PRIMARYDOWN_EVENT)
    Exit
EndFunc

[MrCreatoR]

Updated without increesing the version, since the issue is the same .

[MrCreatoR]

But I also mean it would be a good idea to caution users no to unset their last event inside a function called by the hook, as that would also cause a crash for the same reason

No need to, fixed that too (using timers - i just have "put on hold" the resources release until the callback function does not return).

[wraithdu]

I'm interested to see your implementation. It might be tricky though, cause there's no way to know how long someone will remain in their function after unsetting the event and before returning.

[MrCreatoR]

I'm interested to see your implementation

Just download the latest version