Struct unsegen::base::style::TextFormatModifier

pub struct TextFormatModifier {
    pub bold: BoolModifyMode,
    pub italic: BoolModifyMode,
    pub invert: BoolModifyMode,
    pub underline: BoolModifyMode,
    // some fields omitted
}

Specifies how to modify a text format value.

Fields

bold: BoolModifyMode

italic: BoolModifyMode

invert: BoolModifyMode

underline: BoolModifyMode

Implementations

impl TextFormatModifier

pub fn new() -> Self

Construct a new (not actually) modifier, that leaves all properties unchanged.

pub fn bold<M: Into<BoolModifyMode>>(self, val: M) -> Self

Set the bold property of the TextFormatModifier

Examples:

use unsegen::base::{TextFormatModifier, BoolModifyMode};

assert_eq!(TextFormatModifier::new().bold(BoolModifyMode::Toggle).bold,
BoolModifyMode::Toggle);

pub fn italic<M: Into<BoolModifyMode>>(self, val: M) -> Self

Set the italic property of the TextFormatModifier

Examples:

use unsegen::base::{TextFormatModifier, BoolModifyMode};

assert_eq!(TextFormatModifier::new().italic(BoolModifyMode::True).italic,
BoolModifyMode::True);

pub fn invert<M: Into<BoolModifyMode>>(self, val: M) -> Self

Set the invert property of the TextFormatModifier

Examples:

use unsegen::base::{TextFormatModifier, BoolModifyMode};

assert_eq!(TextFormatModifier::new().invert(BoolModifyMode::False).invert,
BoolModifyMode::False);

pub fn underline<M: Into<BoolModifyMode>>(self, val: M) -> Self

Set underline invert property of the TextFormatModifier

Examples:

use unsegen::base::{TextFormatModifier, BoolModifyMode};

assert_eq!(TextFormatModifier::new().underline(BoolModifyMode::LeaveUnchanged).underline,
BoolModifyMode::LeaveUnchanged);

pub fn on_top_of(self, other: TextFormatModifier) -> Self

Combine the current value with that of the argument so that the application of the returned value is always equivalent to first applying other and then applying self to some TextFormat.

Examples:

use unsegen::base::{TextFormatModifier, TextFormat, BoolModifyMode};

let mut f1 = TextFormat::default();
let mut f2 = f1;

let m1 =
TextFormatModifier::new().italic(BoolModifyMode::Toggle).bold(true).underline(false);
let m2 = TextFormatModifier::new().italic(true).bold(false);

m1.on_top_of(m2).modify(&mut f1);

m2.modify(&mut f2);
m1.modify(&mut f2);

assert_eq!(f1, f2);

pub fn modify(self, format: &mut TextFormat)

Modify the passed textformat according to the modification rules of self.

Trait Implementations

impl Clone for TextFormatModifier

fn clone(&self) -> TextFormatModifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TextFormatModifier

impl Debug for TextFormatModifier

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

Formats the value using the given formatter.

impl Default for TextFormatModifier

fn default() -> Self

Returns the "default value" for a type.

impl Eq for TextFormatModifier

impl PartialEq<TextFormatModifier> for TextFormatModifier

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for TextFormatModifier

impl StructuralPartialEq for TextFormatModifier