Crate fryingpan

A TUI library based on pancurses.

Example

use fryingpan::{FryingPan, Input, Panel, Point, A_ITALIC, init_pair, COLOR_BLUE, color_pair, COLOR_WHITE};
use std::{thread::sleep, time::Duration};

const BLUE_WHITE: i16 = 1;
const SLEEP_TIME: Duration = Duration::from_millis(50);

fn main() {
    // cook pancake and init colors
    let pancake = FryingPan::default()
        .hide_cursor(true)
        .no_delay(true)
        .color(true)
        .build()
        .unwrap();
    init_pair(BLUE_WHITE, COLOR_BLUE, COLOR_WHITE);

    // make panel,                   position v   v size
    let mut panel = Panel::new(Point::from(1, 1), 10, 30);
    panel.draw_box();

    // printing does not move the cursor
    panel.mv_print(Point::from(1, 0), "╴pancakes╶");
    panel.mv_print(Point::from(1, 1), "hello");

    // the cursor will be within bounds, unwrap is fine
    panel.attr_on(A_ITALIC).unwrap();
    panel.attr_on(color_pair(BLUE_WHITE)).unwrap();

    loop {
        if let Some(Input::Character('q')) = pancake.get_char() {
            break;
        }

        pancake.erase();
        pancake.render_panel(&panel);
        pancake.refresh();

        sleep(SLEEP_TIME);
    }

    pancake.quit();
}

Structs

FryingPan

Builder struct for the Pancake struct.

Pancake

Central data structure.

Panel

A panel.

Point

A point in 2D space.

Enums

Error

Errors used by this library.

Input

Input enum, re-exported from pancurses.

Constants

A_BLINK

Makes text blink.

A_BOLD

Makes text bold.

A_DIM

Makes text dim.

A_ITALIC

Makes text italic.

A_UNDERLINE

Makes text underlined.

COLOR_BLACK

COLOR_BLUE

COLOR_CYAN

COLOR_GREEN

COLOR_MAGENTA

COLOR_RED

COLOR_WHITE

COLOR_YELLOW

Functions

color_pair

Converts a color pair ID into an attribute.

init_pair

Change the definition of a color pair. Does not do anything if colors are disabled.

Type Aliases

chtype

Contains information about a character and/or an attribute.