epoc32/include/mw/eikdef.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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 "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.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 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    23 #include <uikon/eikdefconst.h>
    24 #include <uikon/eikdefmacros.h>
    25 #include <uikon/eikdefconstinternal.h>
    26 #endif
    27 
    28 /** This is used in combination with a specified position to place a popout on 
    29 the display. 
    30 
    31 The TPopupTargetPosType enum identifies which corner of the popout 
    32 will be placed in the given target position. The default is the top left corner. 
    33 
    34 @publishedAll
    35 @released */
    36 enum TPopupTargetPosType
    37 	{
    38 	/** Places the popout with the top left corner in the specified position. */
    39 	EPopupTargetTopLeft,
    40 	/** Places the popout with the top right corner in the specified position. */
    41 	EPopupTargetTopRight,
    42 	/** Places the popout with the bottom left corner in the specified position. */
    43 	EPopupTargetBottomLeft,
    44 	/** Places the popout with the bottom right corner in the specified position. */
    45 	EPopupTargetBottomRight
    46 	};
    47 
    48 
    49 /** Defines the printer port settings. This is used by GUI print dialogs.*/
    50 enum TEikPortFlag
    51 	{
    52 	/** Printing is via a serial port.*/
    53 	ESerialPort = 0x01,
    54 	/** Printing is via a parallel port.*/
    55 	EParallelPort = 0x02,
    56 	/** Printing is via infra red.*/
    57 	EIrdaPort = 0x04,
    58 	/** Printing is to a file. */
    59 	EFilePort = 0x08,
    60 	/** Printing is via a PC.*/
    61 	EViaPCPort = 0x10
    62 	};
    63 
    64 /** Macro to allow easy access to the CEikonEnv instance.
    65 
    66 @publishedAll
    67 @released
    68 */
    69 #define iEikonEnv (STATIC_CAST(CEikonEnv*,iCoeEnv))
    70 
    71 /** Indicates that all windows should appear faded.
    72 
    73 @publishedAll
    74 @released
    75 */
    76 const TInt KEikMessageFadeAllWindows			=0x100056C2;
    77 
    78 /** Indicates that all windows should appear unfaded.
    79 
    80 @publishedAll
    81 @released
    82 */
    83 const TInt KEikMessageUnfadeWindows				=0x100056C3;
    84 
    85 /** Indicates that the colour scheme has changed.
    86 
    87 @publishedAll
    88 @released
    89 */
    90 const TInt KEikMessageColorSchemeChange			=KUidValueCoeColorSchemeChangeEvent;
    91 
    92 /** Indicates that the color scheme has changed.
    93 
    94 @publishedAll
    95 @released
    96 */
    97 #define KEikColorResourceChange KEikMessageColorSchemeChange // for source compatibility
    98 
    99 /** Indicates that the zoom level has changed.
   100 
   101 @publishedAll
   102 @released
   103 */
   104 const TInt KEikMessageZoomChange				=KUidValueCoeZoomChangeEvent;
   105 
   106 /** Indicates that a font has changed. Controls should ensure they are using 
   107 the right font after receiving this message.
   108 
   109 @publishedAll
   110 @released
   111 */
   112 const TInt KEikMessageFontChange     = KUidValueCoeFontChangeEvent;  
   113 
   114 /** Indicates that the state of the virtual cursor has changed.
   115 
   116 @publishedAll
   117 @released
   118 */
   119 const TInt KEikMessageVirtualCursorStateChange	=0x10005D0A;
   120 
   121 /** Indicates that caps lock key has been pressed.
   122 
   123 @publishedAll
   124 @released
   125 */
   126 const TInt KEikMessageCapsLock					=0x100048F9;
   127 
   128 /** Indicates that the application should be ready to save any data that needs saving.
   129 
   130 @publishedAll
   131 @released
   132 */
   133 const TInt KEikMessagePrepareForSave			=0x100069FD;
   134 
   135 /** Indicates that the level of embedding of the application has changed.
   136 
   137 @publishedAll
   138 @released
   139 */
   140 const TInt KEikMessageEmbedLevelChange			=0x1000A4AA;
   141 
   142 /** Passed immediately after completion of the call to CCoeEnv::SetAppUi() 
   143 when aNewAppUi has become current AppUi. This happens during the destruction of the embedded
   144 AppUi.
   145 
   146 @publishedAll 
   147 @released
   148 */
   149 const TInt KEikHasBecomeCurrentAppUiWhileEmbeddedAppUiDeletes = 0x10207F75;
   150 
   151 /** Passed immediately before CEikAppUiFactory::CreateEmbeddedL()
   152 
   153 @publishedAll 
   154 @released
   155 */
   156 const TInt KEikNotifyPreCreateEmbeddedL = 0x10207F67;
   157 
   158 /** Passed immediately after CEikAppUiFactory::CreateEmbeddedL()
   159 
   160 @publishedAll 
   161 @released
   162 */
   163 const TInt KEikNotifyPostCreateEmbeddedL = 0x10207F65;
   164 
   165 /** Passed immediately after CCoeAppUi::ConstructL()
   166 
   167 @publishedAll 
   168 @released
   169 */
   170 const TInt KEikPostCoeAppUiConstructL = 0x10207F66;
   171 
   172 /**
   173 @publishedAll
   174 @released
   175 */
   176 _LIT8(KDebugStart, "-DebugMemFail:");
   177 
   178 /**
   179 WARNING: constant for internal use ONLY.  Compatibility is not guaranteed in future releases.
   180 */
   181 const TInt KEikCustomColorsArrayValue			=0x100057C2;
   182 
   183 
   184 #endif	// __EIKDEF_H__