comparison man/lispref/commands.texi @ 2828:a25c824ed558

[xemacs-hg @ 2005-06-26 18:04:49 by aidan] Rename the ascii-character property, support more keysyms.
author aidan
date Sun, 26 Jun 2005 18:05:05 +0000
parents 47c30044fc4e
children b95fe16005fd
comparison
equal deleted inserted replaced
2827:936a6576c655 2828:a25c824ed558
1480 If you don't want this silly meta interpretation done, you should pass 1480 If you don't want this silly meta interpretation done, you should pass
1481 in a list containing the character. 1481 in a list containing the character.
1482 1482
1483 Beware that @code{character-to-event} and @code{event-to-character} are 1483 Beware that @code{character-to-event} and @code{event-to-character} are
1484 not strictly inverse functions, since events contain much more 1484 not strictly inverse functions, since events contain much more
1485 information than the @sc{ascii} character set can encode. 1485 information than the XEmacs internal character encoding can store.
1486 @end defun 1486 @end defun
1487 1487
1488 @defun event-to-character event &optional allow-extra-modifiers allow-meta allow-non-ascii 1488 @defun event-to-character event &optional allow-extra-modifiers allow-meta
1489 This function returns the closest @sc{ascii} approximation to 1489 This function returns the closest character approximation to
1490 @var{event}. If the event isn't a keypress, this returns @code{nil}. 1490 @var{event}. If the event isn't a keypress, this returns @code{nil}.
1491 1491
1492 If @var{allow-extra-modifiers} is non-@code{nil}, then this is lenient 1492 If @var{allow-extra-modifiers} is non-@code{nil}, then this is lenient
1493 in its translation; it will ignore modifier keys other than 1493 in its translation; it will ignore modifier keys other than
1494 @key{control} and @key{meta}, and will ignore the @key{shift} modifier 1494 @key{control} and @key{meta}, and will ignore the @key{shift} modifier
1499 If @var{allow-meta} is non-@code{nil}, then the @key{Meta} modifier will 1499 If @var{allow-meta} is non-@code{nil}, then the @key{Meta} modifier will
1500 be represented by turning on the high bit of the byte returned; 1500 be represented by turning on the high bit of the byte returned;
1501 otherwise, @code{nil} will be returned for events containing the 1501 otherwise, @code{nil} will be returned for events containing the
1502 @key{Meta} modifier. 1502 @key{Meta} modifier.
1503 1503
1504 If @var{allow-non-ascii} is non-@code{nil}, then characters which are 1504 Specifying @var{allow-meta} will give ambiguous results---@key{M-x} and
1505 present in the prevailing character set (@pxref{Keymaps, variable 1505 @key{oslash} will return the same thing, for example---so you should
1506 @code{character-set-property}}) will be returned as their code in that 1506 probably not use it.
1507 character set, instead of the return value being restricted to
1508 @sc{ascii}.
1509
1510 Note that specifying both @var{allow-meta} and @var{allow-non-ascii} is
1511 ambiguous, as both use the high bit; @key{M-x} and @key{oslash} will be
1512 indistinguishable.
1513 @end defun 1507 @end defun
1514 1508
1515 @defun events-to-keys events &optional no-mice 1509 @defun events-to-keys events &optional no-mice
1516 Given a vector of event objects, this function returns a vector of key 1510 Given a vector of event objects, this function returns a vector of key
1517 descriptors, or a string (if they all fit in the @sc{ascii} range). 1511 descriptors, or a string (if they all fit in the @sc{ascii} range).