Struct liriodendron::log::action::Action

pub struct Action {
    grid_id: usize,
    grid: Grid,
    tool: Tool,
    checked: bool,
}

Represents a user action

Fields

grid_id: usize

grid: Grid

tool: Tool

checked: bool

The log grid's coordinates and the user interface grid's coordinates are different. In log grid's coordinates starts to 0, but in the the user interface, it depends of the terminal size and where the grid area is supposed to be on the user interface. The log have to modify it's own grid's coordinates system to fit with the grid's coordinates system. The checked member allows to know if the log fitted its grid's coordinates system for the tested action. The checked member only matters for cells setter tools.

Methods

impl Action

pub fn new((grid, grid_id): (Grid, usize), tool: Tool) -> Action

pub fn get_grid_id(&self) -> usize

pub fn get_grid(&self) -> Grid

pub fn get_tool(&self) -> Tool

pub fn is_checked(&self) -> bool

pub fn corrected(&self, left: Option<u16>, top: Option<u16>) -> Action

Creates a new Action object with fitted grid's coordinates to the user interface system.

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Action

impl PartialEq<Action> for Action

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.