Readonly
addedThis attribute has a valid value when type is "notify-text-change". This is added text length by the change(s). If this is empty, old text was just deleted. Otherwise, the text replaces the old text.
Readonly
causedThis attribute has a valid value when type is "notify-selection-change". If the selection change was caused by composition, this is set to true. Otherwise, false.
Readonly
causedThis attribute has a valid value when type is "notify-selection-change". If the selection change was caused by selection event, this is set to true. Otherwise, false.
Readonly
causedThis attribute has a valid value when type is "notify-text-change". If the text change(s) was caused only by composition, this is set to true. Otherwise, false. I.e., if one of text changes are caused by JS or modifying without composition, this is set to false.
Readonly
collapsedThis attribute has a valid value when type is "notify-selection-change". This is set to true when the selection is collapsed or no range. Otherwise, false.
Readonly
hasThis attribute has a vaild value when type is "notify-selection-change". This is true if selection has a range. Otherwise, i.e., there is no range such as after calling Selection.removeAllRanges, this is false.
Readonly
includingThis attribute has a valid value when type is "notify-text-change". If at least one text change not caused by composition occurred during composition, this is set to true. Otherwise, false. Note that this is set to false when new change is caused by neither composition nor occurred during composition because it's outdated for new composition. In other words, when text changes not caused by composition occurred during composition and it may cause committing composition, this is set to true.
Readonly
includingThis attribute has a valid value when type is "notify-text-change". If at least one text change occurred when there was no composition, this is set to true. Otherwise, false.
Readonly
lengthThis attribute has a valid value when type is "notify-selection-change" and hasRange is true. This is selected length. I.e., if this is 0, collapsed is set to true.
Readonly
occurredThis attribute has a valid value when type is "notify-selection-change". If the selection change occurred during composition, this is set to true. Otherwise, false.
Readonly
offsetBe careful, line breakers in the editor are treated as native line breakers. I.e., on Windows, a line breaker is "\r\n" (CRLF). On the others, it is "\n" (LF). If you want TextInputProcessor to treat line breakers on Windows as XP line breakers (LF), please file a bug with the reason why you need the behavior. This attribute has a valid value when type is "notify-text-change", or is "notify-selection-change" and hasRange is true. This is offset of the start of modified text range if type is "notify-text-change". Or offset of start of selection if type is "notify-selection-change".
Readonly
removedThis attribute has a valid value when type is "notify-text-change". This is removed text length by the change(s). If this is empty, new text was just inserted. Otherwise, the text is replaced with new text.
Readonly
reversedThis attribute has a valid value when type is "notify-selection-change" and hasRange is true. When selection is created from latter point to former point, this is set to true. Otherwise, false. I.e., if this is true, offset + length is the anchor of selection.
Readonly
textThis attribute has a valid value when type is "notify-selection-change" and hasRange is true. This is selected text. I.e., the length is selected length and it's empty if the selection is collapsed.
Readonly
typetype attribute represents what's notified or requested. Value must be one of following values:
"request-to-commit" (required to be handled) This is requested when Gecko believes that active composition should be committed. nsITextInputProcessorCallback::onNotify() has to handle this notification.
"request-to-cancel" (required to be handled) This is requested when Gecko believes that active composition should be canceled. I.e., composition should be committed with empty string. nsITextInputProcessorCallback::onNotify() has to handle this notification.
"notify-end-input-transaction" (optional) This is notified when the callback is detached from nsITextInputProcessor. I.e., the TextInputProcessor lost the rights to input text and needs to call .beginInputTransaction() before next input.
"notify-focus" (optional) This is notified when an editable editor gets focus and Gecko starts to observe changes in the content. E.g., selection changes. IME shouldn't change DOM tree, focus nor something when this is notified.
"notify-blur" (optional) This is notified when an editable editor loses focus and Gecko stops observing the changes in the content.
"notify-text-change" (optional) This is notified when text in the focused editor is modified. Some attributes below are available to retrieve the detail. IME shouldn't change DOM tree, focus nor something when this is notified. Note that when there is no chance to notify you of some text changes safely, this represents all changes as a change.
"notify-selection-change" (optional) This is notified when selection in the focused editor is changed. Some attributes below are available to retrieve the detail. IME shouldn't change DOM tree, focus nor something when this is notified. Note that when there was no chance to notify you of this safely, this represents the latest selection change.
"notify-position-change" (optional) This is notified when layout is changed in the editor or the window is moved. IME shouldn't change DOM tree, focus nor something when this is notified. Note that when there was no chance to notify you of this safely, this represents the latest layout change.
Readonly
writingThis attribute has a valid value when type is "notify-selection-change". This indicates the start of the selection's writing mode. The value can be "horizontal-tb", "vertical-rl" or "vertical-lr".
Optional
aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
Generated using TypeDoc
nsITextInputProcessorNotification stores the type of notification to IME and its detail. See each explanation of attribute for the detail.