Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
@get:Nullable
val activity: FragmentActivity?
Link copied to clipboard
@get:Nullable
var arguments: Bundle?
Link copied to clipboard
@get:Nullable
@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
open val callbackFragment: Fragment?
Link copied to clipboard
@get:NonNull
val childFragmentManager: FragmentManager
Link copied to clipboard
@get:Nullable
open val context: Context?
Link copied to clipboard
@get:NonNull
@get:CallSuper
open val defaultViewModelCreationExtras: CreationExtras
Link copied to clipboard
@get:NonNull
open val defaultViewModelProviderFactory: ViewModelProvider.Factory
Link copied to clipboard
@get:Nullable
open var enterTransition: Any?
Link copied to clipboard
@get:Nullable
open var exitTransition: Any?
Link copied to clipboard
@get:Nullable
val fragmentManager: FragmentManager?
Link copied to clipboard
@get:Nullable
val host: Any?
Link copied to clipboard
val id: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
val isMenuVisible: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@get:NonNull
val layoutInflater: LayoutInflater
Link copied to clipboard
@get:NonNull
open val lifecycle: Lifecycle
Link copied to clipboard
val listView: RecyclerView?
Link copied to clipboard
@get:NonNull
open val loaderManager: LoaderManager
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY])
@Nullable
var mPreviousWho: String?
Link copied to clipboard
@get:Nullable
val parentFragment: Fragment?
Link copied to clipboard
@get:NonNull
val parentFragmentManager: FragmentManager
Link copied to clipboard
open val preferenceManager: PreferenceManager?
Link copied to clipboard
open var preferenceScreen: PreferenceScreen?
Link copied to clipboard
@get:Nullable
open var reenterTransition: Any?
Link copied to clipboard
@get:NonNull
val resources: Resources
Link copied to clipboard
Link copied to clipboard
@get:Nullable
open var returnTransition: Any?
Link copied to clipboard
@get:NonNull
val savedStateRegistry: SavedStateRegistry
Link copied to clipboard
@get:Nullable
open var sharedElementEnterTransition: Any?
Link copied to clipboard
@get:Nullable
open var sharedElementReturnTransition: Any?
Link copied to clipboard
@get:Nullable
val tag: String?
Link copied to clipboard
@get:Nullable
val targetFragment: Fragment?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@get:Nullable
open val view: View?
Link copied to clipboard
@get:MainThread
@get:NonNull
open val viewLifecycleOwner: LifecycleOwner
Link copied to clipboard
@get:NonNull
open val viewLifecycleOwnerLiveData: LiveData<LifecycleOwner?>
Link copied to clipboard
@get:NonNull
open val viewModelStore: ViewModelStore

Functions

Link copied to clipboard
open fun addPreferencesFromResource(@XmlRes preferencesResId: Int)
Link copied to clipboard
open fun dump(@NonNull prefix: String, @Nullable fd: FileDescriptor?, @NonNull writer: PrintWriter, @Nullable args: Array<out String?>??)
Link copied to clipboard
@Nullable
open fun <T : Preference?> findPreference(@NonNull key: CharSequence): T?
Link copied to clipboard
fun Fragment.getChooseFolderLauncher(dirSelected: (uri: Uri?, path: String?) -> Unit): ActivityResultLauncher<Uri?>
Link copied to clipboard
fun PreferenceFragmentCompat?.getPref(id: Int): Preference?
Link copied to clipboard
Link copied to clipboard
@NonNull
fun getString(@StringRes resId: Int): String
@NonNull
fun getString(@StringRes resId: Int, @Nullable vararg formatArgs: Any?): String
Link copied to clipboard
@NonNull
fun getText(@StringRes resId: Int): CharSequence
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
fun hasOptionsMenu(): Boolean
Link copied to clipboard
fun Fragment.hideKeyboard()
Link copied to clipboard
fun PreferenceFragmentCompat?.hidePrefs(ids: List<Int>, layoutFlags: Int)

Hide many Preferences on selected layouts.

Link copied to clipboard
@MainThread
@CallSuper
open fun onActivityCreated(@Nullable savedInstanceState: Bundle?)
Link copied to clipboard
open fun onActivityResult(requestCode: Int, resultCode: Int, @Nullable data: Intent?)
Link copied to clipboard
@MainThread
@CallSuper
open fun onAttach(@NonNull activity: Activity)
@MainThread
@CallSuper
open fun onAttach(@NonNull context: Context)
Link copied to clipboard
@MainThread
open fun onAttachFragment(@NonNull childFragment: Fragment)
Link copied to clipboard
open override fun onAuthenticationError()
Link copied to clipboard
open override fun onAuthenticationSuccess()
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
protected open fun onBindPreferences()
Link copied to clipboard
open override fun onConfigurationChanged(newConfig: Configuration)
Link copied to clipboard
@MainThread
open fun onContextItemSelected(@NonNull item: MenuItem): Boolean
Link copied to clipboard
open fun onCreate(@Nullable savedInstanceState: Bundle?)
Link copied to clipboard
@NonNull
protected open fun onCreateAdapter(@NonNull preferenceScreen: PreferenceScreen): RecyclerView.Adapter<*>
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateAnimation(transit: Int, enter: Boolean, nextAnim: Int): Animation?
Link copied to clipboard
@MainThread
@Nullable
open fun onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int): Animator?
Link copied to clipboard
@MainThread
open fun onCreateContextMenu(@NonNull menu: ContextMenu, @NonNull v: View, @Nullable menuInfo: ContextMenu.ContextMenuInfo?)
Link copied to clipboard
@NonNull
open fun onCreateLayoutManager(): RecyclerView.LayoutManager
Link copied to clipboard
@MainThread
open fun onCreateOptionsMenu(@NonNull menu: Menu, @NonNull inflater: MenuInflater)
Link copied to clipboard
open override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?)
Link copied to clipboard
@NonNull
open fun onCreateRecyclerView(@NonNull inflater: LayoutInflater, @NonNull parent: ViewGroup, @Nullable savedInstanceState: Bundle?): RecyclerView
Link copied to clipboard
@NonNull
open fun onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup?, @Nullable savedInstanceState: Bundle?): View
Link copied to clipboard
@MainThread
@CallSuper
open fun onDestroy()
Link copied to clipboard
@MainThread
open fun onDestroyOptionsMenu()
Link copied to clipboard
open fun onDestroyView()
Link copied to clipboard
@MainThread
@CallSuper
open fun onDetach()
Link copied to clipboard
open fun onDisplayPreferenceDialog(@NonNull preference: Preference)
Link copied to clipboard
@NonNull
open fun onGetLayoutInflater(@Nullable savedInstanceState: Bundle?): LayoutInflater
Link copied to clipboard
@MainThread
open fun onHiddenChanged(hidden: Boolean)
Link copied to clipboard
@UiThread
@CallSuper
open fun onInflate(@NonNull activity: Activity, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)
@UiThread
@CallSuper
open fun onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet, @Nullable savedInstanceState: Bundle?)
Link copied to clipboard
@MainThread
@CallSuper
open fun onLowMemory()
Link copied to clipboard
open fun onMultiWindowModeChanged(isInMultiWindowMode: Boolean)
Link copied to clipboard
open fun onNavigateToScreen(@NonNull preferenceScreen: PreferenceScreen)
Link copied to clipboard
@MainThread
open fun onOptionsItemSelected(@NonNull item: MenuItem): Boolean
Link copied to clipboard
@MainThread
open fun onOptionsMenuClosed(@NonNull menu: Menu)
Link copied to clipboard
@MainThread
@CallSuper
open fun onPause()
Link copied to clipboard
open fun onPictureInPictureModeChanged(isInPictureInPictureMode: Boolean)
Link copied to clipboard
open fun onPreferenceTreeClick(@NonNull preference: Preference): Boolean
Link copied to clipboard
@MainThread
open fun onPrepareOptionsMenu(@NonNull menu: Menu)
Link copied to clipboard
@MainThread
open fun onPrimaryNavigationFragmentChanged(isPrimaryNavigationFragment: Boolean)
Link copied to clipboard
open fun onRequestPermissionsResult(requestCode: Int, @NonNull permissions: Array<out String?>, @NonNull grantResults: IntArray)
Link copied to clipboard
@MainThread
@CallSuper
open fun onResume()
Link copied to clipboard
open fun onSaveInstanceState(@NonNull outState: Bundle)
Link copied to clipboard
open fun onStart()
Link copied to clipboard
open fun onStop()
Link copied to clipboard
@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])
protected open fun onUnbindPreferences()
Link copied to clipboard
open override fun onViewCreated(view: View, savedInstanceState: Bundle?)
Link copied to clipboard
@MainThread
@CallSuper
open fun onViewStateRestored(@Nullable savedInstanceState: Bundle?)
Link copied to clipboard
fun Fragment.pickDownloadPath(uri: Uri?, path: String?)
Link copied to clipboard
fun postponeEnterTransition(duration: Long, @NonNull timeUnit: TimeUnit)
Link copied to clipboard
@MainThread
@NonNull
fun <I : Any?, O : Any?> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull callback: ActivityResultCallback<O>): ActivityResultLauncher<I?>
@MainThread
@NonNull
fun <I : Any?, O : Any?> registerForActivityResult(@NonNull contract: ActivityResultContract<I, O>, @NonNull registry: ActivityResultRegistry, @NonNull callback: ActivityResultCallback<O>): ActivityResultLauncher<I?>
Link copied to clipboard
open fun registerForContextMenu(@NonNull view: View)
Link copied to clipboard
fun requestPermissions(@NonNull permissions: Array<out String?>, requestCode: Int)
Link copied to clipboard
@NonNull
fun requireActivity(): FragmentActivity
Link copied to clipboard
@NonNull
fun requireArguments(): Bundle
Link copied to clipboard
@NonNull
fun requireContext(): Context
Link copied to clipboard
@NonNull
fun requireFragmentManager(): FragmentManager
Link copied to clipboard
@NonNull
fun requireHost(): Any
Link copied to clipboard
@NonNull
fun requireParentFragment(): Fragment
Link copied to clipboard
@NonNull
fun requireView(): View
Link copied to clipboard
open fun scrollToPreference(@NonNull preference: Preference)
open fun scrollToPreference(@NonNull key: String)
Link copied to clipboard
open fun setDivider(@Nullable divider: Drawable?)
Link copied to clipboard
open fun setDividerHeight(height: Int)
Link copied to clipboard
open fun setEnterSharedElementCallback(@Nullable callback: SharedElementCallback?)
Link copied to clipboard
open fun setExitSharedElementCallback(@Nullable callback: SharedElementCallback?)
Link copied to clipboard
open fun setHasOptionsMenu(hasMenu: Boolean)
Link copied to clipboard
open fun setInitialSavedState(@Nullable state: Fragment.SavedState?)
Link copied to clipboard
open fun setMenuVisibility(menuVisible: Boolean)
Link copied to clipboard
fun PreferenceFragmentCompat.setPaddingBottom()

On TV you cannot properly scroll to the bottom of settings, this fixes that.

Link copied to clipboard
open fun setPreferencesFromResource(@XmlRes preferencesResId: Int, @Nullable key: String?)
Link copied to clipboard
fun Fragment.setSystemBarsPadding()
Link copied to clipboard
open fun setTargetFragment(@Nullable fragment: Fragment?, requestCode: Int)
Link copied to clipboard
fun Fragment?.setToolBarScrollFlags()
fun PreferenceFragmentCompat.setToolBarScrollFlags()
Link copied to clipboard
fun Fragment?.setUpToolbar(@StringRes title: Int)
fun Fragment?.setUpToolbar(title: String)
Link copied to clipboard
open fun shouldShowRequestPermissionRationale(@NonNull permission: String): Boolean
Link copied to clipboard
open fun startActivity(@NonNull intent: Intent)
open fun startActivity(@NonNull intent: Intent, @Nullable options: Bundle?)
Link copied to clipboard
open fun startActivityForResult(@NonNull intent: Intent, requestCode: Int)
open fun startActivityForResult(@NonNull intent: Intent, requestCode: Int, @Nullable options: Bundle?)
Link copied to clipboard
open fun startIntentSenderForResult(@NonNull intent: IntentSender, requestCode: Int, @Nullable fillInIntent: Intent?, flagsMask: Int, flagsValues: Int, extraFlags: Int, @Nullable options: Bundle?)
Link copied to clipboard
Link copied to clipboard
open fun unregisterForContextMenu(@NonNull view: View)