• 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.systemui.scene.shared.model
18 
19 import com.android.compose.animation.scene.OverlayKey
20 
21 /**
22  * Keys of all known overlays.
23  *
24  * PLEASE KEEP THE KEYS SORTED ALPHABETICALLY.
25  */
26 object Overlays {
27     /**
28      * The bouncer is the overlay that displays authentication challenges like PIN, password, or
29      * pattern.
30      */
31     @JvmField val Bouncer = OverlayKey("bouncer")
32 
33     /**
34      * The notifications shade overlay primarily shows a scrollable list of notifications.
35      *
36      * It's used only in the dual shade configuration, where there are two separate shades: one for
37      * notifications (this overlay) and another for [QuickSettingsShade].
38      *
39      * It's not used in the single/accordion configuration (swipe down once to reveal the shade,
40      * swipe down again the to expand quick settings) or in the "split" shade configuration (on
41      * large screens or unfolded foldables, where notifications and quick settings are shown
42      * side-by-side in their own columns).
43      */
44     @JvmField val NotificationsShade = OverlayKey("notifications_shade")
45 
46     /**
47      * The quick settings shade overlay shows the quick settings tiles UI.
48      *
49      * It's used only in the dual shade configuration, where there are two separate shades: one for
50      * quick settings (this overlay) and another for [NotificationsShade].
51      *
52      * It's not used in the single/accordion configuration (swipe down once to reveal the shade,
53      * swipe down again the to expand quick settings) or in the "split" shade configuration (on
54      * large screens or unfolded foldables, where notifications and quick settings are shown
55      * side-by-side in their own columns).
56      */
57     @JvmField val QuickSettingsShade = OverlayKey("quick_settings_shade")
58 }
59