epoc32/include/mw/coedef.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/coedef.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 const TInt KCoeCustomColorsArrayValue=0x100057C2;
    23 const TInt KCoeColorGray4=0x19bd6002;
    24 const TInt KCoeColorColor16=0x19bd6003;
    25 const TInt ECoeResourceSignatureValue=4;
    26 
    27 /** Event handling flags. 
    28 
    29 These should be returned by CCoeControl::OfferKeyEventL() to indicate whether 
    30 or not a key event was processed by the control. 
    31 
    32 @publishedAll
    33 @released */
    34 enum TKeyResponse
    35 	{
    36 	/** The key event was not handled. */
    37 	EKeyWasNotConsumed,
    38 	/** The key event was handled. */
    39 	EKeyWasConsumed
    40 	};
    41 
    42 /** Control redraw flags. 
    43 
    44 Passed to CCoeControl::SetFocus() to indicate the requirements for control 
    45 redrawing. 
    46 
    47 @publishedAll
    48 @released */
    49 enum TDrawNow
    50 	{
    51 	/** Redraw of the control is not required immediately. */
    52 	ENoDrawNow,
    53 	/** Redraw control immediately. */
    54 	EDrawNow
    55 	};
    56 
    57 /** Window priority values. 
    58 
    59 These are passed in the aOrdinalPriority argument to RWindowTreeNode::SetOrdinalPosition(). 
    60 
    61 @publishedAll
    62 @released */
    63 enum TCoeWinPriority
    64 	{
    65 	/** -1000 */
    66 	ECoeWinPriorityNeverAtFront		=-1000,
    67 	/** -750 */
    68 	ECoeWinPriorityLow				=-750,
    69 	/** 0 */
    70 	ECoeWinPriorityNormal			=0,
    71 	/** 500 */
    72 	ECoeWinPriorityMedium			=500,
    73 	/** 750 */
    74 	ECoeWinPriorityHigh				=750,
    75 	/** 900 */
    76 	ECoeWinPriorityFep				=900,
    77 	/** 1000 */
    78 	ECoeWinPriorityAlwaysAtFront	=1000
    79 	};
    80 
    81 /** The message UID sent when a colour scheme change event occurs.
    82 
    83 @internalTechnology */
    84 const TInt KUidValueCoeColorSchemeChangeEvent	=0x100056C4;
    85 const TInt KUidValueCoeZoomChangeEvent          =0x100057C3;
    86 const TInt KUidValueCoeFontChangeEvent          =0x100057C4;
    87 
    88 /** @internalTechnology */
    89 const TUint KUidFepFrameworkRepository=0x10272618;
    90 
    91 /** @internalTechnology */
    92 enum // key-masks and keys for the "KUidFepFrameworkRepository" repository
    93 	{
    94 	ERepositoryKeyMask_DefaultSetting	=0x00001000,
    95 	ERepositoryKeyMask_DynamicSetting	=0x00002000,
    96 
    97 	ERepositoryKeyMask_FepId			=0x00000001,
    98 	ERepositoryKeyMask_OnState			=0x00000002,
    99 	ERepositoryKeyMask_OnKeyData		=0x00000004,
   100 	ERepositoryKeyMask_OffKeyData		=0x00000008,
   101 
   102 	ERepositoryKey_DefaultFepId			=ERepositoryKeyMask_DefaultSetting|ERepositoryKeyMask_FepId,
   103 	ERepositoryKey_DefaultOnState		=ERepositoryKeyMask_DefaultSetting|ERepositoryKeyMask_OnState,
   104 	ERepositoryKey_DefaultOnKeyData		=ERepositoryKeyMask_DefaultSetting|ERepositoryKeyMask_OnKeyData,
   105 	ERepositoryKey_DefaultOffKeyData	=ERepositoryKeyMask_DefaultSetting|ERepositoryKeyMask_OffKeyData,
   106 
   107 	ERepositoryKey_DynamicFepId			=ERepositoryKeyMask_DynamicSetting|ERepositoryKeyMask_FepId,
   108 	ERepositoryKey_DynamicOnState		=ERepositoryKeyMask_DynamicSetting|ERepositoryKeyMask_OnState,
   109 	ERepositoryKey_DynamicOnKeyData		=ERepositoryKeyMask_DynamicSetting|ERepositoryKeyMask_OnKeyData,
   110 	ERepositoryKey_DynamicOffKeyData	=ERepositoryKeyMask_DynamicSetting|ERepositoryKeyMask_OffKeyData
   111 	};
   112 
   113 /** @internalTechnology */
   114 #if defined(_DEBUG)
   115 #define __DEBUG_CHECK_HEAP_INTEGRITY User::Heap().Check()
   116 #else
   117 #define __DEBUG_CHECK_HEAP_INTEGRITY
   118 #endif
   119 
   120 /** Control key modifier.
   121 
   122 Key codes get changed when the Ctrl key modifier is pressed at the same time as the key . 
   123 The CTRL macro is used to shift the key character appropriately.
   124 
   125 Note: this is not an inline function since that can't be used as the case of a switch 
   126 statement.
   127  
   128 @publishedAll
   129 @released */
   130 #define CTRL(x) ((x)-'a'+1)
   131 
   132 /** Constant that represents all standard keyboard modifier keys.
   133 
   134 @publishedAll
   135 @released */
   136 #define EAllStdModifiers (EModifierFunc|EModifierCtrl|EModifierShift)
   137 
   138 #endif	// __COEDEF_H__