WebAPI/KeboardIME - Revision history

Timdream: Remove the IDL draft

2014-11-03T03:35:50Z

Remove the IDL draft

Timdream: /* Proposed API */ link to WebIDL

2014-11-01T05:43:03Z

Proposed API: link to WebIDL

← Older revision		Revision as of 05:43, 1 November 2014
Line 233:		Line 233:

	== Proposed API ==		== Proposed API ==

			'''The API has made available to privileged apps. See the [http://dxr.mozilla.org/mozilla-central/source/dom/webidl/InputMethod.webidl WebIDL] for the current interface.'''

	The input method API is available to web content who intend to implement an input method, or "input source", or "virtual keyboard".		The input method API is available to web content who intend to implement an input method, or "input source", or "virtual keyboard".

Chaasof at 23:53, 1 October 2014

2014-10-01T23:53:40Z

← Older revision		Revision as of 23:53, 1 October 2014
Line 500:		Line 500:

	http://developer.chrome.com/trunk/extensions/input.ime.html		http://developer.chrome.com/trunk/extensions/input.ime.html

			[[Category:Web APIs]]

Raniere: /* Use cases for each of the methods */

2014-06-16T14:09:23Z

Use cases for each of the methods

← Older revision		Revision as of 14:09, 16 June 2014
Line 426:		Line 426:

	* For a simple virtual keyboard action (send a character and key events w/ each user action), use <code>sendKey()</code>. TODO: should we allow backspace key to be sent from the method? If not, how do send these non-printable characters and it's effect with key events?		* For a simple virtual keyboard action (send a character and key events w/ each user action), use <code>sendKey()</code>. TODO: should we allow backspace key to be sent from the method? If not, how do send these non-printable characters and it's effect with key events?
	*[yxl] I perfer to allowing non-printable character, such as backspace key, to be sent, if there is no security issue. This		**[yxl] I perfer to allowing non-printable character, such as backspace key, to be sent, if there is no security issue. This would give the IME more flexibility.
	* would give the IME more flexibility.
	* For spellcheck, autocomplete etc, use surrounding text methods.		* For spellcheck, autocomplete etc, use surrounding text methods.
	* For cursor moment helper features, use <code>setSelectionRange()</code> and related attributes.		* For cursor moment helper features, use <code>setSelectionRange()</code> and related attributes.

Raniere: /* Features */

2014-06-16T14:02:03Z

Features

← Older revision		Revision as of 14:02, 16 June 2014
Line 26:		Line 26:
	The Virtual Keyboard/IME API supports the following features:		The Virtual Keyboard/IME API supports the following features:

	* Notifies the VKB app when the focus text field was changing in other		* Notifies the VKB app when the focus text field was changing in other apps
	apps
	* Allow user to manual hide the keyboard. Check {{bug\|737110}}.		* Allow user to manual hide the keyboard. Check {{bug\|737110}}.
	* The VKB app should be responsive to properties and the state of the input field (more than HTML5 input type, including current content, cursor position, x-inputmode {{bug\|796544}}).		* The VKB app should be responsive to properties and the state of the input field (more than HTML5 input type, including current content, cursor position, x-inputmode {{bug\|796544}}).

Yuanxulei: rename entry_points to inputs

2014-05-05T10:49:24Z

rename entry_points to inputs

← Older revision		Revision as of 10:49, 5 May 2014
Line 43:		Line 43:
	* [Line 4] a "role" field with value "keyboard" declares it's an IME app. Homescreen app will ignore some role types when displaying app icons, and "keyboard" is one of them. (see {{bug\|892397}})		* [Line 4] a "role" field with value "keyboard" declares it's an IME app. Homescreen app will ignore some role types when displaying app icons, and "keyboard" is one of them. (see {{bug\|892397}})
	* [Line 6-8] a "permissions" field that requests "keyboard" permission. All IME apps need this permission for sending input keys and updating the value of a input field.		* [Line 6-8] a "permissions" field that requests "keyboard" permission. All IME apps need this permission for sending input keys and updating the value of a input field.
	* [Line 9-30] a "~~entry_points~~" field specifies supported layouts. Each layout is described in a key-value pair, where the key represents the layout name (will be shown up on Settings app with the app name), and the value describes the detailed information of the layout, including launch path of the layout and supported input types. (See [[#Layout Matching Algorithm]])		* [Line 9-30] a "inputs" field specifies supported layouts. Each layout is described in a key-value pair, where the key represents the layout name (will be shown up on Settings app with the app name), and the value describes the detailed information of the layout, including launch path of the layout and supported input types. (See [[#Layout Matching Algorithm]])
	** The allowed value in "types" field is a subset of [http://www.whatwg.org/specs/web-apps/current-work/multipage/the-input-element.html#attr-input-type type attribute of input element]: text, search, tel, number, url, email. Other types will be ignored by FxOS Gaia in the initial version because at this point UI for <select> and <input type=date> (called "value selectors") are not open for 3rd-party implementation.		** The allowed value in "types" field is a subset of [http://www.whatwg.org/specs/web-apps/current-work/multipage/the-input-element.html#attr-input-type type attribute of input element]: text, search, tel, number, url, email. Other types will be ignored by FxOS Gaia in the initial version because at this point UI for <select> and <input type=date> (called "value selectors") are not open for 3rd-party implementation.

RudyL: /* Proposed Manifest of a 3rd-Party IME */ modify role/permission/input-list to "input(s)".

2014-01-22T02:48:33Z

Proposed Manifest of a 3rd-Party IME: modify role/permission/input-list to "input(s)".

← Older revision		Revision as of 02:48, 22 January 2014
Line 50:		Line 50:
	"description": "3rd-party Keyboard",		"description": "3rd-party Keyboard",
	"type": "privilege",		"type": "privilege",
	"role": "~~keyboard~~",		"role": "input",
	"launch_path": "/settings.html",		"launch_path": "/settings.html",
	"developer": {		"developer": {
Line 57:		Line 57:
	},		},
	"permissions": {		"permissions": {
	"~~keyboard~~": {}		"input": {}
	},		},
	"~~entry_points~~": {		"inputs": {
	"en": {		"en": {
	"launch_path": "/index.html#en",		"launch_path": "/index.html#en",

Yuanxulei: Remove striked lines.

2013-12-21T07:19:39Z

Remove striked lines.

← Older revision		Revision as of 07:19, 21 December 2013
Line 347:		Line 347:
	* selectionStart and selectionEnd.		* selectionStart and selectionEnd.
	*/		*/
	~~<strike>Promise<boolean> setSelectionRange(long start, long length);</strike>~~
	Promise<void> setSelectionRange(long start, long length);		Promise<void> setSelectionRange(long start, long length);

Line 362:		Line 361:
	* @param length The length of text to replace. Defaults to 0.		* @param length The length of text to replace. Defaults to 0.
	*/		*/
	~~<strike>Promise<boolean> replaceSurroundingText(DOMString text, optional long offset, optional long length);</strike>~~
	Promise<void> replaceSurroundingText(DOMString text, optional long offset, optional long length);		Promise<void> replaceSurroundingText(DOMString text, optional long offset, optional long length);

Line 371:		Line 369:
	* @param length The length of text to delete.		* @param length The length of text to delete.
	*/		*/
	~~<strike>Promise<boolean> deleteSurroundingText(long offset, long length);</strike>~~
	Promise<void> deleteSurroundingText(long offset, long length);		Promise<void> deleteSurroundingText(long offset, long length);

Line 390:		Line 387:
	* Alternative: sendKey(KeyboardEvent event), but we will likely waste memory for creating the KeyboardEvent object.		* Alternative: sendKey(KeyboardEvent event), but we will likely waste memory for creating the KeyboardEvent object.
	*/		*/
	~~<strike>Promise<boolean> sendKey(long keyCode, long charCode, optional long modifiers);</strike>~~
	Promise<void> sendKey(long keyCode, long charCode, optional long modifiers);		Promise<void> sendKey(long keyCode, long charCode, optional long modifiers);

Line 413:		Line 409:
	* To finish composition and commit text to current input field, an IME should call \|endComposition\|.		* To finish composition and commit text to current input field, an IME should call \|endComposition\|.
	*/		*/
	~~<strike>Promise<boolean> setComposition(DOMString text, optional long cursor);</strike>~~
	Promise<void> setComposition(DOMString text, optional long cursor);		Promise<void> setComposition(DOMString text, optional long cursor);

Line 426:		Line 421:
	* \|replaceSurroundingText\|, \|deleteSurroundingText\|, user moving the cursor, changing the focus, etc.		* \|replaceSurroundingText\|, \|deleteSurroundingText\|, user moving the cursor, changing the focus, etc.
	*/		*/
	~~<strike>~~Promise<~~boolean~~> endComposition(optional ~~DOMString text);</strike>~~		Promise<void> endComposition(optional DOMString text);
	~~Promise<void> endComposition(~~DOMString text);
	};		};

RudyL: Does not need settings permission for a general 3rd-party keyboard app

2013-09-05T04:04:55Z

Does not need settings permission for a general 3rd-party keyboard app

← Older revision		Revision as of 04:04, 5 September 2013
Line 57:		Line 57:
	},		},
	"permissions": {		"permissions": {
	~~"settings": { "access": "readwrite" },~~
	"keyboard": {}		"keyboard": {}
	},		},

Pychen: /* Proposed Manifest of a 3rd-Party IME */

2013-09-05T03:43:32Z

Proposed Manifest of a 3rd-Party IME

← Older revision		Revision as of 03:43, 5 September 2013
Line 49:		Line 49:
	"name": "3rd-party Keyboard",		"name": "3rd-party Keyboard",
	"description": "3rd-party Keyboard",		"description": "3rd-party Keyboard",
	"type": "~~certified~~",		"type": "privilege",
	"role": "keyboard",		"role": "keyboard",
	"launch_path": "/settings.html",		"launch_path": "/settings.html",