Difference between revisions of "API Mouse.GetFocus"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets the handle of the component under the mouse | Gets the handle of the component under the mouse | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Mouse|Mouse]] | ||
| + | :[[API Mouse|GetFocus]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''This function has no parameters'' | ''This function has no parameters'' | ||
| − | + | ||
| − | [[Variable | + | ==Return value== |
| + | [[Variable Types|HANDLE]] | ||
Returns the handle of the component under the mouse | Returns the handle of the component under the mouse | ||
| − | |||
| − | |||
| − | ===Examples | + | ==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> |
| + | |||
| + | ''<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
Contents
Parameters
This function has no parameters
Return value
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
