epoc32/include/mw/profile.hrh
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) 2002 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:  Profiles Engine enumerations TProfileKeypadVolume,
    15 *                TProfileRingingType, TDefaultProfileId and
    16 *                TProfileRingingVolume
    17 *
    18 */
    19 
    20 
    21 #ifndef __PROFILE_HRH__
    22 #define __PROFILE_HRH__
    23 
    24 // DATA TYPES
    25 
    26 /**
    27 * Ringing type of an alert tone. This affects how the tone is actually played
    28 * when a call or a message arrives.
    29 */
    30 enum TProfileRingingType
    31     {
    32     /** The tone is played in a loop.
    33     */
    34     EProfileRingingTypeRinging      = 0,
    35     /**
    36     * The tone is played in a loop. On the 1st round, the volume is gradually
    37     * increment from the lowest level to the set level.
    38     */
    39     EProfileRingingTypeAscending    = 1,
    40     /** The tone is played only once.
    41     */
    42     EProfileRingingTypeRingingOnce  = 2,
    43     /**
    44     * The phone only beeps once instead of playing the tone if one has been set.
    45     */
    46     EProfileRingingTypeBeepOnce     = 3,
    47     /** The phone is silent.
    48     */
    49     EProfileRingingTypeSilent       = 4
    50     };
    51 
    52 /**
    53 * Available volume levels for keypad tones.
    54 */
    55 enum TProfileKeypadVolume
    56     {
    57     EProfileKeypadVolumeOff    = 0,
    58     EProfileKeypadVolumeLevel1 = 1,
    59     EProfileKeypadVolumeLevel2 = 2,
    60     EProfileKeypadVolumeLevel3 = 3
    61     };
    62 
    63 /**
    64 * Default profile identifiers. Default profiles are those pre-installed in the
    65 * phone.
    66 */
    67 enum TDefaultProfileId
    68     {
    69     EProfileGeneralId   = 0,
    70     EProfileSilentId    = 1,
    71     EProfileMeetingId   = 2,
    72     EProfileOutdoorId   = 3,
    73     EProfilePagerId     = 4,
    74 	EProfileOffLineId   = 5, ///< Use this only if Off-Line Profile is supported
    75 	EProfileDriveId   = 6    ///< Use this only if Drive Profile is supported
    76     };
    77 
    78 /**
    79 * Available volume levels for alert tones.
    80 */
    81 enum TProfileRingingVolume
    82     {
    83     EProfileRingingVolumeLevel1 = 1,
    84     EProfileRingingVolumeLevel2 = 2,
    85     EProfileRingingVolumeLevel3 = 3,
    86     EProfileRingingVolumeLevel4 = 4,
    87     EProfileRingingVolumeLevel5 = 5,
    88     EProfileRingingVolumeLevel6 = 6,
    89     EProfileRingingVolumeLevel7 = 7,
    90     EProfileRingingVolumeLevel8 = 8,
    91     EProfileRingingVolumeLevel9 = 9,
    92     EProfileRingingVolumeLevel10 = 10
    93     };
    94 
    95 #endif // __PROFILE_HRH__
    96 
    97 // End of File
    98