basiclocationinfodisplay/blid/engine/inc/MBlidSettings.h
branchRCL_3
changeset 17 1fc85118c3ae
parent 16 8173571d354e
child 18 870918037e16
equal deleted inserted replaced
16:8173571d354e 17:1fc85118c3ae
     1 /*
       
     2 * Copyright (c) 2005 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:  Blid settings can be modified
       
    15 *                and read with help of this API.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef __MBLIDSETTINGS_H__
       
    22 #define __MBLIDSETTINGS_H__
       
    23 
       
    24 // CLASS DECLARATION
       
    25 
       
    26 /**
       
    27 *  This Blid application engine API is only used by Blid application.
       
    28 *  Blid settings can be modified and read with help of this API.
       
    29 *
       
    30 */
       
    31 class MBlidSettings
       
    32     {
       
    33     public:  // Constructors and destructor
       
    34         /**
       
    35          * Destructor.
       
    36          */
       
    37         virtual ~MBlidSettings(){};
       
    38 
       
    39     public: // New functions
       
    40         /**
       
    41          * Set altitude calibration 
       
    42          *
       
    43          * @param aAltCalibration
       
    44          */
       
    45         virtual void SetAltCalibration( const TReal32 aAltCalibration ) = 0;
       
    46         
       
    47         /**
       
    48          * Get altitude calibration
       
    49          *
       
    50          * @return altitude calibration
       
    51          */
       
    52         virtual TReal32 AltCalibration() = 0;
       
    53         
       
    54         /**
       
    55          * Get Unit of Measurement 
       
    56          *
       
    57          * @return measurement unit 
       
    58          */
       
    59         virtual TReal32 UnitOfMeasurement() = 0;
       
    60         
       
    61         /**
       
    62          * Set Index of selected Backlight settings option
       
    63          *
       
    64          * @param aBacklightOption
       
    65          */
       
    66         virtual void SetBacklightOption( const TReal32 aBacklightOption ) = 0;
       
    67         
       
    68         /**
       
    69          * Get backlight option selected index
       
    70          *
       
    71          * @return backlight option selected index 
       
    72          */
       
    73         virtual TReal32 GetBacklightOption() = 0;        
       
    74         
       
    75         virtual void SetArrivedToneName( const TDesC8& aArrivedToneName ) = 0;
       
    76         virtual TDesC8& GetArrivedToneName() = 0;
       
    77         virtual void SetResetOdometerOption( const TReal32 aIsOdoReset ) = 0;
       
    78         virtual TReal32 GetResetOdometerOption() = 0;
       
    79         
       
    80 
       
    81         /**
       
    82          * Set the arrived distance
       
    83          */
       
    84         virtual void SetArrivedDistance( TReal32 aDistance )=0 ;
       
    85 
       
    86         /**
       
    87          * Get the arrived distance
       
    88          */
       
    89         virtual TReal32 GetArrivedDistance( ) = 0 ;
       
    90         
       
    91         
       
    92     };
       
    93 
       
    94 #endif      // __MBLIDSETTINGS_H__
       
    95 
       
    96 // End of File