Class CMMFFormatSelectionParameters

class CMMFFormatSelectionParameters : public CBase;

Description

Defines the format support required.

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CMMFFormatSelectionParameters - Defines the format support required.

Members

Defined in CMMFFormatSelectionParameters:

• EMatchAnyAll plugins will be selected. This is the default option.
• EMatchFileExtensionThe match will be based on a file extension.
• EMatchHeaderDataThe match will be based on a header data.
• EMatchMimeTypeThe match will be based on a mime type.
• MatchData()constReturns the data used to perform the plugin match.
• MatchDataType()constReturns the type of the data used to perform the plugin match.
• NewL()Allocates and constructs a new format selection parameter object with blank para...
• NewLC()Allocates and constructs a new format selection parameter object with blank para...
• SetMatchToFileNameL(const TDesC &)Sets this object to match to a file extension.
• SetMatchToHeaderDataL(const TDesC8 &)Sets this object to match to a pattern in header data.
• SetMatchToMimeTypeL(const TDesC8 &)Sets this object to match to a MIME type.
• SetMatchToUriL(const TDesC &)Sets this object to match to a file extension specified by a URI
• TMatchDataTypeDescribes the type of match to be performed. The match types are mutually exclus...
• ~CMMFFormatSelectionParameters()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CMMFFormatSelectionParameters* NewL();

Description

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

Calls CMMFFormatSelectionParameters::NewLC().

Return value

CMMFFormatSelectionParameters * A new format selection parameter object.

IMPORT_C static CMMFFormatSelectionParameters* NewLC();

Description

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

Return value

CMMFFormatSelectionParameters * A new format selection parameter object.

virtual ~CMMFFormatSelectionParameters();

Description

Destructor.

IMPORT_C void SetMatchToFileNameL(const TDesC &aFileName);

Description

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.

Parameters

const TDesC16 &aFileName The file name to be matched. Must include the extension.

IMPORT_C void SetMatchToUriL(const TDesC &aUri);

Description

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

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

Parameters

const TDesC16 &aUri The URI containing the file name to be matched. Must include the extension.

IMPORT_C void SetMatchToMimeTypeL(const TDesC8 &aMimeType);

Description

Sets this object to match to a MIME type.

Parameters

const TDesC8 &aMimeType The mime type to match.

IMPORT_C void SetMatchToHeaderDataL(const TDesC8 &aHeaderData);

Description

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

Parameters

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

IMPORT_C const TDesC8& MatchData() const;

Description

Returns the data used to perform the plugin match.

Return value

const TDesC8 & The match data.

IMPORT_C TMatchDataType MatchDataType() const;

Description

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

Return value

CMMFFormatSelectionParameters::TMatchDataType The match data type.

TMatchDataType

Description

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

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.