Difference between revisions of "API Mouse.GetPosition2D"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API Mouse|Mouse]]
+
====Class hierarchy====
 +
[[API Mouse|Mouse]]
 
:[[API Mouse|GetPosition2D]]
 
:[[API Mouse|GetPosition2D]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==Parameters==
 
==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''
 
:Pixel screen coordinate from the left of the panel area
 
:Pixel screen coordinate from the left of the panel area
  
''[[Variable types|LONG]] Y''
+
[[Variable types|LONG]] ''Y''
 
:''This parameter is returned back to the caller''
 
:''This parameter is returned back to the caller''
 
:Pixel screen coordinate from the top of the panel area
 
:Pixel screen coordinate from the top of the panel area
Line 23: Line 24:
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 29: Line 31:
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetPosition2D(return_x, return_y)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetPosition2D(return_x, return_y)</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:09, 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

HANDLE

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)

No additional information