Struct requestty_ui::layout::Layout

pub struct Layout {
    pub line_offset: u16,
    pub offset_x: u16,
    pub offset_y: u16,
    pub width: u16,
    pub height: u16,
    pub max_height: u16,
    pub render_region: RenderRegion,
}

Layout represents a portion of the screen that is available to be rendered to.

Assume the highlighted part of the block below is the place available for rendering in the given box

 ____________
|            |
|     ███████|
|  ██████████|
|  ██████████|
'------------'

Fields

line_offset: u16

 ____________
|  vvv-- line_offset
|     ███████|
|  ██████████|
|  ██████████|
'------------'

offset_x: u16

 ____________
|vv-- offset_x
|     ███████|
|  ██████████|
|  ██████████|
'------------'

offset_y: u16

 .-- offset_y
|'>          |
|     ███████|
|  ██████████|
|  ██████████|
'------------'

width: u16

 ____________
|            |
|     ███████|
|  ██████████|
|  ██████████|
'------------'
 ^^^^^^^^^^^^-- width

height: u16

 _____ height --.
|            | <'
|     ███████| <'
|  ██████████| <'
|  ██████████| <'
'------------'

max_height: u16

 ____________
|.-- max_height
|'>   ███████|
|'>██████████|
|'>██████████|
'------------'

render_region: RenderRegion

The region to render if full text cannot be rendered

Implementations

impl Layout

pub fn new(line_offset: u16, size: Size) -> Self

Creates a new Layout.

pub fn with_line_offset(self, line_offset: u16) -> Self

Creates a new Layout with given line_offset.

pub fn with_size(self, size: Size) -> Self

Creates a new Layout with given width and height.

pub fn with_offset(self, offset_x: u16, offset_y: u16) -> Self

Creates a new Layout with new offset_x and offset_y.

pub fn with_render_region(self, region: RenderRegion) -> Self

Creates a new Layout with new render_region.

pub fn with_max_height(self, max_height: u16) -> Self

Creates a new Layout with new max_height.

pub fn with_cursor_pos(self, cursor_pos: (u16, u16)) -> Self

Creates a new Layout that represents a region past the cursor_pos. cursor_pos is relative to offset_x and offset_y.

pub fn set_size(&mut self, terminal_size: Size)

Sets the width and height of the layout.

pub fn offset_cursor(&self, cursor_pos: (u16, u16)) -> (u16, u16)

Converts a cursor_pos relative to (offset_x, offset_y) to be relative to (0, 0)

pub fn line_width(&self) -> u16

Gets the width of renderable space on the first line.

 ____________
|     vvvvvvv-- line_width
|     ███████|
|  ██████████|
|  ██████████|
'------------'

pub fn available_width(&self) -> u16

Gets the width of renderable space on subsequent lines.

 ____________
|  vvvvvvvvvv-- available_width
|     ███████|
|  ██████████|
|  ██████████|
'------------'

pub fn get_start(&self, height: u16) -> u16

Gets the starting line number for the given height taking into account the max_height and the render_region.

If the height of the widget to render is 5 and the max_height is 2, then the start would be:

• RenderRegion::Top: 0
• RenderRegion::Middle: 1
• RenderRegion::Top: 3

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Layout

Returns the “default value” for a type.

impl Hash for Layout

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Layout> for Layout

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

impl Eq for Layout

impl StructuralEq for Layout

impl StructuralPartialEq for Layout