Home | History | Annotate | Download | only in view
      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.
     14 ** See the License for the specific language governing permissions and
     15 ** limitations under the License.
     16 */
     17 
     18 package android.view;
     19 
     20 import android.content.ClipData;
     21 import android.content.res.Configuration;
     22 import android.graphics.Rect;
     23 import android.graphics.Region;
     24 import android.os.Bundle;
     25 import android.view.InputChannel;
     26 import android.view.IWindow;
     27 import android.view.MotionEvent;
     28 import android.view.WindowManager;
     29 import android.view.Surface;
     30 
     31 /**
     32  * System private per-application interface to the window manager.
     33  *
     34  * {@hide}
     35  */
     36 interface IWindowSession {
     37     int add(IWindow window, int seq, in WindowManager.LayoutParams attrs,
     38             in int viewVisibility, out Rect outContentInsets,
     39             out InputChannel outInputChannel);
     40     int addWithoutInputChannel(IWindow window, int seq, in WindowManager.LayoutParams attrs,
     41             in int viewVisibility, out Rect outContentInsets);
     42     void remove(IWindow window);
     43 
     44     /**
     45      * Change the parameters of a window.  You supply the
     46      * new parameters, it returns the new frame of the window on screen (the
     47      * position should be ignored) and surface of the window.  The surface
     48      * will be invalid if the window is currently hidden, else you can use it
     49      * to draw the window's contents.
     50      *
     51      * @param window The window being modified.
     52      * @param seq Ordering sequence number.
     53      * @param attrs If non-null, new attributes to apply to the window.
     54      * @param requestedWidth The width the window wants to be.
     55      * @param requestedHeight The height the window wants to be.
     56      * @param viewVisibility Window root view's visibility.
     57      * @param flags Request flags: {@link WindowManagerImpl#RELAYOUT_INSETS_PENDING},
     58      * {@link WindowManagerImpl#RELAYOUT_DEFER_SURFACE_DESTROY}.
     59      * @param outFrame Rect in which is placed the new position/size on
     60      * screen.
     61      * @param outContentInsets Rect in which is placed the offsets from
     62      * <var>outFrame</var> in which the content of the window should be
     63      * placed.  This can be used to modify the window layout to ensure its
     64      * contents are visible to the user, taking into account system windows
     65      * like the status bar or a soft keyboard.
     66      * @param outVisibleInsets Rect in which is placed the offsets from
     67      * <var>outFrame</var> in which the window is actually completely visible
     68      * to the user.  This can be used to temporarily scroll the window's
     69      * contents to make sure the user can see it.  This is different than
     70      * <var>outContentInsets</var> in that these insets change transiently,
     71      * so complex relayout of the window should not happen based on them.
     72      * @param outConfiguration New configuration of window, if it is now
     73      * becoming visible and the global configuration has changed since it
     74      * was last displayed.
     75      * @param outSurface Object in which is placed the new display surface.
     76      *
     77      * @return int Result flags: {@link WindowManagerImpl#RELAYOUT_SHOW_FOCUS},
     78      * {@link WindowManagerImpl#RELAYOUT_FIRST_TIME}.
     79      */
     80     int relayout(IWindow window, int seq, in WindowManager.LayoutParams attrs,
     81             int requestedWidth, int requestedHeight, int viewVisibility,
     82             int flags, out Rect outFrame,
     83             out Rect outContentInsets, out Rect outVisibleInsets,
     84             out Configuration outConfig, out Surface outSurface);
     85 
     86     /**
     87      * If a call to relayout() asked to have the surface destroy deferred,
     88      * it must call this once it is okay to destroy that surface.
     89      */
     90     void performDeferredDestroy(IWindow window);
     91 
     92     /**
     93      * Called by a client to report that it ran out of graphics memory.
     94      */
     95     boolean outOfMemory(IWindow window);
     96 
     97     /**
     98      * Give the window manager a hint of the part of the window that is
     99      * completely transparent, allowing it to work with the surface flinger
    100      * to optimize compositing of this part of the window.
    101      */
    102     void setTransparentRegion(IWindow window, in Region region);
    103 
    104     /**
    105      * Tell the window manager about the content and visible insets of the
    106      * given window, which can be used to adjust the <var>outContentInsets</var>
    107      * and <var>outVisibleInsets</var> values returned by
    108      * {@link #relayout relayout()} for windows behind this one.
    109      *
    110      * @param touchableInsets Controls which part of the window inside of its
    111      * frame can receive pointer events, as defined by
    112      * {@link android.view.ViewTreeObserver.InternalInsetsInfo}.
    113      */
    114     void setInsets(IWindow window, int touchableInsets, in Rect contentInsets,
    115             in Rect visibleInsets, in Region touchableRegion);
    116 
    117     /**
    118      * Return the current display size in which the window is being laid out,
    119      * accounting for screen decorations around it.
    120      */
    121     void getDisplayFrame(IWindow window, out Rect outDisplayFrame);
    122 
    123     void finishDrawing(IWindow window);
    124 
    125     void setInTouchMode(boolean showFocus);
    126     boolean getInTouchMode();
    127 
    128     boolean performHapticFeedback(IWindow window, int effectId, boolean always);
    129 
    130     /**
    131      * Allocate the drag's thumbnail surface.  Also assigns a token that identifies
    132      * the drag to the OS and passes that as the return value.  A return value of
    133      * null indicates failure.
    134      */
    135     IBinder prepareDrag(IWindow window, int flags,
    136             int thumbnailWidth, int thumbnailHeight, out Surface outSurface);
    137 
    138     /**
    139      * Initiate the drag operation itself
    140      */
    141     boolean performDrag(IWindow window, IBinder dragToken, float touchX, float touchY,
    142             float thumbCenterX, float thumbCenterY, in ClipData data);
    143 
    144 	/**
    145 	 * Report the result of a drop action targeted to the given window.
    146 	 * consumed is 'true' when the drop was accepted by a valid recipient,
    147 	 * 'false' otherwise.
    148 	 */
    149 	void reportDropResult(IWindow window, boolean consumed);
    150 
    151     /**
    152      * Tell the OS that we've just dragged into a View that is willing to accept the drop
    153      */
    154     void dragRecipientEntered(IWindow window);
    155 
    156     /**
    157      * Tell the OS that we've just dragged *off* of a View that was willing to accept the drop
    158      */
    159     void dragRecipientExited(IWindow window);
    160 
    161     /**
    162      * For windows with the wallpaper behind them, and the wallpaper is
    163      * larger than the screen, set the offset within the screen.
    164      * For multi screen launcher type applications, xstep and ystep indicate
    165      * how big the increment is from one screen to another.
    166      */
    167     void setWallpaperPosition(IBinder windowToken, float x, float y, float xstep, float ystep);
    168 
    169     void wallpaperOffsetsComplete(IBinder window);
    170 
    171     Bundle sendWallpaperCommand(IBinder window, String action, int x, int y,
    172             int z, in Bundle extras, boolean sync);
    173 
    174     void wallpaperCommandComplete(IBinder window, in Bundle result);
    175 }
    176