Struct ThemeVariant 

pub struct ThemeVariant(/* private fields */);

Specifies a UI theme variant that should be used for the control and application types.

Theme variants are compared by their key.

Implementations

impl ThemeVariant

pub fn new( key: impl Into<ResourceKey>, inherit_variant: Option<ThemeVariant>, ) -> Self

Creates a theme variant.

key is the key of the custom theme variant. inherit_variant is the variant that this variant inherits from: if set, a resource that is missing from the theme dictionary of the current variant is looked up in the dictionary of the inherited one. Inheriting the default variant is not supported.

pub fn default() -> ThemeVariant

Use the default theme variant: inherit the variant from the parent, and at the root use the variant of the platform.

pub fn light() -> ThemeVariant

Use the Light theme variant.

pub fn dark() -> ThemeVariant

Use the Dark theme variant.

pub fn actual_theme_variant_property() -> &'static StyledProperty<Option<ThemeVariant>>

Defines the ActualThemeVariant property: the theme variant in effect for an element, inherited down the tree. It is None until a root or an element with a requested variant sets it.

pub fn requested_theme_variant_property() -> &'static StyledProperty<Option<ThemeVariant>>

Defines the RequestedThemeVariant property: the theme variant requested for an element and its descendants.

pub fn key(&self) -> &ResourceKey

Key of the theme variant by which variants are compared.

pub fn inherit_variant(&self) -> Option<ThemeVariant>

The theme variant that this variant inherits from.

pub fn update_actual_theme_variant(target: &FerroObject)

Updates the actual theme variant of target from its requested theme variant: a requested variant other than the default becomes the actual one, otherwise the actual variant is inherited.

pub fn register_theme_variant_root_type(type_: &'static TypeInfo)

Declares that the objects of a class that is not a styled element (the application class) are roots of theme variant resolution. Styled elements say so through the is_theme_variant_root virtual. (Upstream: the IThemeVariantRoot interface.)

pub fn to_platform_theme_variant( theme_variant: Option<&ThemeVariant>, ) -> Option<PlatformThemeVariant>

The platform theme variant of a theme variant (the original’s explicit conversion to a nullable platform theme variant): the light and the dark variant convert to their counterparts, another variant converts as the variant it inherits from, and a variant that inherits from neither, or no variant, converts to nothing.

Trait Implementations

impl Clone for ThemeVariant

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThemeVariant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ThemeVariant

fn default() -> Self

Returns the “default value” for a type.

impl Display for ThemeVariant

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ThemeVariant

impl From<PlatformThemeVariant> for ThemeVariant

The original’s explicit conversion from a platform theme variant.

fn from(theme_variant: PlatformThemeVariant) -> Self

Converts to this type from the input type.

impl FromStr for ThemeVariant

fn from_str(s: &str) -> Result<Self, Self::Err>

Converts the name of a built in theme variant.

type Err = ThemeVariantParseError

The associated error which can be returned from parsing.

impl Hash for ThemeVariant

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MarkupTyped for ThemeVariant

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for ThemeVariant

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.