Enum tuirealm::Attribute

pub enum Attribute {
    Alignment,
    Background,
    Borders,
    Color,
    Content,
    Dataset,
    Direction,
    Disabled,
    Display,
    Focus,
    FocusStyle,
    Foreground,
    Height,
    HighlightedStr,
    HighlightedColor,
    InputLength,
    InputType,
    Layout,
    Palette,
    Rewind,
    Shape,
    Scroll,
    ScrollStep,
    Style,
    Text,
    TextAlign,
    TextProps,
    TextWrap,
    Title,
    Value,
    Width,
    Custom(&'static str),
}

Describes a “selector” to query an attribute on props. The selector must identify uniquely an attribute in the properties. Check each attribute documentation to see how they’re supposed to be used, but remember that when implementing a component, you’re free to use each attribute as you prefer!

Variants

Alignment

Layout alignment

Background

Background color or style

Borders

Borders styles

Color

Main color

Content

Component content. Generic purpose

Dataset

Dataset of component; should be associated to AttrValue::Dataset

Direction

Component layout direction

Disabled

Describes whether the component is disabled (e.g. an Input)

Display

Whether to display or not the component. This should be reserved to hide components. As shown in stdlib and in example, its value should be AttrValue::Flag and should be checked on top of the view() method to choose whether to or not to render the component.

Focus

Reserved for tracking focus on component. You should not implement focus by yourself, since it’s already read/written by the active() and blur() methods on view/application. When implementing a component, its value should be read-only. The value is always AttrValue::Flag

FocusStyle

Should be used to use a different style from default when component is not enabled.

Foreground

Foreground color or style

Height

Height size. Useful when building layouts or containers

HighlightedStr

String to prepend to highlighted items in list or other

HighlightedColor

Color to apply to highlighted items

InputLength

Maximum input length for input fields

InputType

Input type for input fields

Layout

Defines a layout

Palette

A map of colors for complex components

Rewind

Intended to decide whether to rewind when reaching boundaries on list/tables

Shape

Intended to store a AttrValue::Shape

Scroll

Should be used to choose whether to make list interactive (scrollable) or not

ScrollStep

Intended as scroll step for fast scroll, for example when using PageUp

Style

Component style

Text

Component text content

TextAlign

Text align

TextProps

Text properties

TextWrap

Whether to wrap text (or how)

Title

Component box title

Value

A generic component value

Width

Component width; useful when using containers or layouts

Custom(&'static str)

A user defined property

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl Hash for Attribute

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 PartialEq for Attribute

fn eq(&self, other: &Attribute) -> 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 for Attribute

fn partial_cmp(&self, other: &Attribute) -> 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 Copy for Attribute

impl Eq for Attribute

impl StructuralPartialEq for Attribute