Changes between Version 3 and Version 4 of HTMLGfx

Timestamp:

Dec 27, 2014, 1:46:39 PM (9 years ago)

Author:

romw

Comment:

Checkpoint

HTMLGfx

@@ -2 +2 @@
 
 == Introduction ==
-HTML and JavaScript have become the predominate rendering technologies on the web.  Used for everything from web browsing to mobile phone applications.  HTMLGfx attempts to bring HTML rendering technologies into the BOINC graphics and screensaver environment.
+HTML and !JavaScript have become the predominate rendering technologies on the web.  Used for everything from web browsing to mobile phone applications.  HTMLGfx attempts to bring HTML rendering technologies into the BOINC graphics and screensaver environment.
 
 By providing precompiled binaries the barrier to entry is greatly reduced allowing projects to deploy customized graphics for their applications. All projects would need to supply is the HTML/CSS/JavaScript required to display something about what is going on with the currently executing job.
@@ -129 +129 @@
     The port, if configured for it, vboxwrapper has assigned to the task for Remote Desktop requests. (RDP)
 
-=== !JavaScript Extension ===
+=== !JavaScript Extension on Windows ===
+Currently HTMLGfx can pass information to the HTML DOM via the 'window.external' extension.
+
+==== Methods ====
+
+|| Name                  || Returns || Description ||
+|| !IsAppInitDataUpdated || Boolean || Informs the HTML document to refresh all the UI state information ||
+|| !IsScreensaver        || Boolean || Was the graphics application launched in screensaver mode    ||
+|| !IsSuspended          || Boolean || Whether the task is currently suspended ||
+|| !IsNetworkSuspended   || Boolean || Should the UI suspend Internet activity ||
+|| !IsExiting            || Boolean || Should the UI prepare to exit ||
+|| !IsVboxwrapperJob     || Boolean || Is this task a vboxwrapper task? ||
+|| !SetAppInitDataUpdate || void    || Sets the Boolean value to the specified input ||
+
+==== Properties ====
+
+|| Name                  || Data Type || Description ||
+|| !ApplicationName      || string    || ||
+|| !ApplicationVersion   || long      || ||
+|| !WorkunitName         || string    || ||
+|| !ResultName           || string    || ||
+|| !TeamName             || string    || ||
+|| !UserName             || string    || ||
+|| !UserCreditTotal      || float     || ||
+|| !UserCreditAverage    || float     || ||
+|| !HostCreditTotal      || float     || ||
+|| !HostCreditAverage    || float     || ||
+|| !ExitCountdown        || float     || ||
+|| !CPUTime              || float     || ||
+|| !ElapsedTime          || float     || ||
+|| !FractionDone         || float     || ||
+|| !RemoteDesktopPort    || long      || ||
+|| !WebAPIPort           || long      || ||
 
 
+==== Examples ====
+
+Example of refreshing the state of various controls:
+{{{
+    refresh() {
+        if (window.external.IsAppInitDataUpdated()) {
+            window.external.SetAppInitDataUpdate(false);
+            username = window.external.UserName;
+            teamname = window.external.TeamName;
+        }
+        fractiondone = window.external.FractionDone;
+    }
+}}}