core/androidx.core.graphics.drawable/IconCompat

IconCompat

open class IconCompat : CustomVersionedParcelable(source)

Helper for accessing features in android.graphics.drawable.Icon.

Constructors

IconCompat

@RestrictTo(value = LIBRARY)

constructor()

Used for VersionedParcelable.

Types

IconType

@RestrictTo(value = LIBRARY)

@Retention(value = RetentionPolicy.SOURCE)

annotation class IconType

Properties

mData

@RestrictTo(value = LIBRARY)

open var mData: @Nullable Array<Byte>

mInt1

@RestrictTo(value = LIBRARY)

open var mInt1: Int

mInt2

@RestrictTo(value = LIBRARY)

open var mInt2: Int

mParcelable

@RestrictTo(value = LIBRARY)

@Nullable

open var mParcelable: @Nullable Parcelable

mString1

@RestrictTo(value = LIBRARY)

@Nullable

open var mString1: @Nullable String

mTintList

@RestrictTo(value = LIBRARY)

@Nullable

open var mTintList: @Nullable ColorStateList

mTintModeStr

@RestrictTo(value = LIBRARY)

@Nullable

open var mTintModeStr: @Nullable String

mType

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open var mType: Int

TYPE_ADAPTIVE_BITMAP

val TYPE_ADAPTIVE_BITMAP: Int = 5

An icon that was created using createWithAdaptiveBitmap.

TYPE_BITMAP

val TYPE_BITMAP: Int = 1

An icon that was created using createWithBitmap.

TYPE_DATA

val TYPE_DATA: Int = 3

An icon that was created using createWithData.

TYPE_RESOURCE

val TYPE_RESOURCE: Int = 2

An icon that was created using createWithResource.

TYPE_UNKNOWN

val TYPE_UNKNOWN: Int = -1

Value returned when the type of an Icon cannot be determined.

TYPE_URI

val TYPE_URI: Int = 4

An icon that was created using createWithContentUri.

TYPE_URI_ADAPTIVE_BITMAP

val TYPE_URI_ADAPTIVE_BITMAP: Int = 6

An icon that was created using createWithAdaptiveBitmapContentUri.

Functions

addToShortcutIntent

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun addToShortcutIntent(@NonNull outIntent: @NonNull Intent, @Nullable badge: @Nullable Drawable, @NonNull c: @NonNull Context)

checkResource

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

open fun checkResource(@NonNull context: @NonNull Context)

createFromBundle

@Nullable

open fun createFromBundle(@NonNull bundle: @NonNull Bundle): @Nullable IconCompat

Extracts an icon from a bundle that was added using toBundle.

createFromIcon

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@RequiresApi(value = 23)

@NonNull

open fun createFromIcon(@NonNull icon: @NonNull Icon): @NonNull IconCompat

@RequiresApi(value = 23)

@NonNull

open fun createFromIcon(@NonNull context: @NonNull Context, @NonNull icon: @NonNull Icon): @NonNull IconCompat

Creates an IconCompat from an Icon.

createFromIconOrNullIfZeroResId

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@RequiresApi(value = 23)

@Nullable

open fun createFromIconOrNullIfZeroResId(@NonNull icon: @NonNull Icon): @Nullable IconCompat

Creates an IconCompat from an Icon, or returns null if the given Icon is created from resource 0.

createWithAdaptiveBitmap

@NonNull

open fun createWithAdaptiveBitmap(@NonNull bits: @NonNull Bitmap): @NonNull IconCompat

Create an Icon pointing to a bitmap in memory that follows the icon design guideline defined by android.graphics.drawable.AdaptiveIconDrawable.

createWithAdaptiveBitmapContentUri

@NonNull

open fun createWithAdaptiveBitmapContentUri(@NonNull uri: @NonNull Uri): @NonNull IconCompat

@NonNull

open fun createWithAdaptiveBitmapContentUri(@NonNull uri: @NonNull String): @NonNull IconCompat

Create an Icon pointing to an image file specified by URI.

createWithBitmap

@NonNull

open fun createWithBitmap(@NonNull bits: @NonNull Bitmap): @NonNull IconCompat

Create an Icon pointing to a bitmap in memory.

createWithContentUri

@NonNull

open fun createWithContentUri(@NonNull uri: @NonNull Uri): @NonNull IconCompat

@NonNull

open fun createWithContentUri(@NonNull uri: @NonNull String): @NonNull IconCompat

Create an Icon pointing to an image file specified by URI.

createWithData

@NonNull

open fun createWithData(data: @NonNull Array<Byte>, offset: Int, length: Int): @NonNull IconCompat

Create an Icon pointing to a compressed bitmap stored in a byte array.

createWithResource

@NonNull

open fun createWithResource(@NonNull context: @NonNull Context, @DrawableRes resId: Int): @NonNull IconCompat

Create an Icon pointing to a drawable resource.

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@NonNull

open fun createWithResource(@Nullable r: @Nullable Resources, @NonNull pkg: @NonNull String, @DrawableRes resId: Int): @NonNull IconCompat

getBitmap

@RestrictTo(value = LIBRARY_GROUP_PREFIX)

@Nullable

open fun getBitmap(): @Nullable Bitmap

Gets the bitmap used to create this icon.

getResId

@DrawableRes

open fun getResId(): Int

Gets the drawable resource id used to create this icon.

getResPackage

@NonNull

open fun getResPackage(): @NonNull String

Gets the package used to create this icon.

getType

open fun getType(): Int

Gets the type of the icon provided.

getUri

@NonNull

open fun getUri(): @NonNull Uri

Gets the uri used to create this icon.

getUriInputStream

@RestrictTo(value = LIBRARY_GROUP)

@Nullable

open fun getUriInputStream(@NonNull context: @NonNull Context): @Nullable InputStream

Create an input stream for bitmap by resolving corresponding content uri.

loadDrawable

@Nullable

open fun loadDrawable(@NonNull context: @NonNull Context): @Nullable Drawable

Returns a Drawable that can be used to draw the image inside this Icon, constructing it if necessary.

onPostParceling

open fun onPostParceling()

onPreParceling

open fun onPreParceling(isStream: Boolean)

setTint

@NonNull

open fun setTint(@ColorInt tint: Int): @NonNull IconCompat

Store a color to use whenever this Icon is drawn.

setTintList

@NonNull

open fun setTintList(@Nullable tintList: @Nullable ColorStateList): @NonNull IconCompat

Store a color to use whenever this Icon is drawn.

setTintMode

@NonNull

open fun setTintMode(mode: @Nullable PorterDuff.Mode): @NonNull IconCompat

Store a blending mode to use whenever this Icon is drawn.

toBundle

@NonNull

open fun toBundle(): @NonNull Bundle

Adds this Icon to a Bundle that can be read back with the same parameters to createFromBundle.

toIcon

@RequiresApi(value = 23)

@NonNull

open fun ~~toIcon~~(): @NonNull Icon

@RequiresApi(value = 23)

@NonNull

open fun toIcon(@Nullable context: @Nullable Context): @NonNull Icon

Convert this compat object to Icon object.

toString

@NonNull

open fun toString(): @NonNull String