mirror of
https://github.com/veeso/termscp.git
synced 2025-12-07 09:36:00 -08:00
121 lines
3.2 KiB
Rust
121 lines
3.2 KiB
Rust
//! ## Layout
|
|
//!
|
|
//! `Layout` is the module which provides components, view, state and properties to create layouts
|
|
|
|
/*
|
|
*
|
|
* Copyright (C) 2020-2021 Christian Visintin - christian.visintin1997@gmail.com
|
|
*
|
|
* This file is part of "TermSCP"
|
|
*
|
|
* TermSCP is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* TermSCP is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with TermSCP. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
// Modules
|
|
pub mod components;
|
|
pub mod props;
|
|
pub mod utils;
|
|
pub mod view;
|
|
|
|
// locals
|
|
use props::{PropValue, Props, PropsBuilder};
|
|
// ext
|
|
use crossterm::event::Event as InputEvent;
|
|
use crossterm::event::KeyEvent;
|
|
use std::io::Stdout;
|
|
use tui::backend::CrosstermBackend;
|
|
use tui::layout::Rect;
|
|
use tui::Frame;
|
|
|
|
type Backend = CrosstermBackend<Stdout>;
|
|
pub(crate) type Canvas<'a> = Frame<'a, Backend>;
|
|
|
|
// -- Msg
|
|
|
|
/// ## Msg
|
|
///
|
|
/// Msg is an enum returned after an event is raised for a certain component
|
|
/// Yep, I took inspiration from Elm.
|
|
#[derive(std::fmt::Debug, PartialEq, Eq)]
|
|
pub enum Msg {
|
|
OnSubmit(Payload),
|
|
OnChange(Payload),
|
|
OnKey(KeyEvent),
|
|
None,
|
|
}
|
|
|
|
/// ## Payload
|
|
///
|
|
/// Payload describes a component value
|
|
#[derive(std::fmt::Debug, PartialEq, Eq)]
|
|
pub enum Payload {
|
|
Text(String),
|
|
//Signed(isize),
|
|
Unsigned(usize),
|
|
None,
|
|
}
|
|
|
|
// -- Component
|
|
|
|
/// ## Component
|
|
///
|
|
/// Component is a trait which defines the behaviours for a Layout component.
|
|
/// All layout components must implement a method to render and one to update
|
|
pub trait Component {
|
|
/// ### render
|
|
///
|
|
/// Based on the current properties and states, renders the component in the provided area frame
|
|
#[cfg(not(tarpaulin_include))]
|
|
fn render(&self, frame: &mut Canvas, area: Rect);
|
|
|
|
/// ### update
|
|
///
|
|
/// Update component properties
|
|
/// Properties should first be retrieved through `get_props` which creates a builder from
|
|
/// existing properties and then edited before calling update.
|
|
/// Returns a Msg to the view
|
|
fn update(&mut self, props: Props) -> Msg;
|
|
|
|
/// ### get_props
|
|
///
|
|
/// Returns a props builder starting from component properties.
|
|
/// This returns a prop builder in order to make easier to create
|
|
/// new properties for the element.
|
|
fn get_props(&self) -> PropsBuilder;
|
|
|
|
/// ### on
|
|
///
|
|
/// Handle input event and update internal states.
|
|
/// Returns a Msg to the view
|
|
fn on(&mut self, ev: InputEvent) -> Msg;
|
|
|
|
/// ### get_value
|
|
///
|
|
/// Get current value from component
|
|
fn get_value(&self) -> Payload;
|
|
|
|
// -- events
|
|
|
|
/// ### blur
|
|
///
|
|
/// Blur component; basically remove focus
|
|
fn blur(&mut self);
|
|
|
|
/// ### active
|
|
///
|
|
/// Active component; basically give focus
|
|
fn active(&mut self);
|
|
}
|