Symbian^3 Application 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 ()
void DeletePresetL ( TInt )
void GetFirstPresetL ( TInt &)
TInt GetMaxNumberOfPresets ( TInt &)
void GetNextPresetL ( TInt , TInt &)
TInt GetNumberOfPresets ( TInt &)
void GetPresetFavouriteInfoL ( TInt , TBool &)
void GetPresetFrequencyL ( TInt , TInt &)
void GetPresetL ( TInt , TFmPresetName &, TInt &)
void GetPresetNameL ( TInt , TFmPresetName &)
void GetPresetPICodeL ( TInt , TUint &)
void GetPresetPtyL ( TInt , TUint &)
void GetPresetUrlL ( TInt , TFmPresetUrl &)
void GetPresetUserRenameInfoL ( TInt , TBool &)
CBody * NewL ( MRadioPresetObserver &)
void SetPresetFavouriteInfoL ( TInt , TBool )
void SetPresetL ( TInt , const TFmPresetName &, TInt )
void SetPresetPICodeL ( TInt , TUint )
void SetPresetPtyL ( TInt , TUint )
void SetPresetUrlL ( TInt , const TFmPresetUrl &)
void SetPresetUserRenameInfoL ( TInt , TBool )
Private Member Functions
CBody ()
void ConstructL ()
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()

void ConstructL ( ) [private]

DeletePresetL(TInt)

void DeletePresetL ( TInt aIndex )

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 aIndex A preset index.

GetFirstPresetL(TInt &)

void GetFirstPresetL ( 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 & aIndex On 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 & aMaxNumOfPresets On return contains the maximum number of presets.

GetNextPresetL(TInt, TInt &)

void GetNextPresetL ( TInt aIndex,
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 aIndex Current preset index.
TInt & aNextIndex On 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 & aNumOfPresets On return contains the current number of presets.

GetPresetFavouriteInfoL(TInt, TBool &)

void GetPresetFavouriteInfoL ( TInt aIndex,
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 aIndex A preset index.
TBool & aFavourite On return, contains the preset favourite info.

GetPresetFrequencyL(TInt, TInt &)

void GetPresetFrequencyL ( TInt aIndex,
TInt & aFrequency
)

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

Since
S60 5.1

Parameters

TInt aIndex A preset index.
TInt & aFrequency On return, contains the preset name.

GetPresetL(TInt, TFmPresetName &, TInt &)

void GetPresetL ( TInt aIndex,
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 aIndex A preset index.
TFmPresetName & aName
TInt & aFrequency On return, contains the preset name.

GetPresetNameL(TInt, TFmPresetName &)

void GetPresetNameL ( TInt aIndex,
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 aIndex A preset index.
TFmPresetName & aName On return, contains the preset name.

GetPresetPICodeL(TInt, TUint &)

void GetPresetPICodeL ( TInt aIndex,
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 aIndex A preset index.
TUint & aPICode On return, contains the preset programme identification.

GetPresetPtyL(TInt, TUint &)

void GetPresetPtyL ( TInt aIndex,
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 aIndex A preset index.
TUint & aPty On return, contains the preset PTY.

GetPresetUrlL(TInt, TFmPresetUrl &)

void GetPresetUrlL ( TInt aIndex,
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 aIndex A preset index.
TFmPresetUrl & aUrl On return, contains the preset name.

GetPresetUserRenameInfoL(TInt, TBool &)

void GetPresetUserRenameInfoL ( TInt aIndex,
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 aIndex A preset index.
TBool & aRename On 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 & aObserver The observer object

SetPresetFavouriteInfoL(TInt, TBool)

void SetPresetFavouriteInfoL ( TInt aIndex,
TBool aFavourite
)

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 aIndex A preset index.
TBool aFavourite Preset favourite info.

SetPresetL(TInt, const TFmPresetName &, TInt)

void SetPresetL ( TInt aIndex,
const TFmPresetName & aName,
TInt aFrequency
)

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 aIndex A preset index.
const TFmPresetName & aName Preset name.
TInt aFrequency Frequency in Hz.

SetPresetPICodeL(TInt, TUint)

void SetPresetPICodeL ( TInt aIndex,
TUint aPICode
)

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 aIndex A preset index.
TUint aPICode Preset PI (programme identification).

SetPresetPtyL(TInt, TUint)

void SetPresetPtyL ( TInt aIndex,
TUint aPty
)

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 aIndex A preset index.
TUint aPty Preset PTY (programme type).

SetPresetUrlL(TInt, const TFmPresetUrl &)

void SetPresetUrlL ( TInt aIndex,
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 aIndex A preset index.
const TFmPresetUrl & aUrl Preset URL.

SetPresetUserRenameInfoL(TInt, TBool)

void SetPresetUserRenameInfoL ( TInt aIndex,
TBool aRename
)

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 aIndex A preset index.
TBool aRename Preset 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.