Crate ncurseswwin
source · [−]Modules
Extended color’s, color pairs and attributes module.
Compiled in ncursesw features
Form module
Menu module
Normal color’s, color pairs and attributes module.
Structs
Custom box drawing graphics.
Ascii character and rendition.
Ascii string and rendition.
Complex character (wide character and rendition).
Complex character string (wide characters and renditions).
A mouse pointer device.
An iterator over the variants of Self
An iterator over the variants of Self
A mouse button’s state.
The mouse event that occurred.
The type of origin as reported by a mouse.
Origin using y and x axis
A pad canvas.
A moveable panel that is a container for a Window.
A ripoff line.
A ripoff line window canvas.
Size using lines and columns
Wide character (UTF-8 character).
Wide character string (UTF-8).
A moveable window canvas.
Enums
Normal and extended attributes and color pair returned by ncurses functions.
The box drawing graphic characters.
Box drawing type.
Box drawing type detail.
Make a line look like it’s been touched since last wrefresh, used by wtouchln.
Return a GetCharacterType from the getch() and
get_wch() families of functions.
Cursor type.
Horizontal box drawing graphic type.
The various input modes that you can set for the terminal.
Justification.
Keys returned by NCurses getch() and get_wch() families of functions.
Override locale-encoding checks.
A mouse button.
A type of mouse button event.
The type of events the mouse will report.
The color type that ncursesw is running under. by default it will be ColorType::Normal until a ColorPair structure is generated.
NCursesw Errors/Events.
NCursesw form errors.
NCursesw menu errors.
NCursesw mouse errors.
NCursesw panels errors.
NCurseswWin Errors.
The screen region (top or bottom) to rip a line off.
Position to insert/delete line see insdelln() and winsdelln().
The soft-label layout type
Vertical box drawing graphic type.
Traits
Attributes.
Does the window canvas type have ncursesw add functions.
Is the window canvas type capable of creating a sub-window.
Color attribute type in the NCurses library.
Color pair’s colors.
Color pair.
Color.
Background and foreground colors.
Is the window canvas type capable of creating a derived window.
Does the window canvas type have ncursesw add functions.
Does the window canvas type have ncursesw attribute type functions.
Does the window canvas type have ncursesw background functions.
Does the window canvas type have ncursesw delete functions.
Does the window canvas type have ncursesw get functions.
Does the window canvas type have ncursesw graphics functions.
Does the window canvas type have ncursesw in functions.
Does the window canvas type have ncursesw insert functions.
Does the window canvas type have ncursesw origin add functions.
Does the window canvas type have ncursesw attribute origin functions.
Does the window canvas type have ncursesw delete origin functions.
Does the window canvas type have ncursesw get origin functions.
Does the window canvas type have ncursesw in origin functions.
Does the window canvas type have ncursesw insert origin functions.
Does the window canvas type support non-blocking functions.
Does the window canvas have an x-axis.
Does the window canvas have an y-axis.
Does the window canvas have an x and y axis.
is the window canvas type a pad.
is the window canvas type a window.
Does the window canvas type have ncursesw mouse functions.
Is the window canvas type moveable.
Is the window canvas a ncursesw window type.
Is the window canvas type scrollable.
Functions
Return the number of colors available.
Return the number of color pairs available.
Return the maximum number of columns.
Return the delay used to interpret termianl keyboard escape sequences.
Return the maximum number of lines.
Return the number of columns a tab represents on the terminal.
Use the specialifed colors (foreground and background) as the default colors for defining color pair 0.
Return the output speed of the terminal in bits per second. On software terminal emulators it will have a fixed high value. Included for historical reasons; in former times, it was used to write output loops for time delays and occasionally to change interfaces depending on the line speed.
Emit a short attention sound.
Return true or false, depending on whether the programmer
can change the colors displayed by the terminal.
Returns the topmost panel. Helper function and equivilant of panel_below(None).
Obtain the box drawing graphic of ChtypeChar type.
Obtain the box drawing graphic of ComplexChar type.
Return the current screen.
Return the version number, including patch level of the underlying library, e.g., 6.1.20180127.
Set the cursor type to display.
Save the current terminal mode as the “program” mode, the mode when
the running program is using NCurses. (Its counterpart is the “shell”
mode, for when the program is not in NCurses.) Subsequent calls to
reset_prog_mode() will restore this mode.
Save the current terminal mode as the “shell” mode, the mode when the running program is not using NCurses. (Its counterpart is the “program” mode, when the program is using NCurses capabilities.) Subsequent calls to reset_shell_mode() will restore this mode.
Permits an application to define keycodes with their corresponding control strings, so that the NCurses library will interpret them just as it would the predefined codes in the terminfo database.
Insert an ms millisecond pause in output.
Update the physical screen. The NCurses library keeps two data structures, one representing the current physical screen contents and a virtual screen representing the desired next state. The doupdate() ground updates the physical screen to match the virtual screen.
Flash the screen. That is, change it to reverse-video and then change
it back in a short interval. Some people prefer such as ‘visible bell’
to the audible attention signal produced by beep().
Returns the escape delay.
Get a widecharacter string and rendition from a complex character.
Returns the lowest panel. Helper function and equivilant of panel_above(None).
Used for half-delay mode, which is similar to cbreak mode in that characters
typed by the user are immediately available to the program. However, after
blocking for tenths tenths of seconds, raise an exception if nothing has
been typed. The value of tenths must be a number between 1 and 255.
Use nocbreak() to leave half-delay mode.
Return true if the terminal can display colors; otherwise, return false.
Return true if the terminal has insert- and delete-character capabilities.
This function is included for historical reasons only, as all modern
software terminal emulators have such capabilities.
Return true if the terminal has insert- and delete-line capabilities,
or can simulate them using scrolling regions. This function is included
for historical reasons only, as all modern software terminal emulators
have such capabilities.
Take a key value ch, and return true if the current terminal type
recognizes a key with that value.
The has_mouse() function returns true if the mouse driver has
been successfully initialized.
Returns wether a mouse interface is available.
Return true if resize_term() would modify the window structure,
false otherwise.
Permits an application to determine if a string represented
as individual bytes is currently bound to any KeyBindind.
Returns a string corresponding to a given KeyBinding.
Permits an application to determine the string which is defined in the terminfo for specific keycodes.
Return the name of the key binding c. The name of a key generating printable ASCII character is the key’s character. The name of a control-key combination is a two-byte bytes object consisting of a caret (b’^‘) followed by the corresponding printable ASCII character. The name of an alt-key combination (128–255) is a bytes object consisting of the prefix b’M-’ followed by the name of the corresponding ASCII character.
Permits an application to disable specific KeyBinding, rather than use
the keypad function to disable all keycodes. Keys that have been disabled
can be re-enabled.
Return the user’s current line kill character. Under Unix operating systems this is a property of the controlling tty of the NCurses program, and is not set by the NCurses library itself.
Return the user’s current line kill character as a wide character. Under Unix operating systems this is a property of the controlling tty of the NCurses program, and is not set by the NCurses library itself.
Return the terminfo long name field describing the current terminal.
The maximum length of a verbose description is 128 characters.
It is defined only after the call to initscr().
Ship binary data to printer. Returns the number of characters actually sent to the printer.
Return the NCurses mouse version.
The mouseinterval() function sets the maximum time (in thousands of a second)
that can elapse between press and release events for them to be recognized as a
click. Use mouseinterval(Some(time::Duration::from_millis(0))) to disable click
resolution. This function returns the previous interval value.
Use mouseinterval(None) to obtain the interval without altering it.
The default is one sixth of a second.
Returns the color type that ncursesw is running under. by default it will be ColorType::Normal until a ColorPair structure is generated.
Has the crates color type been set.
Return the semantic version of the NCurses library.
Safely initialise NCurses, panic’s will be caught correctly and
passed back as NCurseswWinError::Panic.
NCurses should free (as best it can) memory etc correctly.
Safely initialise NCurses, panic will be caught correctly and NCurses free (as best it can) correctly.
Return the new screen.
Returns the panel above the specified panel.
Returns the panel just below the specified panel.
Restore the terminal to “program” mode, as previously saved by def_prog_mode().
Restore the terminal to “shell” mode, as previously saved by def_shell_mode().
Restore the state of the terminal modes to what it was at the last call to savetty().
Backend function used by resizeterm(), performing most of the work; when
resizing the windows, resize_term() blank-fills the areas that are extended.
The calling application should fill in these areas with appropriate data.
The resize_term() function attempts to resize all windows. However, due to
the calling convention of pads, it is not possible to resize these without
additional interaction with the application.
Resize the standard and current windows to the specified dimensions, and adjusts other bookkeeping data used by the NCurses library that record the window dimensions (in particular the SIGWINCH handler).
Safely create an application entry point, unlike ncursesw_entry() this does
not initialise the NCurses library by calling initscr(). panic’s will be caught
correctly and passed back as NCurseswWinError::Panic. NCurses should free
(as best it can) memory etc correctly.
Save the current state of the terminal modes in a buffer, usable by resetty().
The scr_dump() routine dumps the current contents of the virtual screen
to the file specificed by path.
The scr_init() routine reads in the contents of path and uses them to
initialize the curses data structures about what the terminal currently has
on its screen. If the data is determined to be valid, curses bases its next
update of the screen on this information rather than clearing the screen
and starting from scratch.
The scr_restore() routine sets the virtual screen to the contents of the file
specificed by path, which must have been written using scr_dump(). The next call
to doupdate() restores the physical screen to the way it looked in the
dump file.
The scr_set() routine is a combination of scr_restore() and scr_init().
It tells the program that the information in path is what is currently
on the screen, and also what the program wants on the screen. This can be
thought of as a screen inheritance function.
For positive n, the scrl() routine scroll the window up n lines
(line i+n becomes i); otherwise scroll the window down n lines.
This involves moving the lines in the window character image structure.
The current cursor position is not changed.
Set echo on or off within NCurses.
Sets the escape delay delay.
Set the input mode to use within NCurses.
Control whether the NCurses translates the return key into newline on input,
Sets the tab size.
Sets a complex character from a character and rendition.
Initialise NCurses internal color system.
Return the standard screen.
The terminal/screen size as an Origin i.e. y and x axis using 0,0 as top left.
The terminal/screen Size i.e. lines and columns using 0,0 as top left.
Specify that the file descriptor file be used for typeahead checking.
If file is None, then no typeahead checking is done.
Refreshes the virtual screen to reflect the relations between the panels in the stack.
Use the default terminal colors for color pair 0.
Override locale-encoding checks.
Obtain the box drawing graphic of WideChar type.
Type Definitions
Non-Blocking get function return type, None is a timeout.
Timeout type, None represents blocking mode.