Struct tuirealm::props::builder::GenericPropsBuilder

pub struct GenericPropsBuilder { /* fields omitted */ }

GenericPropsBuilder

This props builder exports methods to set values for all the possible properties. In a normal case you shouldn’t use this builder, unless you can actually customize everything of your component. For a Builder you should always implement only three traits: Default, From<Props> and PropsBuilder, then you should implement the setter methods for it, for the only properties you need for the associated component.

Implementations

impl GenericPropsBuilder

pub fn with_foreground(&mut self, color: Color) -> &mut Self

with_foreground

Set foreground color for component

pub fn with_background(&mut self, color: Color) -> &mut Self

with_background

Set background color for component

pub fn with_borders(
    &mut self,
    borders: Borders,
    variant: BorderType,
    color: Color
) -> &mut Self

with_borders

Set component borders style

pub fn bold(&mut self) -> &mut Self

bold

Set bold property for component

pub fn italic(&mut self) -> &mut Self

italic

Set italic property for component

pub fn underlined(&mut self) -> &mut Self

underlined

Set underlined property for component

pub fn slow_blink(&mut self) -> &mut Self

slow_blink

Set slow_blink property for component

pub fn rapid_blink(&mut self) -> &mut Self

rapid_blink

Set rapid_blink property for component

pub fn reversed(&mut self) -> &mut Self

reversed

Set reversed property for component

pub fn strikethrough(&mut self) -> &mut Self

strikethrough

Set strikethrough property for component

pub fn with_texts(&mut self, texts: TextParts) -> &mut Self

with_texts

Set texts for component

pub fn with_input(&mut self, input_type: InputType) -> &mut Self

with_input

Set input type for component

pub fn with_input_len(&mut self, len: usize) -> &mut Self

with_input_len

Set max input len

pub fn with_custom_color(
    &mut self,
    name: &'static str,
    color: Color
) -> &mut Self

with_custom_color

Set a custom color inside the color palette

pub fn with_value(&mut self, value: PropPayload) -> &mut Self

with_value

Set initial value for component

Trait Implementations

impl Default for GenericPropsBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<Props> for GenericPropsBuilder

fn from(props: Props) -> Self

Performs the conversion.

impl PropsBuilder for GenericPropsBuilder

fn build(&mut self) -> Props

build

fn hidden(&mut self) -> &mut Self

hidden

fn visible(&mut self) -> &mut Self

visible