API Mouse.GetFocus: Difference between revisions

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

@@ 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]]
+| width="90%" class="mtx-class-macrohead" | '''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''
+|}
-===Parameters===
+==Detailed description==
-''This function has no parameters''
+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.
-===Return value===
-[[Variable types|HANDLE]]
-Returns the handle of the component under the mouse
+==Examples==
+===Calling in a calculation===
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type HANDLE
-* Add to a calculation icon: result = ::Mouse.GetFocus()
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Mouse.GetFocus()</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation