/*
 * Copyright 2021 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 androidx.car.app.navigation.model;

import android.annotation.SuppressLint;

import androidx.annotation.NonNull;
import androidx.car.app.OnDoneCallback;
import androidx.car.app.annotations.CarProtocol;
import androidx.car.app.annotations.RequiresCarApi;

/**
 * A host-side delegate for sending {@link PanModeListener} events to the car app.
 */
@CarProtocol
@RequiresCarApi(2)
public interface PanModeDelegate {
    /**
     * Notifies that the user has entered or exited pan mode.
     *
     * @param isInPanMode   the latest pan mode state.
     * @param callback      the {@link OnDoneCallback} to trigger when the client finishes handling
     *                      the event
     */
    // This mirrors the AIDL class and does not an executor as an input.
    @SuppressLint("ExecutorRegistration")
    void sendPanModeChanged(boolean isInPanMode, @NonNull OnDoneCallback callback);
}