OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 /** | 5 /** |
6 * @fileoverview Defines a Braille interface. | 6 * @fileoverview Defines a Braille interface. |
7 * | 7 * |
8 * All Braille engines in ChromeVox conform to this interface. | 8 * All Braille engines in ChromeVox conform to this interface. |
9 * | 9 * |
10 */ | 10 */ |
11 | 11 |
12 goog.provide('cvox.BrailleInterface'); | 12 goog.provide('cvox.BrailleInterface'); |
13 | 13 |
14 goog.require('cvox.BrailleKeyCommand'); | 14 goog.require('cvox.BrailleKeyCommand'); |
15 goog.require('cvox.BrailleKeyEvent'); | 15 goog.require('cvox.BrailleKeyEvent'); |
16 goog.require('cvox.NavBraille'); | 16 goog.require('cvox.NavBraille'); |
17 | 17 |
18 /** | 18 /** |
19 * @interface | 19 * @interface |
20 */ | 20 */ |
21 cvox.BrailleInterface = function() { }; | 21 cvox.BrailleInterface = function() {}; |
22 | 22 |
23 /** | 23 /** |
24 * Sends the given params to the Braille display for output. | 24 * Sends the given params to the Braille display for output. |
25 * @param {!cvox.NavBraille} params Parameters to send to the | 25 * @param {!cvox.NavBraille} params Parameters to send to the |
26 * platform braille service. | 26 * platform braille service. |
27 */ | 27 */ |
28 cvox.BrailleInterface.prototype.write = | 28 cvox.BrailleInterface.prototype.write = function(params) {}; |
29 function(params) { }; | |
30 | 29 |
31 /** | 30 /** |
32 * Takes an image in the form of a data url and outputs it to a Braille | 31 * Takes an image in the form of a data url and outputs it to a Braille |
33 * display. | 32 * display. |
34 * @param {!string} imageDataUrl The image to output, in the form of a | 33 * @param {!string} imageDataUrl The image to output, in the form of a |
35 * dataUrl. | 34 * dataUrl. |
36 */ | 35 */ |
37 cvox.BrailleInterface.prototype.writeRawImage = | 36 cvox.BrailleInterface.prototype.writeRawImage = function(imageDataUrl) {}; |
38 function(imageDataUrl) { }; | |
39 | 37 |
40 /** | 38 /** |
41 * Freeze whatever is on the braille display until the next call to thaw(). | 39 * Freeze whatever is on the braille display until the next call to thaw(). |
42 */ | 40 */ |
43 cvox.BrailleInterface.prototype.freeze = function() { }; | 41 cvox.BrailleInterface.prototype.freeze = function() {}; |
44 | 42 |
45 | 43 |
46 /** | 44 /** |
47 * Un-freeze the braille display so that it can be written to again. | 45 * Un-freeze the braille display so that it can be written to again. |
48 */ | 46 */ |
49 cvox.BrailleInterface.prototype.thaw = function() { }; | 47 cvox.BrailleInterface.prototype.thaw = function() {}; |
50 | 48 |
51 | 49 |
52 /** | 50 /** |
53 * @return {!cvox.BrailleDisplayState} The current display state. | 51 * @return {!cvox.BrailleDisplayState} The current display state. |
54 */ | 52 */ |
55 cvox.BrailleInterface.prototype.getDisplayState = function() { }; | 53 cvox.BrailleInterface.prototype.getDisplayState = function() {}; |
OLD | NEW |