Difference between revisions of "API Component.SetInteractive"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The start line of the article
+
<sidebar>API Contents</sidebar>
==ComponentSetInteractive==
+
Sets whether a component can interact with the mouse
  
Sets whether a component can interact with the mouse
+
<div style="width:25%; float:right" class="toc">
----
+
====Class hierarchy====
 +
[[API Component|Component]]
 +
:[[API Component|SetInteractive]]
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
''[[Variable types|HANDLE]] Target''
+
[[Variable Types|HANDLE]] ''Target''
 
:The component to set the state for
 
:The component to set the state for
 
:''The default value for this parameter is: '''''this'''
 
:''The default value for this parameter is: '''''this'''
  
''[[Variable types|BOOL]] Enabled''
+
[[Variable Types|BOOL]] ''Enabled''
 
:True to enable, false to disable
 
:True to enable, false to disable
  
===Return value===
+
 
 +
==Return value==
 
''This call does not return a value''
 
''This call does not return a value''
  
===Detailed description===
 
''No additional information''
 
  
===Examples===
+
==Detailed description==
====Calling in a calculation:====
+
An interactive component responds to mouse clicks and other user interface events.
* Add to a calculation icon: ::Component.SetInteractive(target, true)
+
 
 +
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===
 +
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetInteractive(target, true)</pre>
 +
 
 +
''<span style="color:red;">No additional examples</span>''

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Sets whether a component can interact with the mouse

Class hierarchy

Component

SetInteractive

Parameters

HANDLE Target

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

BOOL Enabled

True to enable, false to disable


Return value

This call does not return a value


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

  • Add to a calculation icon:
    ::Component.SetInteractive(target, true)

No additional examples