CFLDController Class Reference

class CFLDController : public CBase

CFLDController observes the list box and invokes a MFLDFileProcessor if the timer expires.

filelist.lib
Since
2.1

Inherits from

Public Member Functions
~CFLDController ()
IMPORT_C void CompleteConstructionL ( RWindow &)
IMPORT_C void HandleFileListBoxEventL (TFileListBoxEvent, const TDesC &)
void HandleSoftKeyState (TFileListSoftKeyState &)
IMPORT_C CFLDController * NewL ( TBool , TTimeIntervalMicroSeconds32 )
IMPORT_C CFLDController * NewLC ( TBool , TTimeIntervalMicroSeconds32 )
void Release ()
IMPORT_C void Set3dEffects ( TBool )
IMPORT_C void SetDelay ( TTimeIntervalMicroSeconds32 )
IMPORT_C void SetFileObserver ( MFLDFileObserver *)
IMPORT_C void SetRingingType ( TInt )
IMPORT_C void SetVibra ( TBool )
IMPORT_C void SetVolume ( TInt )
Private Member Functions
CFLDController ( TBool , TTimeIntervalMicroSeconds32 )
void ConstructL ()
TInt HandleTimerTickL ( TAny *)
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 Member Enumerations
enum TRingingTypes { ERingingTypeRinging  = 0, ERingingTypeAscending , ERingingTypeRingOnce , ERingingTypeBeepOnce , ERingingTypeSilent }
Private Attributes
TBool i3dEffects
MFLDFileProcessor * iAudioProcessor
TFileName iCurrentFile
TTimeIntervalMicroSeconds32 iDelay
MFLDFileObserver * iFileObserver
RConeResourceLoader iResourceLoader
TInt iRingingType
TInt iRingingVolume
TBool iShowErrorMsgs
CPeriodic * iTimer
TBool iVibra
RWindow * iWindow

Constructor & Destructor Documentation

CFLDController(TBool, TTimeIntervalMicroSeconds32)

CFLDController ( TBool aShowErrorMsgs,
TTimeIntervalMicroSeconds32 aDelay
) [private]

Constructor

Parameters

TBool aShowErrorMsgs Show an error note if the file format is not supported
TTimeIntervalMicroSeconds32 aDelay The delay in microseconds until the timer expires

~CFLDController()

IMPORT_C ~CFLDController ( ) [virtual]

Destructor

Member Functions Documentation

CompleteConstructionL(RWindow &)

IMPORT_C void CompleteConstructionL ( RWindow & aWindow )

Completes the construction of CFLDController .

Parameters

RWindow & aWindow A reference to window handle

ConstructL()

void ConstructL ( ) [private]

Second phase constructor

HandleFileListBoxEventL(TFileListBoxEvent, const TDesC &)

IMPORT_C void HandleFileListBoxEventL ( TFileListBoxEvent aEvent,
const TDesC & aFileName
)

Receives the event notification from the file list box

Parameters

TFileListBoxEvent aEvent
const TDesC & aFileName

HandleSoftKeyState(TFileListSoftKeyState &)

void HandleSoftKeyState ( TFileListSoftKeyState & aSoftKeyState )

Passes softkey notifications to the file list box

Parameters

TFileListSoftKeyState & aSoftKeyState

HandleTimerTickL(TAny *)

TInt HandleTimerTickL ( TAny * aPtr ) [private, static]

This callback method is called when the timer expires. Calls MFLDFileProcessor::ProcessFileL() .

Parameters

TAny * aPtr pointer to CFLDController

NewL(TBool, TTimeIntervalMicroSeconds32)

IMPORT_C CFLDController * NewL ( TBool aShowErrorMsgs,
TTimeIntervalMicroSeconds32 aDelay
) [static]

Two-phased static constructor.

Parameters

TBool aShowErrorMsgs Show an error note if the file format is not supported
TTimeIntervalMicroSeconds32 aDelay The delay in microseconds until the timer expires

NewLC(TBool, TTimeIntervalMicroSeconds32)

IMPORT_C CFLDController * NewLC ( TBool aShowErrorMsgs,
TTimeIntervalMicroSeconds32 aDelay
) [static]

Two-phased static constructor, leaves a pointer to cleanup stack

Parameters

TBool aShowErrorMsgs Show an error note if the file format is not supported
TTimeIntervalMicroSeconds32 aDelay The delay in microseconds until the timer expires

Release()

void Release ( )

Release allocated resources

Set3dEffects(TBool)

IMPORT_C void Set3dEffects ( TBool a3dEffects )

Sets 3d-effects on or off. If this method is called using parameter EFalse 3d-effects are always disabled even though those are set in active profile. Otherwise toneplayer uses the setting in active profile.

Parameters

TBool a3dEffects True: 3dEffects are on. False: 3dEffects are off.

SetDelay(TTimeIntervalMicroSeconds32)

IMPORT_C void SetDelay ( TTimeIntervalMicroSeconds32 aDelay )

Set the delay until the timer expires.

Parameters

TTimeIntervalMicroSeconds32 aDelay The delay in microseconds

SetFileObserver(MFLDFileObserver *)

IMPORT_C void SetFileObserver ( MFLDFileObserver * aFileObserver )
Sets the file observer for the class. The file observer is asked if the file is ok to be processed.
Since
2.5

Parameters

MFLDFileObserver * aFileObserver Pointer to the file observer.

SetRingingType(TInt)

IMPORT_C void SetRingingType ( TInt aRingingType )

Sets the ringing type If this method is not called, audio and video players uses the setting in active profile.

Parameters

TInt aRingingType The ringing type (see enum TRingingTypes)

SetVibra(TBool)

IMPORT_C void SetVibra ( TBool aVibra )

Sets vibrating alert on or off. If this method is not called, audio and video players uses the setting in active profile.

Parameters

TBool aVibra True: Vibra is on. False: Vibra is off.

SetVolume(TInt)

IMPORT_C void SetVolume ( TInt aVolume )

Set the volume level on which the sound is played If this method is not called, audio and video players uses the setting in active profile.

Parameters

TInt aVolume The volume level

Member Enumerations Documentation

Enum TRingingTypes

Enumerators

ERingingTypeRinging = 0
ERingingTypeAscending
ERingingTypeRingOnce
ERingingTypeBeepOnce
ERingingTypeSilent

Member Data Documentation

TBool i3dEffects

TBool i3dEffects [private]

MFLDFileProcessor * iAudioProcessor

MFLDFileProcessor * iAudioProcessor [private]

TFileName iCurrentFile

TFileName iCurrentFile [private]

TTimeIntervalMicroSeconds32 iDelay

TTimeIntervalMicroSeconds32 iDelay [private]

MFLDFileObserver * iFileObserver

MFLDFileObserver * iFileObserver [private]

RConeResourceLoader iResourceLoader

RConeResourceLoader iResourceLoader [private]

TInt iRingingType

TInt iRingingType [private]

TInt iRingingVolume

TInt iRingingVolume [private]

TBool iShowErrorMsgs

TBool iShowErrorMsgs [private]

CPeriodic * iTimer

CPeriodic * iTimer [private]

TBool iVibra

TBool iVibra [private]

RWindow * iWindow

RWindow * iWindow [private]