Difference between revisions of "API Mouse.GetPosition2D"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 10: Line 10:
  
 
==Parameters==
 
==Parameters==
[[Variable types|LONG]] ''X''
+
[[Variable Types|LONG]] ''X''
 
:Pixel screen coordinate from the left of the panel area
 
:Pixel screen coordinate from the left of the panel area
 
:''This parameter is returned back to the caller''
 
:''This parameter is returned back to the caller''
  
[[Variable types|LONG]] ''Y''
+
[[Variable Types|LONG]] ''Y''
 
:Pixel screen coordinate from the top of the panel area
 
:Pixel screen coordinate from the top of the panel area
 
:''This parameter is returned back to the caller''
 
:''This parameter is returned back to the caller''
Line 20: Line 20:
  
 
==Return value==
 
==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

Revision as of 11:09, 10 June 2013

<sidebar>API contents</sidebar> Gets the X/Y position of the mouse in screen coords

Class hierarchy

Mouse

GetPosition2D

Parameters

LONG X

Pixel screen coordinate from the left of the panel area
This parameter is returned back to the caller

LONG Y

Pixel screen coordinate from the top of the panel area
This parameter is returned back to the caller


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