RzCons

class RzCons

property blankline: int

property break_lines: bool

property break_word: str

property break_word_len: int

property cb_break: RzConsBreakCallback

property cb_click: RzConsClickCallback

property cb_editor: RzConsEditorCallback

property cb_fkey: RzConsFunctionKey

property cb_sleep_begin: RzConsSleepBeginCallback

property cb_sleep_end: RzConsSleepEndCallback

property cb_task_oneshot: RzConsQueueTaskOneshot

property click_set: bool

property click_x: int

property click_y: int

property columns: int

property context: RzConsContext

property dotted_lines: bool

property _echo: int

property _enable_highlight: bool

property event_data: Any

property event_resize: RzConsEvent

property fdin: FILE

property fdout: int

property _filter: bool

property fix_columns: int

property fix_rows: int

property _flush: bool

property force_columns: int

property force_rows: int

property grep_color: bool

property grep_highlight: bool

property _highlight: str

property _input: RzConsInputContext

property is_html: bool

property is_wine: int

property _lastline: str

property line: RzLine

property lines: int

property linesleep: int

property mouse: int

property mouse_event: int

property _newline: bool

property null: int

property num: RzNum

property pager: str

property pagesize: int

property refcnt: int

property rgbstr: CFunction[[str, size_t, int], str]

property rows: int

property show_autocomplete_widget: bool

property show_vals: bool

property teefile: str

property timeout: int

property use_utf8: bool

property use_utf8_curvy: bool

property user: Any

property user_fgets: CFunction[[str, int, Any], int]

property user_fgets_user: Any

property vline: Pointer[Pointer[int]]

property vtmode: RzVirtTermMode

property was_html: bool

static any_key() → int

Calls function rz_cons_any_key (defined in input.c)

static arrow_to_hjkl() → int

Calls function rz_cons_arrow_to_hjkl (defined in input.c)

static bind() → None

Calls function rz_cons_bind (defined in cons.c)

static break_clear() → None

Calls function rz_cons_break_clear (defined in cons.c)

static break_end() → None

Calls function rz_cons_break_end (defined in cons.c)

static break_pop() → None

Calls function rz_cons_break_pop (defined in cons.c)

static break_push(user: Any) → None

Calls function rz_cons_break_push (defined in cons.c)

static break_timeout() → None

Calls function rz_cons_break_timeout (defined in cons.c)

static breakword() → None

Calls function rz_cons_breakword (defined in cons.c)

static canvas_box(x: int, y: int, w: int, h: int, color: str) → None

Calls function rz_cons_canvas_box (defined in canvas.c)

static canvas_clear() → None

Calls function rz_cons_canvas_clear (defined in canvas.c)

static canvas_fill(x: int, y: int, w: int, h: int, ch: int) → None

Calls function rz_cons_canvas_fill (defined in canvas.c)

static canvas_free() → None

Calls function rz_cons_canvas_free (defined in canvas.c)

static canvas_gotoxy(x: int, y: int) → bool

Calls function rz_cons_canvas_gotoxy (defined in canvas.c)

static canvas_line(x: int, y: int, x2: int, y2: int, style: RzCanvasLineStyle) → None

Calls function rz_cons_canvas_line (defined in canvas.c)

static canvas_line_back_edge(x: int, y: int, x2: int, y2: int, style: RzCanvasLineStyle, ybendpoint1: int, xbendpoint: int, ybendpoint2: int, isvert: int) → None

Calls function rz_cons_canvas_line_back_edge (defined in canvas_line.c)

static canvas_line_diagonal(x: int, y: int, x2: int, y2: int, style: RzCanvasLineStyle) → None

Calls function rz_cons_canvas_line_diagonal (defined in canvas_line.c)

static canvas_line_square(x: int, y: int, x2: int, y2: int, style: RzCanvasLineStyle) → None

Calls function rz_cons_canvas_line_square (defined in canvas_line.c)

static canvas_line_square_defined(x: int, y: int, x2: int, y2: int, style: RzCanvasLineStyle, bendpoint: int, isvert: int) → None

Calls function rz_cons_canvas_line_square_defined (defined in canvas_line.c)

static canvas_new(h: int) → RzConsCanvas

Calls function rz_cons_canvas_new (defined in canvas.c)

static canvas_print() → None

Calls function rz_cons_canvas_print (defined in canvas.c)

static canvas_print_region() → None

Calls function rz_cons_canvas_print_region (defined in canvas.c)

static canvas_resize(w: int, h: int) → int

Calls function rz_cons_canvas_resize (defined in canvas.c)

static canvas_to_string() → str

Calls function rz_cons_canvas_to_string (defined in canvas.c)

static canvas_write(_s: str) → None

Calls function rz_cons_canvas_write (defined in canvas.c)

static chop() → None

Calls function rz_cons_chop (defined in cons.c)

static clear() → None

Calls function rz_cons_clear (defined in cons.c)

static clear00() → None

Calls function rz_cons_clear00 (defined in cons.c)

static clear_buffer() → None

Calls function rz_cons_clear_buffer (defined in cons.c)

static clear_line() → None

Calls function rz_cons_clear_line (defined in cons.c)

static cmd_help(use_color: bool) → None

Calls function rz_cons_cmd_help (defined in cons.c)

static color(r: int, g: int, b: int) → None

Calls function rz_cons_color (defined in cons.c)

static color_random() → RzColor

Calls function rz_cons_color_random (defined in cons.c)

static column() → None

Calls function rz_cons_column (defined in cons.c)

static context_break() → None

Calls function rz_cons_context_break (defined in cons.c)

static context_break_pop(sig: bool) → None

Calls function rz_cons_context_break_pop (defined in cons.c)

static context_break_push(cb: RzConsBreak, user: Any, sig: bool) → None

Calls function rz_cons_context_break_push (defined in cons.c)

static context_free() → None

Calls function rz_cons_context_free (defined in cons.c)

static context_is_main() → bool

Calls function rz_cons_context_is_main (defined in cons.c)

static context_load() → None

Calls function rz_cons_context_load (defined in cons.c)

static context_new() → RzConsContext

Calls function rz_cons_context_new (defined in cons.c)

static context_reset() → None

Calls function rz_cons_context_reset (defined in cons.c)

static controlz() → int

Calls function rz_cons_controlz (defined in input.c)

static default_context_is_interactive() → bool

Calls function rz_cons_default_context_is_interactive (defined in cons.c)

static drop() → bool

Calls function rz_cons_drop (defined in cons.c)

static echo() → None

Calls function rz_cons_echo (defined in cons.c)

static enable_highlight() → None

Calls function rz_cons_enable_highlight (defined in cons.c)

static enable_mouse() → bool

Calls function rz_cons_enable_mouse (defined in cons.c)

static eof() → int

Calls function rz_cons_eof (defined in cons.c)

static fgets(len: int, argc: int, argv: Pointer[Pointer[int]]) → int

Calls function rz_cons_fgets (defined in input.c)

static fill_line() → None

Calls function rz_cons_fill_line (defined in cons.c)

static filter() → None

Calls function rz_cons_filter (defined in cons.c)

static flush() → None

Calls function rz_cons_flush (defined in cons.c)

static free() → RzCons

Calls function rz_cons_free (defined in cons.c)

static get_buffer() → str

Calls function rz_cons_get_buffer (defined in cons.c)

Return the current RzCons buffer.

static get_buffer_dup() → str

Calls function rz_cons_get_buffer_dup (defined in cons.c)

Return a newly allocated buffer containing what’s currently in RzCons buffer.

static get_buffer_len() → int

Calls function rz_cons_get_buffer_len (defined in cons.c)

static get_click(y: int) → bool

Calls function rz_cons_get_click (defined in cons.c)

static get_column() → int

Calls function rz_cons_get_column (defined in cons.c)

static get_cur_line() → int

Calls function rz_cons_get_cur_line (defined in cons.c)

static get_cursor() → int

Calls function rz_cons_get_cursor (defined in cons.c)

Calculates the aproximated x,y coordinates of the cursor before flushing.

Parameters:

rows – Row number of the cursor

Returns:

Column number of the cursor

static get_rune() → str

Calls function rz_cons_get_rune (defined in cons.c)

static get_size() → int

Calls function rz_cons_get_size (defined in cons.c)

static goto_origin_reset() → None

Calls function rz_cons_goto_origin_reset (defined in cons.c)

static gotoxy(y: int) → None

Calls function rz_cons_gotoxy (defined in cons.c)

static grep() → None

Calls function rz_cons_grep (defined in grep.c)

static grep_help() → None

Calls function rz_cons_grep_help (defined in grep.c)

static grep_line(len: int) → int

Calls function rz_cons_grep_line (defined in grep.c)

static grep_parsecmd(quotestr: str) → None

Calls function rz_cons_grep_parsecmd (defined in grep.c)

static grep_process() → None

Calls function rz_cons_grep_process (defined in grep.c)

static grep_strip(quotestr: str) → str

Calls function rz_cons_grep_strip (defined in grep.c)

static grepbuf() → None

Calls function rz_cons_grepbuf (defined in grep.c)

static highlight() → None

Calls function rz_cons_highlight (defined in cons.c)

static html_filter(newlen: int) → str

Calls function rz_cons_html_filter (defined in html.c)

static hud(prompt: str) → str

Calls function rz_cons_hud (defined in hud.c)

static hud_file() → str

Calls function rz_cons_hud_file (defined in hud.c)

static hud_path(dir: int) → str

Calls function rz_cons_hud_path (defined in hud.c)

static hud_string() → str

Calls function rz_cons_hud_string (defined in hud.c)

static input() → str

Calls function rz_cons_input (defined in input.c)

static invert(color: int) → None

Calls function rz_cons_invert (defined in cons.c)

static is_breaked() → bool

Calls function rz_cons_is_breaked (defined in cons.c)

static is_interactive() → bool

Calls function rz_cons_is_interactive (defined in cons.c)

static is_utf8() → bool

Calls function rz_cons_is_utf8 (defined in cutf8.c)

static isatty() → bool

Calls function rz_cons_isatty (defined in cons.c)

static last() → None

Calls function rz_cons_last (defined in cons.c)

static lastline() → str

Calls function rz_cons_lastline (defined in cons.c)

static lastline_utf8_ansi_len() → str

Calls function rz_cons_lastline_utf8_ansi_len (defined in cons.c)

static less() → None

Calls function rz_cons_less (defined in less.c)

static less_str(exitkeys: str) → int

Calls function rz_cons_less_str (defined in less.c)

static memcat(len: int) → int

Calls function rz_cons_memcat (defined in cons.c)

static memset(len: int) → None

Calls function rz_cons_memset (defined in cons.c)

static message() → None

Calls function rz_cons_message (defined in hud.c)

static new() → RzCons

Calls function rz_cons_new (defined in cons.c)

static newline() → None

Calls function rz_cons_newline (defined in cons.c)

static pal_copy(src: RzConsContext) → None

Calls function rz_cons_pal_copy (defined in pal.c)

static pal_free() → None

Calls function rz_cons_pal_free (defined in pal.c)

static pal_get() → RzColor

Calls function rz_cons_pal_get (defined in pal.c)

static pal_get_i() → RzColor

Calls function rz_cons_pal_get_i (defined in pal.c)

static pal_get_name() → str

Calls function rz_cons_pal_get_name (defined in pal.c)

static pal_init() → None

Calls function rz_cons_pal_init (defined in pal.c)

static pal_len() → int

Calls function rz_cons_pal_len (defined in pal.c)

static pal_list(arg: str) → None

Calls function rz_cons_pal_list (defined in pal.c)

static pal_parse(outcol: RzColor) → str

Calls function rz_cons_pal_parse (defined in pal.c)

static pal_random() → None

Calls function rz_cons_pal_random (defined in pal.c)

static pal_set(val: str) → int

Calls function rz_cons_pal_set (defined in pal.c)

static pal_show() → None

Calls function rz_cons_pal_show (defined in pal.c)

static pal_update_event() → None

Calls function rz_cons_pal_update_event (defined in pal.c)

static pipe_close() → None

Calls function rz_cons_pipe_close (defined in cpipe.c)

static pipe_open(fdn: int, append: int) → int

Calls function rz_cons_pipe_open (defined in cpipe.c)

static pop() → None

Calls function rz_cons_pop (defined in cons.c)

static println() → None

Calls function rz_cons_println (defined in cons.c)

static push() → None

Calls function rz_cons_push (defined in cons.c)

static rainbow_free() → None

Calls function rz_cons_rainbow_free (defined in pal.c)

static rainbow_get(last: int, bg: bool) → str

Calls function rz_cons_rainbow_get (defined in pal.c)

static rainbow_new(sz: int) → None

Calls function rz_cons_rainbow_new (defined in pal.c)

static readbuffer_readchar() → bool

Calls function rz_cons_readbuffer_readchar (defined in input.c)

static readchar() → int

Calls function rz_cons_readchar (defined in input.c)

static readchar_timeout() → int

Calls function rz_cons_readchar_timeout (defined in input.c)

static readflush() → None

Calls function rz_cons_readflush (defined in input.c)

static readpush(len: int) → bool

Calls function rz_cons_readpush (defined in input.c)

static reset() → None

Calls function rz_cons_reset (defined in cons.c)

static reset_colors() → None

Calls function rz_cons_reset_colors (defined in cons.c)

static rgb_init() → None

Calls function rz_cons_rgb_init (defined in rgb.c)

static rgb_parse(r: int, g: int, b: int, a: int) → int

Calls function rz_cons_rgb_parse (defined in rgb.c)

static rgb_str(sz: size_t, rcolor: RzColor) → str

Calls function rz_cons_rgb_str (defined in rgb.c)

static rgb_str_mode(outstr: str, sz: size_t, rcolor: RzColor) → str

Calls function rz_cons_rgb_str_mode (defined in rgb.c)

static rgb_str_off(sz: size_t, off: int) → str

Calls function rz_cons_rgb_str_off (defined in rgb.c)

static rgb_tostring(g: int, b: int) → str

Calls function rz_cons_rgb_tostring (defined in rgb.c)

static set_click(y: int) → None

Calls function rz_cons_set_click (defined in cons.c)

static set_cup() → bool

Calls function rz_cons_set_cup (defined in cons.c)

static set_flush() → None

Calls function rz_cons_set_flush (defined in cons.c)

Set whether RzCons should flush content to screen or not.

Parameters:

flush – If true, calls to rz_cons_flush and rz_cons_visual_flush would flush cons content to the screen, otherwise they will not.

static set_interactive() → None

Calls function rz_cons_set_interactive (defined in cons.c)

static set_last_interactive() → None

Calls function rz_cons_set_last_interactive (defined in cons.c)

static set_raw() → None

Calls function rz_cons_set_raw (defined in cons.c)

void rz_cons_set_raw( [0,1] )

Change canonicality of the terminal

For optimization reasons, there’s no initialization flag, so you need to ensure that the make the first call to rz_cons_set_raw() with ‘1’ and the next calls ^=1, so: 1, 0, 1, 0, 1, …

If you doesn’t use this order you’ll probably loss your terminal properties.

static set_title() → None

Calls function rz_cons_set_title (defined in cons.c)

static set_utf8() → None

Calls function rz_cons_set_utf8 (defined in cons.c)

static show_cursor() → None

Calls function rz_cons_show_cursor (defined in cons.c)

static singleton() → RzCons

Calls function rz_cons_singleton (defined in cons.c)

static sleep_begin() → Any

Calls function rz_cons_sleep_begin (defined in cons.c)

static sleep_end() → None

Calls function rz_cons_sleep_end (defined in cons.c)

static strcat() → None

Calls function rz_cons_strcat (defined in cons.c)

static strcat_at(x: int, y: int, w: int, h: int) → None

Calls function rz_cons_strcat_at (defined in cons.c)

static strcat_justify(j: int, c: int) → None

Calls function rz_cons_strcat_justify (defined in cons.c)

static swap_ground() → str

Calls function rz_cons_swap_ground (defined in cons.c)

static switchbuf() → None

Calls function rz_cons_switchbuf (defined in input.c)

static visual_flush() → None

Calls function rz_cons_visual_flush (defined in cons.c)

static visual_write() → None

Calls function rz_cons_visual_write (defined in cons.c)

static zero() → None

Calls function rz_cons_zero (defined in cons.c)