Symbian^3 Product Developer Library >

CRadioFmPresetUtility::CBody Class Reference

class CRadioFmPresetUtility::CBody : public CBase

This class provides an interface for controlling the preset for an FM tuner. The maximum number of presets supported by this utility is pre-defined and the client must first query it.

RadioPresetUtility.lib
Since
S60 3.2

Inherits from

  • CRadioFmPresetUtility::CBody
Public Member Functions
~CBody()
voidDeletePresetL(TInt)
voidGetFirstPresetL(TInt &)
TInt GetMaxNumberOfPresets(TInt &)
voidGetNextPresetL(TInt, TInt &)
TInt GetNumberOfPresets(TInt &)
voidGetPresetFavouriteInfoL(TInt, TBool &)
voidGetPresetFrequencyL(TInt, TInt &)
voidGetPresetL(TInt, TFmPresetName &, TInt &)
voidGetPresetNameL(TInt, TFmPresetName &)
voidGetPresetPICodeL(TInt, TUint &)
voidGetPresetPtyL(TInt, TUint &)
voidGetPresetUrlL(TInt, TFmPresetUrl &)
voidGetPresetUserRenameInfoL(TInt, TBool &)
CBody *NewL(MRadioPresetObserver &)
voidSetPresetFavouriteInfoL(TInt, TBool)
voidSetPresetL(TInt, const TFmPresetName &, TInt)
voidSetPresetPICodeL(TInt, TUint)
voidSetPresetPtyL(TInt, TUint)
voidSetPresetUrlL(TInt, const TFmPresetUrl &)
voidSetPresetUserRenameInfoL(TInt, TBool)
Private Member Functions
CBody()
voidConstructL()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CCentralRepositoryHandler *iCentralRepositoryHandler
MRadioPresetObserver *iRadioPresetClient
TRadioSettings *iRadioSettings

Constructor & Destructor Documentation

CBody()

CBody()[private]

~CBody()

~CBody()

Member Functions Documentation

ConstructL()

voidConstructL()[private]

DeletePresetL(TInt)

voidDeletePresetL(TIntaIndex)

From MRadioPreset Reset the specified preset. Has not effect if specified index contains no preset.

NOTE: Specifying aIndex == 0, will reset all presets.

Since
S60 3.2

Parameters

TInt aIndexA preset index.

GetFirstPresetL(TInt &)

voidGetFirstPresetL(TInt &aIndex)const

From MRadioPreset Get the first preset index that has been set. Leaves with KErrNone if no preset exists.

Since
S60 3.2

Parameters

TInt & aIndexOn return contains the index of the first preset.

GetMaxNumberOfPresets(TInt &)

TInt GetMaxNumberOfPresets(TInt &aMaxNumOfPresets)const

From MRadioPreset Get the maximum number of presets supported by this utility. The numbering of presets starts from 1 and the largest preset number equals the value returned from this function.

Since
S60 3.2

Parameters

TInt & aMaxNumOfPresetsOn return contains the maximum number of presets.

GetNextPresetL(TInt, TInt &)

voidGetNextPresetL(TIntaIndex,
TInt &aNextIndex
)const

From MRadioPreset Get the next preset index that has been set, given the current index. Leaves with KErrNone if no other preset exists.

Since
S60 3.2

Parameters

TInt aIndexCurrent preset index.
TInt & aNextIndexOn return contains the index of next preset.

GetNumberOfPresets(TInt &)

TInt GetNumberOfPresets(TInt &aNumOfPresets)const

From MRadioPreset Get the number of presets already set by the client (i.e. contains data).

Since
S60 3.2

Parameters

TInt & aNumOfPresetsOn return contains the current number of presets.

GetPresetFavouriteInfoL(TInt, TBool &)

voidGetPresetFavouriteInfoL(TIntaIndex,
TBool &aFavourite
)

From MRadioFmPresetUtility Get the preset favourite info at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TBool & aFavouriteOn return, contains the preset favourite info.

GetPresetFrequencyL(TInt, TInt &)

voidGetPresetFrequencyL(TIntaIndex,
TInt &aFrequency
)

Get the preset frequency at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since
S60 5.1

Parameters

TInt aIndexA preset index.
TInt & aFrequencyOn return, contains the preset name.

GetPresetL(TInt, TFmPresetName &, TInt &)

voidGetPresetL(TIntaIndex,
TFmPresetName &aName,
TInt &aFrequency
)

From MRadioFmPreset Get the preset name and frequency at the specified index. Leaves with KErrNotFound if invalid index is specified.

Preset name is maximum of 32 characters. Client must allocate buffer big enough to hold the 32 characters. If not, characters will be truncated to fit the buffer.

Since
S60 3.2

Parameters

TInt aIndexA preset index.
TFmPresetName & aName
TInt & aFrequencyOn return, contains the preset name.

GetPresetNameL(TInt, TFmPresetName &)

voidGetPresetNameL(TIntaIndex,
TFmPresetName &aName
)

From MRadioFmPreset Get the preset name at the specified index. Leaves with KErrNotFound if invalid index is specified.

Preset name is maximum of 32 characters. Client must allocate buffer big enough to hold the 32 characters. If not, characters will be truncated to fit the buffer.

Since
S60 5.1

Parameters

TInt aIndexA preset index.
TFmPresetName & aNameOn return, contains the preset name.

GetPresetPICodeL(TInt, TUint &)

voidGetPresetPICodeL(TIntaIndex,
TUint &aPICode
)

From MRadioFmPresetUtility Get the preset PI code (programme identification) at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TUint & aPICodeOn return, contains the preset programme identification.

GetPresetPtyL(TInt, TUint &)

voidGetPresetPtyL(TIntaIndex,
TUint &aPty
)

From MRadioFmPresetUtility Get the preset PTY (programme type) at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TUint & aPtyOn return, contains the preset PTY.

GetPresetUrlL(TInt, TFmPresetUrl &)

voidGetPresetUrlL(TIntaIndex,
TFmPresetUrl &aUrl
)

From MRadioFmPresetUtility Get the preset URL at the specified index. Leaves with KErrNotFound if invalid index is specified.

Preset URL is maximum of 64 characters. Client must allocate buffer big enough to hold the 64 characters. If not, characters will be truncated to fit the buffer.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TFmPresetUrl & aUrlOn return, contains the preset name.

GetPresetUserRenameInfoL(TInt, TBool &)

voidGetPresetUserRenameInfoL(TIntaIndex,
TBool &aRename
)

From MRadioFmPresetUtility Get the preset user rename info at the specified index. Leaves with KErrNotFound if invalid index is specified.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TBool & aRenameOn return, contains the preset rename info.

NewL(MRadioPresetObserver &)

CBody *NewL(MRadioPresetObserver &aObserver)[static]

Factory function to create a new instance of the FM tuner.

Since
S60 3.2

Parameters

MRadioPresetObserver & aObserverThe observer object

SetPresetFavouriteInfoL(TInt, TBool)

voidSetPresetFavouriteInfoL(TIntaIndex,
TBoolaFavourite
)

From MRadioFmPresetUtility Set the preset with specified favourite information. Previous content in the specified index will be overwritten with the new information.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TBool aFavouritePreset favourite info.

SetPresetL(TInt, const TFmPresetName &, TInt)

voidSetPresetL(TIntaIndex,
const TFmPresetName &aName,
TIntaFrequency
)

From MRadioFmPresetUtility Set the preset with specified frequency and name. Previous content in the specified index will be overwritten with the new information.

The maximum length for the preset name is 32 characters. Names longer than 32 characters will be truncated.

Since
S60 3.2

Parameters

TInt aIndexA preset index.
const TFmPresetName & aNamePreset name.
TInt aFrequencyFrequency in Hz.

SetPresetPICodeL(TInt, TUint)

voidSetPresetPICodeL(TIntaIndex,
TUintaPICode
)

From MRadioFmPresetUtility Set the preset with specified PI code. Previous content in the specified index will be overwritten with the new information.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TUint aPICodePreset PI (programme identification).

SetPresetPtyL(TInt, TUint)

voidSetPresetPtyL(TIntaIndex,
TUintaPty
)

From MRadioFmPresetUtility Set the preset with specified PTY. Previous content in the specified index will be overwritten with the new information.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TUint aPtyPreset PTY (programme type).

SetPresetUrlL(TInt, const TFmPresetUrl &)

voidSetPresetUrlL(TIntaIndex,
const TFmPresetUrl &aUrl
)

From MRadioFmPresetUtility Set the preset with specified URL. Previous content in the specified index will be overwritten with the new information.

The maximum length for the preset URL is 64 characters. URLs longer than 32 characters will be truncated.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
const TFmPresetUrl & aUrlPreset URL.

SetPresetUserRenameInfoL(TInt, TBool)

voidSetPresetUserRenameInfoL(TIntaIndex,
TBoolaRename
)

From MRadioFmPresetUtility Set the preset with specified user rename information. Previous content in the specified index will be overwritten with the new information.

Since
S60 5.2

Parameters

TInt aIndexA preset index.
TBool aRenamePreset user rename info.

Member Data Documentation

CCentralRepositoryHandler * iCentralRepositoryHandler

CCentralRepositoryHandler *iCentralRepositoryHandler[private]

MRadioPresetObserver * iRadioPresetClient

MRadioPresetObserver *iRadioPresetClient[private]

TRadioSettings * iRadioSettings

TRadioSettings *iRadioSettings[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.