InputMethodSettingsInterface.java revision c9a877174c6ba3552c1a6e396509f8d08049a3f6 
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
17package com.android.inputmethodcommon;
18
19import android.graphics.drawable.Drawable;
20
21/**
22 * InputMethodSettingsInterface is the interface for adding IME related preferences to
23 * PreferenceActivity or PreferenceFragment.
24 */
25public 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     */
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     */
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     */
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     */
50    public void setSubtypeEnablerTitle(CharSequence title);
51
52    /**
53     * Sets the summary for the inputmethod enabler preference for launching subtype enabler with a
54     * resource ID.
55     * @param resId The resource id of the summary for the preference.
56     */
57    public void setSubtypeEnablerSummary(int resId);
58
59    /**
60     * Sets the summary for the inputmethod enabler preference for launching subtype enabler with a
61     * CharSequence.
62     * @param summary The summary of the preference.
63     */
64    public void setSubtypeEnablerSummary(CharSequence summary);
65
66    /**
67     * Sets the icon for the preference for launching subtype enabler with a resource ID.
68     * @param resId The resource id of an optional icon for the preference.
69     */
70    public void setSubtypeEnablerIcon(int resId);
71
72    /**
73     * Sets the icon for the Preference for launching subtype enabler with a Drawable.
74     * @param drawable The drawable of an optional icon for the preference.
75     */
76    public void setSubtypeEnablerIcon(Drawable drawable);
77}
78