CMMFFormatImplementationInformation Class Reference

#include <mmf/common/mmfcontrollerpluginresolver.h>

Link against: mmfcontrollerframework.lib

class CMMFFormatImplementationInformation : public CMMFPluginImplementationInformation, private MTaggedDataParserClient, public CMMFPluginImplementationInformation, private MTaggedDataParserClient

Inherits from

CMMFFormatImplementationInformation

Public Member Functions
virtual	~CMMFFormatImplementationInformation()
CMMFFormatImplementationInformation *	NewL(const CImplementationInformation &)
CMMFFormatImplementationInformation *	NewLC(const CImplementationInformation &)
IMPORT_C const CDesC8Array &	SupportedFileExtensions()
IMPORT_C const CDesC8Array &	SupportedHeaderData()
IMPORT_C const CDesC8Array &	SupportedMimeTypes()
IMPORT_C TBool	SupportsCustomInterfaces()
IMPORT_C TBool	SupportsFileExtension(const TDesC8 &)
IMPORT_C TBool	SupportsHeaderDataL(const TDesC8 &)
IMPORT_C TBool	SupportsMimeType(const TDesC8 &)

Protected Member Functions
	CMMFFormatImplementationInformation()
void	AddFileExtensionL(const TDesC8 &)
void	AddHeaderDataL(const TDesC8 &)
void	AddMimeTypeL(const TDesC8 &)
void	ConstructL(const CImplementationInformation &)
virtual void	ProcessTaggedDataL(const TDesC8 &, const TDesC8 &)

Inherited Attributes
	CMMFPluginImplementationInformation::iDisplayName
	CMMFPluginImplementationInformation::iMediaIds
	CMMFPluginImplementationInformation::iSupplier
	CMMFPluginImplementationInformation::iUid
	CMMFPluginImplementationInformation::iVersion

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()
	CMMFPluginImplementationInformation::AddMediaIdL(const TDesC8 &)
	CMMFPluginImplementationInformation::CMMFPluginImplementationInformation()
	CMMFPluginImplementationInformation::DisplayName()const
	CMMFPluginImplementationInformation::SetSupplierL(const TDesC8 &)
	CMMFPluginImplementationInformation::Supplier()const
	CMMFPluginImplementationInformation::SupportedMediaIds()const
	CMMFPluginImplementationInformation::SupportsMediaId(TUid)const
	CMMFPluginImplementationInformation::SupportsSupplier(const TDesC &)const
	CMMFPluginImplementationInformation::Uid()const
	CMMFPluginImplementationInformation::Version()const
	CMMFPluginImplementationInformation::~CMMFPluginImplementationInformation()

Detailed Description

Contains format support information retrieved from the ECom registry.

An object of this type may describe either a concrete format plugin (ie a CMMFFormatEncode or a CMMFFormatDecode implementation) or a format supported by a controller plugin.

The object is created using a CImplementationInformation object retrieved from the ECom registry. All relevant data is copied out of the CImplementationInformation object, and its opaque data is parsed to provide the supplier, supported media ids, supported mime types, supported file extensions, and supported header data matches.

Notes for Format Plugin developers:

The opaque data section of the ECom plugin resource file must be in the format:

opaque_data = "<?>Data 1<?>Data 2<?>Data 3<?>Data 4[...]<?>Data N";

The <?> preceding the data determines the meaning of the data.  The following are the possible tags:

	<s> - Supplier
	<i> - Media Id
	<m> - Mime Type
	<e> - File Extension
	<h> - Header Data
	<c> - Custom Interfaces

UIDs must always be in hex in the format '0x12345678', must include the '0x' and be 10 characters long

Since: 7.0s

Constructor & Destructor Documentation

CMMFFormatImplementationInformation ( )

CMMFFormatImplementationInformation

(

)

[protected]

Constructor

~CMMFFormatImplementationInformation ( )

(

const CImplementationInformation &

aImplInfo

)

[static]

Constructs a new format implementation information object.

Since: 7.0s

Parameters
aImplInfo	The ECOM implementation information

Return Value: The new object created.

NewLC ( const CImplementationInformation & )

CMMFFormatImplementationInformation *

NewLC

(

const CImplementationInformation &

aImplInfo

)

[static]

Constructs a new format implementation information object.

Since: 7.0s

Parameters
aImplInfo	The ECOM implementation information

Return Value: The new object created. Note that this will be on the cleanup stack.

ProcessTaggedDataL ( const TDesC8 &, const TDesC8 & )

void	ProcessTaggedDataL	(	const TDesC8 &	aTag,
			const TDesC8 &	aData
		)	[protected, virtual]

Reimplemented from MTaggedDataParserClient::ProcessTaggedDataL(const TDesC8 &,const TDesC8 &)

from MTaggedDataParserClient

SupportedFileExtensions ( )

IMPORT_C const CDesC8Array &

SupportedFileExtensions

(

)

const

Returns the array of supported file extensions.

Since: 7.0s

Return Value: The array of file extensions.

SupportedHeaderData ( )

IMPORT_C const CDesC8Array &

SupportedHeaderData

(

)

const

Returns the array of supported header data matches.

Since: 7.0s

Return Value: The array of header data.

SupportedMimeTypes ( )

IMPORT_C const CDesC8Array &

SupportedMimeTypes

(

)

const

Returns the array of supported mime types.

Since: 7.0s

Return Value: The array of mime types.

SupportsCustomInterfaces ( )

IMPORT_C TBool

SupportsCustomInterfaces

(

)

const

Tests whether this format provides support for Custom Interfaces.

Return Value: A boolean indicating if Custom Interfaces are supported. ETrue if this format provides the required support, EFalse if not.

SupportsFileExtension ( const TDesC8 & )

IMPORT_C TBool

SupportsFileExtension

(

const TDesC8 &

aFileExtension

)

const

Tests whether this format provides support for the specified file extension, aFileExtension.

Since: 7.0s

Parameters
aFileExtension	The requested file extension. Must be the extension only, and contain the dot '.'

Return Value: A boolean indicating if the specified file extension is supported. ETrue if this format provides the required support, EFalse if it does not.

SupportsHeaderDataL ( const TDesC8 & )

IMPORT_C TBool

SupportsHeaderDataL

(

const TDesC8 &

aHeaderData

)

const

Tests whether this format provides support for aHeaderData. aHeaderData is searched for each chunk supported by this format.

Since: 7.0s

Parameters
aHeaderData	The requested header data.

Return Value: A boolean indicating if aHeaderData is supported. ETrue if this format provides the required support, EFalse if not.

SupportsMimeType ( const TDesC8 & )

IMPORT_C TBool

SupportsMimeType

(

const TDesC8 &

aMimeType

)

const

Tests whether this format provides support for aMimeType.

Since: 7.0s

Parameters
aMimeType	The requested mime type.

Return Value: A boolean indicating if the format is supported. ETrue if this format provides the required support, EFalse if not.