epoc32/include/app/messagingsdkcrkeys.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
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) 2007 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:   Central repository keys and repository identifiers for the S60
    15 *                Messaging UI components
    16 *
    17 */
    18 
    19 
    20 
    21 #ifndef MESSAGINGSDKCRKEYS_H
    22 #define MESSAGINGSDKCRKEYS_H
    23 
    24 //  INCLUDES
    25 #include <e32std.h>
    26 
    27 /**
    28  * This is a READ-ONLY API to get information about the Messaging UI
    29  * settings.
    30  *
    31  * How to use:
    32  *
    33  * @code
    34  * #include <centralrepository.h>
    35  * #include <MessagingSDKCRKeys.h>
    36  *
    37  * CRepository* cr = CRepository::NewLC( KCRUidMessagingUiSettings );
    38  * TInt value;
    39  *
    40  * // Get the current zoom level of messaging editors:
    41  * User::LeaveIfError( cr->Get( KMessagingEditorLocalUiZoom, value ) );
    42  * // use value
    43  *
    44  * CleanupStack::PopAndDestroy( cr );
    45  * @endcode
    46  */
    47 
    48 /**
    49  * The UID of the Central Repository file containing the settings. Should be
    50  * given as a parameter in CRepository::NewL() call.
    51  */
    52 const TUid KCRUidMessagingUiSettings = {0x102072E2};
    53 
    54 /**
    55  * Zoom level of the message editors (and viewers), integer value.
    56  *
    57  * Possible values (corresponding enumeration from "akndef.hrh" in parentheses):
    58  *
    59  * -1 = Automatic (EAknUiZoomAutomatic)<br>
    60  * 0 = Normal (EAknUiZoomNormal)<br>
    61  * 1 = Small (EAknUiZoomSmall)<br>
    62  * 2 = Large (EAknUiZoomLarge)<br>
    63  */
    64 const TUint32 KMessagingEditorLocalUiZoom = 0x00000001;
    65 
    66 
    67 #endif // MESSAGINGSDKCRKEYS_H