nsIEditorIMESupport

Please add a summary to this article.
Inherits from: nsISupports Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Method overview

void beginComposition(in nsTextEventReplyPtr aReply); Native code only! Obsolete since Gecko 2.0
void endComposition(); Obsolete since Gecko 2.0
void forceCompositionEnd();
void getPreferredIMEState(out unsigned long aState); Native code only!
void getQueryCaretRect(in nsQueryCaretRectEventReplyPtr aReply); Native code only! Obsolete since Gecko 1.9.1
void getReconversionString(in nsReconversionEventReplyPtr aReply); Native code only! Obsolete since Gecko 1.9.1
void notifyIMEOnBlur(); Obsolete since Gecko 1.9.1
void notifyIMEOnFocus(); Obsolete since Gecko 1.9.1
void queryComposition(in nsTextEventReplyPtr aReply); Native code only! Obsolete since Gecko 2.0
void setCompositionString(in DOMString aCompositionString, in nsIPrivateTextRangeListPtr aTextRange, in nsTextEventReplyPtr aReply); Native code only! Obsolete since Gecko 2.0

Attributes

Attribute Type Description
composing boolean whether this editor has active IME transaction. Read only.

Methods

Native code only!

beginComposition

Obsolete since Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Handles the start of inline input composition.

void beginComposition(
  in nsTextEventReplyPtr aReply
);
Parameters
aReply

Obsolete since Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

endComposition()

Handles the end of inline input composition.

void endComposition();
Parameters

None.

forceCompositionEnd()

Force the composition end.

void forceCompositionEnd();
Parameters

None.

Native code only!

getPreferredIMEState

Get preferred IME status of current widget.

void getPreferredIMEState(
  out unsigned long aState
);
Parameters
aState

Native code only!

getQueryCaretRect

Obsolete since Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Get the query caret rect.

void getQueryCaretRect(
  in nsQueryCaretRectEventReplyPtr aReply
);
Parameters
aReply

Native code only!

getReconversionString

Obsolete since Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Get the reconversion string.

void getReconversionString(
  in nsReconversionEventReplyPtr aReply
);
Parameters
aReply

Requires Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

notifyIMEOnBlur()

Obsolete since Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Notify for IME when the editor lost focus.

void notifyIMEOnBlur();
Parameters

None.

Requires Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

notifyIMEOnFocus()

Obsolete since Gecko 1.9.1 (Firefox 3.5 / Thunderbird 3.0 / SeaMonkey 2.0)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Notify for IME when the editor got focus.

void notifyIMEOnFocus();
Parameters

None.

Native code only!

queryComposition

Obsolete since Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Get the composition position.

void queryComposition(
  in nsTextEventReplyPtr aReply
);
Parameters
aReply

Native code only!

setCompositionString

Obsolete since Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)
This feature is obsolete. Although it may still work in some browsers, its use is discouraged since it could be removed at any time. Try to avoid using it.

Sets the inline input composition string. beginComposition() must be called prior to this.

void setCompositionString(
  in DOMString aCompositionString,
  in nsIPrivateTextRangeListPtr aTextRange,
  in nsTextEventReplyPtr aReply
);
Parameters
aCompositionString
aTextRange
aReply

Document Tags and Contributors

Contributors to this page: Sheppy, trevorh
Last updated by: Sheppy,