epoc32/include/eikdef.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
     1.1 --- a/epoc32/include/eikdef.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/eikdef.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,321 @@
     1.4 -eikdef.h
     1.5 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// 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
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +//
    1.19 +
    1.20 +#ifndef __EIKDEF_H__
    1.21 +#define __EIKDEF_H__
    1.22 +
    1.23 +#include <e32std.h>
    1.24 +#include <coedef.h>
    1.25 +
    1.26 +/** This is used in combination with a specified position to place a popout on 
    1.27 +the display. 
    1.28 +
    1.29 +The TPopupTargetPosType enum identifies which corner of the popout 
    1.30 +will be placed in the given target position. The default is the top left corner. 
    1.31 +
    1.32 +@publishedAll
    1.33 +@released */
    1.34 +enum TPopupTargetPosType
    1.35 +	{
    1.36 +	/** Places the popout with the top left corner in the specified position. */
    1.37 +	EPopupTargetTopLeft,
    1.38 +	/** Places the popout with the top right corner in the specified position. */
    1.39 +	EPopupTargetTopRight,
    1.40 +	/** Places the popout with the bottom left corner in the specified position. */
    1.41 +	EPopupTargetBottomLeft,
    1.42 +	/** Places the popout with the bottom right corner in the specified position. */
    1.43 +	EPopupTargetBottomRight
    1.44 +	};
    1.45 +
    1.46 +
    1.47 +/** Defines the printer port settings. This is used by GUI print dialogs.*/
    1.48 +enum TEikPortFlag
    1.49 +	{
    1.50 +	/** Printing is via a serial port.*/
    1.51 +	ESerialPort = 0x01,
    1.52 +	/** Printing is via a parallel port.*/
    1.53 +	EParallelPort = 0x02,
    1.54 +	/** Printing is via infra red.*/
    1.55 +	EIrdaPort = 0x04,
    1.56 +	/** Printing is to a file. */
    1.57 +	EFilePort = 0x08,
    1.58 +	/** Printing is via a PC.*/
    1.59 +	EViaPCPort = 0x10
    1.60 +	};
    1.61 +
    1.62 +/** Macro to allow easy access to the CEikonEnv instance.
    1.63 +
    1.64 +@publishedAll
    1.65 +@released
    1.66 +*/
    1.67 +#define iEikonEnv (STATIC_CAST(CEikonEnv*,iCoeEnv))
    1.68 +
    1.69 +/** Defines the border style for an editable control.
    1.70 +
    1.71 +@publishedPartner
    1.72 +@released
    1.73 +*/
    1.74 +#define KEikEditableControlBorder TGulBorder::EShallowSunken
    1.75 +
    1.76 +/** Name of the default bitmap store.
    1.77 +
    1.78 +@publishedPartner
    1.79 +@released
    1.80 +*/
    1.81 +_LIT(KEikDefaultAppBitmapStore,"*");
    1.82 +
    1.83 +/** Uid of the KEikMessageColorSchemeChange message.
    1.84 +
    1.85 +@publishedPartner
    1.86 +@released
    1.87 +*/
    1.88 +const TInt KUidValueEikColorSchemeChangeEvent	=0x10006956;
    1.89 +
    1.90 +/**
    1.91 +@internalComponent
    1.92 +*/
    1.93 +const TInt KEikCustomColorsArrayValue			=0x100057C2;
    1.94 +
    1.95 +/** Indicates that all windows should appear faded.
    1.96 +
    1.97 +@publishedAll
    1.98 +@released
    1.99 +*/
   1.100 +const TInt KEikMessageFadeAllWindows			=0x100056C2;
   1.101 +
   1.102 +/** Indicates that all windows should appear unfaded.
   1.103 +
   1.104 +@publishedAll
   1.105 +@released
   1.106 +*/
   1.107 +const TInt KEikMessageUnfadeWindows				=0x100056C3;
   1.108 +
   1.109 +/** Indicates that the colour scheme has changed.
   1.110 +
   1.111 +@publishedAll
   1.112 +@released
   1.113 +*/
   1.114 +const TInt KEikMessageColorSchemeChange			=KUidValueCoeColorSchemeChangeEvent;
   1.115 +
   1.116 +/** Indicates that the color scheme has changed.
   1.117 +
   1.118 +@publishedAll
   1.119 +@released
   1.120 +*/
   1.121 +#define KEikColorResourceChange KEikMessageColorSchemeChange // for source compatibility
   1.122 +
   1.123 +/** Indicates that the zoom level has changed.
   1.124 +
   1.125 +@publishedAll
   1.126 +@released
   1.127 +*/
   1.128 +const TInt KEikMessageZoomChange				=KUidValueCoeZoomChangeEvent;
   1.129 +
   1.130 +/** Indicates that a font has changed. Controls should ensure they are using 
   1.131 +the right font after receiving this message.
   1.132 +
   1.133 +@publishedAll
   1.134 +@released
   1.135 +*/
   1.136 +const TInt KEikMessageFontChange     = KUidValueCoeFontChangeEvent;  
   1.137 +
   1.138 +/** Indicates that the state of the virtual cursor has changed.
   1.139 +
   1.140 +@publishedAll
   1.141 +@released
   1.142 +*/
   1.143 +const TInt KEikMessageVirtualCursorStateChange	=0x10005D0A;
   1.144 +
   1.145 +/** Indicates that caps lock key has been pressed.
   1.146 +
   1.147 +@publishedAll
   1.148 +@released
   1.149 +*/
   1.150 +const TInt KEikMessageCapsLock					=0x100048F9;
   1.151 +
   1.152 +/** Indicates that the application should be ready to save any data that needs saving.
   1.153 +
   1.154 +@publishedAll
   1.155 +@released
   1.156 +*/
   1.157 +const TInt KEikMessagePrepareForSave			=0x100069FD;
   1.158 +
   1.159 +/** Indicates that the level of embedding of the application has changed.
   1.160 +
   1.161 +@publishedAll
   1.162 +@released
   1.163 +*/
   1.164 +const TInt KEikMessageEmbedLevelChange			=0x1000A4AA;
   1.165 +
   1.166 +/** Passed immediately after completion of the call to CCoeEnv::SetAppUi() 
   1.167 +when aNewAppUi has become current AppUi. This happens during the destruction of the embedded
   1.168 +AppUi.
   1.169 +
   1.170 +@publishedAll 
   1.171 +@released
   1.172 +*/
   1.173 +const TInt KEikHasBecomeCurrentAppUiWhileEmbeddedAppUiDeletes = 0x10207F75;
   1.174 +
   1.175 +/** Passed immediately before CEikAppUiFactory::CreateEmbeddedL()
   1.176 +
   1.177 +@publishedAll 
   1.178 +@released
   1.179 +*/
   1.180 +const TInt KEikNotifyPreCreateEmbeddedL = 0x10207F67;
   1.181 +
   1.182 +/** Passed immediately after CEikAppUiFactory::CreateEmbeddedL()
   1.183 +
   1.184 +@publishedAll 
   1.185 +@released
   1.186 +*/
   1.187 +const TInt KEikNotifyPostCreateEmbeddedL = 0x10207F65;
   1.188 +
   1.189 +/** Passed immediately after CCoeAppUi::ConstructL()
   1.190 +
   1.191 +@publishedAll 
   1.192 +@released
   1.193 +*/
   1.194 +const TInt KEikPostCoeAppUiConstructL = 0x10207F66;
   1.195 +
   1.196 +/**
   1.197 +@publishedAll
   1.198 +@released
   1.199 +*/
   1.200 +_LIT8(KDebugStart, "-DebugMemFail:");
   1.201 +
   1.202 +/**
   1.203 +@publishedPartner 
   1.204 +@released
   1.205 +*/
   1.206 +const TInt KEikDefaultCursorWidth=2;
   1.207 +
   1.208 +/**
   1.209 +@publishedPartner 
   1.210 +@released
   1.211 +*/
   1.212 +const TInt KTimeBetweenClicks=1000000;	 // in Microseconds	
   1.213 +
   1.214 +/**
   1.215 +@publishedPartner 
   1.216 +@released
   1.217 +*/		 
   1.218 +const TInt KDoubleClickDistance=10;
   1.219 +
   1.220 +/**
   1.221 +@publishedPartner 
   1.222 +@released
   1.223 +*/	
   1.224 +const TInt KKeyboardRepeatRate=50000;
   1.225 +
   1.226 +/**
   1.227 +@publishedPartner 
   1.228 +@released
   1.229 +*/	
   1.230 +const TInt KKeyboardRepeatInitialDelay=800000;
   1.231 +
   1.232 +/** Resource id of the query dialog.
   1.233 +@publishedPartner
   1.234 +@released
   1.235 +*/
   1.236 +const TInt KEikResIdQueryDialog	=0;
   1.237 +
   1.238 +/** Resource id of the info dialog.
   1.239 +@publishedPartner
   1.240 +@released
   1.241 +*/
   1.242 +const TInt KEikResIdInfoDialog	=1;
   1.243 +
   1.244 +/**
   1.245 +@publishedPartner 
   1.246 +@released
   1.247 +*/	
   1.248 +const TInt KEikErrorResolverMaxTextLength = 256;
   1.249 +
   1.250 +/**
   1.251 +@internalTechnology
   1.252 +*/
   1.253 +#define COMPARE_BOOLS(a,b) (((a) && (b)) || (!(a) && !(b)))
   1.254 +
   1.255 +/**
   1.256 +@internalComponent
   1.257 +*/
   1.258 +#if defined(_DEBUG)
   1.259 +#define __UHEAP_CHECK_INTEGRITY User::Heap().Check()
   1.260 +#else
   1.261 +#define __UHEAP_CHECK_INTEGRITY
   1.262 +#endif
   1.263 +
   1.264 +/**
   1.265 +@internalComponent
   1.266 +*/
   1.267 +#define PROFILE_POINT_EIKON_FIRST		32
   1.268 +
   1.269 +/**
   1.270 +@internalComponent
   1.271 +*/
   1.272 +#define PROFILE_POINT_EIKON_LAST		39
   1.273 +
   1.274 +/**
   1.275 +@internalComponent
   1.276 +*/
   1.277 +#define PROFILE_POINT_EIKON_SIMPLE		32
   1.278 +
   1.279 +/**
   1.280 +@internalComponent
   1.281 +*/
   1.282 +#define PROFILE_POINT_EIKON_DIALOG_LOAD	33
   1.283 +
   1.284 +/**
   1.285 +@internalComponent
   1.286 +*/
   1.287 +#define PROFILE_POINT_EIKON_APP_LAUNCH	34
   1.288 +
   1.289 +/**
   1.290 +@internalComponent
   1.291 +*/
   1.292 +#define PROFILE_POINT_EIKON_CLOCK		35
   1.293 +
   1.294 +/**
   1.295 +@internalComponent
   1.296 +*/
   1.297 +#define PROFILE_POINT_EIKON_CALENDER	35
   1.298 +
   1.299 +/**
   1.300 +@internalComponent
   1.301 +*/
   1.302 +#define PROFILE_POINT_EIKON_LIBS_LOAD	36
   1.303 +
   1.304 +/**
   1.305 +@internalComponent
   1.306 +*/
   1.307 +#define PROFILE_POINT_EIKON_ADD_RES		37
   1.308 +
   1.309 +/**
   1.310 +@internalComponent
   1.311 +*/
   1.312 +#define KEikEikonBitmapStore		KNullDesC
   1.313 +
   1.314 +/**
   1.315 +@internalComponent
   1.316 +*/
   1.317 +const TUid KSystemIniFileUid = {0x1000010C};
   1.318 +
   1.319 +/**
   1.320 +@internalComponent
   1.321 +*/	
   1.322 +const TInt KLastSystemWideErrCode = KErrCommsBreak;
   1.323 +
   1.324 +
   1.325 +#endif	// __EIKDEF_H__