/*
 * Copyright (C) 2022 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 com.android.systemui.compose

import android.view.View

/**
 * An initializer to use Compose outside of an Activity, e.g. inside a window added directly using
 * [android.view.WindowManager.addView] (like the shade or status bar) or inside a dialog.
 *
 * Example:
 * ```
 *    windowManager.addView(MyWindowRootView(context), /* layoutParams */)
 *
 *    class MyWindowRootView(context: Context) : FrameLayout(context) {
 *        override fun onAttachedToWindow() {
 *            super.onAttachedToWindow()
 *            ComposeInitializer.onAttachedToWindow(this)
 *        }
 *
 *        override fun onDetachedFromWindow() {
 *            super.onDetachedFromWindow()
 *            ComposeInitializer.onDetachedFromWindow(this)
 *        }
 *    }
 * ```
 */
interface ComposeInitializer {
    /** Function to be called on your window root view's [View.onAttachedToWindow] function. */
    fun onAttachedToWindow(root: View)

    /** Function to be called on your window root view's [View.onDetachedFromWindow] function. */
    fun onDetachedFromWindow(root: View)
}