gsprofilesrv_pub/profiles_engine_wrapper_api/inc/Profile.hrh
author Pat Downey <patd@symbian.org>
Wed, 01 Sep 2010 12:20:44 +0100
branchRCL_3
changeset 25 7e0eff37aedb
parent 24 8ee96d21d9bf
permissions -rw-r--r--
Revert incorrect RCL_3 drop: Revision: 201033 Kit: 201035

/*
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Profiles Engine enumerations TProfileKeypadVolume,
*                TProfileRingingType, TDefaultProfileId and
*                TProfileRingingVolume
*
*/


#ifndef __PROFILE_HRH__
#define __PROFILE_HRH__

// DATA TYPES

/**
* Ringing type of an alert tone. This affects how the tone is actually played
* when a call or a message arrives.
*/
enum TProfileRingingType
    {
    /** The tone is played in a loop.
    */
    EProfileRingingTypeRinging      = 0,
    /**
    * The tone is played in a loop. On the 1st round, the volume is gradually
    * increment from the lowest level to the set level.
    */
    EProfileRingingTypeAscending    = 1,
    /** The tone is played only once.
    */
    EProfileRingingTypeRingingOnce  = 2,
    /**
    * The phone only beeps once instead of playing the tone if one has been set.
    */
    EProfileRingingTypeBeepOnce     = 3,
    /** The phone is silent.
    */
    EProfileRingingTypeSilent       = 4
    };

/**
* Available volume levels for keypad tones.
*/
enum TProfileKeypadVolume
    {
    EProfileKeypadVolumeOff    = 0,
    EProfileKeypadVolumeLevel1 = 1,
    EProfileKeypadVolumeLevel2 = 2,
    EProfileKeypadVolumeLevel3 = 3
    };

/**
* Default profile identifiers. Default profiles are those pre-installed in the
* phone.
*/
enum TDefaultProfileId
    {
    EProfileGeneralId   = 0,
    EProfileSilentId    = 1,
    EProfileMeetingId   = 2,
    EProfileOutdoorId   = 3,
    EProfilePagerId     = 4,
	EProfileOffLineId   = 5, ///< Use this only if Off-Line Profile is supported
	EProfileDriveId   = 6    ///< Use this only if Drive Profile is supported
    };

/**
* Available volume levels for alert tones.
*/
enum TProfileRingingVolume
    {
    EProfileRingingVolumeLevel1 = 1,
    EProfileRingingVolumeLevel2 = 2,
    EProfileRingingVolumeLevel3 = 3,
    EProfileRingingVolumeLevel4 = 4,
    EProfileRingingVolumeLevel5 = 5,
    EProfileRingingVolumeLevel6 = 6,
    EProfileRingingVolumeLevel7 = 7,
    EProfileRingingVolumeLevel8 = 8,
    EProfileRingingVolumeLevel9 = 9,
    EProfileRingingVolumeLevel10 = 10
    };

#endif // __PROFILE_HRH__

// End of File