epoc32/include/mw/coedef.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __COEDEF_H__
    17 #define __COEDEF_H__
    18 
    19 #include <e32std.h> 
    20 #include <guldef.h> // only requried for limited source compatability with releases prior to 250
    21 
    22 
    23 
    24 
    25 
    26 
    27 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    28 #include <graphics/cone/coedefkeys.h>
    29 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
    30 
    31 /**
    32 
    33 @publishedAll
    34 @released */
    35 const TInt KCoeCustomColorsArrayValue=0x100057C2;
    36 /**
    37 
    38 @publishedAll
    39 @released */
    40 const TInt KCoeColorGray4=0x19bd6002;
    41 
    42 /**
    43 
    44 @publishedAll
    45 @released */
    46 const TInt KCoeColorColor16=0x19bd6003;
    47 
    48 /**
    49 
    50 @publishedAll
    51 @released */
    52 const TInt ECoeResourceSignatureValue=4;
    53 
    54 
    55 /** Event handling flags. 
    56 
    57 These should be returned by CCoeControl::OfferKeyEventL() to indicate whether 
    58 or not a key event was processed by the control. 
    59 
    60 @publishedAll
    61 @released */
    62 enum TKeyResponse
    63 	{
    64 	/** The key event was not handled. */
    65 	EKeyWasNotConsumed,
    66 	/** The key event was handled. */
    67 	EKeyWasConsumed
    68 	};
    69 
    70 /** Control redraw flags. 
    71 
    72 Passed to CCoeControl::SetFocus() to indicate the requirements for control 
    73 redrawing. 
    74 
    75 @publishedAll
    76 @released */
    77 enum TDrawNow
    78 	{
    79 	/** Redraw of the control is not required immediately. */
    80 	ENoDrawNow,
    81 	/** Redraw control immediately. */
    82 	EDrawNow
    83 	};
    84 
    85 /** Window priority values. 
    86 
    87 These are passed in the aOrdinalPriority argument to RWindowTreeNode::SetOrdinalPosition(). 
    88 
    89 @publishedAll
    90 @released */
    91 enum TCoeWinPriority
    92 	{
    93 	/** -1000 */
    94 	ECoeWinPriorityNeverAtFront		=-1000,
    95 	/** -750 */
    96 	ECoeWinPriorityLow				=-750,
    97 	/** 0 */
    98 	ECoeWinPriorityNormal			=0,
    99 	/** 500 */
   100 	ECoeWinPriorityMedium			=500,
   101 	/** 750 */
   102 	ECoeWinPriorityHigh				=750,
   103 	/** 900 */
   104 	ECoeWinPriorityFep				=900,
   105 	/** 1000 */
   106 	ECoeWinPriorityAlwaysAtFront	=1000
   107 	};
   108 
   109 /** The message UID sent when a colour scheme change event occurs.
   110 WARNING: Constants for internal use ONLY.  Compatibility is not guaranteed in future releases.
   111  */
   112 const TInt KUidValueCoeColorSchemeChangeEvent	=0x100056C4;
   113 const TInt KUidValueCoeZoomChangeEvent          =0x100057C3;
   114 const TInt KUidValueCoeFontChangeEvent          =0x100057C4;
   115 
   116 /** Control key modifier.
   117 
   118 Key codes get changed when the Ctrl key modifier is pressed at the same time as the key . 
   119 The CTRL macro is used to shift the key character appropriately.
   120 
   121 Note: this is not an inline function since that can't be used as the case of a switch 
   122 statement.
   123  
   124 @publishedAll
   125 @released */
   126 #define CTRL(x) ((x)-'a'+1)
   127 
   128 /** Constant that represents all standard keyboard modifier keys.
   129 
   130 @publishedAll
   131 @released */
   132 #define EAllStdModifiers (EModifierFunc|EModifierCtrl|EModifierShift)
   133 
   134 #endif	// __COEDEF_H__