NPAPI:CocoaCompositionClarification: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= Status =
= Status =


Under consideration.
Accepted, ready for implementation.


= Contributors =
= Contributors =


* Last modified: November 28, 2010
* Last modified: January 18, 2011
* Authors: Josh Aas (Mozilla)
* Authors: Josh Aas (Mozilla)
* Contributors: Stuart Morgan (Google)
* Contributors: Stuart Morgan (Google)
Line 11: Line 11:
= Overview =
= Overview =


This proposal modifies the existing Cocoa NPAPI specification ([[NPAPI:CocoaEventModel]]). Plugins need a way to know when complex text composition (started by returning 'kNPEventStartIME' for an 'NPCocoaEventKeyDown' event) has been canceled by the user or the browser. Plugins receive key events during composition and without this extension they cannot tell in-composition key events from post-composition key events unless a composition completes and results in an 'NPCocoaEventTextInput' event.
This proposal modifies the existing Cocoa NPAPI specification ([[NPAPI:CocoaEventModel]]). Under the current specification plugins receive key events during complex text composition but do not have a reliable way to know whether or not key events are intended for use in the composition. Since composition can be canceled by the user or the browser plugins cannot assume that composition is in progress until they receive an 'NPCocoaEventTextInput' event.


= Specification Change =
= Specification Change =


In order to provide the plugin with information about whether or not there is a complex text composition in progress we will bump the 'NPCocoaEvent' version to '2'. If a plugin receives an 'NPCocoaEvent' with a version of '2' or higher then the key structure will contain a field of type 'NPBool' called 'compositionInProgress'. The 'compositionInProgress' field is only valid for 'NPCocoaEventKeyDown' events. It will be set to false when no composition is in progress and true when a composition is in progress.
The original "Text Input" section stated:


= Open Questions =
"During complex text input the browser will continue to send regular key events. So long as the plugin still wants complex text input (which may result in a NPCocoaEventTextInput event being sent) it should continue to return kNPEventStartIME for NPCocoaEventKeyDown. If a plugin returns anything other than kNPEventStartIME for NPCocoaEventKeyDown then complex text input will be canceled."


<ul>
This has been changed. See the current "Text Input" section of the [[NPAPI:CocoaEventModel|Cocoa event model spec]] for the updated version.
<li> Alternatively, we could say that once composition is started it will always result in an 'NPCocoaEventTextInput' event and canceled compositions will simply result in an 'NPCocoaEventTextInput' event with an empty string.
</ul>

Latest revision as of 23:59, 20 January 2011

Status

Accepted, ready for implementation.

Contributors

  • Last modified: January 18, 2011
  • Authors: Josh Aas (Mozilla)
  • Contributors: Stuart Morgan (Google)

Overview

This proposal modifies the existing Cocoa NPAPI specification (NPAPI:CocoaEventModel). Under the current specification plugins receive key events during complex text composition but do not have a reliable way to know whether or not key events are intended for use in the composition. Since composition can be canceled by the user or the browser plugins cannot assume that composition is in progress until they receive an 'NPCocoaEventTextInput' event.

Specification Change

The original "Text Input" section stated:

"During complex text input the browser will continue to send regular key events. So long as the plugin still wants complex text input (which may result in a NPCocoaEventTextInput event being sent) it should continue to return kNPEventStartIME for NPCocoaEventKeyDown. If a plugin returns anything other than kNPEventStartIME for NPCocoaEventKeyDown then complex text input will be canceled."

This has been changed. See the current "Text Input" section of the Cocoa event model spec for the updated version.