Collapse all Symbian^3 Application Developer Library

TEComResolverParams Class Reference

class TEComResolverParams

Used to pass values to a Resolver to aid in the filtering of Interface Implementation plugins. These values are considered match characteristics used during resolution of these Interface Implementation. It is a class used in the ECOM API provided by the REComSession class. This class DOES NOT own the descriptor data iDataType points to and so it will not release the data on descruction. This is the responsibility of the user of this class.

REComSession

Public Member Functions
	TEComResolverParams ()
const TDesC8 &	DataType ()
TBool	IsGenericMatch ()
TBool	IsWildcardMatch ()
void	SetDataType (const TDesC8 &)
void	SetGenericMatch ( TBool )
void	SetWildcardMatch ( TBool )

Private Attributes
TPtrC8	iDataType
TBool	iGenericMatch

Constructor & Destructor Documentation

TEComResolverParams()

TEComResolverParams

(

)

[inline]

Member Functions Documentation

DataType()

const TDesC8 &

DataType

(

)

const [inline]

Provides read access to the Interface Implementation plugin 'datatype' match pattern. Note, since TEComResolveParams has a default constructor this data member may be an invalid descriptor which implies 'default matching'.

Pre-condition: The object is constructed

IsGenericMatch()

TBool

IsGenericMatch

(

)

const [inline]

Check if 'generic' matching is allowed.

Pre-condition: The object is constructed

IsWildcardMatch()

TBool

IsWildcardMatch

(

)

const [inline]

IsGenericMatch

SetDataType(const TDesC8 &)

void

SetDataType

(

const TDesC8 &

aDataType

)

[inline]

Set the Interface Implementation plugin 'datatype' match pattern.

Pre-condition: The object is constructed

Post-condition: iDataType equals aDataType.

Parameters

const TDesC8 & aDataType

The 'datatype' match pattern to be stored.

SetGenericMatch(TBool)

void

SetGenericMatch

(

TBool

aGenericMatch

)

[inline]

Indicates that a 'generic' match is required.

Either allow Interface Implementation plugins that are specific (use no wildcards in their registry file) or generic (use wildcards in their registry file).

In any case the user of a should NOT use wildcards in the datatype string that is passed into this object.

Rationale: The client that sets up the resolver is expected to know what type of data it is handling.

Use Case: "I have this gif to convert, but I'd prefer only gif-specific plugins" or "I have this gif to convert, but I'm happy with some generic image conversion plugin".

NOT: "I have this image I want some plugin to convert, but I don't know the type of the image".

Pre-condition: The object is constructed

Post-condition: iGenericMatch equals aGenericMatch.

Parameters

TBool aGenericMatch

ETrue if a generic match is required, EFalse if not.

SetWildcardMatch(TBool)

void

SetWildcardMatch

(

TBool

aWildcardMatch

)

[inline]

SetGenericMatch

Parameters

TBool aWildcardMatch

Member Data Documentation

TPtrC8 iDataType

TPtrC8

iDataType

[private]

The Interface Implementation plugin 'datatype' match descriptor.

TBool iGenericMatch

TBool

iGenericMatch

[private]

The flag to show if generic matching is enabled