Difference between revisions of "API Component.GetInteractive"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import of updated API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
Gets whether a component can interact with the mouse
 
Gets whether a component can interact with the mouse
Line 32: Line 34:
 
* 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 information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Gets whether a component can interact with the mouse

Class hierarchy

Component

GetInteractive

Parameters

HANDLE Target

The component to read the state from
The default value for this parameter is: this


Return value

BOOL

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