Struct unsegen::base::window::ExtentEstimationWindow

pub struct ExtentEstimationWindow { /* fields omitted */ }

A dummy window that does not safe any of the content written to it, but records the maximal coordinates used.

This is therefore suitable for determining the required space demand of a widget if nothing or not enough is known about the content of a widget.

Implementations

impl ExtentEstimationWindow

pub fn with_width(width: Width) -> Self

Create an ExtentEstimationWindow with a fixed width

pub fn unbounded() -> Self

Create an ExtentEstimationWindow with an unbounded width

pub fn extent_x(&self) -> Width

Get the width of the window required to display the contents written to the window.

pub fn extent_y(&self) -> Height

Get the height of the window required to display the contents written to the window.

Trait Implementations

impl CursorTarget for ExtentEstimationWindow

fn get_width(&self) -> Width

Return the actual width of the window. Writing to a column outside of this range is not possible.

fn get_height(&self) -> Height

Return the maximum height of the target. Writing to a row outside of this range is not possible.

fn get_cell_mut(
    &mut self,
    x: ColIndex,
    y: RowIndex
) -> Option<&mut StyledGraphemeCluster>

Get the (mutable) cell at the specified position. The implementor must ensure that in the range for x \in [0, Width) and y \in [0, Height) a valid cluster is returned.

fn get_cell(&self, x: ColIndex, _: RowIndex) -> Option<&StyledGraphemeCluster>

Get the cell at the specified position. The implementor must ensure that in the range for x \in [0, Width) and y \in [0, Height) a valid cluster is returned.

fn get_default_style(&self) -> Style

Return the default style that characters of this target should be printed as. This serves as the base for further style modifications while writing to the target.

fn get_soft_width(&self) -> Width

Return the soft or “desired” width of the target. In most cases this is equal to the width. An example where this is not the case would be a terminal with builtin wrapping of lines where it is some cases desirable for the cursor to wrap at the width of the terminal, even though there is no (conceptual) limit of line length.