Difference between revisions of "API Component.GetInteractive"
From Flowcode Help
Jump to navigationJump to search (XML import API changes) |
(XML import) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets whether a component can interact with the mouse | Gets whether a component can interact with the mouse | ||
Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
− | [[Variable | + | [[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''' | ||
Line 16: | Line 16: | ||
==Return value== | ==Return value== | ||
− | [[Variable | + | [[Variable Types|BOOL]] |
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
Line 22: | Line 22: | ||
==Detailed description== | ==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. | ||
Line 30: | Line 32: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetInteractive(target)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetInteractive(target)</pre> | ||
− | ''<span style="color:red;">No additional | + | ''<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