ColorTheme & Curses Color Definitions

ColorTheme

class curses_fzf.ColorTheme(text: Color = Color.WHITE, window_title: Color = Color.YELLOW, no_match: Color = Color.RED, query: Color = Color.YELLOW, footer: Color = Color.YELLOW, selected: Color = Color.GREEN, cursor: Color = Color.BLACK_ON_WHITE, cursor_selected: Color = Color.BLACK_ON_GREEN, highlight: Color = Color.BLACK_ON_CYAN)[source]

A color theme for the FuzzyFinder, to allow for easy color customization. This is mainly meant to account for color blindness or unusual terminal colors.

Provide a ColorTheme instance to FuzzyFinder’s color_theme parameter.

All color indices are accessible by class attributes of the same name as the respective parameter.

Parameters:

text (Color) – The normal text (default Color.WHITE).
window_title (Color) – The title in the upper left corner of the main and sub windows (default Color.YELLOW).
no_match (Color) – The warning indicating that there are no matched items left (default Color.RED).
query (Color) – The query string entered by the user (default Color.YELLOW).
footer (Color) – The footer line at the lower end of the main window (default Color.YELLOW).
selected (Color) – The text color of selected items in multi-select mode (default Color.GREEN).
cursor (Color) – The text color for the line with the cursor (default Color.BLACK_ON_WHITE).
cursor_selected (Color) – The text color for the line with the cursor, if the item is selected in multi-select mode (default Color.BLACK_ON_GREEN).
highlight (Color) – The highlight of the text that was matched by the query (default Color.BLACK_ON_CYAN).

Color

class curses_fzf.Color(*values)[source]

An integer enum with the indices that get registered by curses.init_pair(). As those indices start at 30, you are free to use 1-29 to register your own additional color pairs.

BLACK = 30: Black text on default terminal background.

BLACK_ON_BLUE = 44: Black text on blue background.

BLACK_ON_CYAN = 46: Black text on cyan background.

BLACK_ON_GREEN = 42: Black text on green background.

BLACK_ON_MAGENTA = 45: Black text on magenta background.

BLACK_ON_RED = 41: Black text on red background.

BLACK_ON_WHITE = 47: Black text on white background.

BLACK_ON_YELLOW = 43: Black text on yellow background.

BLUE = 34: Blue text on default terminal background.

CYAN = 36: Cyan text on default terminal background.

GREEN = 32: Green text on default terminal background.

MAGENTA = 35: Magenta text on default terminal background.

RED = 31: Red text on default terminal background.

WHITE = 37: White text on default terminal background.

WHITE_ON_BLACK = 50: White text on black background.

WHITE_ON_BLUE = 54: White text on blue background.

WHITE_ON_CYAN = 56: White text on cyan background.

WHITE_ON_GREEN = 52: White text on green background.

WHITE_ON_MAGENTA = 55: White text on magenta background.

WHITE_ON_RED = 51: White text on red background.

WHITE_ON_YELLOW = 53: White text on yellow background.

YELLOW = 33: Yellow text on default terminal background.