1 /*
2  * Copyright (C) 2011 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.inputmethodcommon;
18 
19 import android.graphics.drawable.Drawable;
20 
21 /**
22  * InputMethodSettingsInterface is the interface for adding IME related preferences to
23  * PreferenceActivity or PreferenceFragment.
24  */
25 public interface InputMethodSettingsInterface {
26     /**
27      * Sets the title for the input method settings category with a resource ID.
28      * @param resId The resource ID of the title.
29      */
setInputMethodSettingsCategoryTitle(int resId)30     public void setInputMethodSettingsCategoryTitle(int resId);
31 
32     /**
33      * Sets the title for the input method settings category with a CharSequence.
34      * @param title The title for this preference.
35      */
setInputMethodSettingsCategoryTitle(CharSequence title)36     public void setInputMethodSettingsCategoryTitle(CharSequence title);
37 
38     /**
39      * Sets the title for the input method enabler preference for launching subtype enabler with a
40      * resource ID.
41      * @param resId The resource ID of the title.
42      */
setSubtypeEnablerTitle(int resId)43     public void setSubtypeEnablerTitle(int resId);
44 
45     /**
46      * Sets the title for the input method enabler preference for launching subtype enabler with a
47      * CharSequence.
48      * @param title The title for this preference.
49      */
setSubtypeEnablerTitle(CharSequence title)50     public void setSubtypeEnablerTitle(CharSequence title);
51 
52     /**
53      * Sets the icon for the preference for launching subtype enabler with a resource ID.
54      * @param resId The resource id of an optional icon for the preference.
55      */
setSubtypeEnablerIcon(int resId)56     public void setSubtypeEnablerIcon(int resId);
57 
58     /**
59      * Sets the icon for the Preference for launching subtype enabler with a Drawable.
60      * @param drawable The drawable of an optional icon for the preference.
61      */
setSubtypeEnablerIcon(Drawable drawable)62     public void setSubtypeEnablerIcon(Drawable drawable);
63 }
64