commands/screenmode/screenmode.cif
changeset 0 7f656887cf89
child 66 2a78c4ff2eab
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # screenmode.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 screenmode
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Reports or changes the current Window Server screen mode.
       
    18 
       
    19 ==argument enum command optional
       
    20 
       
    21 The command to perform. Defaults to C<list>.
       
    22 
       
    23 ==enum-value list
       
    24 
       
    25 List the available screen modes, and get a index number of current screen mode.
       
    26 
       
    27 ==enum-value set
       
    28 
       
    29 Set the screen mode by calling C<CWsScreenDevice::SetScreenMode>. Use C<--mode> to specify a mode index. Note some UI platforms don't handle the screen mode being changed in this way. If available, it is recommended to use a UI platform specific method instead.
       
    30 
       
    31 ==enum-value follow
       
    32 
       
    33 Track changes to the screen mode.
       
    34 
       
    35 ==enum-value rotate
       
    36 
       
    37 Change the screen orientation by calling C<CAknCapServer::RotateScreenL> (only supported on S60).
       
    38 
       
    39 ==option bool v verbose
       
    40 
       
    41 Print verbose output.
       
    42 
       
    43 ==option uint m mode
       
    44 
       
    45 The screen mode to set. Only applicable to the C<set> command.
       
    46 
       
    47 ==copyright
       
    48 
       
    49 Copyright (c) 2009-2010 Accenture. All rights reserved.
       
    50