EPOC   SDK Home Glossary Indexes Previous Next Up

MtmUiFactoryFunctionL typedef


MtmUiFactoryFunctionL typedef — User Interface MTM factory

typedef CBaseMtmUi* MtmUiFactoryFunctionL(CBaseMtm&, CRegisteredMtmDll&);

Defined in

mtuireg.h

Description

A concrete User Interface MTM must implement an exported factory function of this type. It should return an instance of the CBaseMtmUi-derived class that provides the implementation. The factory function is called by the User Interface MTM registry when a client requests this User Interface MTM.

A CBaseMtmUi-derived class typically provides a NewL() function, which the factory function calls.

The factory function is called by ordinal. The ordinal of the function must match that recorded in the MTM’s registry information.

Arguments

CBaseMtm&

The CBaseMtm requesting the object

CRegisteredMtmDll& aRegisteredMtmDll

Registration data for the MTM DLL.

Return value

CBaseMtmUi*

A newly-created instance of the CBaseMtmUi-derived class for the User Interface MTM.

Leave considerations

The factory function should leave if it cannot create the object.

Example

For example, a User Interface MTM whose concrete class was CEgMtmUi could define a suitable factory function as:

    EXPORT_C CBaseMtmUi* NewEgMtmUiL(CBaseMtm& aMtm, CRegisteredMtmDll& aRegisteredDll)
          {
          return CEgMtmUi::NewL(aMtm, aRegisteredDll);
          }
EPOC       SDK Home Glossary Indexes Previous Next Up