Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id E4F55200CCB for ; Thu, 6 Jul 2017 04:29:14 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id E3AFE16513D; Thu, 6 Jul 2017 02:29:14 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id DABF416513A for ; Thu, 6 Jul 2017 04:29:12 +0200 (CEST) Received: (qmail 58132 invoked by uid 500); 6 Jul 2017 02:29:11 -0000 Mailing-List: contact commits-help@guacamole.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@guacamole.incubator.apache.org Delivered-To: mailing list commits@guacamole.incubator.apache.org Received: (qmail 58072 invoked by uid 99); 6 Jul 2017 02:29:11 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Jul 2017 02:29:11 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 195BFC13AF for ; Thu, 6 Jul 2017 02:29:11 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.031 X-Spam-Level: X-Spam-Status: No, score=-3.031 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LINEPADDING=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id llIUwP3daub3 for ; Thu, 6 Jul 2017 02:29:08 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id 5536460EC3 for ; Thu, 6 Jul 2017 02:28:55 +0000 (UTC) Received: (qmail 57252 invoked by uid 99); 6 Jul 2017 02:28:51 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 06 Jul 2017 02:28:51 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 0E13DF321E; Thu, 6 Jul 2017 02:28:51 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: mjumper@apache.org To: commits@guacamole.incubator.apache.org Date: Thu, 06 Jul 2017 02:29:30 -0000 Message-Id: In-Reply-To: <86647479316447b1847ab81c7721b5e8@git.apache.org> References: <86647479316447b1847ab81c7721b5e8@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [41/51] [partial] incubator-guacamole-website git commit: Deploy draft documentation for 0.9.13-incubating. archived-at: Thu, 06 Jul 2017 02:29:15 -0000 http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/eff0fb8d/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Keyboard.ModifierState.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Keyboard.ModifierState.html b/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Keyboard.ModifierState.html new file mode 100644 index 0000000..701a384 --- /dev/null +++ b/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Keyboard.ModifierState.html @@ -0,0 +1,695 @@ + + + + + JSDoc: Class: ModifierState + + + + + + + + + + +
+ +

Class: ModifierState

+ + + + + + +
+ +
+ +

+ Guacamole.Keyboard.ModifierState

+ + +
+ +
+
+ + + + + +

new ModifierState()

+ + + + + +
+ The state of all supported keyboard modifiers. +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +

Members

+ + + +

alt :Boolean

+ + + + +
+ Whether alt is currently pressed. +
+ + + +
Type:
+
    +
  • + +Boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

ctrl :Boolean

+ + + + +
+ Whether ctrl is currently pressed. +
+ + + +
Type:
+
    +
  • + +Boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

hyper :Boolean

+ + + + +
+ Whether hyper (windows key) is currently pressed. +
+ + + +
Type:
+
    +
  • + +Boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

meta :Boolean

+ + + + +
+ Whether meta (apple key) is currently pressed. +
+ + + +
Type:
+
    +
  • + +Boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

shift :Boolean

+ + + + +
+ Whether shift is currently pressed. +
+ + + +
Type:
+
    +
  • + +Boolean + + +
    • +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + +

(static) fromKeyboardEvent(e) → {Guacamole.Keyboard.ModifierState}

+ + + + + +
+ Returns the modifier state applicable to the keyboard event given. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
e + + +KeyboardEvent + + + + The keyboard event to read.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ The current state of keyboard + modifiers. +
+ + + +
+
+ Type +
+
+ +Guacamole.Keyboard.ModifierState + + +
+
+ + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sun Jul 02 2017 12:09:53 GMT-0700 (PDT) +
+ + + + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/eff0fb8d/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Keyboard.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Keyboard.html b/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Keyboard.html new file mode 100644 index 0000000..1784435 --- /dev/null +++ b/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Keyboard.html @@ -0,0 +1,1181 @@ + + + + + JSDoc: Class: Keyboard + + + + + + + + + + +
+ +

Class: Keyboard

+ + + + + + +
+ +
+ +

+ Guacamole.Keyboard

+ + +
+ +
+
+ + + + + +

new Keyboard(element)

+ + + + + +
+ Provides cross-browser and cross-keyboard keyboard for a specific element. +Browser and keyboard layout variation is abstracted away, providing events +which represent keys as their corresponding X11 keysym. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
element + + +Element + + + + The Element to use to provide keyboard events.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + +

Classes

+ +
+
ModifierState
+
+
+ + + + + + + +

Members

+ + + +

modifiers

+ + + + +
+ All modifiers and their states. +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

pressed

+ + + + +
+ The state of every key, indexed by keysym. If a particular key is +pressed, the value of pressed for that keysym will be true. If a key +is not currently pressed, it will not be defined. +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + +

Methods

+ + + + + + +

press(keysym) → {Boolean}

+ + + + + +
+ Marks a key as pressed, firing the keydown event if registered. Key +repeat for the pressed key will start after a delay if that key is +not a modifier. The return value of this function depends on the +return value of the keydown event handler, if any. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
keysym + + +Number + + + + The keysym of the key to press.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ true if event should NOT be canceled, false otherwise. +
+ + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + +

release(keysym)

+ + + + + +
+ Marks a key as released, firing the keyup event if registered. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
keysym + + +Number + + + + The keysym of the key to release.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

reset()

+ + + + + +
+ Resets the state of this keyboard, releasing all keys, and firing keyup +events for each released key. +
+ + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + +

(inner) isPrintable(keysym) → {Boolean}

+ + + + + +
+ Returns true if the given keysym corresponds to a printable character, +false otherwise. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
keysym + + +Number + + + + The keysym to check.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ true if the given keysym corresponds to a printable character, + false otherwise. +
+ + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + + +

Events

+ + + + + + +

onkeydown

+ + + + + +
+ Fired whenever the user presses a key with the element associated +with this Guacamole.Keyboard in focus. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
keysym + + +Number + + + + The keysym of the key being pressed.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + +
Returns:
+ + +
+ true if the key event should be allowed through to the + browser, false otherwise. +
+ + + +
+
+ Type +
+
+ +Boolean + + +
+
+ + + + + + + + + + +

onkeyup

+ + + + + +
+ Fired whenever the user releases a key with the element associated +with this Guacamole.Keyboard in focus. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
keysym + + +Number + + + + The keysym of the key being released.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sun Jul 02 2017 12:09:53 GMT-0700 (PDT) +
+ + + + + + + \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/eff0fb8d/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Layer.Pixel.html ---------------------------------------------------------------------- diff --git a/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Layer.Pixel.html b/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Layer.Pixel.html new file mode 100644 index 0000000..7086d04 --- /dev/null +++ b/content/doc/0.9.13-incubating/guacamole-common-js/Guacamole.Layer.Pixel.html @@ -0,0 +1,548 @@ + + + + + JSDoc: Class: Pixel + + + + + + + + + + +
+ +

Class: Pixel

+ + + + + + +
+ +
+ +

+ Guacamole.Layer.Pixel

+ + +
+ +
+
+ + + + + +

new Pixel(r, g, b, a)

+ + + + + +
+ Represents a single pixel of image data. All components have a minimum value +of 0 and a maximum value of 255. +
+ + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
r + + +Number + + + + The red component of this pixel.
g + + +Number + + + + The green component of this pixel.
b + + +Number + + + + The blue component of this pixel.
a + + +Number + + + + The alpha component of this pixel.
+ + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +

Members

+ + + +

alpha

+ + + + +
+ The alpha component of this pixel, where 0 is the minimum value, +and 255 is the maximum. +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

blue

+ + + + +
+ The blue component of this pixel, where 0 is the minimum value, +and 255 is the maximum. +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

green

+ + + + +
+ The green component of this pixel, where 0 is the minimum value, +and 255 is the maximum. +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + +

red

+ + + + +
+ The red component of this pixel, where 0 is the minimum value, +and 255 is the maximum. +
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ + + + + + + +
+ + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ +
+ Documentation generated by JSDoc 3.4.0 on Sun Jul 02 2017 12:09:54 GMT-0700 (PDT) +
+ + + + + + + \ No newline at end of file