newt 0.7.1

Rust bindings for the Newt console UI library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

# newt-rs

_Rust bindings for the Newt console UI library._

[ChangeLog](https://github.com/rtgill82/newt-rs/blob/v0.7.1/ChangeLog.md) |
[API Docs](https://docs.rs/newt/0.7.1/newt/) |
[crates.io](https://crates.io/crates/newt)

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

[newt]: https://pagure.io/newt

## 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

```rust
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`][static_feature], [`asm`][asm_feature], [`f16`][f16_feature].

[static_feature]: #static_feature
[asm_feature]: #asm_feature
[f16_feature]: #f16_feature

### `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.

[newt_sys]: https://crates.io/crates/newt-sys

### <a name="asm_feature"></a> `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_, <i>x86_64</i>, _arm_, _aarch64_,
_riscv32_, and _riscv64_ architectures.

### <a name="f16_feature"></a> `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

Copyright (C) 2018-2020,2025  Robert Gill <<rtgill82@gmail.com>>

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