# Changelog

All breaking changes are marked with [BC] and potentially require API consumer changes after updating to the respective version.

## [0.6.3] - 2022-02-22

- Added `AsRef` and `Clone` traits for `Screen`, `Window`, `Pad`, `Panel`, `Menu`, `MenuItem`, `PostedMenu`, `Form`, `Field`, `FieldType`, `PostedForm`, `Alphabetic`, `AlphaNumeric`, `Enumerate`, `Integer`, `IpV4`, `Numeric`, `RegularExpression`, `Mouse`, `RipoffWindow` and `RipoffLine`.
- Added `AsMut` trait for `Menu`, `PostedMenu`, `Form`, `Field`, `FieldType`, `PostedForm`, `Alphabetic`, `AlphaNumeric`, `Enumerate`, `Integer`, `IpV4`, `Numeric`, `RegularExpression` and `Mouse`.
- Added `PartialOrd` and `Ord` traits on `Origin` and `Size`.
- Added `Into<String>` traits on appropriate methods and functions.
- `RipoffLine::update` now returns a `anyhow::Result<T>` instead of a `std::result::Result<T, NCurseswWinError>`.

## [0.6.2] - 2022-01-06

- Must now use a minimum `ncursesw` crate of `0.6.3`.
- Added `erasewchar()` and `killwchar()` methods to `Screen`.
- Added `ceiling_panel()` and `ground_panel()` functions to `ncurseswwin::panels` module (to bring it in line with equivilant `Screen::ceiling_panel()` and `Screen::ground_panel()` methods).

## [0.6.1] - 2022-01-02

- Change to Cargo.toml to load ncursesw-rs from crates.io and not github.

## [0.6.0] - 2022-01-01 [BC]

- NCurses form module implemented as `form`.
- Now uses `thiserror` crate instead of `custom_error` crate to create `Error` types.
- `ncursesw_entry()`, `ncursesw_init()` and `safe_entry()` now use `anyhow::Result` as a return type. [BC]
- Added NCurses screen functionality.
- Added `{normal,extend}::SoftLabels`.
- Changed `Window::default()` to return `newscr()` instead of `stdscr()`.
- Removed `setlocale()` function. [BC]
- Removed `intrflush()` from `BaseCanvas` trait and made a crate public function. [BC]
- Removed `NCurseswWinError::RipoffNotInitialized`. [BC]
- `menu_request_by_name()` now returns a `Result<Option<menu::MenuRequest>, menu::NCurseswMenuError>` instead of `Result<bool, menu::NCurseswMenuError>`. [BC]
- `menu::menu_request_name()` now takes a `menu::MenuRequest` instead of a `i32` for the request. [BC]
- `menu::Menu::set_menu_pad()` now takes a `char` instead of a `i32` for the pad character. [BC]
- `menu::Menu::{set_item_init, set_item_term, set_menu_init, set_menu_term}` now use `Fn(&Menu)` traits. [BC]
- `menu::Menu::{item_init, item_term, menu_init, menu_term}` have been depreciated. [BC]
- `menu::PostedMenu::menu_driver()` now returns a `Result<Option<menu::MenuRequest>, menu::NCurseswMenuError>` instead of `Result<Option<i32>, menu::NCurseswMenuError>`. [BC]
- `BaseCanvas::putwin()`, `IsWindow::putwin()` and `IsPad::putwin()` now take `O: std::os::unix::io::AsRawFd + std::io::Write` instead of `&std::path::Path`. [BC]
- `NCurseswWindow::getwin()` and `IsPad::genwin()` now take `I: std::os::unix::io::AsRawFd + std::io::Read` instead of `&std::path::Path`. [BC]
- Moved `is_subwin()` from `Scrollable` trait to `BaseCanvas` trait. [BC]
- `Mouse::new()` no longer required an `id` parameter. [BC]
- `curscr()`, `newscr()` and `stdscr()` now return `Window` instead of `Result<Window, NCurseswWinError>`. [BC]
- Changed the follwoing functions `length` parameters from `u16` to `Option<u16>` : `addchnstr()`, `addnstr()` `addnwstr()` `add_wchnstr()` `chgat()` `insnstr()` `ins_nwstr()` `mvaddchnstr()` `mvaddnstr()` `mvaddnwstr()` `mvadd_wchnstr()` `mvchgat()` `mvinsnstr()` and `mvins_nwstr()`. [BC]

## [0.5.0] - ????-??-?? [BC]

- Unreleased.

## [0.4.0] - 2019-12-09 [BC]

- Coordinate systems used within the crate (i.e. `Origin`, `Size` etc.) have been changed from using axis basic types of `i32` to `u16`. [BC]
- NCurses menu module implemented as `menu`.
- Moved `dupwin()` and `getwin()` from the `IsWindow` trait to `NCursesWindow` trait. [BC]

## [0.3.1] - 2019-11-07

- NCurses `mouse` functionality added.
- `Window`, `Pad` and `RipoffWindow` now use traits to provide functionality.
- Added non-blocking functionality to `get` type functions.

## [0.3.0] - 2019-11-02 [BC]

- Initialising NCurses functionality is now done using the `ncursesw_entry()` function instead of the `ncursesw_init()` function to provide better panic trapping that can be caught and processed as a `Result`.
- ...

## [0.2.1] - 2019-10-25

- ...

## [0.2.0] - 2019-10-15 [BC]

- ...

## [0.1.5] - 2019-10-14

- ...

## [0.1.4] - 2019-07-13

- ...

## [0.1.3] - 2019-07-09

- ...

## [0.1.2] - 2019-07-06

- ...

## [0.1.1] - 2019-07-04

- ...

## [0.1.0] - 2019-07-01

- Initial release.