Class CEikApplication

class CEikApplication : public CApaApplication;

Description

The base of all Uikon applications.

CEikApplication builds on CApaApplication, providing a basis for applications working within the framework provided by Uikon. It also contains an interface to the resource file and the document object belonging to the application.

Each Uikon application class is derived from CEikApplication. Application writers must provide at least an implementation of the pure virtual function CEikApplication::CreateDocumentL().

The application's resource file can be changed from the default by overriding CEikApplication::ResourceFileName()const.

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.

Members

Defined in CEikApplication:

• AppCaption()constGets the caption for this application.
• BitmapStoreName()constGets the localized name of the bitmap file used by this application.
• CEikApplication()Default constructor.
• CEikApplication_Reserved1()
• CEikApplication_Reserved2()
• Capability(TDes8 &)constGets the application's capabilities.
• CreateDocumentL()
• CreateDocumentL(CApaProcess *)Creates a new document.
• EnsureCaptionIsLocalisedL(const TDesC &)Calling this method will ensure that the application Caption has been localized....
• GetDefaultDocumentFileName(TFileName &)constGets the default document name for this application.
• NewAppServerL(CApaAppServer *&)Virtual function called by the framework when the application has been launched ...
• OpenIniFileLC(RFs &)constOpens the application's .ini file, if one exists.
• PreDocConstructL()Prepares for document creation.
• Process()constGets the managing process.
• ResourceFileName()constGets the localized name of the resource file used by this application.
• ResourceFileOffset()constGets the offset value defined for this application's default resource file.
• SetToIniFileNameL(TParse &)constSets a supplied file name parser to contain the path of this application's .ini ...
• iCoeEnv
• iResourceFileOffset
• ~CEikApplication()Destructor.

Inherited from CApaApplication:

• AppDllUid()constGets the application specific UID.
• AppFullName()constReturns the full name and path of the application.
• CApaApplication_Reserved1()Reserved for future use
• CApaApplication_Reserved2()Reserved for future use
• DllName()constReturns the full name and path of the loaded application DLL.
• GenerateFileName(RFs &,TFileName &)Generates a unique filename based on the file name contained within the specifie...
• OpenIniFileL(RFs &)constOpens the .ini file associated with the application, constructs the dictionary s...

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...

See also:

• CEikDocumentThe base class for all GUI applications' documents.

Related Topics

 » Symbian OS v9.4 » Examples » Application Framework example code » AnimExample: An UI application with a toolbar

• Animation example » Class summary

 » Symbian OS v9.4 » Examples » Application Framework example code » ControlFramework: An UI application with a toolbar

• ControlFramework: A UI application with a toolbar

 » Symbian OS v9.4 » Examples » Application Framework example code » EmbApp: An embedded application

• EmbApp: An embedded application » Class summary

 » Symbian OS v9.4 » Examples » Application Framework example code » Minimal: A minimal UI application

• Minimal: A minimal UI application » Class Summary

IMPORT_C ~CEikApplication();

Description

Destructor.

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

protected: IMPORT_C CEikApplication();

Description

Default constructor.

The default constructor is empty, and there are no NewL() or NewLC() functions as Uikon applications are created automatically by the application DLL framework when applications are started.

inline TInt ResourceFileOffset() const;

Description

Gets the offset value defined for this application's default resource file.

As the resource file offset can also be accessed through iResourceFileOffset, this function should not be needed by any apps.

Return value

TInt Offset of a resource file.

inline CApaProcess* Process() const;

Description

Gets the managing process.

Return value

CApaProcess * A pointer to the process object managing this application's documents.

inline const TApaAppCaption& AppCaption() const;

Description

Gets the caption for this application.

Captions are displayed in the task list.

Return value

const TBuf & Application caption.

IMPORT_C virtual void GetDefaultDocumentFileName(TFileName &aDocumentName) const;

Description

Gets the default document name for this application.

Parameters

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

IMPORT_C virtual TFileName BitmapStoreName() const;

Description

Gets the localized 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(const RFs &,TFileName &).

Return value

TBuf The name of the bitmap store for this application.

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

Description

Opens the application's .ini file, if one exists.

If a .ini file does not exist for this application, or if it is corrupt, this function creates one and opens that. .ini files are located on system drive, in the same directory as the application EXE.

Parameters

RFs &aFs File server session to use.

Return value

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

IMPORT_C virtual void Capability(TDes8 &aInfo) const;

Description

Gets the application's capabilities.

Application developers should not need to override this function.

Parameters

TDes8 &aInfo

IMPORT_C void SetToIniFileNameL(TParse &aParser) const;

Description

Sets a supplied file name parser to contain the path of this application's .ini file.

Parameters

TParse &aParser A file name parser. On return, this contains the path of the application's ini file.

protected: IMPORT_C virtual void PreDocConstructL();

Description

Prepares for document creation.

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

If this function leaves, this should be treated as if construction had failed, and the object should be destroyed by the caller.

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

Description

Creates a new document.

This function is called by the application DLL framework during application startup to create a new instance of the document associated with this application. This implementation of the function makes a record of the CApaProcess argument, and returns a document created by the un-parameterised, private, overload.

Parameters

CApaProcess *aProcess

Return value

CApaDocument *

protected: IMPORT_C virtual void NewAppServerL(CApaAppServer *&aAppServer);

Description

Virtual function 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 implementation of the server.

Base class implementation of this function leaves with KErrNotSupported, to prevent non-server applications from being launched as server applications.

Parameters

CApaAppServer *&aAppServer The server pointer to be set.

protected: IMPORT_C void EnsureCaptionIsLocalisedL(const TDesC &aLocalisableResourceFile);

Description

Calling this method will ensure that the application Caption has been localized. This is called at the start of applications override of CEikApplication's CreateDocumentL, when application needs to started in Critical phase of Start-Up.

Parameters

const TDesC16 &aLocalisableResourceFile Location of the localized resource file

IMPORT_C virtual TFileName ResourceFileName() const;

Description

Gets the localized 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 through BaflUtils::NearestLanguageFile(const RFs &,TFileName &).

Return value

TBuf The name of the resource file. Used by CEikApplication::PreDocConstructL().

private: IMPORT_C virtual void CEikApplication_Reserved1();

Description

private: IMPORT_C virtual void CEikApplication_Reserved2();

Description

private: virtual CApaDocument* CreateDocumentL()=0;

Description

Return value

CApaDocument *

protected: CCoeEnv * iCoeEnv;

Description

protected: TInt iResourceFileOffset;

Description