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