Difference between revisions of "API Mouse.GetFocus"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets the handle of the component under the mouse
 
Gets the handle of the component under the mouse
  
Line 20: Line 20:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
The returned object is the component that would be the focus of a [[Event Mouse.Click|Mouse.Click]] event given the current mouse position. This will be 0 if no valid object is under the mouse.
  
  
Line 28: Line 28:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetFocus()</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetFocus()</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the handle of the component under the mouse

Class hierarchy

Mouse

GetFocus

Parameters

This function has no parameters


Return value

HANDLE

Returns the handle of the component under the mouse


Detailed description

The returned object is the component that would be the focus of a Mouse.Click event given the current mouse position. This will be 0 if no valid object is under the mouse.


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Mouse.GetFocus()

No additional examples