Class CQikApplication

class CQikApplication : public CEikApplication;

Description

The root of all UIQ applications. CQikApplication builds on CEikApplication and CApaApplication , providing a basis for applications working within the framework provided by Qikon and Uikon.

The class provides a factory for application documents, and an interface to the application's resource file.

Note that:

• In 6.1, this class simply calls the base class functions provided by CEikApplication .

• Application writers must provide at least an implementation of the form of CreateDocumentL() that has no parameters.

• The application’s resource file can be changed from the default by overriding ResourceFileName() .

Derivation

• CBase - Base class for all classes to be instantiated on the heap
• CApaApplication - Defines the basic behaviour for applications
• CEikApplication - The base of all Uikon applications
• CQikApplication - The root of all UIQ applications

Members

Defined in CQikApplication:
AppFullName(), BitmapStoreName(), CQikApplication(), Capability(), CreateDocumentL(), GetDefaultDocumentFileName(), NewAppServerL(), OpenIniFileLC(), PreDocConstructL(), ResourceFileName(), ~CQikApplication()

Inherited from CApaApplication:
AppDllUid(), CApaApplication_Reserved1(), CApaApplication_Reserved2(), DllName(), GenerateFileName(), OpenIniFileL()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CEikApplication:
AppCaption(), EnsureCaptionIsLocalisedL(), Process(), ResourceFileOffset(), SetToIniFileNameL(), iCoeEnv, iResourceFileOffset

See also:

• CQikDocument
• CQikAppUi

IMPORT_C ~CQikApplication();

Description

Destructor.

Deletes any resources acquired by this CQikApplication during its construction phases.

protected: IMPORT_C CQikApplication();

Description

Constructor.

virtual IMPORT_C void GetDefaultDocumentFileName(TFileName &aDocumentName) const;

Description

Gets the default document name for this application.

Parameters

TFileName &aDocumentName On return, contains the default document file name.

See also:

• CEikApplication::GetDefaultDocumentFileName()

virtual IMPORT_C TFileName BitmapStoreName() const;

Description

Gets the name of the bitmap file used by this application.

By default, this file has an extension of .mbm and uses the same name as the application file in the same directory. Language variants are supported using BaflUtils::NearestLanguageFile().

Return value

TFileName The name of the bitmap store for this application.

See also:

• CEikApplication::BitmapStoreName()

virtual IMPORT_C TFileName ResourceFileName() const;

Description

Gets the name of the resource file used by this application.

By default, this file has an extension of .rsc and uses the same name as the application file located in the same directory. Language variants are supported using BaflUtils::NearestLanguageFile().

Return value

TFileName The name of the resource file.

See also:

• CEikApplication::ResourceFileName()

virtual IMPORT_C CDictionaryStore *OpenIniFileLC(RFs &aFs) const;

Description

Opens the application's ini file if it exists.

If an ini file does not exist for this application, or if it is corrupt, this function creates a new ini file and opens that. ini files are located on KIniFileDrive (by default, c:), in the same directory as the application DLL.

Parameters

RFs &aFs File server session to use.

Return value

CDictionaryStore * Pointer to the dictionary store for the opened file.

See also:

• CEikApplication::OpenIniFileLC()

virtual IMPORT_C void Capability(TDes8 &aInfo) const;

Description

Gets the application's capabilities.

The capabilities relate to the embeddability, hidden, and newfile settings in the application's registration files.

Application developers do not need to override this function.

Parameters

TDes8 &aInfo A packaged modifiable buffer descriptor (a TPckgBuf ), encapsulating a TApaAppCapability object.

See also:

• TApaAppCapability
• TPckgBuf

virtual IMPORT_C TFileName AppFullName() const;

Description

Returns the full name and path for the application.

Return value

TFileName Full path for the application.

protected: virtual IMPORT_C void PreDocConstructL();

Description

Prepares for document creation.

This is called by the application framework to complete construction and initialise the new application object. After this function has been called, the CQikApplication can create document objects. If there is a default resource file for this application, then it is added to the control environment.

This function's leaving should be treated as if construction had failed, and the object should be destroyed by the caller.

See also:

• CEikApplication::PreDocConstructL()

protected: virtual IMPORT_C CApaDocument *CreateDocumentL(CApaProcess *aProcess);

Description

Creates a new document.

This is called by the application framework to create a new instance of the document associated with this application. The implementation stores the aProcess argument, and returns a document created by the un-parameterised, private, form of CQikApplication::CreateDocumentL() .

Parameters

CApaProcess *aProcess

Return value

CApaDocument *

virtual IMPORT_C void NewAppServerL(CApaAppServer *&aAppServer);

Description

Called by the framework when the application has been launched as a server application. Applications that wish to be used as server applications must override this function to return their implemetation of the server.

Parameters

CApaAppServer *&aAppServer The server pointer to be set.

See also:

• CApaApplication::NewAppServerL()