comparison src/keyboard.c @ 43271:a8329a91e9b5

(Fthis_command_keys, Fthis_command_keys_vector) (Fthis_single_command_keys, Fthis_single_command_raw_keys) (Fclear_this_command_keys): Doc fixes.
author Richard M. Stallman <rms@gnu.org>
date Wed, 13 Feb 2002 16:23:08 +0000
parents 241310b1046a
children 030bfb08056e
comparison
equal deleted inserted replaced
43270:935816913346 43271:a8329a91e9b5
9621 } 9621 }
9622 } 9622 }
9623 9623
9624 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0, 9624 DEFUN ("this-command-keys", Fthis_command_keys, Sthis_command_keys, 0, 0, 0,
9625 doc: /* Return the key sequence that invoked this command. 9625 doc: /* Return the key sequence that invoked this command.
9626 However, if the command has called `read-key-sequence', it returns
9627 the the last key sequence that has been read.
9626 The value is a string or a vector. */) 9628 The value is a string or a vector. */)
9627 () 9629 ()
9628 { 9630 {
9629 return make_event_array (this_command_key_count, 9631 return make_event_array (this_command_key_count,
9630 XVECTOR (this_command_keys)->contents); 9632 XVECTOR (this_command_keys)->contents);
9631 } 9633 }
9632 9634
9633 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0, 9635 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector, Sthis_command_keys_vector, 0, 0, 0,
9634 doc: /* Return the key sequence that invoked this command, as a vector. */) 9636 doc: /* Return the key sequence that invoked this command, as a vector.
9637 However, if the command has called `read-key-sequence', it returns
9638 the the last key sequence that has been read. */)
9635 () 9639 ()
9636 { 9640 {
9637 return Fvector (this_command_key_count, 9641 return Fvector (this_command_key_count,
9638 XVECTOR (this_command_keys)->contents); 9642 XVECTOR (this_command_keys)->contents);
9639 } 9643 }
9640 9644
9641 DEFUN ("this-single-command-keys", Fthis_single_command_keys, 9645 DEFUN ("this-single-command-keys", Fthis_single_command_keys,
9642 Sthis_single_command_keys, 0, 0, 0, 9646 Sthis_single_command_keys, 0, 0, 0,
9643 doc: /* Return the key sequence that invoked this command. 9647 doc: /* Return the key sequence that invoked this command.
9648 More generally, it returns the last key sequence read, either by
9649 the command loop or by `read-key-sequence'.
9644 Unlike `this-command-keys', this function's value 9650 Unlike `this-command-keys', this function's value
9645 does not include prefix arguments. 9651 does not include prefix arguments.
9646 The value is always a vector. */) 9652 The value is always a vector. */)
9647 () 9653 ()
9648 { 9654 {
9653 } 9659 }
9654 9660
9655 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys, 9661 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys,
9656 Sthis_single_command_raw_keys, 0, 0, 0, 9662 Sthis_single_command_raw_keys, 0, 0, 0,
9657 doc: /* Return the raw events that were read for this command. 9663 doc: /* Return the raw events that were read for this command.
9664 More generally, it returns the last key sequence read, either by
9665 the command loop or by `read-key-sequence'.
9658 Unlike `this-single-command-keys', this function's value 9666 Unlike `this-single-command-keys', this function's value
9659 shows the events before all translations (except for input methods). 9667 shows the events before all translations (except for input methods).
9660 The value is always a vector. */) 9668 The value is always a vector. */)
9661 () 9669 ()
9662 { 9670 {
9686 } 9694 }
9687 9695
9688 DEFUN ("clear-this-command-keys", Fclear_this_command_keys, 9696 DEFUN ("clear-this-command-keys", Fclear_this_command_keys,
9689 Sclear_this_command_keys, 0, 0, 0, 9697 Sclear_this_command_keys, 0, 0, 0,
9690 doc: /* Clear out the vector that `this-command-keys' returns. 9698 doc: /* Clear out the vector that `this-command-keys' returns.
9691 Clear vector containing last 100 events. */) 9699 Also clear the record of the last 100 events. */)
9692 () 9700 ()
9693 { 9701 {
9694 int i; 9702 int i;
9695 9703
9696 this_command_key_count = 0; 9704 this_command_key_count = 0;