Symbian^3 Application Developer Library >

CMPXPluginInfo Class Reference

class CMPXPluginInfo : public CBase

MPX plugin info.

mpxcommon.lib

Inherits from

Public Member Functions
~CMPXPluginInfo ()
TInt ComparePluginInfoByPriority (const CMPXPluginInfo &, const CMPXPluginInfo &)
const TDesC & DisplayName ()
IMPORT_C TUint Flags ()
IMPORT_C const TUid & ImplementationUid ()
CMPXPluginInfo * NewL (const CImplementationInformation &)
CMPXPluginInfo * NewLC (const CImplementationInformation &)
const TUid & PluginType ()
TInt Priority ()
TInt & ReferenceCount ()
TBool SupportUids (const TArray < TUid > &)
const TUid & SupportedAppUid ()
const CDesCArray & SupportedExtensions ()
const CDesCArray & SupportedMimeTypes ()
const CDesCArray & SupportedSchemas ()
const TArray < TUid > SupportedUids ()
TInt Version ()
Protected Member Functions
CMPXPluginInfo ()
IMPORT_C void ConstructL (const CImplementationInformation &)
IMPORT_C void ExtractIntoArrayL (const TDesC8 &, CDesCArray *&)
void ExtractSupportedUidsL (const TDesC8 &)
IMPORT_C void ExtractUidsFromTextL (const TDesC8 &, RArray < TUid > &)
IMPORT_C void ProcessTaggedDataExL (const TDesC8 &, const TDesC8 &)
IMPORT_C void ProcessTaggedDataL (const TDesC8 &, const TDesC8 &)
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()
Protected Attributes
TUint iFlags
HBufC * iPluginName
TUid iPluginTypeUid
TUid iPluginUid
TInt iPriority
TInt iReferenceCount
TUid iSupportedAppUid
CDesCArray * iSupportedExtensions
CDesCArray * iSupportedMimeTypes
CDesCArray * iSupportedSchemas
RArray < TUid > iSupportedUids
TInt iVersion

Constructor & Destructor Documentation

CMPXPluginInfo()

IMPORT_C CMPXPluginInfo ( ) [protected]

C++ default constructor.

Since
S60 3.2.3

~CMPXPluginInfo()

IMPORT_C ~CMPXPluginInfo ( ) [virtual]

Destructor.

Since
S60 3.2.3

Member Functions Documentation

ComparePluginInfoByPriority(const CMPXPluginInfo &, const CMPXPluginInfo &)

TInt ComparePluginInfoByPriority ( const CMPXPluginInfo & aPluginInfo1,
const CMPXPluginInfo & aPluginInfo2
) [static]

Compare two plugin info by prioritiy.

Since
S60 3.2.3

Parameters

const CMPXPluginInfo & aPluginInfo1 the first plugin info object
const CMPXPluginInfo & aPluginInfo2 the second plugin info object

ConstructL(const CImplementationInformation &)

IMPORT_C void ConstructL ( const CImplementationInformation & aData ) [protected]

By default Symbian 2nd phase constructor is private.

Since
S60 3.2.3
leave
The function leaves with one of the system wide error codes,

Parameters

const CImplementationInformation & aData Plugin's implementation information.

DisplayName()

const TDesC & DisplayName ( ) const

Returns plugin's display name.

Since
S60 3.2.3

ExtractIntoArrayL(const TDesC8 &, CDesCArray *&)

IMPORT_C void ExtractIntoArrayL ( const TDesC8 & aText,
CDesCArray *& aArray
) [protected]

Extracts elemements separated by semicolon into array descriptor

Parameters

const TDesC8 & aText original content to extract elements from
CDesCArray *& aArray the array to add the extracted elements to

ExtractSupportedUidsL(const TDesC8 &)

void ExtractSupportedUidsL ( const TDesC8 & aData ) [protected]

Extracts plugin supported Uids from data.

Since
S60 3.2.3

Parameters

const TDesC8 & aData Supported uids descriptor separated by comma.

ExtractUidsFromTextL(const TDesC8 &, RArray< TUid > &)

IMPORT_C void ExtractUidsFromTextL ( const TDesC8 & aData,
RArray < TUid > & aArray
) [protected]

Extracts a list of UIDs from a text string.

Since
S60 3.2.3
leave
The function leaves with one of the system wide error codes,

Parameters

const TDesC8 & aData Supported uids descriptor separated by comma.
RArray < TUid > & aArray array to insert the data into

Flags()

IMPORT_C TUint Flags ( ) const

Returns the flags bit array.

Since
S60 3.2.3

ImplementationUid()

IMPORT_C const TUid & ImplementationUid ( ) const

Returns plugin's implementation uid.

Since
S60 3.2.3

NewL(const CImplementationInformation &)

CMPXPluginInfo * NewL ( const CImplementationInformation & aData ) [static]

Two-phased constructor.

Since
S60 3.2.3

Parameters

const CImplementationInformation & aData Plugin's implementation information.

NewLC(const CImplementationInformation &)

CMPXPluginInfo * NewLC ( const CImplementationInformation & aData ) [static]

Two-phased constructor.

Since
S60 3.2.3

Parameters

const CImplementationInformation & aData Plugin's implementation information.

PluginType()

const TUid & PluginType ( ) const

Returns plugin's plugin type.

Since
S60 3.2.3

Priority()

TInt Priority ( ) const

Returns plugin's priority.

Since
S60 3.2.3

ProcessTaggedDataExL(const TDesC8 &, const TDesC8 &)

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

Process a extended tagged data which derived class may support. Default implementation in this class just ignore the data.

Since
S60 3.2.3

Parameters

const TDesC8 & aTag xml-styled tag
const TDesC8 & aData data in the xml-styled tag

ProcessTaggedDataL(const TDesC8 &, const TDesC8 &)

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

Process a tagged data.

Since
S60 3.2.3

Parameters

const TDesC8 & aTag xml-styled tag
const TDesC8 & aData data in the xml-styled tag

ReferenceCount()

TInt & ReferenceCount ( )

Returns a reference to the reference count.

Since
S60 3.2.3

SupportUids(const TArray< TUid > &)

TBool SupportUids ( const TArray < TUid > & aUids ) const

Check if the plugin supports the array of uids.

Since
S60 3.2.3

Parameters

const TArray < TUid > & aUids contains plugin uids

SupportedAppUid()

const TUid & SupportedAppUid ( ) const

Returns plugin's supported App Uid.

SupportedExtensions()

const CDesCArray & SupportedExtensions ( ) const

Returns supported extensions.

Since
S60 3.2.3

SupportedMimeTypes()

const CDesCArray & SupportedMimeTypes ( ) const

Returns supported mime types.

Since
S60 3.2.3

SupportedSchemas()

const CDesCArray & SupportedSchemas ( ) const

Returns supported schemas.

Since
3.0

SupportedUids()

const TArray < TUid > SupportedUids ( ) const

Returns plugin's supported uids.

Since
S60 3.2.3

Version()

TInt Version ( ) const

Returns the plugin version.

Since
S60 3.2.3

Member Data Documentation

TUint iFlags

TUint iFlags [protected]

Plugin feature flags.

HBufC * iPluginName

HBufC * iPluginName [protected]

Plugin's display name. Own.

TUid iPluginTypeUid

TUid iPluginTypeUid [protected]

Plugin's plugin type Uid.

TUid iPluginUid

TUid iPluginUid [protected]

Plugin's implementation Uid.

TInt iPriority

TInt iPriority [protected]

Plugin priority.

TInt iReferenceCount

TInt iReferenceCount [protected]

Loaded plugin reference count.

TUid iSupportedAppUid

TUid iSupportedAppUid [protected]

Plugin's supported App Uid.

CDesCArray * iSupportedExtensions

CDesCArray * iSupportedExtensions [protected]

CDesCArray * iSupportedMimeTypes

CDesCArray * iSupportedMimeTypes [protected]

CDesCArray * iSupportedSchemas

CDesCArray * iSupportedSchemas [protected]

RArray< TUid > iSupportedUids

RArray < TUid > iSupportedUids [protected]

List of supported Uids. Sorted by TUid.iUid

TInt iVersion

TInt iVersion [protected]

The version number of this plugin.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.