Jump to content

API Mouse.GetFocus: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import API changes
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
{| class="mtx-class-macrotable wikitable"
Gets the handle of the component under the mouse
|-
 
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
| width="90%" class="mtx-class-macrohead" | '''GetFocus'''
====Class hierarchy====
|-
[[API Mouse|Mouse]]
| colspan="2" | Gets the handle of the component under the mouse&nbsp;
:[[API Mouse|GetFocus]]
|-
</div>
|-
__TOC__
| 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''
==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 27: 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 14:11, 13 July 2026

GetFocus
Gets the handle of the component under the mouse 
- 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()