epoc32/include/mw/eikdef.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
equal deleted inserted replaced
2:2fe1408b6811 3:e1b950c65cb4
       
     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 __EIKDEF_H__
       
    17 #define __EIKDEF_H__
       
    18 
       
    19 #include <e32std.h>
       
    20 #include <coedef.h>
       
    21 
       
    22 /** This is used in combination with a specified position to place a popout on 
       
    23 the display. 
       
    24 
       
    25 The TPopupTargetPosType enum identifies which corner of the popout 
       
    26 will be placed in the given target position. The default is the top left corner. 
       
    27 
       
    28 @publishedAll
       
    29 @released */
       
    30 enum TPopupTargetPosType
       
    31 	{
       
    32 	/** Places the popout with the top left corner in the specified position. */
       
    33 	EPopupTargetTopLeft,
       
    34 	/** Places the popout with the top right corner in the specified position. */
       
    35 	EPopupTargetTopRight,
       
    36 	/** Places the popout with the bottom left corner in the specified position. */
       
    37 	EPopupTargetBottomLeft,
       
    38 	/** Places the popout with the bottom right corner in the specified position. */
       
    39 	EPopupTargetBottomRight
       
    40 	};
       
    41 
       
    42 
       
    43 /** Defines the printer port settings. This is used by GUI print dialogs.*/
       
    44 enum TEikPortFlag
       
    45 	{
       
    46 	/** Printing is via a serial port.*/
       
    47 	ESerialPort = 0x01,
       
    48 	/** Printing is via a parallel port.*/
       
    49 	EParallelPort = 0x02,
       
    50 	/** Printing is via infra red.*/
       
    51 	EIrdaPort = 0x04,
       
    52 	/** Printing is to a file. */
       
    53 	EFilePort = 0x08,
       
    54 	/** Printing is via a PC.*/
       
    55 	EViaPCPort = 0x10
       
    56 	};
       
    57 
       
    58 /** Macro to allow easy access to the CEikonEnv instance.
       
    59 
       
    60 @publishedAll
       
    61 @released
       
    62 */
       
    63 #define iEikonEnv (STATIC_CAST(CEikonEnv*,iCoeEnv))
       
    64 
       
    65 /** Defines the border style for an editable control.
       
    66 
       
    67 @publishedPartner
       
    68 @released
       
    69 */
       
    70 #define KEikEditableControlBorder TGulBorder::EShallowSunken
       
    71 
       
    72 /** Name of the default bitmap store.
       
    73 
       
    74 @publishedPartner
       
    75 @released
       
    76 */
       
    77 _LIT(KEikDefaultAppBitmapStore,"*");
       
    78 
       
    79 /** Uid of the KEikMessageColorSchemeChange message.
       
    80 
       
    81 @publishedPartner
       
    82 @released
       
    83 */
       
    84 const TInt KUidValueEikColorSchemeChangeEvent	=0x10006956;
       
    85 
       
    86 /**
       
    87 @internalComponent
       
    88 */
       
    89 const TInt KEikCustomColorsArrayValue			=0x100057C2;
       
    90 
       
    91 /** Indicates that all windows should appear faded.
       
    92 
       
    93 @publishedAll
       
    94 @released
       
    95 */
       
    96 const TInt KEikMessageFadeAllWindows			=0x100056C2;
       
    97 
       
    98 /** Indicates that all windows should appear unfaded.
       
    99 
       
   100 @publishedAll
       
   101 @released
       
   102 */
       
   103 const TInt KEikMessageUnfadeWindows				=0x100056C3;
       
   104 
       
   105 /** Indicates that the colour scheme has changed.
       
   106 
       
   107 @publishedAll
       
   108 @released
       
   109 */
       
   110 const TInt KEikMessageColorSchemeChange			=KUidValueCoeColorSchemeChangeEvent;
       
   111 
       
   112 /** Indicates that the color scheme has changed.
       
   113 
       
   114 @publishedAll
       
   115 @released
       
   116 */
       
   117 #define KEikColorResourceChange KEikMessageColorSchemeChange // for source compatibility
       
   118 
       
   119 /** Indicates that the zoom level has changed.
       
   120 
       
   121 @publishedAll
       
   122 @released
       
   123 */
       
   124 const TInt KEikMessageZoomChange				=KUidValueCoeZoomChangeEvent;
       
   125 
       
   126 /** Indicates that a font has changed. Controls should ensure they are using 
       
   127 the right font after receiving this message.
       
   128 
       
   129 @publishedAll
       
   130 @released
       
   131 */
       
   132 const TInt KEikMessageFontChange     = KUidValueCoeFontChangeEvent;  
       
   133 
       
   134 /** Indicates that the state of the virtual cursor has changed.
       
   135 
       
   136 @publishedAll
       
   137 @released
       
   138 */
       
   139 const TInt KEikMessageVirtualCursorStateChange	=0x10005D0A;
       
   140 
       
   141 /** Indicates that caps lock key has been pressed.
       
   142 
       
   143 @publishedAll
       
   144 @released
       
   145 */
       
   146 const TInt KEikMessageCapsLock					=0x100048F9;
       
   147 
       
   148 /** Indicates that the application should be ready to save any data that needs saving.
       
   149 
       
   150 @publishedAll
       
   151 @released
       
   152 */
       
   153 const TInt KEikMessagePrepareForSave			=0x100069FD;
       
   154 
       
   155 /** Indicates that the level of embedding of the application has changed.
       
   156 
       
   157 @publishedAll
       
   158 @released
       
   159 */
       
   160 const TInt KEikMessageEmbedLevelChange			=0x1000A4AA;
       
   161 
       
   162 /** Passed immediately after completion of the call to CCoeEnv::SetAppUi() 
       
   163 when aNewAppUi has become current AppUi. This happens during the destruction of the embedded
       
   164 AppUi.
       
   165 
       
   166 @publishedAll 
       
   167 @released
       
   168 */
       
   169 const TInt KEikHasBecomeCurrentAppUiWhileEmbeddedAppUiDeletes = 0x10207F75;
       
   170 
       
   171 /** Passed immediately before CEikAppUiFactory::CreateEmbeddedL()
       
   172 
       
   173 @publishedAll 
       
   174 @released
       
   175 */
       
   176 const TInt KEikNotifyPreCreateEmbeddedL = 0x10207F67;
       
   177 
       
   178 /** Passed immediately after CEikAppUiFactory::CreateEmbeddedL()
       
   179 
       
   180 @publishedAll 
       
   181 @released
       
   182 */
       
   183 const TInt KEikNotifyPostCreateEmbeddedL = 0x10207F65;
       
   184 
       
   185 /** Passed immediately after CCoeAppUi::ConstructL()
       
   186 
       
   187 @publishedAll 
       
   188 @released
       
   189 */
       
   190 const TInt KEikPostCoeAppUiConstructL = 0x10207F66;
       
   191 
       
   192 /**
       
   193 @publishedAll
       
   194 @released
       
   195 */
       
   196 _LIT8(KDebugStart, "-DebugMemFail:");
       
   197 
       
   198 /**
       
   199 @publishedPartner 
       
   200 @released
       
   201 */
       
   202 const TInt KEikDefaultCursorWidth=2;
       
   203 
       
   204 /**
       
   205 @publishedPartner 
       
   206 @released
       
   207 */
       
   208 const TInt KTimeBetweenClicks=1000000;	 // in Microseconds	
       
   209 
       
   210 /**
       
   211 @publishedPartner 
       
   212 @released
       
   213 */		 
       
   214 const TInt KDoubleClickDistance=10;
       
   215 
       
   216 /**
       
   217 @publishedPartner 
       
   218 @released
       
   219 */	
       
   220 const TInt KKeyboardRepeatRate=50000;
       
   221 
       
   222 /**
       
   223 @publishedPartner 
       
   224 @released
       
   225 */	
       
   226 const TInt KKeyboardRepeatInitialDelay=800000;
       
   227 
       
   228 /** Resource id of the query dialog.
       
   229 @publishedPartner
       
   230 @released
       
   231 */
       
   232 const TInt KEikResIdQueryDialog	=0;
       
   233 
       
   234 /** Resource id of the info dialog.
       
   235 @publishedPartner
       
   236 @released
       
   237 */
       
   238 const TInt KEikResIdInfoDialog	=1;
       
   239 
       
   240 /**
       
   241 @publishedPartner 
       
   242 @released
       
   243 */	
       
   244 const TInt KEikErrorResolverMaxTextLength = 256;
       
   245 
       
   246 /**
       
   247 @internalTechnology
       
   248 */
       
   249 #define COMPARE_BOOLS(a,b) (((a) && (b)) || (!(a) && !(b)))
       
   250 
       
   251 /**
       
   252 @internalComponent
       
   253 */
       
   254 #if defined(_DEBUG)
       
   255 #define __UHEAP_CHECK_INTEGRITY User::Heap().Check()
       
   256 #else
       
   257 #define __UHEAP_CHECK_INTEGRITY
       
   258 #endif
       
   259 
       
   260 /**
       
   261 @internalComponent
       
   262 */
       
   263 #define PROFILE_POINT_EIKON_FIRST		32
       
   264 
       
   265 /**
       
   266 @internalComponent
       
   267 */
       
   268 #define PROFILE_POINT_EIKON_LAST		39
       
   269 
       
   270 /**
       
   271 @internalComponent
       
   272 */
       
   273 #define PROFILE_POINT_EIKON_SIMPLE		32
       
   274 
       
   275 /**
       
   276 @internalComponent
       
   277 */
       
   278 #define PROFILE_POINT_EIKON_DIALOG_LOAD	33
       
   279 
       
   280 /**
       
   281 @internalComponent
       
   282 */
       
   283 #define PROFILE_POINT_EIKON_APP_LAUNCH	34
       
   284 
       
   285 /**
       
   286 @internalComponent
       
   287 */
       
   288 #define PROFILE_POINT_EIKON_CLOCK		35
       
   289 
       
   290 /**
       
   291 @internalComponent
       
   292 */
       
   293 #define PROFILE_POINT_EIKON_CALENDER	35
       
   294 
       
   295 /**
       
   296 @internalComponent
       
   297 */
       
   298 #define PROFILE_POINT_EIKON_LIBS_LOAD	36
       
   299 
       
   300 /**
       
   301 @internalComponent
       
   302 */
       
   303 #define PROFILE_POINT_EIKON_ADD_RES		37
       
   304 
       
   305 /**
       
   306 @internalComponent
       
   307 */
       
   308 #define KEikEikonBitmapStore		KNullDesC
       
   309 
       
   310 /**
       
   311 @internalComponent
       
   312 */
       
   313 const TUid KSystemIniFileUid = {0x1000010C};
       
   314 
       
   315 /**
       
   316 @internalComponent
       
   317 */	
       
   318 const TInt KLastSystemWideErrCode = KErrCommsBreak;
       
   319 
       
   320 
       
   321 #endif	// __EIKDEF_H__