API Component.SetInteractive: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetInteractive
Sets whether a component can interact with the mouse
- HANDLE	Target
The component to set the state for
- BOOL	Enabled
True to enable, false to disable
- NONE	Return

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)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets whether a component can interact with the mouse
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''SetInteractive'''
+|-
+| colspan="2" | Sets whether a component can interact with the mouse&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Target
+|-
+| colspan="2" | The component to set the state for&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Enabled
+|-
+| colspan="2" | True to enable, false to disable&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Target''
+An interactive component responds to mouse clicks and other user interface events.
-:The component to set the state for
-:''The default value for this parameter is: '''''this'''
-''[[Variable types|BOOL]] Enabled''
+If a component is not interactive, it can not be clicked on by the mouse and will be ignored in mouse-click tests.
-:True to enable, false to disable
-===Return value===
-''This call does not return a value''
-===Detailed description===
+==Examples==
-''No additional information''
+===Calling in a calculation===
+* Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetInteractive(target, true)</pre>
-===Examples===
-====Calling in a calculation====
-* Add to a calculation icon: <pre class="brush:[C]">::Component.SetInteractive(target, true)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation