newt-rs

Rust bindings for the Newt console UI library.

This crate provides bindings to Red Hat, Inc.'s Newt console UI library. Newt is a small and simple to use UI library providing widgets and basic stacked window management for console applications.

Usage

Include newt as a dependency of in your Cargo.toml file as follows.

[dependencies]
newt = "0.7"

The library API is currently subject to change and there are likely to be breaking changes between minor versions. Requires at least Rust 1.59 for inline assembly functions on the supported architectures.

Example

extern crate newt;
use newt::prelude::*;

pub fn main() {
    newt::init().unwrap();
    newt::cls();
    newt::centered_window(20, 5, Some("Greetings")).unwrap();

    let text = Textbox::new(4, 1, 12, 1, 0);
    text.set_text("Hello World!");
    let ok = CompactButton::new(7, 3, "Ok");

    let mut form = Form::new(None, 0);
    form.add_components(&[&text, &ok]).unwrap();
    let reason = form.run().unwrap();
    newt::finished();

    match reason {
        ExitReason::HotKey(key) => // F12 is the default HotKey
            println!("Execution stopped due to HotKey: {}", key),
        ExitReason::Component(co) =>
            println!("Execution stopped due to Component: {:?}", co),
        _ =>
            println!("Execution stopped due to other reason...")
    }
}

Features

The following features are available as build options: static, asm, f16.

`static` feature

Enabling the static feature will force the newt-sys dependency to be statically built against its included libraries rather than dynamically against local system libraries when the required libraries are available on the system.

`asm` feature

Some library functions such as windows::win_entries(), windows::win_menu(), and functions related to the Grid struct require the asm feature to be enabled.

These are currently available on the x86, x86_64, arm, aarch64, riscv32, and riscv64 architectures.

`f16` feature

Enable an implementation of the Data trait for the f16 primitive, allowing it to be passed as data to Listboxes and CheckboxTrees. This primitive is unstable and only available in nightly builds of the compiler. Adding the -Zcrate-attr=feature(f16) option to the RUSTFLAGS environment variable is required to build.

LICENSE

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 2.1 as published by the Free Software Foundation.

This library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

newt 0.7.2