• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2024 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.wm.shell.draganddrop
18 
19 import android.graphics.Insets
20 import android.window.WindowContainerToken
21 import com.android.internal.logging.InstanceId
22 
23 /**
24  * Interface to be implemented by classes which want to provide drop targets
25  * for DragAndDrop in Shell
26  */
27 interface DropTarget {
28     // TODO(b/349828130) Delete after flexible split launches
29     /**
30      * Called at the start of a Drag, before input events are processed.
31      */
startnull32     fun start(dragSession: DragSession, logSessionId: InstanceId)
33     /**
34      * @return [SplitDragPolicy.Target] corresponding to the given coords in display bounds.
35      */
36     fun getTargetAtLocation(x: Int, y: Int) : SplitDragPolicy.Target
37     /**
38      * @return total number of drop targets for the current drag session.
39      */
40     fun getNumTargets() : Int
41     // TODO(b/349828130)
42 
43     /**
44      * @return [List<SplitDragPolicy.Target>] to show for the current drag session.
45      */
46     fun getTargets(insets: Insets) : List<SplitDragPolicy.Target>
47     /**
48      * Called when user is hovering Drag object over the given Target
49      */
50     fun onHoveringOver(target: SplitDragPolicy.Target?) {}
51     /**
52      * Called when the user has dropped the provided target (need not be the same target as
53      * [onHoveringOver])
54      */
onDroppednull55     fun onDropped(target: SplitDragPolicy.Target, hideTaskToken: WindowContainerToken)
56 }