Struct HighlightedLabel 

pub struct HighlightedLabel { /* private fields */ }

Implementations

impl HighlightedLabel

pub fn new( label: impl Into<SharedString>, highlight_indices: Vec<usize>, ) -> Self

Constructs a label with the given characters highlighted. Characters are identified by UTF-8 byte position.

pub fn from_ranges( label: impl Into<SharedString>, highlight_ranges: Vec<Range<usize>>, ) -> Self

Constructs a label with the given byte ranges highlighted. Assumes that the highlight ranges are valid UTF-8 byte positions.

pub fn text(&self) -> &str

pub fn highlight_indices(&self) -> &[usize]

impl HighlightedLabel

pub fn flex_1(self) -> Self

pub fn flex_none(self) -> Self

pub fn flex_grow(self) -> Self

pub fn flex_shrink(self) -> Self

pub fn flex_shrink_0(self) -> Self

Trait Implementations

impl Component for HighlightedLabel

fn scope() -> ComponentScope

Returns the scope of the component.

fn name() -> &'static str

The name of the component.

fn description() -> Option<&'static str>

An optional description of the component.

fn preview(_window: &mut Window, _cx: &mut App) -> Option<AnyElement>

The component’s preview.

fn id() -> ComponentId

The component’s unique identifier.

fn status() -> ComponentStatus

The ready status of this component.

fn sort_name() -> &'static str

Returns a name that the component should be sorted by.

impl IntoElement for HighlightedLabel

type Element = Component<HighlightedLabel>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl LabelCommon for HighlightedLabel

fn size(self, size: LabelSize) -> Self

Sets the size of the label using a LabelSize.

fn weight(self, weight: FontWeight) -> Self

Sets the font weight of the label.

fn line_height_style(self, line_height_style: LineHeightStyle) -> Self

Sets the line height style of the label using a LineHeightStyle.

fn color(self, color: Color) -> Self

Sets the color of the label using a Color.

fn strikethrough(self) -> Self

Sets the strikethrough property of the label.

fn italic(self) -> Self

Sets the italic property of the label.

fn alpha(self, alpha: f32) -> Self

Sets the alpha property of the label, overwriting the alpha value of the color.

fn underline(self) -> Self

Sets the underline property of the label

fn truncate(self) -> Self

Truncates overflowing text with an ellipsis (…) at the end if needed.

fn single_line(self) -> Self

Sets the label to render as a single line.

fn buffer_font(self, cx: &App) -> Self

Sets the font to the buffer’s

fn inline_code(self, cx: &App) -> Self

Styles the label to look like inline code.

impl RenderOnce for HighlightedLabel

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.