CT WEBBROWSER: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 4: Line 4:
|value = 106
|value = 106
|description =
|description =
{{Feature|warning|This is a experimental feature currently available for testing on Development-Branch. It is not yet decided whether this will become available in Stable branch.}}
{{Feature|warning|This is a experimental feature currently available for testing on Development-Branch. It is not yet decided whether this will become available in Stable branch. Please provide Feedback on the {{Link|https://discord.gg/arma|{{arma}} Discord}}'s #dev_rc_branch channel.}}
WebBrowser control features an embedded Chromium window.<br>
WebBrowser control features an embedded Chromium window.<br>
The URL is subject to {{hl|allowedHTMLLoadURIs[]}} whitelisting in [[CfgCommands]] config.<br>
The URL is subject to {{hl|allowedHTMLLoadURIs[]}} whitelisting in [[CfgCommands]] config.<br>

Revision as of 13:58, 21 August 2024

Introduction

This is a experimental feature currently available for testing on Development-Branch. It is not yet decided whether this will become available in Stable branch. Please provide Feedback on the Arma Discord's #dev_rc_branch channel.

WebBrowser control features an embedded Chromium window.
The URL is subject to allowedHTMLLoadURIs[] whitelisting in CfgCommands config.
ctrlSetURL Can be used to change the URL after creation of the control.


Related commands & functions

Related User Interface Eventhandlers

Alphabetical Order

TokenNames common to most controls, such as x, y, w, h, text, idc... can be found here.
Not all of the listed attributes might have an effect nor might the list be complete. All attributes were gathered with this config crawler.
#define CT_WEBBROWSER 106



U

url

Type
String
Description
URL to be opened
url = "https://arma3.com";



Scripting

ctrlWebBrowserAction

Warning: Display title "CT WEBBROWSER" overrides earlier display title "CT_WEBBROWSER".
-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 2.20|2.20]]
Hover & click on the images for description

Description

Description:
Executes an action on a WebBrowser control. The type of parameters depends on the action type. Possible Actions are:
Action Parameter Result Description
OpenDevConsole None Nothing Opens a Chrome Developer console for this browser, in a external window.
ExecJS String Nothing Executes Javascript code inside the currently loaded page.
JSResponse Boolean Nothing Respond to a Javascript alert() or confirm(), after triggered by "JSDialog" Eventhandler
OpenDataAsURL String Nothing Displays provided data in browser. This can be used to load HTML from a file and display it in the Browser window.
Groups:
GUI Control

Syntax

Syntax:
control ctrlWebBrowserAction [Action, ...]
Parameters:
control: Control
Action: String
Return Value:
Nothing

Examples

Example 1:
_control ctrlWebBrowserAction ["OpenDataAsURL", loadFile "example.html"];

Additional Information

See also:
ctrlURL menuSetURL

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

[[Category:Introduced with arma3dev version 2.20]][[ Category: arma3dev: New Scripting Commands | CT WEBBROWSER]][[ Category: arma3dev: Scripting Commands | CT WEBBROWSER]]


Control EventHandler

This eventhandler can only be added to WebBrowser controls


JSDialog

  • Use on: Control (CT_WEBBROWSER)
  • Fired on: Fires when Javascript triggers a alert() or confirm() dialog.
  • Returns: Display or control, for controls it also returns the control's config (since Arma 3 logo black.png1.56).

params ["_control", "_isConfirmDialog", "_message"];
The code handling this event can return a Boolean true/false. Which will stop the next Eventhandlers from being triggered, and will be interpreted as a reply to the dialog.
If the code does not immediately provide a reply, it should return Nothing.
If the code does not return bool, then the script must call ctrlWebBrowserAction with the "JSDialog" action to reply to the dialog, the WebBrowser will be unresponsive until a reply has been sent.


Default Classes

Arma 3
AddOns: Classes need to be initialised first with class SomeClass;

Missions: Since Arma 3 v2.02 one can use import SomeClass; to initialise a class (see the import keyword).

In older versions, use "Default" call BIS_fnc_exportGUIBaseClasses; and paste the result into the description.ext.


RscWebBrowser

Baseline RscExtension example

class RscExtension
{
	type = CT_WEBBROWSER; // 106
	idc = -1;
	deletable = 0;
	style = 0;
	x = 0;
	y = 0;
	w = 0.3;
	h = 0.3;
	url= "https://arma3.com";
};