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 android.content;
18 
19 import android.content.ClipData;
20 import android.content.ClipDescription;
21 import android.content.IOnPrimaryClipChangedListener;
22 
23 /**
24  * Programming interface to the clipboard, which allows copying and pasting
25  * between applications.
26  * {@hide}
27  */
28 interface IClipboard {
setPrimaryClip(in ClipData clip, String callingPackage, String attributionTag, int userId, int deviceId)29     void setPrimaryClip(in ClipData clip, String callingPackage, String attributionTag, int userId,
30             int deviceId);
31     @EnforcePermission("SET_CLIP_SOURCE")
setPrimaryClipAsPackage(in ClipData clip, String callingPackage, String attributionTag, int userId, int deviceId, String sourcePackage)32     void setPrimaryClipAsPackage(in ClipData clip, String callingPackage, String attributionTag,
33             int userId, int deviceId, String sourcePackage);
clearPrimaryClip(String callingPackage, String attributionTag, int userId, int deviceId)34     void clearPrimaryClip(String callingPackage, String attributionTag, int userId, int deviceId);
getPrimaryClip(String pkg, String attributionTag, int userId, int deviceId)35     ClipData getPrimaryClip(String pkg, String attributionTag, int userId, int deviceId);
getPrimaryClipDescription(String callingPackage, String attributionTag, int userId, int deviceId)36     ClipDescription getPrimaryClipDescription(String callingPackage, String attributionTag,
37             int userId, int deviceId);
hasPrimaryClip(String callingPackage, String attributionTag, int userId, int deviceId)38     boolean hasPrimaryClip(String callingPackage, String attributionTag, int userId, int deviceId);
addPrimaryClipChangedListener(in IOnPrimaryClipChangedListener listener, String callingPackage, String attributionTag, int userId, int deviceId)39     void addPrimaryClipChangedListener(in IOnPrimaryClipChangedListener listener,
40             String callingPackage, String attributionTag, int userId, int deviceId);
removePrimaryClipChangedListener(in IOnPrimaryClipChangedListener listener, String callingPackage, String attributionTag, int userId, int deviceId)41     void removePrimaryClipChangedListener(in IOnPrimaryClipChangedListener listener,
42             String callingPackage, String attributionTag, int userId, int deviceId);
43 
44     /**
45      * Returns true if the clipboard contains text; false otherwise.
46      */
hasClipboardText(String callingPackage, String attributionTag, int userId, int deviceId)47     boolean hasClipboardText(String callingPackage, String attributionTag, int userId,
48             int deviceId);
49 
50     @EnforcePermission("SET_CLIP_SOURCE")
getPrimaryClipSource(String callingPackage, String attributionTag, int userId, int deviceId)51     String getPrimaryClipSource(String callingPackage, String attributionTag, int userId,
52             int deviceId);
53 
areClipboardAccessNotificationsEnabledForUser(int userId)54     boolean areClipboardAccessNotificationsEnabledForUser(int userId);
55 
setClipboardAccessNotificationsEnabledForUser(boolean enable, int userId)56     void setClipboardAccessNotificationsEnabledForUser(boolean enable, int userId);
57 }
58