Document :key

This commit is contained in:
David Botton 2021-03-06 22:33:55 -05:00
parent 8659b31f71
commit 3f695ef471
2 changed files with 5 additions and 4 deletions

View file

@ -1053,8 +1053,8 @@ ON-TOUCH-CANCEL-HANDLER is nil unbind the event."))
(defgeneric set-on-character (clog-obj on-character-handler &key one-time) (defgeneric set-on-character (clog-obj on-character-handler &key one-time)
(:documentation "Set the ON-CHARACTER-HANDLER for CLOG-OBJ. If (:documentation "Set the ON-CHARACTER-HANDLER for CLOG-OBJ. If
ON-CHARACTER-HANDLER is nil unbind the event. Setting this event ON-CHARACTER-HANDLER is nil unbind the event. Setting this event to
will replace a on-key-down")) nil will unbind on-key-press also."))
(defmethod set-on-character ((obj clog-obj) handler &key (one-time nil)) (defmethod set-on-character ((obj clog-obj) handler &key (one-time nil))
(set-event obj "keypress" (set-event obj "keypress"

View file

@ -234,8 +234,9 @@ Events in clog-base
:meta-key t or nil if meta-key held down :meta-key t or nil if meta-key held down
:event-type :keyboard :event-type :keyboard
:key-code A key code sometimes called a scan code for the key pressed :key String of key pressed, with out modifiers like ctrl characters
:char-code UTF-8 representation for key pressed when possible :key-code The utf-16 value of :key
:char-code UTF-8 representation for key pressed when possible - deprecated
:alt-key t or nil if alt-key held down :alt-key t or nil if alt-key held down
:ctrl-key t or nil if ctrl-key held down :ctrl-key t or nil if ctrl-key held down
:shift-key t or nil if shift-key held down :shift-key t or nil if shift-key held down