The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1 | /* //device/java/android/android/view/IWindowSession.aidl |
| 2 | ** |
| 3 | ** Copyright 2006, The Android Open Source Project |
| 4 | ** |
| 5 | ** Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | ** you may not use this file except in compliance with the License. |
| 7 | ** You may obtain a copy of the License at |
| 8 | ** |
| 9 | ** http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | ** |
| 11 | ** Unless required by applicable law or agreed to in writing, software |
| 12 | ** distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Andrii Kulian | 4460796 | 2017-03-16 11:06:24 -0700 | [diff] [blame] | 14 | ** See the License for the specific language governing permissions and |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 15 | ** limitations under the License. |
| 16 | */ |
| 17 | |
| 18 | package android.view; |
| 19 | |
Christopher Tate | a53146c | 2010-09-07 11:57:52 -0700 | [diff] [blame] | 20 | import android.content.ClipData; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 21 | import android.graphics.Rect; |
| 22 | import android.graphics.Region; |
Dianne Hackborn | 7580493 | 2009-10-20 20:15:20 -0700 | [diff] [blame] | 23 | import android.os.Bundle; |
Andrii Kulian | 4460796 | 2017-03-16 11:06:24 -0700 | [diff] [blame] | 24 | import android.util.MergedConfiguration; |
Adrian Roos | 5c6b622 | 2017-11-07 17:36:10 +0100 | [diff] [blame] | 25 | import android.view.DisplayCutout; |
Jeff Brown | 46b9ac0 | 2010-04-22 18:58:52 -0700 | [diff] [blame] | 26 | import android.view.InputChannel; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 27 | import android.view.IWindow; |
Dianne Hackborn | e3f23a3 | 2013-03-01 13:25:35 -0800 | [diff] [blame] | 28 | import android.view.IWindowId; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 29 | import android.view.MotionEvent; |
| 30 | import android.view.WindowManager; |
| 31 | import android.view.Surface; |
Daichi Hirono | a1fb9be | 2017-12-18 17:02:54 +0900 | [diff] [blame] | 32 | import android.view.SurfaceControl; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 33 | |
| 34 | /** |
| 35 | * System private per-application interface to the window manager. |
| 36 | * |
| 37 | * {@hide} |
| 38 | */ |
| 39 | interface IWindowSession { |
Dianne Hackborn | 9a230e0 | 2011-10-06 11:51:27 -0700 | [diff] [blame] | 40 | int add(IWindow window, int seq, in WindowManager.LayoutParams attrs, |
Adrian Roos | 37d7a68 | 2014-11-06 18:15:16 +0100 | [diff] [blame] | 41 | in int viewVisibility, out Rect outContentInsets, out Rect outStableInsets, |
Jeff Brown | 46b9ac0 | 2010-04-22 18:58:52 -0700 | [diff] [blame] | 42 | out InputChannel outInputChannel); |
Craig Mautner | 6881a10 | 2012-07-27 13:04:51 -0700 | [diff] [blame] | 43 | int addToDisplay(IWindow window, int seq, in WindowManager.LayoutParams attrs, |
| 44 | in int viewVisibility, in int layerStackId, out Rect outContentInsets, |
Adrian Roos | 5c6b622 | 2017-11-07 17:36:10 +0100 | [diff] [blame] | 45 | out Rect outStableInsets, out Rect outOutsets, |
| 46 | out DisplayCutout.ParcelableWrapper displayCutout, out InputChannel outInputChannel); |
Dianne Hackborn | 9a230e0 | 2011-10-06 11:51:27 -0700 | [diff] [blame] | 47 | int addWithoutInputChannel(IWindow window, int seq, in WindowManager.LayoutParams attrs, |
Adrian Roos | 37d7a68 | 2014-11-06 18:15:16 +0100 | [diff] [blame] | 48 | in int viewVisibility, out Rect outContentInsets, out Rect outStableInsets); |
Craig Mautner | 6881a10 | 2012-07-27 13:04:51 -0700 | [diff] [blame] | 49 | int addToDisplayWithoutInputChannel(IWindow window, int seq, in WindowManager.LayoutParams attrs, |
Adrian Roos | 37d7a68 | 2014-11-06 18:15:16 +0100 | [diff] [blame] | 50 | in int viewVisibility, in int layerStackId, out Rect outContentInsets, |
| 51 | out Rect outStableInsets); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 52 | void remove(IWindow window); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 53 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 54 | /** |
| 55 | * Change the parameters of a window. You supply the |
| 56 | * new parameters, it returns the new frame of the window on screen (the |
| 57 | * position should be ignored) and surface of the window. The surface |
| 58 | * will be invalid if the window is currently hidden, else you can use it |
| 59 | * to draw the window's contents. |
| 60 | * |
| 61 | * @param window The window being modified. |
Dianne Hackborn | 9a230e0 | 2011-10-06 11:51:27 -0700 | [diff] [blame] | 62 | * @param seq Ordering sequence number. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 63 | * @param attrs If non-null, new attributes to apply to the window. |
| 64 | * @param requestedWidth The width the window wants to be. |
| 65 | * @param requestedHeight The height the window wants to be. |
| 66 | * @param viewVisibility Window root view's visibility. |
Jeff Brown | 98365d7 | 2012-08-19 20:30:52 -0700 | [diff] [blame] | 67 | * @param flags Request flags: {@link WindowManagerGlobal#RELAYOUT_INSETS_PENDING}, |
| 68 | * {@link WindowManagerGlobal#RELAYOUT_DEFER_SURFACE_DESTROY}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 69 | * @param outFrame Rect in which is placed the new position/size on |
| 70 | * screen. |
Dianne Hackborn | c4aad01 | 2013-02-22 15:05:25 -0800 | [diff] [blame] | 71 | * @param outOverscanInsets Rect in which is placed the offsets from |
| 72 | * <var>outFrame</var> in which the content of the window are inside |
| 73 | * of the display's overlay region. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 74 | * @param outContentInsets Rect in which is placed the offsets from |
| 75 | * <var>outFrame</var> in which the content of the window should be |
| 76 | * placed. This can be used to modify the window layout to ensure its |
| 77 | * contents are visible to the user, taking into account system windows |
| 78 | * like the status bar or a soft keyboard. |
| 79 | * @param outVisibleInsets Rect in which is placed the offsets from |
| 80 | * <var>outFrame</var> in which the window is actually completely visible |
| 81 | * to the user. This can be used to temporarily scroll the window's |
| 82 | * contents to make sure the user can see it. This is different than |
| 83 | * <var>outContentInsets</var> in that these insets change transiently, |
| 84 | * so complex relayout of the window should not happen based on them. |
Filip Gruszczynski | 2217f61 | 2015-05-26 11:32:08 -0700 | [diff] [blame] | 85 | * @param outOutsets Rect in which is placed the dead area of the screen that we would like to |
| 86 | * treat as real display. Example of such area is a chin in some models of wearable devices. |
Jorim Jaggi | 2e95a48 | 2016-01-14 17:36:55 -0800 | [diff] [blame] | 87 | * @param outBackdropFrame Rect which is used draw the resizing background during a resize |
| 88 | * operation. |
Andrii Kulian | 4460796 | 2017-03-16 11:06:24 -0700 | [diff] [blame] | 89 | * @param outMergedConfiguration New config container that holds global, override and merged |
| 90 | * config for window, if it is now becoming visible and the merged configuration has changed |
| 91 | * since it was last displayed. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 92 | * @param outSurface Object in which is placed the new display surface. |
Filip Gruszczynski | 2217f61 | 2015-05-26 11:32:08 -0700 | [diff] [blame] | 93 | * |
Jeff Brown | 98365d7 | 2012-08-19 20:30:52 -0700 | [diff] [blame] | 94 | * @return int Result flags: {@link WindowManagerGlobal#RELAYOUT_SHOW_FOCUS}, |
| 95 | * {@link WindowManagerGlobal#RELAYOUT_FIRST_TIME}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 96 | */ |
Dianne Hackborn | 9a230e0 | 2011-10-06 11:51:27 -0700 | [diff] [blame] | 97 | int relayout(IWindow window, int seq, in WindowManager.LayoutParams attrs, |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 98 | int requestedWidth, int requestedHeight, int viewVisibility, |
Dianne Hackborn | c4aad01 | 2013-02-22 15:05:25 -0800 | [diff] [blame] | 99 | int flags, out Rect outFrame, out Rect outOverscanInsets, |
Adrian Roos | fa10423 | 2014-06-20 16:10:14 -0700 | [diff] [blame] | 100 | out Rect outContentInsets, out Rect outVisibleInsets, out Rect outStableInsets, |
Andrii Kulian | 4460796 | 2017-03-16 11:06:24 -0700 | [diff] [blame] | 101 | out Rect outOutsets, out Rect outBackdropFrame, |
Adrian Roos | 5c6b622 | 2017-11-07 17:36:10 +0100 | [diff] [blame] | 102 | out DisplayCutout.ParcelableWrapper displayCutout, |
Bryce Lee | 46b0165 | 2017-06-07 23:01:56 +0000 | [diff] [blame] | 103 | out MergedConfiguration outMergedConfiguration, out Surface outSurface); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 104 | |
Robert Carr | 23fa16b | 2016-01-13 13:19:58 -0800 | [diff] [blame] | 105 | /* |
| 106 | * Notify the window manager that an application is relaunching and |
Robert Carr | 77bdfb5 | 2016-05-02 18:18:31 -0700 | [diff] [blame] | 107 | * windows should be prepared for replacement. |
Robert Carr | 23fa16b | 2016-01-13 13:19:58 -0800 | [diff] [blame] | 108 | * |
| 109 | * @param appToken The application |
Robert Carr | 77bdfb5 | 2016-05-02 18:18:31 -0700 | [diff] [blame] | 110 | * @param childrenOnly Whether to only prepare child windows for replacement |
| 111 | * (for example when main windows are being reused via preservation). |
Robert Carr | 23fa16b | 2016-01-13 13:19:58 -0800 | [diff] [blame] | 112 | */ |
Robert Carr | 77bdfb5 | 2016-05-02 18:18:31 -0700 | [diff] [blame] | 113 | void prepareToReplaceWindows(IBinder appToken, boolean childrenOnly); |
Robert Carr | 23fa16b | 2016-01-13 13:19:58 -0800 | [diff] [blame] | 114 | |
Rob Carr | 64e516f | 2015-10-29 00:20:45 +0000 | [diff] [blame] | 115 | /** |
Dianne Hackborn | 6482517 | 2011-03-02 21:32:58 -0800 | [diff] [blame] | 116 | * Called by a client to report that it ran out of graphics memory. |
| 117 | */ |
| 118 | boolean outOfMemory(IWindow window); |
| 119 | |
| 120 | /** |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 121 | * Give the window manager a hint of the part of the window that is |
| 122 | * completely transparent, allowing it to work with the surface flinger |
| 123 | * to optimize compositing of this part of the window. |
| 124 | */ |
| 125 | void setTransparentRegion(IWindow window, in Region region); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 126 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 127 | /** |
| 128 | * Tell the window manager about the content and visible insets of the |
| 129 | * given window, which can be used to adjust the <var>outContentInsets</var> |
| 130 | * and <var>outVisibleInsets</var> values returned by |
| 131 | * {@link #relayout relayout()} for windows behind this one. |
| 132 | * |
| 133 | * @param touchableInsets Controls which part of the window inside of its |
| 134 | * frame can receive pointer events, as defined by |
| 135 | * {@link android.view.ViewTreeObserver.InternalInsetsInfo}. |
| 136 | */ |
| 137 | void setInsets(IWindow window, int touchableInsets, in Rect contentInsets, |
Jeff Brown | fbf0977 | 2011-01-16 14:06:57 -0800 | [diff] [blame] | 138 | in Rect visibleInsets, in Region touchableRegion); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 139 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 140 | /** |
| 141 | * Return the current display size in which the window is being laid out, |
| 142 | * accounting for screen decorations around it. |
| 143 | */ |
| 144 | void getDisplayFrame(IWindow window, out Rect outDisplayFrame); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 145 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 146 | void finishDrawing(IWindow window); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 147 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 148 | void setInTouchMode(boolean showFocus); |
| 149 | boolean getInTouchMode(); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 150 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 151 | boolean performHapticFeedback(IWindow window, int effectId, boolean always); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 152 | |
Dianne Hackborn | c8a0a75 | 2009-08-10 23:05:49 -0700 | [diff] [blame] | 153 | /** |
Christopher Tate | a53146c | 2010-09-07 11:57:52 -0700 | [diff] [blame] | 154 | * Initiate the drag operation itself |
Daichi Hirono | fabca09 | 2017-12-19 15:02:50 +0900 | [diff] [blame] | 155 | * |
| 156 | * @param window Window which initiates drag operation. |
| 157 | * @param flags See {@code View#startDragAndDrop} |
| 158 | * @param surface Surface containing drag shadow image |
| 159 | * @param touchSource See {@code InputDevice#getSource()} |
Daichi Hirono | 1456b92 | 2018-01-24 15:37:26 +0900 | [diff] [blame] | 160 | * @param touchX X coordinate of last touch point |
| 161 | * @param touchY Y coordinate of last touch point |
Daichi Hirono | fabca09 | 2017-12-19 15:02:50 +0900 | [diff] [blame] | 162 | * @param thumbCenterX X coordinate for the position within the shadow image that should be |
| 163 | * underneath the touch point during the drag and drop operation. |
| 164 | * @param thumbCenterY Y coordinate for the position within the shadow image that should be |
| 165 | * underneath the touch point during the drag and drop operation. |
| 166 | * @param data Data transferred by drag and drop |
| 167 | * @return Token of drag operation which will be passed to cancelDragAndDrop. |
Christopher Tate | a53146c | 2010-09-07 11:57:52 -0700 | [diff] [blame] | 168 | */ |
Daichi Hirono | fabca09 | 2017-12-19 15:02:50 +0900 | [diff] [blame] | 169 | IBinder performDrag(IWindow window, int flags, in SurfaceControl surface, int touchSource, |
Vladislav Kaznacheev | ba76112 | 2016-01-22 12:09:45 -0800 | [diff] [blame] | 170 | float touchX, float touchY, float thumbCenterX, float thumbCenterY, in ClipData data); |
Christopher Tate | a53146c | 2010-09-07 11:57:52 -0700 | [diff] [blame] | 171 | |
Daichi Hirono | a1fb9be | 2017-12-18 17:02:54 +0900 | [diff] [blame] | 172 | /** |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 173 | * Report the result of a drop action targeted to the given window. |
| 174 | * consumed is 'true' when the drop was accepted by a valid recipient, |
| 175 | * 'false' otherwise. |
| 176 | */ |
Daichi Hirono | a1fb9be | 2017-12-18 17:02:54 +0900 | [diff] [blame] | 177 | void reportDropResult(IWindow window, boolean consumed); |
Chris Tate | d4533f1 | 2010-10-19 15:15:08 -0700 | [diff] [blame] | 178 | |
Christopher Tate | a53146c | 2010-09-07 11:57:52 -0700 | [diff] [blame] | 179 | /** |
Vladislav Kaznacheev | 8206391 | 2015-11-20 14:20:13 -0800 | [diff] [blame] | 180 | * Cancel the current drag operation. |
| 181 | */ |
| 182 | void cancelDragAndDrop(IBinder dragToken); |
| 183 | |
| 184 | /** |
Christopher Tate | a53146c | 2010-09-07 11:57:52 -0700 | [diff] [blame] | 185 | * Tell the OS that we've just dragged into a View that is willing to accept the drop |
| 186 | */ |
| 187 | void dragRecipientEntered(IWindow window); |
| 188 | |
| 189 | /** |
| 190 | * Tell the OS that we've just dragged *off* of a View that was willing to accept the drop |
| 191 | */ |
| 192 | void dragRecipientExited(IWindow window); |
| 193 | |
| 194 | /** |
Dianne Hackborn | c8a0a75 | 2009-08-10 23:05:49 -0700 | [diff] [blame] | 195 | * For windows with the wallpaper behind them, and the wallpaper is |
| 196 | * larger than the screen, set the offset within the screen. |
Marco Nelissen | bf6956b | 2009-11-09 15:21:13 -0800 | [diff] [blame] | 197 | * For multi screen launcher type applications, xstep and ystep indicate |
| 198 | * how big the increment is from one screen to another. |
Dianne Hackborn | c8a0a75 | 2009-08-10 23:05:49 -0700 | [diff] [blame] | 199 | */ |
Marco Nelissen | bf6956b | 2009-11-09 15:21:13 -0800 | [diff] [blame] | 200 | void setWallpaperPosition(IBinder windowToken, float x, float y, float xstep, float ystep); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 201 | |
Dianne Hackborn | 19382ac | 2009-09-11 21:13:37 -0700 | [diff] [blame] | 202 | void wallpaperOffsetsComplete(IBinder window); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 203 | |
Dianne Hackborn | 067e5f6 | 2014-09-07 23:14:30 -0700 | [diff] [blame] | 204 | /** |
| 205 | * Apply a raw offset to the wallpaper service when shown behind this window. |
| 206 | */ |
| 207 | void setWallpaperDisplayOffset(IBinder windowToken, int x, int y); |
| 208 | |
Dianne Hackborn | 7580493 | 2009-10-20 20:15:20 -0700 | [diff] [blame] | 209 | Bundle sendWallpaperCommand(IBinder window, String action, int x, int y, |
| 210 | int z, in Bundle extras, boolean sync); |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 211 | |
Dianne Hackborn | 7580493 | 2009-10-20 20:15:20 -0700 | [diff] [blame] | 212 | void wallpaperCommandComplete(IBinder window, in Bundle result); |
Dianne Hackborn | a4b7f2f | 2012-05-21 11:28:41 -0700 | [diff] [blame] | 213 | |
Svetoslav Ganov | 1cf70bb | 2012-08-06 10:53:34 -0700 | [diff] [blame] | 214 | /** |
| 215 | * Notifies that a rectangle on the screen has been requested. |
| 216 | */ |
Svetoslav | f7174e8 | 2014-06-12 11:29:35 -0700 | [diff] [blame] | 217 | void onRectangleOnScreenRequested(IBinder token, in Rect rectangle); |
Dianne Hackborn | e3f23a3 | 2013-03-01 13:25:35 -0800 | [diff] [blame] | 218 | |
| 219 | IWindowId getWindowId(IBinder window); |
Jeff Brown | c2932a1 | 2014-11-20 18:04:05 -0800 | [diff] [blame] | 220 | |
| 221 | /** |
| 222 | * When the system is dozing in a low-power partially suspended state, pokes a short |
| 223 | * lived wake lock and ensures that the display is ready to accept the next frame |
| 224 | * of content drawn in the window. |
| 225 | * |
| 226 | * This mechanism is bound to the window rather than to the display manager or the |
| 227 | * power manager so that the system can ensure that the window is actually visible |
| 228 | * and prevent runaway applications from draining the battery. This is similar to how |
| 229 | * FLAG_KEEP_SCREEN_ON works. |
| 230 | * |
| 231 | * This method is synchronous because it may need to acquire a wake lock before returning. |
| 232 | * The assumption is that this method will be called rather infrequently. |
| 233 | */ |
| 234 | void pokeDrawLock(IBinder window); |
Chong Zhang | 8e89b31 | 2015-09-09 15:09:30 -0700 | [diff] [blame] | 235 | |
| 236 | /** |
| 237 | * Starts a task window move with {startX, startY} as starting point. The amount of move |
| 238 | * will be the offset between {startX, startY} and the new cursor position. |
| 239 | * |
| 240 | * Returns true if the move started successfully; false otherwise. |
| 241 | */ |
| 242 | boolean startMovingTask(IWindow window, float startX, float startY); |
Vladislav Kaznacheev | 989b58a | 2016-02-10 12:19:33 -0800 | [diff] [blame] | 243 | |
| 244 | void updatePointerIcon(IWindow window); |
Andrii Kulian | 4b6599e | 2018-01-15 17:24:08 -0800 | [diff] [blame] | 245 | |
| 246 | /** |
| 247 | * Update a tap exclude region with a rectangular area identified by provided id in the window. |
| 248 | * Touches on this region will not switch focus to this window. Passing an empty rect will |
| 249 | * remove the area from the exclude region of this window. |
| 250 | */ |
| 251 | void updateTapExcludeRegion(IWindow window, int regionId, int left, int top, int width, |
| 252 | int height); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 253 | } |