VerticalTextStyle
class VerticalTextStyle
A style object for vertical text, containing only members supported by VerticalText.
Summary
Public companion properties |
|
|---|---|
VerticalTextStyle |
Default |
Public constructors |
|---|
VerticalTextStyle( |
Public functions |
|
|---|---|
VerticalTextStyle |
copy( |
open operator Boolean |
|
open Int |
hashCode() |
VerticalTextStyle |
merge(other: VerticalTextStyle?)Returns a new |
operator VerticalTextStyle |
plus(other: VerticalTextStyle)Plus operator overload for |
open String |
toString() |
Public properties |
|
|---|---|
Color |
The background color for the text. |
Color |
The text color. |
FontFamily? |
The font family to use when rendering the text. |
String? |
The advanced typography settings for the font. |
TextUnit |
The size of glyphs to use when painting the text. |
FontStyle? |
The typeface variant to use when drawing the letters (e.g., italic). |
FontSynthesis? |
Whether to synthesize font weight and/or style when they are not available in the font family. |
FontWeight? |
The thickness of the glyph strokes. |
LocaleList? |
The locales of the text. |
Public companion properties
Default
val Default: VerticalTextStyle
Default VerticalTextStyle with all members unspecified.
Public constructors
VerticalTextStyle
VerticalTextStyle(
color: Color = Color.Unspecified,
fontSize: TextUnit = TextUnit.Unspecified,
fontWeight: FontWeight? = null,
fontStyle: FontStyle? = null,
fontSynthesis: FontSynthesis? = null,
fontFamily: FontFamily? = null,
fontFeatureSettings: String? = null,
background: Color = Color.Unspecified,
localeList: LocaleList? = null
)
| Parameters | |
|---|---|
color: Color = Color.Unspecified |
The text color. |
fontSize: TextUnit = TextUnit.Unspecified |
The size of glyphs to use when painting the text. |
fontWeight: FontWeight? = null |
The thickness of the glyph strokes. |
fontStyle: FontStyle? = null |
The typeface variant to use when drawing the letters (e.g., italic). |
fontSynthesis: FontSynthesis? = null |
Whether to synthesize font weight and/or style when they are not available in the font family. |
fontFamily: FontFamily? = null |
The font family to use when rendering the text. |
fontFeatureSettings: String? = null |
The advanced typography settings for the font. |
background: Color = Color.Unspecified |
The background color for the text. |
localeList: LocaleList? = null |
The locales of the text. |
Public functions
copy
fun copy(
color: Color = this.color,
fontSize: TextUnit = this.fontSize,
fontWeight: FontWeight? = this.fontWeight,
fontStyle: FontStyle? = this.fontStyle,
fontSynthesis: FontSynthesis? = this.fontSynthesis,
fontFamily: FontFamily? = this.fontFamily,
fontFeatureSettings: String? = this.fontFeatureSettings,
background: Color = this.background,
localeList: LocaleList? = this.localeList
): VerticalTextStyle
merge
fun merge(other: VerticalTextStyle?): VerticalTextStyle
Returns a new VerticalTextStyle that is a combination of this style and the given other style.
If a property is specified in other, it will be used in the result. Otherwise, the property from this style will be used.
plus
operator fun plus(other: VerticalTextStyle): VerticalTextStyle
Plus operator overload for merge.
Public properties
fontFamily
val fontFamily: FontFamily?
The font family to use when rendering the text.
fontFeatureSettings
val fontFeatureSettings: String?
The advanced typography settings for the font.
fontStyle
val fontStyle: FontStyle?
The typeface variant to use when drawing the letters (e.g., italic).
fontSynthesis
val fontSynthesis: FontSynthesis?
Whether to synthesize font weight and/or style when they are not available in the font family.