MD Settings: Display: Add unified desktop control and modify api

third_party/closure_compiler/interfaces/system_display_interface.js

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This file was generated by:
 //   ./tools/json_schema_compiler/compiler.py.
 
 // This was modified to replace System.display with SystemDisplay.
 
 /** @fileoverview Interface for system.display that can be overriden. */
 
 assertNotReached('Interface file for Closure Compiler should not be executed.');
 
 /** @interface */
 function SystemDisplay() {}
 
 SystemDisplay.prototype = {
   /**
    * Get the information of all attached display devices.
    * @param {function(!Array<!chrome.system.display.DisplayUnitInfo>):void}
    *     callback
    * @see https://developer.chrome.com/extensions/system.display#method-getInfo
    */
   getInfo: assertNotReached,
 
   /**
+   * Get the layout info for all displays. NOTE: This is only available to
+   * Chrome OS Kiosk apps and Web UI.
+   * @param {function(!Array<!chrome.system.display.DisplayLayout>):void}
+   *     callback
+   * @see https://developer.chrome.com/extensions/system.display#method-getDisplayLayout
+   */
+  getDisplayLayout: assertNotReached,
+
+  /**
    * Updates the properties for the display specified by |id|, according to the
    * information provided in |info|. On failure, $(ref:runtime.lastError) will
    * be set. NOTE: This is only available to Chrome OS Kiosk apps and Web UI.
    * @param {string} id The display's unique identifier.
    * @param {!chrome.system.display.DisplayProperties} info The information
    *     about display properties that should be changed.     A property will be
    *     changed only if a new value for it is specified in     |info|.
    * @param {function():void=} callback Empty function called when the function
    *     finishes. To find out     whether the function succeeded,
    *     $(ref:runtime.lastError) should be     queried.
    * @see https://developer.chrome.com/extensions/system.display#method-setDisplayProperties
    */
   setDisplayProperties: assertNotReached,
 
   /**
    * Set the layout for all displays. Any display not included will use the
    * default layout. If a layout would overlap or be otherwise invalid it will
    * be adjusted to a valid layout. After layout is resolved, an
-   * onDisplayChanged event will be triggered.
-   * @param {!Array<!chrome.system.display.DisplayLayout>} layouts
+   * onDisplayChanged event will be triggered. NOTE: This is only available to
+   * Chrome OS Kiosk apps and Web UI.
+   * @param {!Array<!chrome.system.display.DisplayLayout>} layouts The layout
+   *     information, required for all displays except     the primary display.
+   * @param {function():void=} callback Empty function called when the function
+   *     finishes. To find out     whether the function succeeded,
+   *     $(ref:runtime.lastError) should be     queried.

[xiyuan, 2017/04/05 21:41:45]

nit: fix the extra spaces ?

[stevenjb, 2017/04/06 01:56:09]

ditto

    * @see https://developer.chrome.com/extensions/system.display#method-setDisplayLayout
    */
   setDisplayLayout: assertNotReached,
 
   /**
    * Enables/disables the unified desktop feature. Note that this simply enables
    * the feature, but will not change the actual desktop mode. (That is, if the
    * desktop is in mirror mode, it will stay in mirror mode) NOTE: This is only
    * available to Chrome OS Kiosk apps and Web UI.
    * @param {boolean} enabled True if unified desktop should be enabled.
@@ skipping 32 matching lines @@
 
   /**
    * Complete overscan adjustments for a display  by saving the current values
    * and hiding the overlay.
    * @param {string} id The display's unique identifier.
    * @see https://developer.chrome.com/extensions/system.display#method-overscanCalibrationComplete
    */
   overscanCalibrationComplete: assertNotReached,
 
   /**
-   * Starts native touch calibration for a display. This will show an overlay on
-   * the screen and initialize the UX for touch calibration. If another native
-   * touch calibration is already in progress this will throw an error.
+   * Displays the native touch calibration UX for the display with |id| as
+   * display id. This will show an overlay on the screen with required
+   * instructions on how to proceed. The callback will be invoked in case of
+   * successful calibraion only. If the calibration fails, this will throw an
+   * error.
    * @param {string} id The display's unique identifier.
+   * @param {function(boolean):void=} callback Optional callback to inform the
+   *     caller that the touch      calibration has ended. The argument of the
+   *     callback informs if the      calibration was a success or not.

[xiyuan, 2017/04/05 21:41:45]

nit: fix extra spaces ?

[stevenjb, 2017/04/06 01:56:09]

ditto

    * @see https://developer.chrome.com/extensions/system.display#method-showNativeTouchCalibration
    */
   showNativeTouchCalibration: assertNotReached,
 
   /**
    * Starts custom touch calibration for a display. This should be called when
    * using a custom UX for collecting calibration data. If another touch
    * calibration is already in progress this will throw an error.
    * @param {string} id The display's unique identifier.
    * @see https://developer.chrome.com/extensions/system.display#method-startCustomTouchCalibration
    */
   startCustomTouchCalibration: assertNotReached,
 
   /**
    * Sets the touch calibration pairs for a display. These |pairs| would be used
    * to calibrate the touch screen for display with |id| called in
    * startCustomTouchCalibration(). Always call |startCustomTouchCalibration|
    * before calling this method. If another touch calibration is already in
    * progress this will throw an error.
    * @param {!chrome.system.display.TouchCalibrationPairQuad} pairs The pairs of
    *     point used to calibrate the display.
    * @param {!chrome.system.display.Bounds} bounds Bounds of the display when
    *     the touch calibration was performed.     |bounds.left| and |bounds.top|
    *     values are ignored.
    * @see https://developer.chrome.com/extensions/system.display#method-completeCustomTouchCalibration
    */
   completeCustomTouchCalibration: assertNotReached,
 
   /**
-   * Resets the touch calibration for the display and removes the saved
-   * calibration data.
+   * Resets the touch calibration for the display and brings it back to its
+   * default state by clearing any touch calibration data associated with the
+   * display.
    * @param {string} id The display's unique identifier.
    * @see https://developer.chrome.com/extensions/system.display#method-clearTouchCalibration
    */
   clearTouchCalibration: assertNotReached,
 };
 
 /**
  * Fired when anything changes to the display configuration.
  * @type {!ChromeEvent}
  * @see https://developer.chrome.com/extensions/system.display#event-onDisplayChanged
  */
 SystemDisplay.prototype.onDisplayChanged;