1 /*
2  * Copyright (C) 2022 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.compose
18 
19 import android.view.View
20 
21 /**
22  * An initializer to use Compose outside of an Activity, e.g. inside a window added directly using
23  * [android.view.WindowManager.addView] (like the shade or status bar) or inside a dialog.
24  *
25  * Example:
26  * ```
27  *    windowManager.addView(MyWindowRootView(context), /* layoutParams */)
28  *
29  *    class MyWindowRootView(context: Context) : FrameLayout(context) {
30  *        override fun onAttachedToWindow() {
31  *            super.onAttachedToWindow()
32  *            ComposeInitializer.onAttachedToWindow(this)
33  *        }
34  *
35  *        override fun onDetachedFromWindow() {
36  *            super.onDetachedFromWindow()
37  *            ComposeInitializer.onDetachedFromWindow(this)
38  *        }
39  *    }
40  * ```
41  */
42 interface ComposeInitializer {
43     /** Function to be called on your window root view's [View.onAttachedToWindow] function. */
44     fun onAttachedToWindow(root: View)
45 
46     /** Function to be called on your window root view's [View.onDetachedFromWindow] function. */
47     fun onDetachedFromWindow(root: View)
48 }
49