commands/input/input.cif
changeset 78 b3ffff030d5c
equal deleted inserted replaced
77:8df58d8c99e8 78:b3ffff030d5c
       
     1 # input.cif
       
     2 # 
       
     3 # Copyright (c) 2010 Accenture. All rights reserved.
       
     4 # This component and the accompanying materials are made available
       
     5 # under the terms of the "Eclipse Public License v1.0"
       
     6 # which accompanies this distribution, and is available
       
     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 # 
       
     9 # Initial Contributors:
       
    10 # Accenture - Initial contribution
       
    11 #
       
    12 
       
    13 ==name input
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Simulate user input events.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 A command that converts console key presses into arbitrary user input events, typically Symbian OS key events. Note, similar functionality is available via Autometric. However, the Autometric command syntax is intended for scripting as so is verbose. By contrast this command accepts single character inputs making it better suited to interactive use. Also, Autometric can only be used if the btrace buffer is free. This command doesn't use btrace and so doesn't have this limitation.
       
    22  
       
    23 ==option bool s show
       
    24 
       
    25 Show the key mappings available for this platform.
       
    26  
       
    27 ==option uint k scan-code
       
    28 
       
    29 Input a specific keypress as a scan-code and then exit.
       
    30 
       
    31 ==option uint m modifiers
       
    32 
       
    33 Must be used in conjunction with C<--scan-code>. Specifies a set of modifiers to be used with the scan-code (as defined in F<e32keys.h>).
       
    34 
       
    35 ==argument uint key optional
       
    36 
       
    37 Simulate a single event and then exit. If not specified, continually reads keys from the console. 'q' causes the command to exit.
       
    38 
       
    39 ==copyright
       
    40 
       
    41 Copyright (c) 2010 Accenture. All rights reserved.