1 /* 2 * Copyright (C) 2024 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.wallpaper.picker.customization.ui.viewmodel 18 19 import com.android.wallpaper.picker.customization.ui.util.CustomizationOptionUtil 20 import kotlinx.coroutines.CoroutineScope 21 import kotlinx.coroutines.flow.Flow 22 import kotlinx.coroutines.flow.StateFlow 23 24 interface CustomizationOptionsViewModel { 25 26 val wallpaperCarouselViewModel: WallpaperCarouselViewModel 27 28 val selectedOption: StateFlow<CustomizationOptionUtil.CustomizationOption?> 29 30 /** 31 * View model for the discard changes dialog. The dialog shows when users leave with uncommitted 32 * customization changes. When null, the dialog should hide or dismiss; otherwise, the dialog 33 * should show on the screen. 34 */ 35 val discardChangesDialogViewModel: Flow<DiscardChangesDialogViewModel?> 36 37 /** 38 * Handle back pressed. [CustomizationOptionsViewModel] should deselect the selected option and 39 * return true. If no option is selected, do nothing and return false. 40 * 41 * @return True if back pressed is handled by [CustomizationOptionsViewModel] 42 */ handleBackPressednull43 fun handleBackPressed(): Boolean 44 45 /** Reset all the customization options that are being previewed. */ 46 fun resetPreview() 47 } 48 49 interface CustomizationOptionsViewModelFactory { 50 51 fun create(viewModelScope: CoroutineScope): CustomizationOptionsViewModel 52 } 53