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