Difference between revisions of "API Mouse.GetFocus"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
|||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| 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 | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | == | + | ==Detailed description== |
| − | + | 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. | |
| − | |||
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* Declare a variable 'result' of type HANDLE | * 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> |
Latest revision as of 11:55, 16 January 2023
|
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()
