Difference between revisions of "API Component.GetInteractive"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(19 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | API | + | <sidebar>API Contents</sidebar> |
Gets whether a component can interact with the mouse | Gets whether a component can interact with the mouse | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ====Class hierarchy==== | ||
+ | [[API Component|Component]] | ||
+ | :[[API Component|GetInteractive]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Target'' | |
:The component to read the state from | :The component to read the state from | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
− | |||
− | |||
− | + | ==Return value== | |
+ | [[Variable Types|BOOL]] | ||
− | + | Returns true if the operation is a success, else false | |
− | |||
− | ===Examples | + | |
− | + | ==Detailed description== | |
+ | An interactive component responds to mouse clicks and other user interface events. | ||
+ | |||
+ | If a component is not interactive, it can not be clicked on by the mouse and will be ignored in mouse-click tests. | ||
+ | |||
+ | |||
+ | ==Examples== | ||
+ | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
− | * Add to a calculation icon: result = ::Component.GetInteractive(target) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetInteractive(target)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets whether a component can interact with the mouse
Contents
Parameters
HANDLE Target
- The component to read the state from
- The default value for this parameter is: this
Return value
Returns true if the operation is a success, else false
Detailed description
An interactive component responds to mouse clicks and other user interface events.
If a component is not interactive, it can not be clicked on by the mouse and will be ignored in mouse-click tests.
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Component.GetInteractive(target)
No additional examples