fmradio/fmradioengine/inc/fmradioregion.h
branchRCL_3
changeset 19 cce62ebc198e
parent 18 1a6714c53019
child 20 93c594350b9a
equal deleted inserted replaced
18:1a6714c53019 19:cce62ebc198e
     1 /*
       
     2 * Copyright (c) 2004-2007 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:  Header file for CFMRadioRegion
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef FMRADIOREGION_H
       
    20 #define FMRADIOREGION_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 #include "fmradioengine.hrh"
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class CFMRadioRegion;
       
    28 class TResourceReader;
       
    29 
       
    30 // DATA TYPES
       
    31 typedef RPointerArray<CFMRadioRegion> RFMRadioRegionArray;
       
    32 typedef RPointerArray<HBufC16> RFMRadioCountryCodeArray;
       
    33 
       
    34 // CLASS DECLARATION
       
    35 
       
    36 /**
       
    37 *  Class CFMRadioRegion provides information about FM region
       
    38 */
       
    39 NONSHARABLE_CLASS( CFMRadioRegion ) : public CBase
       
    40     {
       
    41     public:  // Methods
       
    42 
       
    43 	// Constructors and destructor
       
    44         
       
    45         /**
       
    46         * Static constructor.
       
    47         */
       
    48         static CFMRadioRegion* NewL(TResourceReader& aRr);
       
    49         
       
    50         /**
       
    51         * Destructor.
       
    52         */
       
    53          ~CFMRadioRegion();
       
    54 
       
    55 
       
    56 	// New methods
       
    57 
       
    58         /**
       
    59         * Id Get the id of region
       
    60         * @return id of region
       
    61         */
       
    62 		TFMRadioRegionSetting Id() const;
       
    63 
       
    64 		/**
       
    65         * StepSize Get the step interval of region
       
    66         * @return Step size
       
    67         */
       
    68 		TUint32 StepSize() const;
       
    69 
       
    70 		/**
       
    71         * Get the minimum frequency of region
       
    72         * @return Minimum frequency
       
    73         */
       
    74 		TUint32 MinFrequency() const;
       
    75 
       
    76 		/**
       
    77         * Get the maximum frequency of region
       
    78         * @return Maximum frequency
       
    79         */
       
    80 		TUint32 MaxFrequency() const;
       
    81 		
       
    82 		/**
       
    83         * Get the decimal count of region.
       
    84         * @return Decimal count.
       
    85         */
       
    86 		TInt DecimalCount() const;
       
    87 
       
    88 		/**
       
    89         * CountryCode Get the country code of region
       
    90         * @return Country code, or empty descriptor if country code doesn't exist
       
    91         */
       
    92 		const RFMRadioCountryCodeArray& CountryCodes();
       
    93 
       
    94 		/**
       
    95         * Name Get the name of region
       
    96         * @return Name of region
       
    97         */
       
    98 	 	const TDesC16& Name() const;
       
    99         
       
   100         /**
       
   101         * SettingItemName Get the name of region for setting item
       
   102         * @return Name of region
       
   103         */
       
   104 		const TDesC16& SettingItemName() const;
       
   105 
       
   106     private: //Methods
       
   107 
       
   108         /**
       
   109         * C++ default constructor.
       
   110         */
       
   111     	CFMRadioRegion();
       
   112 
       
   113         /**
       
   114         * By default Symbian 2nd phase constructor is private.
       
   115         */
       
   116         void ConstructL(TResourceReader& aRr);
       
   117 
       
   118 
       
   119     private:    // Data
       
   120 		
       
   121     /** Id of the region*/
       
   122 		TFMRadioRegionSetting		iId;
       
   123 		
       
   124 		/** Step interval*/
       
   125 		TUint16				iStepSize;
       
   126 		
       
   127 		/** Min frequency */
       
   128 		TUint32				iMinFreq;
       
   129 		
       
   130 		/** Max frequency */
       
   131 		TUint32				iMaxFreq;
       
   132 		
       
   133 		/** Decimal count */
       
   134 		TInt				iDecimalCount;
       
   135 		
       
   136 		/** Country code*/
       
   137 		RFMRadioCountryCodeArray iCountryCodes;
       
   138 		
       
   139 		/** Region name*/
       
   140 		HBufC16*			iName;
       
   141 		
       
   142 		/** Region name for setting item*/
       
   143 		HBufC16*			iSettingName;
       
   144 
       
   145     };
       
   146 
       
   147 #endif      // FMRADIOREGION_H   
       
   148             
       
   149 // End of File