content: /*
   * Copyright (C) 2006 The Android Open Source Project
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package android.view;
  
  import android.annotation.IntDef;
  
  import java.lang.annotation.Retention;
  import java.lang.annotation.RetentionPolicy;
  
  /**
   * Constants for interfacing with WindowManagerService and WindowManagerPolicyInternal.
   * @hide
   */
  public interface WindowManagerPolicyConstants {
      // Policy flags.  These flags are also defined in frameworks/base/include/ui/Input.h.
      int FLAG_WAKE = 0x00000001;
      int FLAG_VIRTUAL = 0x00000002;
  
      int FLAG_INJECTED = 0x01000000;
      int FLAG_TRUSTED = 0x02000000;
      int FLAG_FILTERED = 0x04000000;
      int FLAG_DISABLE_KEY_REPEAT = 0x08000000;
  
      int FLAG_INTERACTIVE = 0x20000000;
      int FLAG_PASS_TO_USER = 0x40000000;
  
      // Flags for IActivityTaskManager.keyguardGoingAway()
      int KEYGUARD_GOING_AWAY_FLAG_TO_SHADE = 1 << 0;
      int KEYGUARD_GOING_AWAY_FLAG_NO_WINDOW_ANIMATIONS = 1 << 1;
      int KEYGUARD_GOING_AWAY_FLAG_WITH_WALLPAPER = 1 << 2;
      int KEYGUARD_GOING_AWAY_FLAG_SUBTLE_WINDOW_ANIMATIONS = 1 << 3;
  
      // Flags used for indicating whether the internal and/or external input devices
      // of some type are available.
      int PRESENCE_INTERNAL = 1 << 0;
      int PRESENCE_EXTERNAL = 1 << 1;
  
      // Navigation bar position values
      int NAV_BAR_INVALID = -1;
      int NAV_BAR_LEFT = 1 << 0;
      int NAV_BAR_RIGHT = 1 << 1;
      int NAV_BAR_BOTTOM = 1 << 2;
  
      // Navigation bar interaction modes
      int NAV_BAR_MODE_3BUTTON = 0;
      int NAV_BAR_MODE_2BUTTON = 1;
      int NAV_BAR_MODE_GESTURAL = 2;
  
      // Associated overlays for each nav bar mode
      String NAV_BAR_MODE_3BUTTON_OVERLAY = "com.android.internal.systemui.navbar.threebutton";
      String NAV_BAR_MODE_2BUTTON_OVERLAY = "com.android.internal.systemui.navbar.twobutton";
      String NAV_BAR_MODE_GESTURAL_OVERLAY = "com.android.internal.systemui.navbar.gestural";
  
      /**
       * Broadcast sent when a user activity is detected.
       */
      String ACTION_USER_ACTIVITY_NOTIFICATION =
              "android.intent.action.USER_ACTIVITY_NOTIFICATION";
  
      /**
       * Sticky broadcast of the current HDMI plugged state.
       */
      String ACTION_HDMI_PLUGGED = "android.intent.action.HDMI_PLUGGED";
  
      /**
       * Extra in {@link #ACTION_HDMI_PLUGGED} indicating the state: true if
       * plugged in to HDMI, false if not.
       */
      String EXTRA_HDMI_PLUGGED_STATE = "state";
  
      /**
       * Set to {@code true} when intent was invoked from pressing the home key.
       * @hide
       */
      String EXTRA_FROM_HOME_KEY = "android.intent.extra.FROM_HOME_KEY";
  
      // TODO: move this to a more appropriate place.
      interface PointerEventListener {
          /**
           * 1. onPointerEvent will be called on the service.UiThread.
           * 2. motionEvent will be recycled after onPointerEvent returns so if it is needed later a
           * copy() must be made and the copy must be recycled.
           **/
          void onPointerEvent(MotionEvent motionEvent);
      }
  
      /** Screen turned off because of a device admin */
      int OFF_BECAUSE_OF_ADMIN = 1;
      /** Screen turned off because of power button */
      int OFF_BECAUSE_OF_USER = 2;
      /** Screen turned off because of timeout */
      int OFF_BECAUSE_OF_TIMEOUT = 3;
  
      @IntDef(prefix = { "ON_BECAUSE_OF_" }, value = {
              ON_BECAUSE_OF_USER,
              ON_BECAUSE_OF_APPLICATION,
              ON_BECAUSE_OF_UNKNOWN,
      })
      @Retention(RetentionPolicy.SOURCE)
      public @interface OnReason{}
  
      /** Convert the on reason to a human readable format */
      static String onReasonToString(@OnReason int why) {
          switch (why) {
              case ON_BECAUSE_OF_USER:
                  return "ON_BECAUSE_OF_USER";
              case ON_BECAUSE_OF_APPLICATION:
                  return "ON_BECAUSE_OF_APPLICATION";
              case ON_BECAUSE_OF_UNKNOWN:
                  return "ON_BECAUSE_OF_UNKNOWN";
              default:
                  return Integer.toString(why);
          }
      }
  
      /** Screen turned on because of a user-initiated action. */
      int ON_BECAUSE_OF_USER = 1;
      /** Screen turned on because of an application request or event */
      int ON_BECAUSE_OF_APPLICATION = 2;
      /** Screen turned on for an unknown reason */
      int ON_BECAUSE_OF_UNKNOWN = 3;
  
      int APPLICATION_LAYER = 2;
      int APPLICATION_MEDIA_SUBLAYER = -2;
      int APPLICATION_MEDIA_OVERLAY_SUBLAYER = -1;
      int APPLICATION_PANEL_SUBLAYER = 1;
      int APPLICATION_SUB_PANEL_SUBLAYER = 2;
      int APPLICATION_ABOVE_SUB_PANEL_SUBLAYER = 3;
  
      /**
       * Convert the off reason to a human readable format.
       */
      static String offReasonToString(int why) {
          switch (why) {
              case OFF_BECAUSE_OF_ADMIN:
                  return "OFF_BECAUSE_OF_ADMIN";
              case OFF_BECAUSE_OF_USER:
                  return "OFF_BECAUSE_OF_USER";
              case OFF_BECAUSE_OF_TIMEOUT:
                  return "OFF_BECAUSE_OF_TIMEOUT";
              default:
                  return Integer.toString(why);
          }
      }
  }
  