Difference between revisions of "API Mouse.GetFocus"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets the handle of the component under the mouse
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFocus'''
 +
|-
 +
| colspan="2" | Gets the handle of the component under the mouse&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
<div style="width:25%; float:right" class="toc">
 
====Class hierarchy====
 
[[API Mouse|Mouse]]
 
:[[API Mouse|GetFocus]]
 
</div>
 
__TOC__
 
 
==Parameters==
 
''This function has no parameters''
 
 
==Return value==
 
[[Variable types|HANDLE]]
 
 
Returns the handle of the component under the mouse
 
  
 
==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 25: Line 20:
 
* 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.GetFocus()</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetFocus()</pre>
 
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png GetFocus
Gets the handle of the component under the mouse 
Fc9-h32-icon.png - HANDLE Return


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()