epoc32/include/mw/AknDef.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
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 /*
     2 * Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:  Definitions for AVKON's window server and
    15 *                resource change messages.
    16 *
    17 */
    18 
    19 
    20 #ifndef AKNDEF_H
    21 #define AKNDEF_H
    22 
    23 #include <AknDef.hrh>
    24 #include <e32std.h>
    25 
    26 // forward declarations
    27 class TVwsViewId;
    28 
    29 /**
    30  * Resource change message that is passed to applications
    31  * when all the windows become faded or unfaded.
    32  */
    33 const TInt KEikMessageWindowsFadeChange = 0x10006890;
    34 
    35 /**
    36  * Resource change message indicating a change of state to edit mode.
    37  * This message is used by @c CEikCaptionedControl to handle situations
    38  * where the control becomes editable.
    39  */
    40 const TInt KEikMessageCaptionedControlEditableStateChange = 0x10008E99;
    41 
    42 /**
    43  * Resource change message indicating a change of state to view mode.
    44  * This message is used by @c CEikCaptionedControl to handle situations
    45  * where the control becomes non-editable.
    46  */
    47 const TInt KEikMessageCaptionedControlNotEditableStateChange = 0x10008E9A;
    48 
    49 /**
    50  * Resource change message indicating a change of state to edit mode with graphic.
    51  * This message is used by popup fields to handle situations where the
    52  * control becomes editable with graphic.
    53  */
    54 const TInt KEikMessageCaptionedControlEditableStateChangeWideWithGraphic = 0x101F5FBA;
    55 
    56 /**
    57  * Resource change message indicating a change of state to edit mode without graphic.
    58  * This message is used by popup fields to handle situations where the
    59  * control becomes editable without graphic.
    60  */
    61 const TInt KEikMessageCaptionedControlEditableStateChangeWideWithoutGraphic = 0x101F5FBB;
    62 
    63 /**
    64  * Resource change message indicating a change of state to view mode with graphic.
    65  * This message is used by popup fields to handle situations where the
    66  * control becomes non-editable with graphic.
    67  */
    68 const TInt KEikMessageCaptionedControlNotEditableStateChangeWideWithGraphic = 0x101F5FBC;
    69 
    70 /**
    71  * Resource change message indicating a change of state to view mode without graphic.
    72  * This message is used by popup fields to handle situations where the
    73  * control becomes non-editable without graphic.
    74  */
    75 const TInt KEikMessageCaptionedControlNotEditableStateChangeWideWithoutGraphic = 0x101F5FBD;
    76 
    77 /**
    78  * Window server event for clearing partial foreground state.
    79  *
    80  * @internal
    81  */
    82 const TInt KEikClearPartialForegroundState = 0x101f54f4;
    83 
    84 /**
    85  * Window server event for partial foreground state.
    86  *
    87  * @internal
    88  */
    89 const TInt KEikPartialForeground = 0x101f6aab;
    90 
    91 /** Resource change message used to inform applications of layout change. */
    92 const TInt KEikDynamicLayoutVariantSwitch = 0x101F8121;
    93 
    94 /** @deprecated */
    95 const TInt KEikDynamicLayoutVariantSwitch_APAC = 0x101F8124;
    96 
    97 /** Resource change message that is sent by FEP when the input language changes. */
    98 const TInt KEikInputLanguageChange = 0x101F8519;
    99 
   100 /** The application UID and the view UID of the Application Shell */
   101 #define KAknApplicationShellViewId TVwsViewId(TUid::Uid(0x101F4CD2), TUid::Uid(0x00000001))
   102 
   103 /**
   104  * Window server event used when layout changes. This event is not passed to applications,
   105  * they should use the @c KEikDynamicLayoutVariantSwitch event instead.
   106  *
   107  * @internal
   108  */
   109 const TInt KAknHardwareLayoutSwitch = 0x10202672;
   110 
   111 /** @deprecated */
   112 const TInt KAknDelayedLayoutSwitch = 0x102797FD;
   113 
   114 /** Window server event used to inform applications about change in local zoom setting. */
   115 const TInt KAknLocalZoomLayoutSwitch = 0x10281FC1;
   116 
   117 /**
   118  * Window server event used to inform applications that a new ILD 
   119  * (Independent Layout Delivery) layout DLL has been installed. 
   120  * This event is not passed to applications, they should use 
   121  * the @c KEikDynamicLayoutVariantSwitch event instead.
   122  *
   123  * @internal
   124  */
   125 const TInt KAknILDInstallationLayoutSwitch = 0x1028654F;
   126 
   127 /** @deprecated */
   128 const TInt KAknAppOomMonitor_FreeRam = 0x10282304;
   129 
   130 /** @deprecated */
   131 const TInt KAknAppOomMonitor_MemoryGood = 0x10282305;
   132 
   133 /**
   134  * Resource change message used to inform a window group that it has
   135  * gained full or partial foreground.
   136  */
   137 const TInt KAknFullOrPartialForegroundGained = 0x10281F36;
   138 
   139 /**
   140  * Resource change message used to inform a window group that it has
   141  * lost full or partial foreground.
   142  */
   143 const TInt KAknFullOrPartialForegroundLost = 0x10281F37;
   144 
   145 /**
   146  * Instruct an app to either exit or hide itself, according to its configuration
   147  */
   148 const TInt KAknShutOrHideApp = 0x10285A1D;
   149 
   150  
   151 namespace AknDef
   152     {
   153     /**
   154      * Returns the application UID and the view UID of the currently active idle state
   155      * application in form of a @c TVwsViewId object. Alternatives 
   156      * include Phone application and Idle application.
   157      *
   158      * @since S60 2.8
   159      * @param[out] aViewId The view uid of currently active idle state application.
   160      * @return @c KErrNone, if succesful
   161      */
   162     IMPORT_C TInt GetPhoneIdleViewId(TVwsViewId& aViewId);
   163     }
   164 
   165 #endif // AKNDEF_H