Difference between revisions of "API Component.SetInteractive"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
(13 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
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== | |
− | + | [[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'' | |
:True to enable, false to disable | :True to enable, false to disable | ||
− | + | ||
+ | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | An interactive component responds to mouse clicks and other user interface events. | |
− | * Add to a calculation icon: <pre class="brush:[ | + | |
+ | 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
Contents
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