ctrlSetEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed example)
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(65 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Sets given event handler of given control.
|game3= arma2oa
|version3= 1.50


The provided function should return true/false indicating that the event has handled this event fully or not and whether the engine should execute it's default code or not afterwards.  
|game4= tkoh
|version4= 1.00


See [[User_Interface_Event_Handlers|User Interface Event Handlers]] for the full list of handler names.
|game5= arma3
|version5= 0.50


If applicable, see [[DIK_KeyCodes]] for a list of key code constants, which are relevant to key related user interface events like: [[User_Interface_Event_Handlers#onKeyDown|KeyDown]] & [[User_Interface_Event_Handlers#onKeyUp|KeyUp]]. |= Description
|gr1= GUI Control - Event Handlers
____________________________________________________________________________________________
|gr2= Event Handlers


| [[Control]] '''ctrlSetEventHandler''' ["handler name", "function"] |= Syntax
|descr= {{Feature|obsolete|Use [[ctrlAddEventHandler]] instead as it can stack event handlers.|arma2|1.00}}
Sets given event handler of given control: any previously added event handler is removed.


|p1= [[Control]] |= Parameter 1
{{Feature|informative|
* See [[User Interface Event Handlers]] for the full list of handler names
* See also [[DIK KeyCodes]] for a list of key code constants relevant to key-related events like [[User_Interface_Event_Handlers#onKeyDown|KeyDown]] and [[User_Interface_Event_Handlers#onKeyUp|KeyUp]]
}}


|p2= handler name: [[String]] |= Parameter 2
{{Feature|important|When using the event names listed [[User Interface Event Handlers|here]] with the [[ctrlAddEventHandler]], [[ctrlSetEventHandler]], [[displayAddEventHandler]] or [[displaySetEventHandler]] commands, the prefix "on" in the event name must be removed (e.g. ''''ButtonDown'''' instead of ''''onButtonDown'''').}}
|p3= function: [[String]]|= Parameter 2
| [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <pre>_control ctrlSetEventHandler ["KeyDown", ""]</pre> |= Example 1


|x2= <pre>(_display displayCtrl 108) ctrlSetEventHandler ["LBSelChanged","['ListChange',_this] call FireEvents"];</pre> |= Example 2 (using call)
|s1= controlName [[ctrlSetEventHandler]] [handlerName, function]


|p1= controlName: [[Control]]


____________________________________________________________________________________________
|p2= handlerName: [[String]]


| [[displaySetEventHandler]], [[User_Interface_Event_Handlers|UI Event Handlers]], [[DIK_KeyCodes|DIK KeyCodes]] |= See also
|p3= function: [[String]] - should return a [[Boolean]] indicating that the event has handled this event fully or not and whether the engine should execute its default code or not afterwards


}}
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>_control ctrlSetEventHandler ["KeyDown", ""];</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
The article [[User Interface Event Handlers]] contains a list of event handler names.<br>
Be aware though, that the preceding "on" in the listed names must be eliminated when used with the ctrlSetEventHandler command.


e.g. instead of <code> _control ctrlSetEventHandler ["'''OnLBSelChanged'''", ""]; // '''''WRONG'''''</code>
|x2= <sqf>(_display displayCtrl 108) ctrlSetEventHandler ["LBSelChanged","['ListChange',_this] call FireEvents"];</sqf>
use
<code> _control ctrlSetEventHandler ["'''LBSelChanged'''", ""]; // '''''RIGHT''''' </code>
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[displaySetEventHandler]] [[ctrlAddEventHandler]] [[ctrlRemoveEventHandler]] [[User_Interface_Event_Handlers|UI Event Handlers]] [[DIK KeyCodes]]
}}


[[Category:Scripting Commands|CTRLSETEVENTHANDLER]]
{{Note
[[Category:Scripting Commands ArmA|CTRLSETEVENTHANDLER]]
|user= pierremgi
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
|timestamp= 20210428195900
|text= This command doesn't work on map.
<sqf>
waitUntil { !isNull (findDisplay 12 displayCtrl 51) };
(findDisplay 12 displayCtrl 51) ctrlSetEventHandler ["MouseButtonDblClick", "hint str _this; true"]; // doesn't skip the marker dialog as it should.
</sqf>
}}

Latest revision as of 19:43, 3 September 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
🕖
This information is obsolete as of Arma 2 v1.00. Reason: Use ctrlAddEventHandler instead as it can stack event handlers.

Sets given event handler of given control: any previously added event handler is removed.

ⓘ
⚠
When using the event names listed here with the ctrlAddEventHandler, ctrlSetEventHandler, displayAddEventHandler or displaySetEventHandler commands, the prefix "on" in the event name must be removed (e.g. 'ButtonDown' instead of 'onButtonDown').
Groups:
GUI Control - Event HandlersEvent Handlers

Syntax

Syntax:
controlName ctrlSetEventHandler [handlerName, function]
Parameters:
controlName: Control
handlerName: String
function: String - should return a Boolean indicating that the event has handled this event fully or not and whether the engine should execute its default code or not afterwards
Return Value:
Nothing

Examples

Example 1:
_control ctrlSetEventHandler ["KeyDown", ""];
Example 2:
(_display displayCtrl 108) ctrlSetEventHandler ["LBSelChanged","['ListChange',_this] call FireEvents"];

Additional Information

See also:
displaySetEventHandler ctrlAddEventHandler ctrlRemoveEventHandler UI Event Handlers DIK KeyCodes

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
pierremgi - c
Posted on Apr 28, 2021 - 19:59 (UTC)
This command doesn't work on map.
waitUntil { !isNull (findDisplay 12 displayCtrl 51) }; (findDisplay 12 displayCtrl 51) ctrlSetEventHandler ["MouseButtonDblClick", "hint str _this; true"]; // doesn't skip the marker dialog as it should.
Retrieved from "https://community.bistudio.com/wiki?title=ctrlSetEventHandler&oldid=369343"