Struct TextView

pub struct TextView { /* private fields */ }

A simple view showing a fixed text.

Examples

let mut siv = Cursive::new();

siv.add_layer(TextView::new("Hello world!"));

Implementations

impl TextView

pub fn new<S>(content: S) -> TextView

where S: Into<SpannedString<Style>>,

Creates a new TextView with the given content.

pub fn cursup<S>(content: S) -> TextView

where S: Into<String>,

Convenient function to create a TextView by parsing the given content as cursup.

Shortcut for TextView::new(cursup::parse(content)).

Examples

let view = TextView::cursup("/red+bold{warning}");

pub fn new_with_content(content: TextContent) -> TextView

Creates a new TextView using the given TextContent.

If you kept a clone of the given content, you’ll be able to update it remotely.

Examples

let mut content = TextContent::new("content");
let view = TextView::new_with_content(content.clone());

// Later, possibly in a different thread
content.set_content("new content");
assert!(view.get_content().source().contains("new"));

pub fn empty() -> TextView

Creates a new empty TextView.

pub fn set_effect(&mut self, effect: Effect)

👎Deprecated since 0.16.0: Use set_style() instead.

Sets the effect for the entire content.

pub fn set_style<S>(&mut self, style: S)

where S: Into<StyleType>,

Sets the style for the content.

pub fn effect(self, effect: Effect) -> TextView

👎Deprecated since 0.16.0: Use style() instead.

Sets the effect for the entire content.

Chainable variant.

pub fn style<S>(self, style: S) -> TextView

where S: Into<StyleType>,

Sets the style for the entire content.

Chainable variant.

pub fn no_wrap(self) -> TextView

Disables content wrap for this view.

This may be useful if you want horizontal scrolling.

pub fn set_content_wrap(&mut self, wrap: bool)

Controls content wrap for this view.

If true (the default), text will wrap long lines when needed.

pub fn h_align(self, h: HAlign) -> TextView

Sets the horizontal alignment for this view.

pub fn v_align(self, v: VAlign) -> TextView

Sets the vertical alignment for this view.

pub fn align(self, a: Align) -> TextView

Sets the alignment for this view.

pub fn center(self) -> TextView

Center the text horizontally and vertically inside the view.

pub fn content<S>(self, content: S) -> TextView

where S: Into<SpannedString<Style>>,

Replace the text in this view.

Chainable variant.

pub fn set_content<S>(&mut self, content: S)

where S: Into<SpannedString<Style>>,

Replace the text in this view.

pub fn append<S>(&mut self, content: S)

where S: Into<SpannedString<Style>>,

Append content to the end of a TextView.

pub fn get_content(&self) -> TextContentRef

Returns the current text in this view.

pub fn get_shared_content(&mut self) -> TextContent

Returns a shared reference to the content, allowing content mutation.

Trait Implementations

impl View for TextView

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus.

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout().

fn required_size(&mut self, size: XY<usize>) -> XY<usize>

Returns the minimum size the view requires with the given restrictions.

fn layout(&mut self, size: XY<usize>)

Called once the size for this view has been decided.

fn on_event(&mut self, _: Event) -> EventResult

Called when an event is received (key press, mouse event, …).

fn call_on_any( &mut self, _: &Selector<'_>, _: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, _: &Selector<'_>) -> Result<EventResult, ViewNotFound>

Moves the focus to the view identified by the given selector.

fn take_focus(&mut self, source: Direction) -> Result<EventResult, CannotFocus>

Attempt to give this view the focus.

fn important_area(&self, view_size: XY<usize>) -> Rect

What part of the view is important and should be visible?

fn type_name(&self) -> &'static str

Returns the type of this view.