lawnchair/src/com/android/launcher3/OnBackPressedHandler.java

/*
 * Copyright (C) 2023 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.launcher3;

import androidx.annotation.FloatRange;

/**
 * Interface that mimics {@link android.window.OnBackInvokedCallback} without dependencies on U's
 * API such as {@link android.window.BackEvent}.
 *
 * <p> Impl can assume below order during a back gesture:
 * <ol>
 *  <li> [optional] one {@link #onBackStarted()} will be called to start the gesture
 *  <li> zero or multiple {@link #onBackProgressed(float)} will be called during swipe gesture
 *  <li> either one of {@link #onBackInvoked()} or {@link #onBackCancelled()} will be called to end
 *  the gesture
 */
public interface OnBackPressedHandler {

    /** Called when back has started. */
    default void onBackStarted() {}

    /** Called when back is committed. */
    void onBackInvoked();

    /** Called with back gesture's progress. */
    default void onBackProgressed(@FloatRange(from = 0.0, to = 1.0) float backProgress) {}

    /** Called when user drops the back gesture. */
    default void onBackCancelled() {}
}