/*
 * Copyright (C) 2025 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.eyedropper

/**
 * Common interface that every EyeDropper UX mode must implement.
 */
interface EyeDropperController {
    /**
     * Initialize UI components (overlay/listener) capable of 1) Color selection 2) Cancellation.
     *
     * @param onSelectColor sends the selected ARGB color as an integer to the sender of the Intent
     * @param onAbort ends the MainActivity and signals cancellation to the sender of the Intent
     *
     *  Both (1) and (2) end in finish().
     */
    fun showUiOverlay(onSelectColor: (Int) -> Unit, onAbort: () -> Unit)

    /**
     * Undoes showUiOverlay().
     *
     * This routine is the terminal UI logic to be executed before the Activity is destroyed and
     * will be executed in any flow requiring the Activity to be aborted, such as color selection,
     * cancellation, input device change, etc.
     */
    fun removeUiOverlay()
}