charm.message — de.timokramer/charm.clj 0.1.42

Message types for charm.clj TUI applications.

Messages are plain maps with a :type key for easy pattern matching. Use factory functions to create messages and predicates to check types.

alt? clj

(alt? msg)

Check if alt modifier is set.

blur clj

(blur)

Create a focus lost (blur) message.

blur? clj

(blur? msg)

Check if message is a blur event.

ctrl? clj

(ctrl? msg)

Check if ctrl modifier is set.

error clj

(error throwable)

Create an error message.

error? clj

(error? msg)

Check if message is an error.

focus clj

(focus)

Create a focus gained message.

focus? clj

(focus? msg)

Check if message is a focus event.

key-match? clj

(key-match? msg key)

Check if a key-press message matches the given key.

Key can be:

• A string like "q", "a" (matches character keys)
• A keyword like :enter, :up, :tab (matches special keys)
• A pattern like "ctrl+c" (matches with modifiers)

key-press clj

(key-press key
           &
           {:keys [alt ctrl shift] :or {alt false ctrl false shift false}})

Create a key press message.

Options: :alt - Alt key modifier (default false) :ctrl - Ctrl key modifier (default false) :shift - Shift key modifier (default false)

key-press? clj

(key-press? msg)

Check if message is a key press.

mouse clj

(mouse action
       button
       x
       y
       &
       {:keys [alt ctrl shift] :or {alt false ctrl false shift false}})

Create a mouse event message.

Action is one of: :press :release :motion :wheel-up :wheel-down Button is one of: :left :middle :right :none

mouse? clj

(mouse? msg)

Check if message is a mouse event.

msg-type clj

(msg-type msg)

Get the type of a message.

quit clj

(quit)

Create a quit message to exit the program.

quit? clj

(quit? msg)

Check if message is a quit signal.

shift? clj

(shift? msg)

Check if shift modifier is set.

window-size clj

(window-size width height)

Create a window size message.

window-size? clj

(window-size? msg)

Check if message is a window size change.