Struct Screen

Source

pub struct Screen { /* private fields */ }

Implementations§

Source §

impl Screen

Source

pub fn new<S, O, I>( term: Option<S>, output: &O, input: &I, ) -> Result<Self, NCurseswWinError>
where S: Into<String>, O: AsRawFd + Write, I: AsRawFd + Read,

Source

pub fn newterm<S, O, I>( term: Option<S>, output: &O, input: &I, ) -> Result<Self, NCurseswWinError>
where S: Into<String>, O: AsRawFd + Write, I: AsRawFd + Read,

👎Deprecated since 0.5.0: Use Screen::new() instead

Source

pub unsafe fn from_ptr(screen: SCREEN) -> Self

§Safety

convert a ‘SCREEN’ pointer from the underlying ‘ncursesw’ crate to a ‘ncurseswwin::Screen’.

Source

pub unsafe fn as_ptr(&self) -> SCREEN

§Safety

Return’s the ‘Screen’ as a pointer so we can use some of underlying ‘ncursesw’ crates functions, for example ‘ncursesw::extend::ColorPair::new_sp()’ (as imported in this crate as ‘crate::extend::ColorPair::new_sp()’)

Source

pub fn set_input_mode(&self, mode: InputMode) -> Result<(), NCurseswWinError>

Set the input mode to use within NCurses on this Screen.

The terminal gets input from the user. Then it’s sometimes buffered up. At some point it’s passed into the program’s input buffer.

Character: Input is passed in 1 character at a time, but special characters (such as Ctrl+C and Ctrl+S) are automatically processed for you by the terminal.
Cooked: Input is passed in 1 line at a time, with the special character processing mentioned above enabled.
RawCharacter: Input is passed in 1 character at a time, and special character sequences are not processed automatically.
RawCooked: Input is passed in 1 line at a time, and special character sequences are not processed automatically.

The default mode is inherited from the terminal that started the program (usually Cooked), so you should always set the desired mode explicitly at the start of your program.

Source

pub fn set_echo(&self, flag: bool) -> Result<(), NCurseswWinError>

Set echo on or off within NCurses on this Screen.

Enables or disables the automatic echoing of input into the window as the user types. Default to on, but you probably want it to be off most of the time.

Source

pub fn set_filter(&self, flag: bool)

Source

pub fn set_newline(&self, flag: bool) -> Result<(), NCurseswWinError>

Control whether NCurses translates the return key into newline on input on this Screen.

This determines wether ncurses translates newline into return and line-feed on output (in either case, the call addch(‘\n’) does the equivalent of return and line feed on the virtual screen). Initially, these translations do occur. If you disable then ncurses will be able to make better use of the line-feed capability, resulting in faster cursor motion. Also, ncurses will then be able to detect the return key.

Source

pub fn set_qiflush(&self, flag: bool)

Source

pub fn assume_default_colors<S, C, T>( &self, colors: S, ) -> Result<(), NCurseswWinError>
where S: ColorsType<C, T>, C: ColorType<T>, T: ColorAttributeTypes,

Source

pub fn cursor_set( &self, cursor: CursorType, ) -> Result<CursorType, NCurseswWinError>

Source

pub fn curs_set( &self, cursor: CursorType, ) -> Result<CursorType, NCurseswWinError>

👎Deprecated since 0.6.0: Use Screen::cursor_set() instead

Source

pub fn define_key( &self, definition: Option<&str>, keycode: KeyBinding, ) -> Result<(), NCurseswWinError>

Source

pub fn def_prog_mode(&self) -> Result<(), NCurseswWinError>

Source

pub fn def_shell_mode(&self) -> Result<(), NCurseswWinError>

Source

pub fn delay_output(&self, ms: Duration) -> Result<(), NCurseswWinError>

Source

pub fn doupdate(&self) -> Result<(), NCurseswWinError>

Source

pub fn erasechar(&self) -> Result<char, NCurseswWinError>

Source

pub fn flash(&self) -> Result<(), NCurseswWinError>

Source

pub fn flushinp(&self) -> Result<(), NCurseswWinError>

Source

pub fn get_escdelay(&self) -> Result<Duration, NCurseswWinError>

Source

pub fn getwin<I: AsRawFd + Read>( &self, file: &I, ) -> Result<Window, NCurseswWinError>

Source

pub fn halfdelay(&self, tenths: Duration) -> Result<(), NCurseswWinError>

Source

pub fn has_colors(&self) -> bool

Source

pub fn has_ic(&self) -> bool

Source

pub fn has_il(&self) -> bool

Source

pub fn has_key(&self, ch: KeyBinding) -> bool

Source

pub fn has_mouse(&self) -> bool

Source

pub fn intrflush(&self, flag: bool) -> Result<(), NCurseswWinError>

Source

pub fn is_term_resized(&self, size: Size) -> Result<bool, NCurseswWinError>

Source

pub fn keybound(&self, keycode: KeyBinding, count: i32) -> Option<String>

Source

pub fn key_defined( &self, definition: &str, ) -> Result<Option<KeyBinding>, NCurseswWinError>

Source

pub fn keyname(&self, c: KeyBinding) -> Result<String, NCurseswWinError>

Source

pub fn keyok( &self, keycode: KeyBinding, enable: bool, ) -> Result<(), NCurseswWinError>

Source

pub fn killchar(&self) -> Result<char, NCurseswWinError>

Source

pub fn longname(&self) -> Result<String, NCurseswWinError>

Source

pub fn mcprint(&self, data: &[i8], len: i32) -> Result<i32, NCurseswWinError>

Source

pub fn mvcur(&self, old: Origin, new: Origin) -> Result<(), NCurseswWinError>

Source

pub fn napms(&self, ms: Duration) -> Result<(), NCurseswWinError>

👎Deprecated since 0.5.0: ncurses library call superseeded by native rust call. Use std::thread::sleep(dur: std::time::Duration) instead

Source

pub fn reset_color_pairs(&self)

👎Deprecated since 0.5.0: use with caution as this routine will reset all color pairs potentially before they go out of scope and the color pairs will default to terminal default foreground and backgound colors.

Reset all defined color pairs.

Source