editor/idl/nsIEditorIMESupport.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Masayuki Nakano <masayuki@d-toybox.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 #include "domstubs.idl"
  41
  42 %{C++
  43 class nsIPrivateTextRangeList;
  44 struct nsTextEventReply;
  45 %}
  46
  47 [ptr] native nsIPrivateTextRangeListPtr(nsIPrivateTextRangeList);
  48 [ptr] native nsTextEventReplyPtr(nsTextEventReply);
  49
  50
  51 [scriptable, uuid(57032dcb-e8c7-4eb6-8ec6-a0f8e300809d)]
  52
  53 interface nsIEditorIMESupport : nsISupports
  54 {
  55
  56
  57   /**
  58    * beginComposition(nsTextEventReply* aReply) Handles the start of inline input composition.
  59    */
  60
  61   [noscript] void beginComposition(in nsTextEventReplyPtr aReply);
  62
  63   /**
  64    * setCompositionString() Sets the inline input composition string.
  65    * beginComposition must be called prior to this.
  66    */
  67
  68   [noscript] void setCompositionString(in DOMString aCompositionString, in nsIPrivateTextRangeListPtr aTextRange, in nsTextEventReplyPtr aReply);
  69
  70   /**
  71    * endComposition() Handles the end of inline input composition.
  72    */
  73
  74   void  endComposition();
  75
  76   /**
  77    * queryComposition()  Get the composition position
  78    */
  79
  80   [noscript] void queryComposition(in nsTextEventReplyPtr aReply);
  81
  82   /**
  83    * forceCompositionEnd() force the composition end
  84    */
  85
  86   void forceCompositionEnd();
  87
  88   /**
  89    * Get preferred IME status of current widget.
  90    */
  91
  92   [noscript] void getPreferredIMEState(out unsigned long aState);
  93
  94   /**
  95    * whether this editor has active IME transaction
  96    */
  97   readonly attribute boolean composing;
  98 };
  99