API Documentation
- color.py
- colorspace.py
- dec_modes.py
DecModeResponseDecModeResponse.NOT_QUERIEDDecModeResponse.NO_RESPONSEDecModeResponse.NOT_RECOGNIZEDDecModeResponse.SETDecModeResponse.RESETDecModeResponse.PERMANENTLY_SETDecModeResponse.PERMANENTLY_RESETDecModeResponse.modeDecModeResponse.descriptionDecModeResponse.valueDecModeResponse.recognizedDecModeResponse.supportedDecModeResponse.enabledDecModeResponse.disabledDecModeResponse.changeableDecModeResponse.permanentDecModeResponse.failedDecModeResponse.to_dict()
DecPrivateModeDecPrivateMode.SpecialInternalLegacyCSIModifierDecPrivateMode.SpecialInternalModifyOtherKeysDecPrivateMode.SpecialInternalKittyDecPrivateMode.DECCKMDecPrivateMode.DECANMDecPrivateMode.DECCOLMDecPrivateMode.DECSCLMDecPrivateMode.DECSCNMDecPrivateMode.DECOMDecPrivateMode.DECAWMDecPrivateMode.DECARMDecPrivateMode.DECINLMDecPrivateMode.DECEDMDecPrivateMode.DECLTMDecPrivateMode.DECKANAMDecPrivateMode.DECSCFDMDecPrivateMode.DECTEMDecPrivateMode.DECEKEMDecPrivateMode.DECPFFDecPrivateMode.DECPEXDecPrivateMode.OV1DecPrivateMode.BA1DecPrivateMode.BA2DecPrivateMode.PK1DecPrivateMode.AH1DecPrivateMode.DECTCEMDecPrivateMode.DECPSPDecPrivateMode.DECPSMDecPrivateMode.SHOW_SCROLLBAR_RXVTDecPrivateMode.DECRLMDecPrivateMode.DECHEBMDecPrivateMode.DECHEMDecPrivateMode.DECTEKDecPrivateMode.DECCRNLMDecPrivateMode.DECUPMDecPrivateMode.DECNRCMDecPrivateMode.DECGEPMDecPrivateMode.DECGPCMDecPrivateMode.DECGPCSDecPrivateMode.DECGPBMDecPrivateMode.DECGRPMDecPrivateMode.DECTHAIMDecPrivateMode.DECTHAICMDecPrivateMode.DECBWRMDecPrivateMode.DECOPMDecPrivateMode.DEC131TMDecPrivateMode.DECBPMDecPrivateMode.DECNAKBDecPrivateMode.DECIPEMDecPrivateMode.DECKKDMDecPrivateMode.DECHCCMDecPrivateMode.DECVCCMDecPrivateMode.DECPCCMDecPrivateMode.DECBCMMDecPrivateMode.DECNKMDecPrivateMode.DECBKMDecPrivateMode.DECKBUMDecPrivateMode.DECVSSMDecPrivateMode.DECFPMDecPrivateMode.DECXRLMDecPrivateMode.DECSDMDecPrivateMode.DECKPMDecPrivateMode.WY_52_LINEDecPrivateMode.WYENAT_OFFDecPrivateMode.REPLACEMENT_CHAR_COLORDecPrivateMode.DECTHAISCMDecPrivateMode.DECNCSMDecPrivateMode.DECRLCMDecPrivateMode.DECCRTSMDecPrivateMode.DECARSMDecPrivateMode.DECMCMDecPrivateMode.DECAAMDecPrivateMode.DECCANSMDecPrivateMode.DECNULMDecPrivateMode.DECHDPXMDecPrivateMode.DECESKMDecPrivateMode.DECOSCNMDecPrivateMode.DECNUMLKDecPrivateMode.DECCAPSLKDecPrivateMode.DECKLHIMDecPrivateMode.DECFWMDecPrivateMode.DECRPLDecPrivateMode.DECHWUMDecPrivateMode.DECATCUMDecPrivateMode.DECATCBMDecPrivateMode.DECBBSMDecPrivateMode.DECECMDecPrivateMode.MOUSE_REPORT_CLICKDecPrivateMode.MOUSE_HILITE_TRACKINGDecPrivateMode.MOUSE_REPORT_DRAGDecPrivateMode.MOUSE_ALL_MOTIONDecPrivateMode.FOCUS_IN_OUT_EVENTSDecPrivateMode.MOUSE_EXTENDED_UTF8DecPrivateMode.MOUSE_EXTENDED_SGRDecPrivateMode.ALT_SCROLL_XTERMDecPrivateMode.SCROLL_ON_TTY_OUTPUT_RXVTDecPrivateMode.SCROLL_ON_KEYPRESS_RXVTDecPrivateMode.FAST_SCROLLDecPrivateMode.MOUSE_URXVTDecPrivateMode.MOUSE_SGR_PIXELSDecPrivateMode.BOLD_ITALIC_HIGH_INTENSITYDecPrivateMode.META_SETS_EIGHTH_BITDecPrivateMode.MODIFIERS_ALT_NUMLOCKDecPrivateMode.META_SENDS_ESCDecPrivateMode.KP_DELETE_SENDS_DELDecPrivateMode.ALT_SENDS_ESCDecPrivateMode.KEEP_SELECTION_NO_HILITEDecPrivateMode.USE_CLIPBOARD_SELECTIONDecPrivateMode.URGENCY_ON_CTRL_GDecPrivateMode.RAISE_ON_CTRL_GDecPrivateMode.REUSE_CLIPBOARD_DATADecPrivateMode.EXTENDED_REVERSE_WRAPAROUNDDecPrivateMode.ALT_SCREEN_BUFFER_SWITCHDecPrivateMode.ALT_SCREEN_BUFFER_XTERMDecPrivateMode.SAVE_CURSOR_DECSCDecPrivateMode.ALT_SCREEN_AND_SAVE_CLEARDecPrivateMode.TERMINFO_FUNC_KEY_MODEDecPrivateMode.SUN_FUNC_KEY_MODEDecPrivateMode.HP_FUNC_KEY_MODEDecPrivateMode.SCO_FUNC_KEY_MODEDecPrivateMode.LEGACY_KBD_X11R6DecPrivateMode.VT220_KBD_EMULATIONDecPrivateMode.SIXEL_PRIVATE_PALETTEDecPrivateMode.BIDI_ARROW_KEY_SWAPPINGDecPrivateMode.ITERM2_REPORT_KEY_UPDecPrivateMode.READLINE_MOUSE_BUTTON_1DecPrivateMode.READLINE_MOUSE_BUTTON_2DecPrivateMode.READLINE_MOUSE_BUTTON_3DecPrivateMode.BRACKETED_PASTEDecPrivateMode.READLINE_CHARACTER_QUOTINGDecPrivateMode.READLINE_NEWLINE_PASTINGDecPrivateMode.SYNCHRONIZED_OUTPUTDecPrivateMode.GRAPHEME_CLUSTERINGDecPrivateMode.TEXT_REFLOWDecPrivateMode.PASSIVE_MOUSE_TRACKINGDecPrivateMode.REPORT_GRID_CELL_SELECTIONDecPrivateMode.COLOR_PALETTE_UPDATESDecPrivateMode.IN_BAND_WINDOW_RESIZEDecPrivateMode.BRACKETED_PASTE_MIMEDecPrivateMode.MIRROR_BOX_DRAWINGDecPrivateMode.BIDI_AUTODETECTIONDecPrivateMode.AMBIGUOUS_WIDTH_REPORTINGDecPrivateMode.SCROLL_MARKERSDecPrivateMode.REWRAP_ON_RESIZE_MINTTYDecPrivateMode.APPLICATION_ESCAPE_KEYDecPrivateMode.ESC_KEY_SENDS_BACKSLASHDecPrivateMode.GRAPHICS_POSITIONDecPrivateMode.ALT_MODIFIED_MOUSEWHEELDecPrivateMode.SHOW_HIDE_SCROLLBARDecPrivateMode.FONT_CHANGE_REPORTINGDecPrivateMode.GRAPHICS_POSITION_2DecPrivateMode.SHORTCUT_KEY_MODEDecPrivateMode.MOUSEWHEEL_REPORTINGDecPrivateMode.APPLICATION_MOUSEWHEELDecPrivateMode.BIDI_CURRENT_LINEDecPrivateMode.TTCTHDecPrivateMode.SIXEL_SCROLLING_LEAVES_CURSORDecPrivateMode.CHARACTER_MAPPING_SERVICEDecPrivateMode.AMBIGUOUS_WIDTH_DOUBLE_WIDTHDecPrivateMode.WIN32_INPUT_MODEDecPrivateMode.KITTY_HANDLE_CTRL_C_ZDecPrivateMode.MINTTY_BIDIDecPrivateMode.INPUT_METHOD_EDITORDecPrivateMode.long_description
- formatters.py
- keyboard.py
KeystrokeKeystroke._nameKeystroke._codeKeystroke._modeKeystroke._matchKeystroke._modifiersKeystroke.__new__()Keystroke._infer_modifiers()Keystroke.is_sequenceKeystroke._get_modified_keycode_name()Keystroke._get_kitty_protocol_name()Keystroke._get_control_char_name()Keystroke._get_control_symbol()Keystroke._get_alt_only_control_name()Keystroke._get_meta_escape_name()Keystroke._get_mouse_event_name()Keystroke._get_focus_event_name()Keystroke._get_bracketed_paste_name()Keystroke._resolve_name()Keystroke.nameKeystroke.key_nameKeystroke.codeKeystroke.modifiersKeystroke.modifiers_bitsKeystroke._shiftKeystroke._altKeystroke._ctrlKeystroke._superKeystroke._hyperKeystroke._metaKeystroke._caps_lockKeystroke._num_lockKeystroke.uses_keyboard_protocolKeystroke.pressedKeystroke.repeatedKeystroke.releasedKeystroke._is_escape_sequence()Keystroke._make_expected_bits()Keystroke._make_effective_bits()Keystroke._get_keycode_by_name()Keystroke._build_appkeys_predicate()Keystroke._build_alphanum_predicate()Keystroke._get_plain_char_value()Keystroke._get_escape_sequence_value()Keystroke._get_ctrl_sequence_value()Keystroke._get_protocol_value()Keystroke._get_ascii_value()Keystroke.valueKeystroke.key_valueKeystroke.modeKeystroke.mouse_yxKeystroke.mouse_xyKeystroke.cpr_yxKeystroke.cpr_xyKeystroke.textKeystroke._mode_valuesKeystroke._parse_focus()Keystroke._parse_bracketed_paste()Keystroke._parse_resize()
get_keyboard_codes()get_keyboard_sequences()KittyKeyEventModifyOtherKeysEventLegacyCSIKeyEventKittyKeyboardProtocolDeviceAttributeSoftwareVersionBracketedPasteEventFocusEventSyncEventDEFAULT_SEQUENCE_MIXINCURSES_KEYCODE_OVERRIDE_MIXIN
- line_editor.py
DisplayStateLineEditResultLineHistoryLineEditorLineEditor.password_charLineEditor.max_widthLineEditor.ellipsisLineEditor.limitLineEditor.limit_bellLineEditor.scroll_jumpLineEditor.text_sgrLineEditor.suggestion_sgrLineEditor.bg_sgrLineEditor.ellipsis_sgrLineEditor.keymapLineEditor.historyLineEditor.lineLineEditor.password_modeLineEditor.displayLineEditor.render()LineEditor.render_insert()LineEditor.render_backspace()LineEditor.feed_key()LineEditor.insert_text()LineEditor.clear()LineEditor.set_password_mode()
- mouse.py
- sequences.py
SequenceSequenceTextWrapperSequenceTextWrapper._next_hyperlink_id()SequenceTextWrapper._width()SequenceTextWrapper._strip_sequences()SequenceTextWrapper._extract_sequences()SequenceTextWrapper._split()SequenceTextWrapper._wrap_chunks()SequenceTextWrapper._track_hyperlink_state()SequenceTextWrapper._handle_long_word()SequenceTextWrapper._map_stripped_pos_to_original()SequenceTextWrapper._find_break_position()SequenceTextWrapper._find_first_grapheme_end()SequenceTextWrapper._rstrip_visible()
iter_parse()measure_length()
- terminal.py
TerminalTerminal.CursorShapeTerminal.DecrqssTerminal.DecPrivateModeTerminal.__getattr__()Terminal.kindTerminal.does_stylingTerminal.is_a_ttyTerminal.heightTerminal.widthTerminal.pixel_heightTerminal.pixel_widthTerminal.location()Terminal.get_location()Terminal.get_fgcolor()Terminal.get_bgcolor()Terminal.get_fgcolor_hex()Terminal.get_bgcolor_hex()Terminal.get_device_attributes()Terminal.get_software_version()Terminal.does_sixel()Terminal.detect_ambiguous_width()Terminal.get_dec_mode()Terminal.dec_modes_enabled()Terminal.dec_modes_disabled()Terminal.does_mouse()Terminal.does_inband_resize()Terminal.does_bracketed_paste()Terminal.does_synchronized_output()Terminal.does_grapheme_clustering()Terminal.does_focus_events()Terminal.get_xtgettcap()Terminal.does_xtgettcap()Terminal.does_kitty_graphics()Terminal.get_iterm2_capabilities()Terminal.does_iterm2()Terminal.does_iterm2_graphics()Terminal.does_kitty_notifications()Terminal.does_kitty_clipboard()Terminal.does_kitty_pointer_shapes()Terminal.does_osc52_clipboard()Terminal.clipboard_copy()Terminal.clipboard_paste()Terminal.get_color_scheme()Terminal.does_kitty_query()Terminal.get_decrqss()Terminal.does_decrqss()Terminal.does_styled_underlines()Terminal.does_colored_underlines()Terminal.does_text_sizing()Terminal.mouse_enabled()Terminal.bracketed_paste()Terminal.synchronized_output()Terminal.focus_events()Terminal.notify_on_resize()Terminal.get_sixel_height_and_width()Terminal.get_sixel_colors()Terminal.get_cell_height_and_width()Terminal.get_kitty_keyboard_state()Terminal.enable_kitty_keyboard()Terminal.fullscreen()Terminal.hidden_cursor()Terminal.cursor_shape()Terminal.no_line_wrap()Terminal.scroll_region()Terminal.move_xy()Terminal.move_yx()Terminal.move_leftTerminal.move_rightTerminal.move_upTerminal.move_downTerminal.colorTerminal.color_rgb()Terminal.color_hex()Terminal.on_colorTerminal.on_color_rgb()Terminal.on_color_hex()Terminal.formatter()Terminal.rgb_downconvert()Terminal.normalTerminal.link()Terminal.set_window_title()Terminal.window_title()Terminal.progress_bar()Terminal.streamTerminal.number_of_colorsTerminal.color_distance_algorithmTerminal.ljust()Terminal.rjust()Terminal.center()Terminal.text_sized()Terminal.truncate()Terminal.length()Terminal.strip()Terminal.rstrip()Terminal.lstrip()Terminal.strip_seqs()Terminal.split_seqs()Terminal.wrap()Terminal.getch()Terminal.ungetch()Terminal.kbhit()Terminal.cbreak()Terminal.raw()Terminal.keypad()Terminal.flushinp()Terminal.inkey()Terminal.async_inkey()
WINSZ