CMMFFormatSelectionParameters Class Reference

#include <mmf/common/mmfcontrollerpluginresolver.h>

Link against: mmfcontrollerframework.lib

class CMMFFormatSelectionParameters : public CBase, public CBase

Inherits from

CMMFFormatSelectionParameters
- CBase
- CBase

Public Member Enumerations
enum	TMatchDataType { EMatchAny, EMatchFileExtension, EMatchMimeType, EMatchHeaderData, EMatchUri }

Public Member Functions
virtual	~CMMFFormatSelectionParameters()
IMPORT_C const TDesC8 &	MatchData()
IMPORT_C TMatchDataType	MatchDataType()
IMPORT_C const TDesC8 &	MatchUriScheme()
IMPORT_C CMMFFormatSelectionParameters *	NewL()
CMMFFormatSelectionParameters *	NewL(const CMMFFormatSelectionParameters &)
IMPORT_C CMMFFormatSelectionParameters *	NewLC()
IMPORT_C void	SetMatchToFileNameL(const TDesC &)
IMPORT_C void	SetMatchToHeaderDataL(const TDesC8 &)
IMPORT_C void	SetMatchToMimeTypeL(const TDesC8 &)
IMPORT_C void	SetMatchToUriL(const TDesC &)
IMPORT_C void	SetMatchToUriSupportL(const TDesC &)

Protected Member Functions
	CMMFFormatSelectionParameters()
void	ConstructL(const CMMFFormatSelectionParameters &)

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()

Detailed Description

Defines the format support required.

On construction, the selection parameters are blank, causing all plugins to be returned.

Since: 7.0s

Member Enumeration Documentation

Enum TMatchDataType

Describes the type of match to be performed. The match types are mutually exclusive.

Enumerator	Value	Description
EMatchAny		All plugins will be selected. This is the default option.
EMatchFileExtension		The match will be based on a file extension.
EMatchMimeType		The match will be based on a mime type.
EMatchHeaderData		The match will be based on a header data.
EMatchUri		The match will be based on Uri details.

Constructor & Destructor Documentation

CMMFFormatSelectionParameters ( )

CMMFFormatSelectionParameters

(

)

[protected]

Protected constructor.

~CMMFFormatSelectionParameters ( )

~CMMFFormatSelectionParameters

(

)

[virtual]

Destructor.

Member Function Documentation

ConstructL ( const CMMFFormatSelectionParameters & )

void

ConstructL

(

const CMMFFormatSelectionParameters &

aParams

)

[protected]

MatchData ( )

IMPORT_C const TDesC8 &

MatchData

(

)

const

Returns the data used to perform the plugin match.

Since: 7.0s

Return Value: The match data.

MatchDataType ( )

IMPORT_C TMatchDataType

MatchDataType

(

)

const

Returns the type of the data used to perform the plugin match.

Since: 7.0s

Return Value: The match data type.

MatchUriScheme ( )

IMPORT_C const TDesC8 &

MatchUriScheme

(

)

const

Returns the uri scheme used to perform the plugin match.

Return Value: The uri scheme.The uri scheme.

NewL ( )

IMPORT_C CMMFFormatSelectionParameters *

NewL

(

)

[static]

Allocates and constructs a new format selection parameter object with blank parameters.

Calls NewLC().

Return Value: A new format selection parameter object.

NewL ( const CMMFFormatSelectionParameters & )

CMMFFormatSelectionParameters *

NewL

(

const CMMFFormatSelectionParameters &

aParams

)

[static]

Allocates and constructs a new format selection parameter object with the specified parameters.

Parameters
aParams	The required parameters.

Return Value: A new format selection parameter object.

NewLC ( )

IMPORT_C CMMFFormatSelectionParameters *

NewLC

(

)

[static]

Allocates and constructs a new format selection parameter object with blank parameters, placing it on the cleanup stack.

Return Value: A new format selection parameter object.

SetMatchToFileNameL ( const TDesC & )

IMPORT_C void

SetMatchToFileNameL

(

const TDesC &

aFileName

)

Sets this object to match to a file extension.

aFileName can be a full filename or just an extension. If there is no dot in the filename and it is 5 characters or less in length then it is assumed to be an extension. If the first character of the filename is a dot, it assumed to be an extension. Otherwise, the filename is parsed using TParse to reveal the extension.

Once the extension has been extracted, it is converted from unicode to utf8 and copied into iMatchData.

Since: 7.0s

Parameters
aFileName	The file name to be matched. Must include the extension.

SetMatchToHeaderDataL ( const TDesC8 & )

IMPORT_C void

SetMatchToHeaderDataL

(

const TDesC8 &

aHeaderData

)

Sets this object to match to a pattern in header data.

Since: 7.0s

Parameters
aHeaderData	The header of the file in question. This header data will be matched against the match patterns provided by the plugins.

SetMatchToMimeTypeL ( const TDesC8 & )

IMPORT_C void

SetMatchToMimeTypeL

(

const TDesC8 &

aMimeType

)

Sets this object to match to a MIME type.

Since: 7.0s

Parameters
aMimeType	The mime type to match.

SetMatchToUriL ( const TDesC & )

IMPORT_C void

SetMatchToUriL

(

const TDesC &

aUri

)

Sets this object to match to a file extension specified by a URI

Once the extension has been extracted, it is copied into iMatchData.

Since: 7.0s

Parameters
aUri	The URI containing the file name to be matched. Must include the extension.

SetMatchToUriSupportL ( const TDesC & )

IMPORT_C void

SetMatchToUriSupportL

(

const TDesC &

aUri

)

Sets this object to match to uri scheme and file extension specified by a URI.

The Uri scheme and extension are saved in iMatchReqData. Further,iMatchData contains uri extension, iMatchUriScheme contains uri scheme.

Sets this object to match to uri scheme and file extension specified by a URI.

The Uri scheme and extension are saved in iMatchReqData. Further,iMatchData contains uri extension,

iMatchUriScheme contains uri scheme.

Parameters
aUri	The URI containing the scheme and uri extension to be matched.