API Mouse.GetPosition2D: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Gets the X/Y position of the mouse in screen coords | Gets the X/Y position of the mouse in screen coords | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Mouse | |||
::GetPosition2D | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|LONG]] X'' | ''[[Variable types|LONG]] X'' | ||
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
| Line 12: | Line 18: | ||
:Pixel screen coordinate from the top of the panel area | :Pixel screen coordinate from the top of the panel area | ||
==Return value== | |||
[[Variable types|HANDLE]] | [[Variable types|HANDLE]] | ||
Returns the X/Y position of the mouse in screen coords | Returns the X/Y position of the mouse in screen coords | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetPosition2D(return_x, return_y)</pre> | ||
Revision as of 16:42, 11 May 2013
<sidebar>API contents</sidebar> Gets the X/Y position of the mouse in screen coords
Class hierarchy
- Mouse
- GetPosition2D
Parameters
LONG X
- This parameter is returned back to the caller
- Pixel screen coordinate from the left of the panel area
LONG Y
- This parameter is returned back to the caller
- Pixel screen coordinate from the top of the panel area
Return value
Returns the X/Y position of the mouse in screen coords
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Mouse.GetPosition2D(return_x, return_y)