Enum kas_core::theme::TextClass

pub enum TextClass {
    Label(bool),
    LabelScroll,
    AccelLabel(bool),
    Button,
    MenuLabel,
    Edit(bool),
}

Class of text drawn

Themes choose font, font size, colour, and alignment based on this.

Variants

Label(bool)

Label text is drawn over the background colour

This takes one parameter: multi_line. Text is wrapped only if true.

LabelScroll

Scrollable label

This is similar to Label(true), but may occupy less vertical space. Usually it also implies that the text is both scrollable and selectable, but these are characteristics of the widget, not the text object.

AccelLabel(bool)

Label with accelerator keys

This takes one parameter: multi_line. Text is wrapped only if true.

This is identical to Label except that effects are only drawn if accelerator-key mode is activated (usually the Alt key).

Button

Button text is drawn over a button

Same as AccelLabel(false), though theme may differentiate.

MenuLabel

Menu label (single line, does not stretch)

Similar to AccelLabel(false), but with horizontal stretching disabled.

Edit(bool)

Editable text, usually encapsulated in some type of box

This takes one parameter: multi_line. Text is wrapped only if true.

Implementations

impl TextClass

pub fn single_line(self) -> bool

True if text is single-line only

pub fn multi_line(self) -> bool

True if text is multi-line and should automatically line-wrap

Examples found in repository

src/theme/style.rs (line 134)

    pub fn single_line(self) -> bool {
        !self.multi_line()
    }

pub fn is_accel(self) -> bool

True if text effects should only be shown dependant on accelerator-key mode being active

Trait Implementations

impl Clone for TextClass

fn clone(&self) -> TextClass

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextClass

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextClass

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

Deserialize this value from the given Serde deserializer.

impl Hash for TextClass

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 Ord for TextClass

fn cmp(&self, other: &TextClass) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<TextClass> for TextClass

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

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

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

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

impl PartialOrd<TextClass> for TextClass

fn partial_cmp(&self, other: &TextClass) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TextClass

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

Serialize this value into the given Serde serializer.

impl Copy for TextClass

impl Eq for TextClass

impl StructuralEq for TextClass

impl StructuralPartialEq for TextClass