androidx.preference
Interfaces
TargetFragment |
Interface for |
OnBindEditTextListener |
Interface definition for a callback to be invoked when the corresponding dialog view for this preference is bound. |
OnPreferenceChangeListener |
Interface definition for a callback to be invoked when the value of this |
OnPreferenceClickListener |
Interface definition for a callback to be invoked when a |
SummaryProvider |
Interface definition for a callback to be invoked when the summary of this |
OnPreferenceDisplayDialogCallback |
Interface that the fragment's containing activity should implement to be able to process preference items that wish to display a dialog. |
OnPreferenceStartFragmentCallback |
Interface that the fragment's containing activity should implement to be able to process preference items that wish to switch to a specified fragment. |
OnPreferenceStartScreenCallback |
Interface that the fragment's containing activity should implement to be able to process preference items that wish to switch to a new screen of preferences. |
OnPreferenceDisplayDialogCallback |
Interface that the fragment's containing activity should implement to be able to process preference items that wish to display a dialog. |
OnPreferenceStartFragmentCallback |
Interface that the fragment's containing activity should implement to be able to process preference items that wish to switch to a specified fragment. |
OnPreferenceStartScreenCallback |
Interface that the fragment's containing activity should implement to be able to process preference items that wish to switch to a new screen of preferences. |
PreferencePositionCallback |
Interface for PreferenceGroup adapters to implement so that |
OnDisplayPreferenceDialogListener |
Interface definition for a class that will be called when a |
OnNavigateToScreenListener |
Interface definition for a class that will be called when a |
OnPreferenceTreeClickListener |
Interface definition for a callback to be invoked when a |
Classes
CheckBoxPreference |
A |
DialogPreference |
A base class for |
DropDownPreference |
A |
EditTextPreference |
A |
EditTextPreferenceDialogFragment | |
EditTextPreferenceDialogFragmentCompat | |
ListPreference |
A |
ListPreferenceDialogFragment | |
ListPreferenceDialogFragmentCompat | |
MultiSelectListPreference |
A |
MultiSelectListPreferenceDialogFragment | |
MultiSelectListPreferenceDialogFragmentCompat | |
Preference |
The basic building block that represents an individual setting displayed to a user in the preference hierarchy. |
PreferenceCategory |
A container that is used to group similar |
PreferenceDataStore |
A data store interface to be implemented and provided to the |
PreferenceDialogFragment |
Abstract base class which presents a dialog associated with a |
PreferenceDialogFragmentCompat |
Abstract base class which presents a dialog associated with a |
PreferenceFragment |
Shows a hierarchy of |
PreferenceFragmentCompat |
A PreferenceFragmentCompat is the entry point to using the Preference library. |
PreferenceGroup |
A container for multiple |
PreferenceManager |
Used to help create |
PreferenceScreen |
A top-level container that represents a settings screen. |
PreferenceViewHolder |
A |
SeekBarPreference |
Preference based on android. |
SwitchPreference |
A |
SwitchPreferenceCompat |
A |
TwoStatePreference |
Common base class for preferences that have two selectable states, save a boolean value, and may have dependent preferences that are enabled/disabled based on the current state. |
Extension functions summary
For PreferenceGroup | |
operator Boolean |
PreferenceGroup.contains(preference: Preference) Returns |
Unit |
PreferenceGroup.forEach(action: (preference: Preference) -> Unit) Performs the given action on each preference in this preference group. |
Unit |
PreferenceGroup.forEachIndexed(action: (index: Int, preference: Preference) -> Unit) Performs the given action on each preference in this preference group, providing its sequential index. |
operator T? |
PreferenceGroup.get(key: CharSequence) Returns the preference with |
operator Preference |
PreferenceGroup.get(index: Int) Returns the preference at |
Boolean |
Returns true if this preference group contains no preferences. |
Boolean |
Returns true if this preference group contains one or more preferences. |
operator MutableIterator<Preference> |
Returns a MutableIterator over the preferences in this preference group. |
operator Unit |
PreferenceGroup.minusAssign(preference: Preference) Removes |
operator Unit |
PreferenceGroup.plusAssign(preference: Preference) Adds |
Extension properties summary
For PreferenceGroup | |
Sequence<Preference> |
Returns a Sequence over the preferences in this preference group. |
Int |
Returns the number of preferences in this preference group. |
Extension functions
contains
operator fun PreferenceGroup.contains(preference: Preference): Boolean
Returns true
if preference
is found in this preference group.
forEach
inline fun PreferenceGroup.forEach(action: (preference: Preference) -> Unit): Unit
Performs the given action on each preference in this preference group.
forEachIndexed
inline fun PreferenceGroup.forEachIndexed(action: (index: Int, preference: Preference) -> Unit): Unit
Performs the given action on each preference in this preference group, providing its sequential index.
get
inline operator fun <T : Preference> PreferenceGroup.get(key: