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