epoc32/include/app/messagingsdkcrkeys.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:   Central repository keys and repository identifiers for the S60
williamr@2
    15
*                Messaging UI components
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
#ifndef MESSAGINGSDKCRKEYS_H
williamr@2
    22
#define MESSAGINGSDKCRKEYS_H
williamr@2
    23
williamr@2
    24
//  INCLUDES
williamr@2
    25
#include <e32std.h>
williamr@2
    26
williamr@2
    27
/**
williamr@2
    28
 * This is a READ-ONLY API to get information about the Messaging UI
williamr@2
    29
 * settings.
williamr@2
    30
 *
williamr@2
    31
 * How to use:
williamr@2
    32
 *
williamr@2
    33
 * @code
williamr@2
    34
 * #include <centralrepository.h>
williamr@2
    35
 * #include <MessagingSDKCRKeys.h>
williamr@2
    36
 *
williamr@2
    37
 * CRepository* cr = CRepository::NewLC( KCRUidMessagingUiSettings );
williamr@2
    38
 * TInt value;
williamr@2
    39
 *
williamr@2
    40
 * // Get the current zoom level of messaging editors:
williamr@2
    41
 * User::LeaveIfError( cr->Get( KMessagingEditorLocalUiZoom, value ) );
williamr@2
    42
 * // use value
williamr@2
    43
 *
williamr@2
    44
 * CleanupStack::PopAndDestroy( cr );
williamr@2
    45
 * @endcode
williamr@2
    46
 */
williamr@2
    47
williamr@2
    48
/**
williamr@2
    49
 * The UID of the Central Repository file containing the settings. Should be
williamr@2
    50
 * given as a parameter in CRepository::NewL() call.
williamr@2
    51
 */
williamr@2
    52
const TUid KCRUidMessagingUiSettings = {0x102072E2};
williamr@2
    53
williamr@2
    54
/**
williamr@2
    55
 * Zoom level of the message editors (and viewers), integer value.
williamr@2
    56
 *
williamr@2
    57
 * Possible values (corresponding enumeration from "akndef.hrh" in parentheses):
williamr@2
    58
 *
williamr@2
    59
 * -1 = Automatic (EAknUiZoomAutomatic)<br>
williamr@2
    60
 * 0 = Normal (EAknUiZoomNormal)<br>
williamr@2
    61
 * 1 = Small (EAknUiZoomSmall)<br>
williamr@2
    62
 * 2 = Large (EAknUiZoomLarge)<br>
williamr@2
    63
 */
williamr@2
    64
const TUint32 KMessagingEditorLocalUiZoom = 0x00000001;
williamr@2
    65
williamr@2
    66
williamr@2
    67
#endif // MESSAGINGSDKCRKEYS_H