core/java/com/android/internal/view/IInputMethodManager.aidl

   1 /*
   2  * Copyright (C) 2008 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.android.internal.view;
  18
  19 import android.os.ResultReceiver;
  20 import android.text.style.SuggestionSpan;
  21 import android.view.inputmethod.InputMethodInfo;
  22 import android.view.inputmethod.InputMethodSubtype;
  23 import android.view.inputmethod.EditorInfo;
  24 import com.android.internal.view.InputBindResult;
  25 import com.android.internal.view.IInputContext;
  26 import com.android.internal.view.IInputMethodClient;
  27
  28 /**
  29  * Public interface to the global input method manager, used by all client
  30  * applications.
  31  * You need to update BridgeIInputMethodManager.java as well when changing
  32  * this file.
  33  */
  34 interface IInputMethodManager {
  35     // TODO: Use ParceledListSlice instead
  36     List<InputMethodInfo> getInputMethodList();
  37     // TODO: Use ParceledListSlice instead
  38     List<InputMethodInfo> getEnabledInputMethodList();
  39     List<InputMethodSubtype> getEnabledInputMethodSubtypeList(in String imiId,
  40             boolean allowsImplicitlySelectedSubtypes);
  41     InputMethodSubtype getLastInputMethodSubtype();
  42     // TODO: We should change the return type from List to List<Parcelable>
  43     // Currently there is a bug that aidl doesn't accept List<Parcelable>
  44     List getShortcutInputMethodsAndSubtypes();
  45     void addClient(in IInputMethodClient client,
  46             in IInputContext inputContext, int uid, int pid);
  47     void removeClient(in IInputMethodClient client);
  48
  49     void finishInput(in IInputMethodClient client);
  50     boolean showSoftInput(in IInputMethodClient client, int flags,
  51             in ResultReceiver resultReceiver);
  52     boolean hideSoftInput(in IInputMethodClient client, int flags,
  53             in ResultReceiver resultReceiver);
  54     // If windowToken is null, this just does startInput().  Otherwise this reports that a window
  55     // has gained focus, and if 'attribute' is non-null then also does startInput.
  56     InputBindResult startInputOrWindowGainedFocus(
  57             /* @InputMethodClient.StartInputReason */ int startInputReason,
  58             in IInputMethodClient client, in IBinder windowToken, int controlFlags,
  59             int softInputMode, int windowFlags, in EditorInfo attribute,
  60             IInputContext inputContext,
  61             /* @InputConnectionInspector.MissingMethodFlags */ int missingMethodFlags);
  62
  63     void showInputMethodPickerFromClient(in IInputMethodClient client,
  64             int auxiliarySubtypeMode);
  65     void showInputMethodAndSubtypeEnablerFromClient(in IInputMethodClient client, String topId);
  66     void setInputMethod(in IBinder token, String id);
  67     void setInputMethodAndSubtype(in IBinder token, String id, in InputMethodSubtype subtype);
  68     void hideMySoftInput(in IBinder token, int flags);
  69     void showMySoftInput(in IBinder token, int flags);
  70     void updateStatusIcon(in IBinder token, String packageName, int iconId);
  71     void setImeWindowStatus(in IBinder token, int vis, int backDisposition);
  72     void registerSuggestionSpansForNotification(in SuggestionSpan[] spans);
  73     boolean notifySuggestionPicked(in SuggestionSpan span, String originalString, int index);
  74     InputMethodSubtype getCurrentInputMethodSubtype();
  75     boolean setCurrentInputMethodSubtype(in InputMethodSubtype subtype);
  76     boolean switchToLastInputMethod(in IBinder token);
  77     boolean switchToNextInputMethod(in IBinder token, boolean onlyCurrentIme);
  78     boolean shouldOfferSwitchingToNextInputMethod(in IBinder token);
  79     boolean setInputMethodEnabled(String id, boolean enabled);
  80     void setAdditionalInputMethodSubtypes(String id, in InputMethodSubtype[] subtypes);
  81     int getInputMethodWindowVisibleHeight();
  82     void clearLastInputMethodWindowForTransition(in IBinder token);
  83
  84     oneway void notifyUserAction(int sequenceNumber);
  85 }