Symbian^3 Application Developer Library >

CMsgBioControlFactory Class Reference

class CMsgBioControlFactory : public CBase

Bio control factory. Gets needed information from bif files. Remember to keep the bio factory alive, and destroy it after destroying the Bio Control. Do not call the bio control creation methods more than once for a single instance of the factory.

Inherits from

Public Member Functions
~CMsgBioControlFactory ()
IMPORT_C CMsgBioControl * CreateControlL ( MMsgBioControlObserver &, const TUid &, TMsgBioMode , TMsvId , CMsvSession *)
IMPORT_C CMsgBioControl * CreateControlL ( MMsgBioControlObserver &, const TUid &, TMsgBioMode , const RFile &)
IMPORT_C CMsgBioControlFactory * NewL ()
Private Member Functions
CMsgBioControlFactory ()
CMsgBioControlFactory (const CMsgBioControlFactory &)
void ConstructL ()
CMsgBioControl * DoCreateControlL ( MMsgBioControlObserver &, const TUid &, TMsgBioMode , TMsvId , CMsvSession *, const RFile *)
const CMsgBioControlFactory & operator= (const CMsgBioControlFactory &)
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
RLibrary iControlDllLibrary
TFileName iFileName
RFs iFs

Constructor & Destructor Documentation

CMsgBioControlFactory()

CMsgBioControlFactory ( ) [private]

Default constructor hidden away.

CMsgBioControlFactory(const CMsgBioControlFactory &)

CMsgBioControlFactory ( const CMsgBioControlFactory & aSource ) [private]

Copy constructor hidden away.

Parameters

const CMsgBioControlFactory & aSource

~CMsgBioControlFactory()

IMPORT_C ~CMsgBioControlFactory ( )

Destructor

Member Functions Documentation

ConstructL()

void ConstructL ( ) [private]

Second phase constructor

CreateControlL(MMsgBioControlObserver &, const TUid &, TMsgBioMode, TMsvId, CMsvSession *)

IMPORT_C CMsgBioControl * CreateControlL ( MMsgBioControlObserver & aBioControlObserver,
const TUid & aBioMsgType,
TMsgBioMode aEditorOrViewerMode,
TMsvId aId,
CMsvSession * aSession
)
Creates a Bio control. This version reads the message from the server. Do not call the bio control creation methods more than once for a single instance of the factory.
Exceptions
EMEUErrArgument

if aId or aSession is null or aEditorOrViewerMode has invalid value.

Parameters

MMsgBioControlObserver & aBioControlObserver Reference to the Bio control observer.
const TUid & aBioMsgType The type of Bio message.
TMsgBioMode aEditorOrViewerMode Specifies whether the new Bio control will be in Editor or Viewer mode.
TMsvId aId Id of the message.
CMsvSession * aSession Handle to Message Server session. The ownership is not transferred.

CreateControlL(MMsgBioControlObserver &, const TUid &, TMsgBioMode, const RFile &)

IMPORT_C CMsgBioControl * CreateControlL ( MMsgBioControlObserver & aBioControlObserver,
const TUid & aBioMsgType,
TMsgBioMode aEditorOrViewerMode,
const RFile & aFile
)
Creates a Bio Control. This version creates a file based Bio Control. Do not call the bio control creation methods more than once for a single instance of the factory.
Exceptions
EMEUErrArgument

if aEditorOrViewerMode has undefined value

Parameters

MMsgBioControlObserver & aBioControlObserver Reference to the Bio control observer.
const TUid & aBioMsgType The type of Bio message.
TMsgBioMode aEditorOrViewerMode Specifies whether the new Bio control will be in Editor or Viewer mode.
const RFile & aFile The file handle

DoCreateControlL(MMsgBioControlObserver &, const TUid &, TMsgBioMode, TMsvId, CMsvSession *, const RFile *)

CMsgBioControl * DoCreateControlL ( MMsgBioControlObserver & aBioControlObserver,
const TUid & aBioMsgType,
TMsgBioMode aEditorOrViewerMode,
TMsvId aId,
CMsvSession * aSession,
const RFile * aFile
) [private]

This does the actual creating of the control.

Parameters

MMsgBioControlObserver & aBioControlObserver Reference to the Bio control observer.
const TUid & aBioMsgType The type of Bio message.
TMsgBioMode aEditorOrViewerMode Specifies whether the new Bio control will be in Editor or Viewer mode.
TMsvId aId Id of the message.
CMsvSession * aSession Handle to Message Server session.
const RFile * aFile input file handle.

NewL()

IMPORT_C CMsgBioControlFactory * NewL ( ) [static]

Two-phased constructor.

operator=(const CMsgBioControlFactory &)

const CMsgBioControlFactory & operator= ( const CMsgBioControlFactory & aSource ) [private]

Assignment operator hidden away.

Parameters

const CMsgBioControlFactory & aSource

Member Data Documentation

RLibrary iControlDllLibrary

RLibrary iControlDllLibrary [private]

The library where the Bio control is located.

TFileName iFileName

TFileName iFileName [private]

A filename for file based bio controls.

RFs iFs

RFs iFs [private]

File Server Session It is opened during construction of factory, and closed during destruction of factory.

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.