Struct audio_processor_testing_helpers::charts::MultiLineText

pub struct MultiLineText<'a, Coord, T>where
    T: Borrow<str>,{ /* private fields */ }

An multi-line text element. The Text element allows only single line text and the MultiLineText supports drawing multiple lines

Implementations

impl<'a, Coord, T> MultiLineText<'a, Coord, T>where
    T: Borrow<str>,

pub fn new<S>(pos: Coord, style: S) -> MultiLineText<'a, Coord, T>where
    S: Into<TextStyle<'a>>,

Create an empty multi-line text element. Lines can be append to the empty multi-line by calling push_line method

pos: The upper left corner style: The style of the text

pub fn set_line_height(&mut self, value: f64) -> &mut MultiLineText<'a, Coord, T>

Set the line height of the multi-line text element

pub fn push_line<L>(&mut self, line: L)where
    L: Into<T>,

Push a new line into the given multi-line text line: The line to be pushed

pub fn estimate_dimension(
    &self
) -> Result<(i32, i32), <FontDataInternal as FontData>::ErrorType>

Estimate the multi-line text element’s dimension

pub fn relocate(&mut self, coord: Coord)

Move the location to the specified location

impl<'a, T> MultiLineText<'a, (i32, i32), T>where
    T: Borrow<str>,

pub fn compute_line_layout(
    &self
) -> Result<Vec<((i32, i32), (i32, i32)), Global>, <FontDataInternal as FontData>::ErrorType>

Compute the line layout

impl<'a, Coord> MultiLineText<'a, Coord, &'a str>

pub fn from_str<ST, S>(
    text: ST,
    pos: Coord,
    style: S,
    max_width: u32
) -> MultiLineText<'a, Coord, &'a str>where
    ST: Into<&'a str>,
    S: Into<TextStyle<'a>>,

Parse a multi-line text into an multi-line element.

text: The text that is parsed pos: The position of the text style: The style for this text max_width: The width of the multi-line text element, the line will break into two lines if the line is wider than the max_width. If 0 is given, do not do any line wrapping

impl<'a, Coord> MultiLineText<'a, Coord, String>

pub fn from_string<S>(
    text: String,
    pos: Coord,
    style: S,
    max_width: u32
) -> MultiLineText<'a, Coord, String>where
    S: Into<TextStyle<'a>>,

Parse a multi-line text into an multi-line element.

text: The text that is parsed pos: The position of the text style: The style for this text max_width: The width of the multi-line text element, the line will break into two lines if the line is wider than the max_width. If 0 is given, do not do any line wrapping

Trait Implementations

impl<'a, Coord, DB, T> Drawable<DB, BackendCoordOnly> for MultiLineText<'a, Coord, T>where
    Coord: 'a,
    DB: DrawingBackend,
    T: Borrow<str>,

fn draw<I>(
    &self,
    points: I,
    backend: &mut DB,
    (u32, u32)
) -> Result<(), DrawingErrorKind<<DB as DrawingBackend>::ErrorType>>where
    I: Iterator<Item = (i32, i32)>,

Actually draws the element. The key points is already translated into the image coordinate and can be used by DC directly

impl<'b, 'a, Coord, T> PointCollection<'a, Coord, BackendCoordOnly> for &'a MultiLineText<'b, Coord, T>where
    Coord: 'a,
    T: 'a + Borrow<str>,

type Point = &'a Coord

The item in point iterator

type IntoIter = Once<&'a Coord>

The point iterator

fn point_iter(
    self
) -> <&'a MultiLineText<'b, Coord, T> as PointCollection<'a, Coord, BackendCoordOnly>>::IntoIter

framework to do the coordinate mapping