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.settingslib.preference 18 19 import android.content.Context 20 import androidx.preference.PreferenceScreen 21 22 /** 23 * Interface to provide [PreferenceScreen]. 24 * 25 * When implemented by Activity/Fragment, the Activity/Fragment [Context] APIs (e.g. `getContext()`, 26 * `getActivity()`) MUST not be used: preference screen creation could happen in background service, 27 * where the Activity/Fragment lifecycle callbacks (`onCreate`, `onDestroy`, etc.) are not invoked 28 * and context APIs return null. 29 */ 30 interface PreferenceScreenProvider { 31 32 /** 33 * Creates [PreferenceScreen]. 34 * 35 * Preference screen creation could happen in background service. The implementation MUST use 36 * [PreferenceScreenFactory.context] to obtain context. 37 */ createPreferenceScreennull38 fun createPreferenceScreen(factory: PreferenceScreenFactory): PreferenceScreen? 39 } 40