ExTermbox v1.0.2 ExTermbox.Constants View Source

Defines constants from the termbox library. These can be used e.g. to set a formatting attributes or to identify keys passed in an event.

Link to this section Summary

Types

attribute()

color()

constant()

error_code()

event_type()

hide_cursor()

input_mode()

key()

output_mode()

Functions

attribute(name)

Retrieves an attribute constant by name

attributes()

Retrieves the mapping of attribute constants.

color(name)

Retrieves a color constant by name

colors()

Retrieves the mapping of color constants.

error_code(name)

Retrieves an error code constant by name

error_codes()

Retrieves the mapping of error code constants.

event_type(name)

Retrieves an event type constant by name

event_types()

Retrieves the mapping of event type constants.

hide_cursor()

Retrieves the hide cursor constant.

input_mode(name)

Retrieves an input mode constant by name

input_modes()

Retrieves the mapping of input mode constants.

key(name)

Retrieves a key constant by name

keys()

Retrieves the mapping of key constants for use with termbox.

output_mode(name)

Retrieves an output mode constant by name

output_modes()

Retrieves the mapping of output mode constants.

Link to this section Types

attribute()

attribute() :: constant()

color()

color() :: constant()

constant()

constant() :: integer()

error_code()

error_code() :: constant()

event_type()

event_type() :: constant()

hide_cursor()

hide_cursor() :: constant()

input_mode()

input_mode() :: constant()

key()

key() :: constant()

output_mode()

output_mode() :: constant()

Link to this section Functions

attribute(name)

attribute(atom()) :: attribute()

Retrieves an attribute constant by name

Examples

iex> attribute(:bold)
0x0100
iex> attribute(:underline)
0x0200

attributes()

attributes() :: %{required(atom()) => attribute()}

Retrieves the mapping of attribute constants.

color(name)

color(atom()) :: color()

Retrieves a color constant by name

Examples

iex> color(:red)
0x02
iex> color(:blue)
0x05

colors()

colors() :: %{required(atom()) => color()}

Retrieves the mapping of color constants.

error_code(name)

error_code(atom()) :: error_code()

Retrieves an error code constant by name

Examples

iex> error_code(:unsupported_terminal)
-1

error_codes()

error_codes() :: %{required(atom()) => error_code()}

Retrieves the mapping of error code constants.

event_type(name)

event_type(atom()) :: event_type()

Retrieves an event type constant by name

Examples

iex> event_type(:key)
0x01
iex> event_type(:resize)
0x02
iex> event_type(:mouse)
0x03

event_types()

event_types() :: %{required(atom()) => event_type()}

Retrieves the mapping of event type constants.

hide_cursor()

hide_cursor() :: hide_cursor()

Retrieves the hide cursor constant.

Examples

iex> hide_cursor()
-1

input_mode(name)

input_mode(atom()) :: input_mode()

Retrieves an input mode constant by name

Examples

iex> input_mode(:esc)
1
iex> input_mode(:esc_with_mouse)
5

input_modes()

input_modes() :: %{required(atom()) => input_mode()}

Retrieves the mapping of input mode constants.

key(name)

key(atom()) :: key()

Retrieves a key constant by name

Examples

iex> key(:esc)
0x1B
iex> key(:space)
0x20

keys()

keys() :: %{required(atom()) => key()}

Retrieves the mapping of key constants for use with termbox.

These are based on terminfo constants. Note that there's some overlap of terminfo values. For example, it's not possible to distinguish between <backspace> and ctrl-h.

output_mode(name)

output_mode(atom()) :: output_mode()

Retrieves an output mode constant by name

Examples

iex> output_mode(:term_256)
2

output_modes()

output_modes() :: %{required(atom()) => output_mode()}

Retrieves the mapping of output mode constants.