| class CEikApplication : public CApaApplication |
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 CreateDocumentL().
The application's resource file can be changed from the default by overriding ResourceFileName().
| Public Member Functions | |
|---|---|
| ~CEikApplication() | |
| const TApaAppCaption & | AppCaption() |
| IMPORT_C TFileName | BitmapStoreName() |
| IMPORT_C void | Capability(TDes8 &) |
| IMPORT_C void | GetDefaultDocumentFileName(TFileName &) |
| IMPORT_C CDictionaryStore * | OpenIniFileLC(RFs &) |
| CApaProcess * | Process() |
| IMPORT_C TFileName | ResourceFileName() |
| TInt | ResourceFileOffset() |
| IMPORT_C void | SetToIniFileNameL(TParse &) |
| Protected Member Functions | |
|---|---|
| CEikApplication() | |
| IMPORT_C CApaDocument * | CreateDocumentL(CApaProcess *) |
| IMPORT_C void | EnsureCaptionIsLocalisedL(const TDesC &) |
| IMPORT_C void | NewAppServerL(CApaAppServer *&) |
| IMPORT_C void | PreDocConstructL() |
| Private Member Functions | |
|---|---|
| IMPORT_C void | CEikApplication_Reserved1() |
| IMPORT_C void | CEikApplication_Reserved2() |
| CApaDocument * | CreateDocumentL() |
| void | InitAppNameParserWithPathAndExt(TParse &, const TDesC &, const TDesC &) |
| Private Member Enumerations | |
|---|---|
| enum | anonymous { EFlagCaptionCorrectlyLocalised = 0x00000001 } |
| Protected Attributes | |
|---|---|
| CCoeEnv * | iCoeEnv |
| TInt | iResourceFileOffset |
| Private Attributes | |
|---|---|
| TUint | iAppFlags |
| TApaAppCapabilityBuf * | iCapabilityBuf |
| TApaAppCaption | iCaption |
| CApaProcess * | iProcess |
| TInt | iSpare |
| const TApaAppCaption & | AppCaption | ( | ) | const [inline] |
Gets the caption for this application.
Captions are displayed in the task list.
Application caption.
| IMPORT_C void | Capability | ( | TDes8 & | aInfo | ) | const [virtual] |
Returns the capabilities of the application.
Application capability information is represented by an instance of a TApaAppCapability object wrapped in a packaged modifiable buffer descriptor.
The function is called from a number of places within the application framework.
An implementation of this function is supplied by the UI framework.
| TDes8 & aInfo | A packaged modifiable buffer descriptor (a TPckgBuf), encapsulating a TApaAppCapability object. |
| IMPORT_C CApaDocument * | CreateDocumentL | ( | CApaProcess * | aProcess | ) | [protected, virtual] |
Creates a document object.
The function is called by the application process when a new document is required. The application process adds the new document to its list of documents.
An implementation of this function is supplied by the UI framework.
A pointer to the newly created document.
| CApaProcess * aProcess | A pointer to the process associated with the application. |
| IMPORT_C void | EnsureCaptionIsLocalisedL | ( | const TDesC & | aLocalisableResourceFile | ) | [protected] |
| const TDesC & aLocalisableResourceFile |
| IMPORT_C void | GetDefaultDocumentFileName | ( | TFileName & | aDocumentName | ) | const [virtual] |
| TFileName & aDocumentName |
| void | InitAppNameParserWithPathAndExt | ( | TParse & | aParser, |
| const TDesC & | aPath, | |||
| const TDesC & | aExt | |||
| ) | const [private] | |||
| IMPORT_C void | NewAppServerL | ( | CApaAppServer *& | aAppServer | ) | [protected, virtual] |
| CApaAppServer *& aAppServer |
| IMPORT_C CDictionaryStore * | OpenIniFileLC | ( | RFs & | aFs | ) | const [virtual] |
Opens the .ini file associated with the application, constructs the dictionary store object, returns a pointer to it and puts the pointer onto the cleanupstack.
The .ini file must be created, if it does not already exist.
An implementation of this function is supplied by the UI framework.
A pointer to the dictionary store object that represents the application's .ini file.
| RFs & aFs | Handle to a file server session |
| IMPORT_C void | PreDocConstructL | ( | ) | [protected, virtual] |
Completes construction of this application object.
The function is called after an instance of a derived class has been successfully created using the ordinal 1 function of the application DLL.
After calling this function, an application can create document objects.
An implementation of this function is supplied by the UI framework.
| CApaProcess * | Process | ( | ) | const [inline] |
Gets the managing process.
A pointer to the process object managing this application's documents.
| TInt | ResourceFileOffset | ( | ) | const [inline] |
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.
Offset of a resource file.
| IMPORT_C void | SetToIniFileNameL | ( | TParse & | aParser | ) | const |
| TParse & aParser |