| /* |
| * Copyright 2018 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package androidx.compose.ui.text.font |
| |
| import androidx.compose.Immutable |
| import androidx.compose.Stable |
| |
| /** |
| * The interface of the font resource. |
| * |
| * @see ResourceFont |
| */ |
| @Immutable |
| interface Font { |
| /** |
| * The weight of the font. The system uses this to match a font to a font request |
| * that is given in a [androidx.compose.ui.text.SpanStyle]. |
| */ |
| val weight: FontWeight |
| |
| /** |
| * The style of the font, normal or italic. The system uses this to match a font to a |
| * font request that is given in a [androidx.compose.ui.text.SpanStyle]. |
| */ |
| val style: FontStyle |
| |
| /** |
| * Interface used to load a font resource. |
| */ |
| interface ResourceLoader { |
| /** |
| * Loads resource represented by the [Font] object. |
| * |
| * @param font [Font] to be loaded |
| * @return platform specific font |
| */ |
| fun load(font: Font): Any |
| } |
| } |
| |
| /** |
| * Defines a font to be used while rendering text with resource ID. |
| * |
| * @sample androidx.compose.ui.text.samples.CustomFontFamilySample |
| * |
| * @param resId The resource ID of the font file in font resources. i.e. "R.font.myfont". |
| * @param weight The weight of the font. The system uses this to match a font to a font request |
| * that is given in a [androidx.compose.ui.text.TextStyle]. |
| * @param style The style of the font, normal or italic. The system uses this to match a font to a |
| * font request that is given in a [androidx.compose.ui.text.TextStyle]. |
| * |
| * @see FontFamily |
| */ |
| data class ResourceFont( |
| val resId: Int, |
| override val weight: FontWeight = FontWeight.Normal, |
| override val style: FontStyle = FontStyle.Normal |
| ) : Font |
| |
| /** |
| * Creates a Font with using resource ID. |
| * |
| * @param resId The resource ID of the font file in font resources. i.e. "R.font.myfont". |
| * @param weight The weight of the font. The system uses this to match a font to a font request |
| * that is given in a [androidx.compose.ui.text.SpanStyle]. |
| * @param style The style of the font, normal or italic. The system uses this to match a font to a |
| * font request that is given in a [androidx.compose.ui.text.SpanStyle]. |
| * |
| * @see FontFamily |
| */ |
| @Stable |
| fun font( |
| resId: Int, |
| weight: FontWeight = FontWeight.Normal, |
| style: FontStyle = FontStyle.Normal |
| ): Font = ResourceFont(resId, weight, style) |
| |
| /** |
| * Create a [FontFamily] from this single [font]. |
| */ |
| @Stable |
| fun Font.asFontFamily() = fontFamily(this) |