Symbian^3 Application Developer Library >

CApaRegistrationResourceFileWriter Class Reference

class CApaRegistrationResourceFileWriter : public CApaResourceFileWriterBase

Used to support the registration of non-native applications.

The task of this class is to generate the resource files expected by the Apparc server. Applications that register other applications can use functions of this class to customise the generated resource files.

Inherits from

Nested Classes and Structures

Public Member Functions
~CApaRegistrationResourceFileWriter ()
IMPORT_C void AddDataTypeL ( TInt , const TDesC8 &)
IMPORT_C void AddFileOwnershipInfoL (const TDesC &)
TUid AppUid ()
void GenerateFileContentsL ( RBuf8 &)
IMPORT_C CApaRegistrationResourceFileWriter * NewL ( TUid , const TDesC &, TUint )
IMPORT_C void SetAppIsHiddenL ( TBool )
IMPORT_C void SetDefaultScreenNumberL ( TInt )
IMPORT_C void SetEmbeddabilityL ( TApaAppCapability::TEmbeddability )
IMPORT_C void SetGroupNameL (const TDesC &)
IMPORT_C void SetLaunchInBackgroundL ( TBool )
void SetLocalisableResourceFileL (const TDesC &)
IMPORT_C void SetOpaqueDataL (const TDesC8 &)
IMPORT_C void SetSupportsNewFileL ( TBool )
Private Member Functions
CApaRegistrationResourceFileWriter ( TUid , TUint )
void ConstructL (const TDesC &)
void MainResourceInCompiledFormatL ( MDataSink &)
const TDesC8 * SecondResourceL ( TBool &)
void WriteDataTypeL ( MDataSink &, const SDataType &)
void WriteFileOwnershipInfoL ( MDataSink &, const SFileOwnershipInfo &)
Inherited Functions
CApaResourceFileWriterBase::CApaResourceFileWriterBase()
CApaResourceFileWriterBase::DoGenerateFileContentsL(RBuf8 &,TUid,TUid)const
CApaResourceFileWriterBase::WriteBufferL(MDataSink &,const TDesC8 &)const
CApaResourceFileWriterBase::WriteLittleEndianUint16L(MDataSink &,TUint)const
CApaResourceFileWriterBase::WriteLittleEndianUint32L(MDataSink &,TUint)const
CApaResourceFileWriterBase::WriteText8L(MDataSink &,const TDesC8 &)const
CApaResourceFileWriterBase::WriteTextL(MDataSink &,const TDesC &)const
CApaResourceFileWriterBase::WriteUidTypeL(MDataSink &,TUid,TUid)const
CApaResourceFileWriterBase::WriteUint8L(MDataSink &,TUint)const
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()
Private Attributes
HBufC * iAppFile
TBool iAppIsHidden
TUid iAppUid
TUint iAttributes
RArray < SDataType > iDataTypeList
TInt iDefaultScreenNumber
TApaAppCapability::TEmbeddability iEmbeddability
RArray < SFileOwnershipInfo > iFileOwnershipList
HBufC * iGroupName
TBool iLaunchInBackground
HBufC * iLocalisableResourceFile
HBufC8 * iOpaqueData
TBool iSupportsNewFile

Constructor & Destructor Documentation

CApaRegistrationResourceFileWriter(TUid, TUint)

CApaRegistrationResourceFileWriter ( TUid aAppUid,
TUint aAttributes
) [private]

Parameters

TUid aAppUid
TUint aAttributes

~CApaRegistrationResourceFileWriter()

IMPORT_C ~CApaRegistrationResourceFileWriter ( ) [virtual]

The destructor for the CApaRegistrationResourceFileWriter class.

Member Functions Documentation

AddDataTypeL(TInt, const TDesC8 &)

IMPORT_C void AddDataTypeL ( TInt aPriority,
const TDesC8 & aType
)

Adds a datatype to the list of datatypes that the application can handle.

Parameters

TInt aPriority The priority.
const TDesC8 & aType The datatype.

AddFileOwnershipInfoL(const TDesC &)

IMPORT_C void AddFileOwnershipInfoL ( const TDesC & aFileName )

Adds a file to the list of files owned by the CApaRegistrationResourceFileWriter instances. These files are deleted if an error occurs whil registering the new applications.

Parameters

const TDesC & aFileName The name of the file.

AppUid()

TUid AppUid ( ) const

ConstructL(const TDesC &)

void ConstructL ( const TDesC & aAppFile ) [private]

Parameters

const TDesC & aAppFile

GenerateFileContentsL(RBuf8 &)

void GenerateFileContentsL ( RBuf8 & aBuffer ) const

Parameters

RBuf8 & aBuffer

MainResourceInCompiledFormatL(MDataSink &)

void MainResourceInCompiledFormatL ( MDataSink & aDataSink ) const [private, virtual]

Parameters

MDataSink & aDataSink

NewL(TUid, const TDesC &, TUint)

IMPORT_C CApaRegistrationResourceFileWriter * NewL ( TUid aAppUid,
const TDesC & aAppFile,
TUint aAttributes
) [static]

Creates a new CApaRegistrationResourceFileWriter instance.

Parameters

TUid aAppUid The UID of the application.
const TDesC & aAppFile The name and extension of the file to generate.
TUint aAttributes The attributes of the application. See the TApaAppCapability class for more details.

SecondResourceL(TBool &)

const TDesC8 * SecondResourceL ( TBool & aSecondResourceInCompressedUnicodeFormat ) const [private, virtual]

Parameters

TBool & aSecondResourceInCompressedUnicodeFormat

SetAppIsHiddenL(TBool)

IMPORT_C void SetAppIsHiddenL ( TBool aAppIsHidden )

Sets or clears the hidden attribute. The usual purpose of the hidden attribute is to decide if the application should appear in the task list or not but this could vary between products.

Parameters

TBool aAppIsHidden The value of the hidden flag.

SetDefaultScreenNumberL(TInt)

IMPORT_C void SetDefaultScreenNumberL ( TInt aDefaultScreenNumber )

Sets the default screen number. This can be used to specify the preferred screen on devices that support more than one screen.

Parameters

TInt aDefaultScreenNumber The name of the default screen.

SetEmbeddabilityL(TApaAppCapability::TEmbeddability)

IMPORT_C void SetEmbeddabilityL ( TApaAppCapability::TEmbeddability aEmbeddability )

Sets the embeddability attribute. See the TApaAppCapability::TEmbeddability class for more details.

Parameters

TApaAppCapability::TEmbeddability aEmbeddability The value of the embeddability flags.

SetGroupNameL(const TDesC &)

IMPORT_C void SetGroupNameL ( const TDesC & aGroupName )

Sets the name of the application group.

Parameters

const TDesC & aGroupName The name of the application group.

SetLaunchInBackgroundL(TBool)

IMPORT_C void SetLaunchInBackgroundL ( TBool aLaunchInBackground )

Specifies if the application must be launched in the background.

Parameters

TBool aLaunchInBackground ETrue if the application must be launched in the background, EFalse otherwise.

SetLocalisableResourceFileL(const TDesC &)

void SetLocalisableResourceFileL ( const TDesC & aLocalisableResourceFile )

Parameters

const TDesC & aLocalisableResourceFile

SetOpaqueDataL(const TDesC8 &)

IMPORT_C void SetOpaqueDataL ( const TDesC8 & aOpaqueData )

Sets the opaque data. The opaque data is some data that is specific to the type of application.

Parameters

const TDesC8 & aOpaqueData

SetSupportsNewFileL(TBool)

IMPORT_C void SetSupportsNewFileL ( TBool aSupportsNewFile )

Specifies if the application supports the creation of a new file or not.

Parameters

TBool aSupportsNewFile ETrue to specify that the application supports the creation of a new file.

WriteDataTypeL(MDataSink &, const SDataType &)

void WriteDataTypeL ( MDataSink & aDataSink,
const SDataType & aDataType
) const [private]

Parameters

MDataSink & aDataSink
const SDataType & aDataType

WriteFileOwnershipInfoL(MDataSink &, const SFileOwnershipInfo &)

void WriteFileOwnershipInfoL ( MDataSink & aDataSink,
const SFileOwnershipInfo & aFileOwnershipInfo
) const [private]

Parameters

MDataSink & aDataSink
const SFileOwnershipInfo & aFileOwnershipInfo

Member Data Documentation

HBufC * iAppFile

HBufC * iAppFile [private]

TBool iAppIsHidden

TBool iAppIsHidden [private]

TUid iAppUid

TUid iAppUid [private]

TUint iAttributes

TUint iAttributes [private]

RArray< SDataType > iDataTypeList

RArray < SDataType > iDataTypeList [private]

TInt iDefaultScreenNumber

TInt iDefaultScreenNumber [private]

TApaAppCapability::TEmbeddability iEmbeddability

TApaAppCapability::TEmbeddability iEmbeddability [private]

RArray< SFileOwnershipInfo > iFileOwnershipList

RArray < SFileOwnershipInfo > iFileOwnershipList [private]

HBufC * iGroupName

HBufC * iGroupName [private]

TBool iLaunchInBackground

TBool iLaunchInBackground [private]

HBufC * iLocalisableResourceFile

HBufC * iLocalisableResourceFile [private]

HBufC8 * iOpaqueData

HBufC8 * iOpaqueData [private]

TBool iSupportsNewFile

TBool iSupportsNewFile [private]

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.