GUIRegisterMsg: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<!-- Autogenerated Wiki Page. --> | |||
<!-- Not meant to be user editable. --> | |||
<!-- If there is an error here then that means that there is an error in the helpfile. --> | |||
<!-- Report it to Trac with category 'Documentation'. --> | |||
<!-- See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/--> | |||
<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'> | |||
< | <font size='3' weight='normal'>Register a user defined function for a known Windows Message ID (WM_MSG).</font> | ||
</ | |||
==Parameters== | <font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'> | ||
{| | |||
:GUIRegisterMsg ( msgID, "function" ) | |||
</div></font> | |||
===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>=== | |||
{| class='wikitable' | |||
|- | |- | ||
| function || The name of the user function to call when the message appears or an empty string "" to unregister a message. | | msgID || A Windows Message ID (see Appendix: [http://www.autoitscript.com/autoit3/docs/appendix/WinMsgCodes.htm Windows Message Codes]). | ||
|- | |||
| function || The name of the user function to call when the message appears or an empty string "" to unregister a message. | |||
|} | |} | ||
==Return Value== | |||
{| | ===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>=== | ||
{| class='wikitable' | |||
| Success: || 1 | | Success: || 1 | ||
|- | |- | ||
| Line 20: | Line 34: | ||
|} | |} | ||
==Remarks== | |||
===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>=== | |||
To make the user function workable you have to define it with '''maximum 4 function parameters''' otherwise the function won't be called! | To make the user function workable you have to define it with '''maximum 4 function parameters''' otherwise the function won't be called! | ||
i.e: | i.e: | ||
Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam) | Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam) | ||
| Line 35: | Line 52: | ||
When the user function is called then these 4 parameters have the following values: | When the user function is called then these 4 parameters have the following values: | ||
{| | {| class='wikitable' | ||
! | ! | '''Position''' | ||
! | ! | '''Parameter''' | ||
! | ! | '''Meaning''' | ||
|- | |- | ||
| 1 || hWnd || The Window handle of the GUI in which the message appears. | | 1 || hWnd || The Window handle of the GUI in which the message appears. | ||
| Line 56: | Line 73: | ||
If you want AutoIt to run its internal handler for a message, return the variable '''$GUI_RUNDEFMSG''' (in GUIConstantsEx.au3) from the function (see also examples)! | If you want AutoIt to run its internal handler for a message, return the variable '''$GUI_RUNDEFMSG''' (in GUIConstantsEx.au3) from the function (see also examples)! | ||
I.e. if you want to return earlier than the user function ends and also proceed the AutoIt internal message handler. | I.e. if you want to return earlier than the user function ends and also proceed the AutoIt internal message handler. | ||
'''Warning:''' blocking of running user functions which executes window messages with commands such as "[[MsgBox]]" can lead to unexpected behavior, the return to the system should be as fast as possible! | '''Warning:''' blocking of running user functions which executes window messages with commands such as "[[MsgBox]]" can lead to unexpected behavior, the return to the system should be as fast as possible! | ||
Some controls consume internally specific Windows Message ID, so registering them will have no effect, e.g; WM_CHAR, WM_KEYDOWN, WM_KEYUP are consumed by an edit control. | Some controls consume internally specific Windows Message ID, so registering them will have no effect, e.g; WM_CHAR, WM_KEYDOWN, WM_KEYUP are consumed by an edit control. | ||
==Related== | |||
===<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>=== | |||
[[GUICtrlGetHandle]] | [[GUICtrlGetHandle]] | ||
==Example== | |||
===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>=== | |||
<syntaxhighlight lang='autoit'> | <syntaxhighlight lang='autoit'> | ||
; Create an ownerdrawn/colored button | ; Create an ownerdrawn/colored button | ||
| Line 141: | Line 164: | ||
; Proceed the default AutoIt3 internal message commands. | ; Proceed the default AutoIt3 internal message commands. | ||
; You also can complete let the line out. | ; You also can complete let the line out. | ||
; ! | ;! | ||
; the default AutoIt3-message in the future ! | But only 'Return' (without any value) will not proceed | ||
; the default AutoIt3-message in the future! | |||
Return $GUI_RUNDEFMSG | Return $GUI_RUNDEFMSG | ||
EndFunc ;==>MY_WM_COMMAND | EndFunc ;==>MY_WM_COMMAND | ||
| Line 444: | Line 469: | ||
EndFunc ;==>GetWindowLong | EndFunc ;==>GetWindowLong | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</font> | |||
__NOTOC__ | __NOTOC__ | ||
__NOEDITSECTION__ | |||
Latest revision as of 16:13, 23 August 2013
Register a user defined function for a known Windows Message ID (WM_MSG).
- GUIRegisterMsg ( msgID, "function" )
Parameters
| msgID | A Windows Message ID (see Appendix: Windows Message Codes). |
| function | The name of the user function to call when the message appears or an empty string "" to unregister a message. |
Return Value
| Success: | 1 |
| Failure: | 0 |
Remarks
To make the user function workable you have to define it with maximum 4 function parameters otherwise the function won't be called!
i.e: Func MyUserFunction($hWndGUI, $MsgID, $WParam, $LParam) ... EndFunc
Or
Func MyUserFunction($hWndGUI, $MsgID) ... EndFunc
When the user function is called then these 4 parameters have the following values:
| Position | Parameter | Meaning |
|---|---|---|
| 1 | hWnd | The Window handle of the GUI in which the message appears. |
| 2 | Msg | The Windows message ID. |
| 3 | wParam | The first message parameter as hex value. |
| 4 | lParam | The second message parameter as hex value. |
Up to 256 user functions can be registered for message IDs.
By default after finishing the user function the AutoIt internal message handler will be proceed. That won't be if your Return a value (See WM_COMMAND in example) or if you use the keyword 'Return' without any value. By using 'Return' without any return value the AutoIt internal message handler (if there is one for this message) will NOT be proceed!
If you want AutoIt to run its internal handler for a message, return the variable $GUI_RUNDEFMSG (in GUIConstantsEx.au3) from the function (see also examples)!
I.e. if you want to return earlier than the user function ends and also proceed the AutoIt internal message handler.
Warning: blocking of running user functions which executes window messages with commands such as "MsgBox" can lead to unexpected behavior, the return to the system should be as fast as possible!
Some controls consume internally specific Windows Message ID, so registering them will have no effect, e.g; WM_CHAR, WM_KEYDOWN, WM_KEYUP are consumed by an edit control.
Related
Example
; Create an ownerdrawn/colored button
#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>
#include <ButtonConstants.au3>
#include <MsgBoxConstants.au3>
Example()
Func Example()
Local Const $BS_OWNERDRAW = 0x0000000B
Local $iButton = 0, $iButton2 = 0, $iMsg = 0
GUICreate("My Ownerdrawn Created Button", 300, 200)
$iButton = GUICtrlCreateButton("", 90, 50, 120, 30)
GUICtrlSetStyle($iButton, BitOR($WS_TABSTOP, $BS_NOTIFY, $BS_OWNERDRAW)) ; Set the ownerdrawn flag
$iButton2 = GUICtrlCreateButton("Normal Button", 90, 110, 120, 30)
GUIRegisterMsg($WM_COMMAND, "MY_WM_COMMAND")
; WM_DRAWITEM has to registered before showing GUI otherwise the initial drawing isn't done
GUIRegisterMsg($WM_DRAWITEM, "MY_WM_DRAWITEM")
GUISetState()
While 1
$iMsg = GUIGetMsg()
Switch $iMsg
Case $GUI_EVENT_CLOSE
ExitLoop
Case $iButton
; Normally should not run through cause of our MY_WM_COMMAND function
MsgBox($MB_SYSTEMMODAL, "Info", "Button pressed")
Case $iButton2
; Normally should not run through cause of our MY_WM_COMMAND function
MsgBox($MB_SYSTEMMODAL, "Info", "Button2 pressed")
EndSwitch
WEnd
GUIDelete()
EndFunc ;==>Example
; React on a button click
Func MY_WM_COMMAND($hWnd, $Msg, $wParam, $lParam)
Local $nNotifyCode = BitShift($wParam, 16)
Local $nID = BitAND($wParam, 0x0000FFFF)
Local $hCtrl = $lParam
If $nID <> 2 And $nNotifyCode = 0 Then ; Check for IDCANCEL - 2
; Ownerdrawn buttons don't send something by pressing ENTER
; So IDOK - 1 comes up, now check for the control that has the current focus
If $nID = 1 Then
Local $hFocus = DllCall("user32.dll", "hwnd", "GetFocus")
Local $nCtrlID = DllCall("user32.dll", "int", "GetDlgCtrlID", "hwnd", $hFocus[0])
PostButtonClick($hWnd, $nCtrlID[0])
Else
MsgBox($MB_SYSTEMMODAL, "MY_WM_COMMAND", "GUIHWnd" & @TAB & ":" & $hWnd & @CRLF & _
"MsgID" & @TAB & ":" & $Msg & @CRLF & _
"wParam" & @TAB & ":" & $wParam & @CRLF & _
"lParam" & @TAB & ":" & $lParam & @CRLF & @CRLF & _
"WM_COMMAND - Infos:" & @CRLF & _
"-----------------------------" & @CRLF & _
"Code" & @TAB & ":" & $nNotifyCode & @CRLF & _
"CtrlID" & @TAB & ":" & $nID & @CRLF & _
"CtrlHWnd" & @TAB & ":" & $hCtrl)
EndIf
Return 0 ; Only workout clicking on the button
EndIf
; Proceed the default AutoIt3 internal message commands.
; You also can complete let the line out.
;!
But only 'Return' (without any value) will not proceed
; the default AutoIt3-message in the future!
Return $GUI_RUNDEFMSG
EndFunc ;==>MY_WM_COMMAND
; RePost a WM_COMMAND message to a ctrl in a gui window
Func PostButtonClick($hWnd, $nCtrlID)
DllCall("user32.dll", "int", "PostMessage", _
"hwnd", $hWnd, _
"int", $WM_COMMAND, _
"int", BitAND($nCtrlID, 0x0000FFFF), _
"hwnd", GUICtrlGetHandle($nCtrlID))
EndFunc ;==>PostButtonClick
; Draw the button
Func MY_WM_DRAWITEM($hWnd, $Msg, $wParam, $lParam)
#forceref $Msg, $wParam, $lParam
Local $stDrawItem = DllStructCreate("uint;uint;uint;uint;uint;uint;uint;int[4];dword", $lParam)
Local Const $ODT_BUTTON = 4
Local $nCtlType = DllStructGetData($stDrawItem, 1)
If $nCtlType = $ODT_BUTTON Then
; Local $nCtrlID = DllStructGetData($stDrawItem, 2)
Local $nItemState = DllStructGetData($stDrawItem, 5)
Local $hCtrl = DllStructGetData($stDrawItem, 6)
Local $hDC = DllStructGetData($stDrawItem, 7)
Local $nLeft = DllStructGetData($stDrawItem, 8, 1)
Local $nTop = DllStructGetData($stDrawItem, 8, 2)
Local $nRight = DllStructGetData($stDrawItem, 8, 3)
Local $nBottom = DllStructGetData($stDrawItem, 8, 4)
Local $sText = "Ownerdrawn Button"
Local $nTextColor = 0x5555DD
Local $nBackColor = 0xFFEEDD
DrawButton($hWnd, $hCtrl, $hDC, $nLeft, $nTop, $nRight, $nBottom, $nItemState, $sText, $nTextColor, $nBackColor)
$stDrawItem = 0
Return 1
EndIf
$stDrawItem = 0
Return $GUI_RUNDEFMSG ; Proceed the default AutoIt3 internal message commands
EndFunc ;==>MY_WM_DRAWITEM
; The main drawing procedure
Func DrawButton($hWnd, $hCtrl, $hDC, $nLeft, $nTop, $nRight, $nBottom, $nItemState, $sText, $nTextColor, $nBackColor)
#forceref $hWnd
;Local $bDefault = FALSE
Local Const $GWL_STYLE = -16
Local Const $ODS_SELECTED = 0x0001
Local Const $ODS_GRAYED = 0x0002
Local Const $ODS_DISABLED = 0x0004
; Local Const $ODS_CHECKED = 0x0008
Local Const $ODS_FOCUS = 0x0010
; Local Const $ODS_HOTLIGHT = 0x0040
; Local Const $ODS_INACTIVE = 0x0080
; Local Const $ODS_NOACCEL = 0x0100
; Local Const $ODS_NOFOCUSRECT = 0x0200
Local Const $DFC_BUTTON = 4
Local Const $DFCS_BUTTONPUSH = 0x0010
; Local $bChecked = BitAND($nItemState, $ODS_CHECKED)
Local $bFocused = BitAND($nItemState, $ODS_FOCUS)
Local $bGrayed = BitAND($nItemState, BitOR($ODS_GRAYED, $ODS_DISABLED))
Local $bSelected = BitAND($nItemState, $ODS_SELECTED)
Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)
Local $nClrTxt
If $bGrayed Then
$nClrTxt = SetTextColor($hDC, GetSysColor($COLOR_HIGHLIGHTTEXT))
ElseIf $nTextColor = -1 Then
$nClrTxt = SetTextColor($hDC, GetSysColor($COLOR_BTNTEXT))
Else
$nClrTxt = SetTextColor($hDC, $nTextColor)
EndIf
Local $hBrush, $nClrSel
If $nBackColor = -1 Then
$hBrush = GetSysColorBrush($COLOR_BTNFACE)
$nClrSel = GetSysColor($COLOR_BTNFACE)
Else
$hBrush = CreateSolidBrush($nBackColor)
$nClrSel = $nBackColor;
EndIf
Local $nClrBk = SetBkColor($hDC, $nClrSel)
Local $hOldBrush = SelectObject($hDC, $hBrush)
Local $nTmpLeft = $nLeft
Local $nTmpTop = $nTop
Local $nTmpRight = $nRight
Local $nTmpBottom = $nBottom
If $bSelected Then
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -1, -1)
Local $hBrushSel = CreateSolidBrush(GetSysColor($COLOR_BTNSHADOW))
FrameRect($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $hBrushSel)
DeleteObject($hBrushSel)
Else
If $bFocused And Not $bSelected Then InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -1, -1)
DrawFrameControl($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $DFC_BUTTON, $DFCS_BUTTONPUSH)
EndIf
$nTmpLeft = $nLeft
$nTmpTop = $nTop
$nTmpRight = $nRight
$nTmpBottom = $nBottom
If $bSelected Then
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -2, -2)
Else
If $bFocused And Not $bSelected Then
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -3, -3)
$nTmpLeft -= 1
$nTmpTop -= 1
Else
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -2, -2)
$nTmpLeft -= 1
$nTmpTop -= 1
EndIf
EndIf
FillRect($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $hBrush)
If $bSelected Or $bGrayed Then
$nTmpLeft = $nTmpLeft + 2
$nTmpTop = $nTmpTop + 2
EndIf
Local $uFlags = BitOR($DT_NOCLIP, $DT_CENTER, $DT_VCENTER)
If Not BitAND(GetWindowLong($hCtrl, $GWL_STYLE), $BS_MULTILINE) Then $uFlags = BitOR($uFlags, $DT_SINGLELINE)
DrawText($hDC, $sText, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $uFlags)
If $bGrayed Then
$nTmpLeft = $nLeft
$nTmpTop = $nTop
$nTmpRight = $nRight
$nTmpBottom = $nBottom
$nTmpLeft -= 1
$nClrTxt = SetTextColor($hDC, GetSysColor($COLOR_GRAYTEXT))
DrawText($hDC, $sText, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, BitOR($DT_NOCLIP, $DT_CENTER, $DT_VCENTER, $DT_SINGLELINE))
EndIf
$nTmpLeft = $nLeft
$nTmpTop = $nTop
$nTmpRight = $nRight
$nTmpBottom = $nBottom
If $bFocused Then
$hBrush = CreateSolidBrush(0)
FrameRect($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, $hBrush)
$nTmpLeft = $nLeft
$nTmpTop = $nTop
$nTmpRight = $nRight
$nTmpBottom = $nBottom
InflateRect($nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom, -4, -4)
DrawFocusRect($hDC, $nTmpLeft, $nTmpTop, $nTmpRight, $nTmpBottom)
EndIf
SelectObject($hDC, $hOldBrush)
DeleteObject($hBrush)
SetTextColor($hDC, $nClrTxt)
SetBkColor($hDC, $nClrBk)
Return 1
EndFunc ;==>DrawButton
; Some graphic / windows functions
Func CreateSolidBrush($nColor)
Local $hBrush = DllCall("gdi32.dll", "hwnd", "CreateSolidBrush", "int", $nColor)
Return $hBrush[0]
EndFunc ;==>CreateSolidBrush
Func GetSysColor($nIndex)
Local $nColor = DllCall("user32.dll", "int", "GetSysColor", "int", $nIndex)
Return $nColor[0]
EndFunc ;==>GetSysColor
Func GetSysColorBrush($nIndex)
Local $hBrush = DllCall("user32.dll", "hwnd", "GetSysColorBrush", "int", $nIndex)
Return $hBrush[0]
EndFunc ;==>GetSysColorBrush
Func DrawFrameControl($hDC, $nLeft, $nTop, $nRight, $nBottom, $nType, $nState)
Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)
DllCall("user32.dll", "int", "DrawFrameControl", "hwnd", $hDC, "ptr", DllStructGetPtr($stRect), "int", $nType, "int", $nState)
$stRect = 0
EndFunc ;==>DrawFrameControl
Func DrawFocusRect($hDC, $nLeft, $nTop, $nRight, $nBottom)
Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)
DllCall("user32.dll", "int", "DrawFocusRect", "hwnd", $hDC, "ptr", DllStructGetPtr($stRect))
$stRect = 0
EndFunc ;==>DrawFocusRect
Func DrawText($hDC, $sText, $nLeft, $nTop, $nRight, $nBottom, $nFormat)
Local $nLen = StringLen($sText)
Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)
Local $stText = DllStructCreate("char[260]")
DllStructSetData($stText, 1, $sText)
DllCall("user32.dll", "int", "DrawText", "hwnd", $hDC, "ptr", DllStructGetPtr($stText), "int", $nLen, "ptr", DllStructGetPtr($stRect), "int", $nFormat)
$stRect = 0
$stText = 0
EndFunc ;==>DrawText
Func FillRect($hDC, $nLeft, $nTop, $nRight, $nBottom, $hBrush)
Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)
DllCall("user32.dll", "int", "FillRect", "hwnd", $hDC, "ptr", DllStructGetPtr($stRect), "hwnd", $hBrush)
$stRect = 0
EndFunc ;==>FillRect
Func FrameRect($hDC, $nLeft, $nTop, $nRight, $nBottom, $hBrush)
Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)
DllCall("user32.dll", "int", "FrameRect", "hwnd", $hDC, "ptr", DllStructGetPtr($stRect), "hwnd", $hBrush)
$stRect = 0
EndFunc ;==>FrameRect
Func InflateRect(ByRef $nLeft, ByRef $nTop, ByRef $nRight, ByRef $nBottom, $nX, $nY)
Local $stRect = DllStructCreate("int;int;int;int")
DllStructSetData($stRect, 1, $nLeft)
DllStructSetData($stRect, 2, $nTop)
DllStructSetData($stRect, 3, $nRight)
DllStructSetData($stRect, 4, $nBottom)
DllCall("user32.dll", "int", "InflateRect", "ptr", DllStructGetPtr($stRect), "int", $nX, "int", $nY)
$nLeft = DllStructGetData($stRect, 1)
$nTop = DllStructGetData($stRect, 2)
$nRight = DllStructGetData($stRect, 3)
$nBottom = DllStructGetData($stRect, 4)
$stRect = 0
EndFunc ;==>InflateRect
Func SetBkColor($hDC, $nColor)
Local $nOldColor = DllCall("gdi32.dll", "int", "SetBkColor", "hwnd", $hDC, "int", $nColor)
Return $nOldColor[0]
EndFunc ;==>SetBkColor
Func SetTextColor($hDC, $nColor)
Local $nOldColor = DllCall("gdi32.dll", "int", "SetTextColor", "hwnd", $hDC, "int", $nColor)
Return $nOldColor[0]
EndFunc ;==>SetTextColor
Func SelectObject($hDC, $hObj)
Local $hOldObj = DllCall("gdi32.dll", "hwnd", "SelectObject", "hwnd", $hDC, "hwnd", $hObj)
Return $hOldObj[0]
EndFunc ;==>SelectObject
Func DeleteObject($hObj)
DllCall("gdi32.dll", "hwnd", "DeleteObject", "hwnd", $hObj)
EndFunc ;==>DeleteObject
Func GetWindowLong($hWnd, $nIndex)
Local $nVal = DllCall("user32.dll", "int", "GetWindowLong", "hwnd", $hWnd, "int", $nIndex)
Return $nVal[0]
EndFunc ;==>GetWindowLong