curses

---

Description:

Character screen handling and windowing.

• Devhelp-Package download

Content:

Namespaces:

• Curses

Classes:

• Pad
• Screen
• Window

Structs:

• Color - Predefined colors
• MouseEvent
• Terminal

Enums:

• Acs
• Attribute - Character cell attributes
• Button
• Button1
• Button2
• Button3
• Button4
• Button5
• Key - The exact keycaps available are system dependent.
• MouseMask

Constants:

• public const int COLORS
• public const int COLOR_PAIRS
• public const int COLS
• public const int ESCDELAY
• public const int LINES
• public const int TABSIZE

Delegates:

• public delegate int RipofflineInitFunc (Window win, int n)
• public delegate int VidputsPutcFunc (char c)

Methods:

• public int COLOR_PAIR (int n)
  Returns the attribute value for displaying text in the specified color.
• public int PAIR_NUMBER (int attrs)
• public int addch (ulong ch)
  Paint character ch, overwriting any character previously painter at that location.
• public int addchnstr (ulong[] chstr, int n)
• public int addchstr (ulong[] chstr)
• public int addnstr (string str, int n)
  Paint at most n characters of the string, overwriting anything previously on the display.
• public int addstr (string str)
  Paint the string str overwriting anything previously on the display.
• public int attr_get (ref ulong attrs, ref short pair, void* data)
• public int attr_off (ulong attrs, void* data)
• public int attr_on (ulong attrs, void* data)
• public int attr_set (ulong attrs, short pair, void* data)
• public int attroff (ulong attr)
  Remove attribute attr from the "background" set applied to all writes to the current window.
• public int attron (ulong attr)
  Add attribute attr from the "background" set applied to all writes to the current window.
• public int attrset (ulong attr)
• public int baudrate ()
  Returns the output speed of the terminal in bits per second.
• public int beep ()
  Emit a short attention sound.
• public int bkgd (ulong ch)
• public void bkgdset (ulong ch)
• public int border (ulong ls, ulong rs, ulong ts, ulong bs, ulong tl, ulong tr, ulong bl, ulong br)
• public bool can_change_color ()
  Returns true or false, depending on whether the programmer can change the colors displayed by the terminal.
• public int cbreak ()
  Enter cbreak mode.
• public int chgat (int n, ulong attr, short color, void* data)
• public int clear ()
  Like Curses.erase, but also causes the whole window to be repainted upon next call to Curses.refresh .
• public int clrtobot ()
• public int clrtoeol ()
• public int color_content (short color, ref short r, ref short g, ref short b)
  Returns the intensity of the red, green, and blue (RGB) components in the color color_number, which must be between 0 and Curses.COLORS.
• public int color_set (short color_pair_number, void* data)
• public int curs_set (int visibility)
• public int def_prog_mode ()
  Saves the current terminal mode as the "program" mode, the mode when the running program is using curses.
• public int def_shell_mode ()
  Saves the current terminal mode as the "shell" mode, the mode when the running program is not using curses.
• public int delay_output (int ms)
  Inserts an ms millisecond pause in output.
• public int delch ()
  Delete any character at the given position.
• public int deleteln ()
  Delete the line under the cursor.
• public int doupdate ()
• public int echo ()
  Enter echo mode. In echo mode, each character input is echoed to the screen as it is entered.
• public int echochar (ulong ch)
  Add character ch, and immediately call Curses.refresh on the window.
• public int endwin ()
  De-initialize the library, and return terminal to normal status.
• public int erase ()
  Clear the window.
• public char erasechar ()
  Returns the user's current erase character. Under Unix operating systems this is a property of the controlling tty of the curses program, and is not set by the curses library itself.
• public void filter ()
• public int flash ()
  Flash the screen.
• public int flushinp ()
  Flush all input buffers. This throws away any typeahead that has been typed by the user and has not yet been processed by the program.
• public int getch ()
• public bool getmouse (out MouseEvent me)
  After Curses.getch returns Curses.Key.MOUSE to signal a mouse event, this method should be call to retrieve the queued mouse event, represented as a 5-tuple (id, x, y, z, bstate).
• public int getnstr (string str, int n)
• public int getstr (string str)
• public int halfdelay (int tenths)
  Used for half-delay mode, which is similar to cbreak mode in that characters typed by the user are immediately available to the program.
• public bool has_colors ()
  Returns true if the terminal can display colors; otherwise, it returns false.
• public bool has_ic ()
  Returns true if the terminal has insert- and delete- character capabilities.
• public bool has_il ()
  Returns true if the terminal has insert- and delete-line capabilities, or can simulate them using scrolling regions.
• public int hline (ulong ch, int n)
  Display a horizontal line starting with length n consisting of the character ch.
• public ulong inch ()
• public int inchnstr (ulong[] chstr, int n)
• public int inchstr (ulong[] chstr)
• public int init_color (short color, short r, short g, short b)
• public int init_pair (short pair, Color f, Color b)
• public unowned Window initscr ()
  Initialize the library.
• public int innstr (string str, int n)
• public int insch (ulong ch)
  Paint character ch, moving the line from position x right by one character.
• public int insdelln (int n)
• public int insertln ()
  Insert a blank line under the cursor. All following lines are moved down by 1 line.
• public int insnstr (string str, int n)
• public int insstr (string str)
• public int instr (string str)
• public bool isendwin ()
• public string keyname (int c)
• public char killchar ()
  Returns the user's current line kill character. Under Unix operating systems this is a property of the controlling tty of the curses program, and is not set by the curses library itself.
• public string longname ()
• public int mouseinterval (int erval)
  Sets the maximum time in milliseconds that can elapse between press and release events in order for them to be recognized as a click, and returns the previous interval value.
• public int mousemask (MouseMask @new, out MouseMask old)
  Sets the mouse events to be reported, and returns a tuple (availmask, oldmask).
• public int move (int y, int x)
• public int mvaddch (int y, int x, ulong ch)
• public int mvaddchnstr (int y, int x, ulong[] chstr, int n)
• public int mvaddchstr (int y, int x, ulong[] chstr)
• public int mvaddnstr (int y, int x, string str, int n)
• public int mvaddstr (int y, int x, string str)
• public int mvchgat (int y, int x, int n, ulong attr, short color, void* data)
• public int mvcur (int oldrow, int oldcol, int newrow, int newcol)
• public int mvdelch (int y, int x)
• public int mvgetch (int y, int x)
• public int mvgetnstr (int y, int x, string str, int n)
• public int mvgetstr (int y, int x, string str)
• public int mvhline (int y, int x, ulong ch, int n)
• public ulong mvinch (int y, int x)
• public int mvinchnstr (int y, int x, ulong[] chstr, int n)
• public int mvinchstr (int y, int x, ulong[] chstr)
• public int mvinnstr (int y, int x, string str, int n)
• public int mvinsch (int y, int x, ulong ch)
• public int mvinsnstr (int y, int x, string str, int n)
• public int mvinsstr (int y, int x, string str)
• public int mvinstr (int y, int x, string str)
• public int mvprintw (int y, int x, string str, ...)
• public int mvscanw (int y, int x, string str, ...)
• public int mvvline (int y, int x, ulong ch, int n)
• public int napms (int ms)
  Sleep for ms milliseconds.
• public int nl ()
  Enter newline mode.
• public int nocbreak ()
  Leave cbreak mode. Return to normal "cooked" mode with line buffering.
• public int noecho ()
  Leave echo mode. Echoing of input characters is turned off.
• public int nonl ()
  Leave newline mode.
• public void noqiflush ()
  When the noqiflush routine is used, normal flush of input and output queues associated with the INTR, QUIT and SUSP characters will not be done.
• public int noraw ()
  Leave raw mode. Return to normal "cooked" mode with line buffering.
• public int pair_content (short pair, ref Color f, ref Color b)
• public int printw (string str, ...)
• public void qiflush ()
• public int raw ()
  Enter raw mode.
• public int refresh ()
  Update the display immediately (sync actual screen with previous drawing/deleting methods).
• public int reset_prog_mode ()
• public int reset_shell_mode ()
• public int resetty ()
• public int restartterm (string? term, int filedes, out int errret)
• public int ripoffline (int line, RipofflineInitFunc init)
• public int savetty ()
• public int scanw (string str, ...)
• public int scr_dump (string str)
• public int scr_init (string str)
• public int scr_restore (string str)
• public int scr_set (string str)
• public int scrl (int n)
• public int setscrreg (int top, int bot)
• public int setterm (string? term)
• public int setupterm (string? term, int filedes, out int errret)
• public ulong slk_attr ()
• public int slk_attr_off (ulong attrs, void* data)
• public int slk_attr_on (ulong attrs, void* data)
• public int slk_attr_set (ulong attrs, short pair, void* data)
• public int slk_attroff (ulong attrs)
• public int slk_attron (ulong attrs)
• public int slk_attrset (ulong attrs)
• public int slk_clear ()
• public int slk_color (short color_pair_number)
• public int slk_init (int fmt)
• public string slk_label (int labnum)
• public int slk_noutrefresh ()
• public int slk_refresh ()
• public int slk_restore ()
• public int slk_set (int labnum, string label, int fmt)
• public int slk_touch ()
• public int standend ()
• public int standout ()
• public int start_color ()
• public ulong termattrs ()
  Returns a logical OR of all video attributes supported by the terminal.
• public string termname ()
  Returns the value of the environment variable TERM, truncated to 14 characters.
• public void timeout (int delay)
  Sets blocking or non-blocking read behavior for the window. If delay is negative, blocking read is used (which will wait indefinitely for input).
• public int typeahead (int fd)
  Specifies that the file descriptor fd be used for typeahead checking. If fd is -1, then no typeahead checking is done.
• public int ungetch (int ch)
  Push ch so the next Curses.getch will return it.
• public void use_env (bool bf)
  If used, this function should be called before Curses.initscr or newterm are called.
• public int vidattr (ulong attrs)
• public int vidputs (ulong attrs, VidputsPutcFunc putc)
• public int vline (ulong ch, int n)
  Display a vertical line starting at (y, x) with length n consisting of the character ch.

Fields:

• public Terminal? cur_term
• public Window curscr
• public Window newscr
• public Window stdscr
• TermInfo

Methods:

• public int getflag (string capname)
• public int getnum (string capname)
• public unowned string? getstr (string capname)
• public unowned string parm (string capname, ...)
• public int puts (string str, int affcnt = 1, VidputsPutcFunc putc = (c) => { [...] })