Struct cosmic::cosmic_theme::ThemeBuilder

pub struct ThemeBuilder {

    pub palette: CosmicPalette,
    pub spacing: Spacing,
    pub corner_radii: CornerRadii,
    pub neutral_tint: Option<Rgb>,
    pub bg_color: Option<Alpha<Rgb, f32>>,
    pub primary_container_bg: Option<Alpha<Rgb, f32>>,
    pub secondary_container_bg: Option<Alpha<Rgb, f32>>,
    pub text_tint: Option<Rgb>,
    pub accent: Option<Rgb>,
    pub success: Option<Rgb>,
    pub warning: Option<Rgb>,
    pub destructive: Option<Rgb>,
    pub is_frosted: bool,
    pub gaps: (u32, u32),
    pub active_hint: u32,
    pub window_hint: Option<Rgb>,
}

Helper for building customized themes

Fields

palette: CosmicPalette

override the palette for the builder

spacing: Spacing

override spacing for the builder

corner_radii: CornerRadii

override corner radii for the builder

neutral_tint: Option<Rgb>

override neutral_tint for the builder

bg_color: Option<Alpha<Rgb, f32>>

override bg_color for the builder

primary_container_bg: Option<Alpha<Rgb, f32>>

override the primary container bg color for the builder

secondary_container_bg: Option<Alpha<Rgb, f32>>

override the secontary container bg color for the builder

text_tint: Option<Rgb>

override the text tint for the builder

accent: Option<Rgb>

override the accent color for the builder

success: Option<Rgb>

override the success color for the builder

warning: Option<Rgb>

override the warning color for the builder

destructive: Option<Rgb>

override the destructive color for the builder

is_frosted: bool

enabled blurred transparency

gaps: (u32, u32)

cosmic-comp window gaps size (outer, inner)

active_hint: u32

cosmic-comp active hint window outline width

window_hint: Option<Rgb>

cosmic-comp custom window hint color

Implementations

impl ThemeBuilder

pub fn set_palette( &mut self, config: &Config, value: CosmicPalette, ) -> Result<bool, Error>

Sets ThemeBuilder::palette and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_spacing( &mut self, config: &Config, value: Spacing, ) -> Result<bool, Error>

Sets ThemeBuilder::spacing and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_corner_radii( &mut self, config: &Config, value: CornerRadii, ) -> Result<bool, Error>

Sets ThemeBuilder::corner_radii and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_neutral_tint( &mut self, config: &Config, value: Option<Rgb>, ) -> Result<bool, Error>

Sets ThemeBuilder::neutral_tint and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_bg_color( &mut self, config: &Config, value: Option<Alpha<Rgb, f32>>, ) -> Result<bool, Error>

Sets ThemeBuilder::bg_color and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_primary_container_bg( &mut self, config: &Config, value: Option<Alpha<Rgb, f32>>, ) -> Result<bool, Error>

Sets ThemeBuilder::primary_container_bg and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_secondary_container_bg( &mut self, config: &Config, value: Option<Alpha<Rgb, f32>>, ) -> Result<bool, Error>

Sets ThemeBuilder::secondary_container_bg and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_text_tint( &mut self, config: &Config, value: Option<Rgb>, ) -> Result<bool, Error>

Sets ThemeBuilder::text_tint and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_accent( &mut self, config: &Config, value: Option<Rgb>, ) -> Result<bool, Error>

Sets ThemeBuilder::accent and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_success( &mut self, config: &Config, value: Option<Rgb>, ) -> Result<bool, Error>

Sets ThemeBuilder::success and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_warning( &mut self, config: &Config, value: Option<Rgb>, ) -> Result<bool, Error>

Sets ThemeBuilder::warning and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_destructive( &mut self, config: &Config, value: Option<Rgb>, ) -> Result<bool, Error>

Sets ThemeBuilder::destructive and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_is_frosted( &mut self, config: &Config, value: bool, ) -> Result<bool, Error>

Sets ThemeBuilder::is_frosted and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_gaps( &mut self, config: &Config, value: (u32, u32), ) -> Result<bool, Error>

Sets ThemeBuilder::gaps and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_active_hint( &mut self, config: &Config, value: u32, ) -> Result<bool, Error>

Sets ThemeBuilder::active_hint and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

pub fn set_window_hint( &mut self, config: &Config, value: Option<Rgb>, ) -> Result<bool, Error>

Sets ThemeBuilder::window_hint and writes to cosmic_config::Config if changed

Returns Ok(true) when the field’s value has changed and was written to disk

impl ThemeBuilder

pub fn dark() -> ThemeBuilder

Get a builder that is initialized with the default dark theme

pub fn light() -> ThemeBuilder

Get a builder that is initialized with the default light theme

pub fn dark_high_contrast() -> ThemeBuilder

Get a builder that is initialized with the default dark high contrast theme

pub fn light_high_contrast() -> ThemeBuilder

Get a builder that is initialized with the default light high contrast theme

pub fn palette(palette: CosmicPalette) -> ThemeBuilder

Get a builder that is initialized with the provided palette

pub fn spacing(self, spacing: Spacing) -> ThemeBuilder

set the spacing of the builder

pub fn corner_radii(self, corner_radii: CornerRadii) -> ThemeBuilder

set the corner radii of the builder

pub fn neutral_tint(self, tint: Rgb) -> ThemeBuilder

apply a neutral tint to the palette

pub fn text_tint(self, tint: Rgb) -> ThemeBuilder

apply a text tint to the palette

pub fn bg_color(self, c: Alpha<Rgb, f32>) -> ThemeBuilder

apply a background color to the palette

pub fn primary_container_bg(self, c: Alpha<Rgb, f32>) -> ThemeBuilder

apply a primary container background color to the palette

pub fn accent(self, c: Rgb) -> ThemeBuilder

apply a accent color to the palette

pub fn success(self, c: Rgb) -> ThemeBuilder

apply a success color to the palette

pub fn warning(self, c: Rgb) -> ThemeBuilder

apply a warning color to the palette

pub fn destructive(self, c: Rgb) -> ThemeBuilder

apply a destructive color to the palette

pub fn build(self) -> Theme

build the theme

pub fn dark_config() -> Result<Config, Error>

Get the builder for the dark config

pub fn light_config() -> Result<Config, Error>

Get the builder for the light config

Trait Implementations

impl Clone for ThemeBuilder

fn clone(&self) -> ThemeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CosmicConfigEntry for ThemeBuilder

const VERSION: u64 = 1u64

fn write_entry(&self, config: &Config) -> Result<(), Error>

fn get_entry( config: &Config, ) -> Result<ThemeBuilder, (Vec<Error>, ThemeBuilder)>

fn update_keys<T>( &mut self, config: &Config, changed_keys: &[T], ) -> (Vec<Error>, Vec<&'static str>)

where T: AsRef<str>,

Returns the keys that were updated

impl Debug for ThemeBuilder

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

Formats the value using the given formatter.

impl Default for ThemeBuilder

fn default() -> ThemeBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ThemeBuilder

fn deserialize<__D>( __deserializer: __D, ) -> Result<ThemeBuilder, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ThemeBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ThemeBuilder

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ThemeBuilder