Changes between Version 1 and Version 2 of HemlockProgrammer/LogicalKeyEvents


Ignore:
Timestamp:
Jan 15, 2008, 4:35:50 PM (12 years ago)
Author:
gz
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • HemlockProgrammer/LogicalKeyEvents

    v1 v2  
     1[HemlockProgrammer Back to Table of Contents]
    12[[PageOutline]]
    23
    34= 11. Logical Key-Events =
    45
    5 == 11.1. Introduction ==
     6== 11.1. Introduction ==#Introduction
    67
    78Some primitives such as prompt-for-key (page 50) and commands such as
     
    1819any key-event may represent different logical key-events.
    1920
    20 == 11.2. Logical Key-Event Functions ==
     21== 11.2. Logical Key-Event Functions ==#LogicalKeyEventFunctions
    2122
    22 *logical-key-event-names* [Variable]
     23`*logical-key-event-names*` [Variable]
    2324
    2425This variable holds a string-table mapping all logical key-event names
    2526to the keyword identifying the logical key-event.
    2627
    27 define-logical-key-event string-name documentation [Function]
     28`define-logical-key-event` string-name documentation [Function]
    2829
    29 This function defines a new logical key-event with name string-name, a
    30 simple-string.  Logical key-event operations take logical key-events
     30This function defines a new logical key-event with name string-name.
     31Logical key-event operations take logical key-events
    3132arguments as a keyword whose name is string-name uppercased with
    3233spaces replaced by hyphens.
     
    3435Documentation describes the action indicated by the logical key-event.
    3536
    36 logical-key-event-key-events keyword [Function]
     37`logical-key-event-key-events` keyword [Function]
    3738
    3839This function returns the list of key-events representing the logical
    3940key-event keyword.
    4041
    41 logical-key-event-name keyword [Function]
    42 
    43 logical-key-event-documentation keyword [Function]
     42`logical-key-event-name` keyword [Function][[BR]]
     43`logical-key-event-documentation` keyword [Function][[BR]]
    4444
    4545These functions return the string name and documentation given
    4646to define-logical-key-event for logical key-event keyword.
    4747
    48 logical-key-event-p key-event keyword [Function]
     48`logical-key-event-p` key-event keyword [Function]
    4949
    5050This function returns t if key-event is the logical key-event
     
    5353undefined logical key-event.
    5454
    55 == 11.3. System Defined Logical Key-Events ==
     55== 11.3. System Defined Logical Key-Events ==#SystemDefinedLogicalKeyEvents
    5656
    5757There are many default logical key-events, some of which are used by
     
    6464and displaying help messages.
    6565
     66 * :abort Indicates the prompter should terminate its activity without performing any closing actions of convenience, for example.
    6667 * :yes Indicates the prompter should take the action under consideration.
    6768 * :no Indicates the prompter should NOT take the action under consideration.
    6869 * :do-all Indicates the prompter should repeat the action under consideration as many times as possible.
    6970 * :do-once Indicates the prompter should execute the action under consideration once and then exit.
    70  * :exit Indicates the prompter should terminate its activity in a normal fashion.
    71  * :abort Indicates the prompter should terminate its activity without performing any closing actions of convenience, for example.
    72  * :keep Indicates the prompter should preserve something.
    7371 * :help Indicates the prompter should display some help information.
    7472 * :confirm Indicates the prompter should take any input provided or use the default if the user entered nothing.
    7573 * :quote Indicates the prompter should take the following key-event as itself without any sort of command interpretation.
    76  * :recursive-edit Indicates the prompter should enter a recursive edit in the current context.
    77  * :cancel Indicates the prompter should cancel the effect of a previous key-event input.
    78  * :forward-search Indicates the prompter should search forward in the current context.
    79  * :backward-search Indicates the prompter should search backward in the current context.
     74 * :keep Indicates the prompter should preserve something.
     75 * :y Indicates a short positive response
     76 * :n Indicates a short negative response
    8077
    8178Define a new logical key-event whenever:
     
    8885 change the command in their init files.
    8986
    90  3. You are using command-case which prevents implementors from
     87 3. You are using `command-case` which prevents implementors from
    9188 specifying non-standard characters for dispatching in otherwise
    9289 possibly portable code, and you can define and set the logical
     
    9491 implementation dependent characters.
    9592
     93
     94[HemlockProgrammer Back to Table of Contents]