| class CApaApplication : public CBase |
Defines the basic behaviour for applications.
The class defines the basic twin roles of an application class as a factory that creates concrete document objects, and as a supplier of utility functions not specific to any particular instance of a document. For example, returning an application's caption, or accessing its .ini file.
The class is derived from by the UI framework and is further derived from by the UI application.
| Public Member Functions | |
|---|---|
| ~CApaApplication() | |
| TUid | AppDllUid() |
| IMPORT_C TFileName | AppFullName() |
| void | Capability(TDes8 &) |
| CApaDocument * | CreateDocumentL(CApaProcess *) |
| IMPORT_C TFileName | DllName() |
| IMPORT_C TInt | GenerateFileName(RFs &, TFileName &) |
| IMPORT_C void | NewAppServerL(CApaAppServer *&) |
| IMPORT_C CDictionaryStore * | OpenIniFileL(RFs &) |
| CDictionaryStore * | OpenIniFileLC(RFs &) |
| void | PreDocConstructL() |
| void | SetAppFileNameRef(const RBuf &) |
| Protected Member Functions | |
|---|---|
| CApaApplication() | |
| Private Member Functions | |
|---|---|
| IMPORT_C void | CApaApplication_Reserved1() |
| IMPORT_C void | CApaApplication_Reserved2() |
| Private Attributes | |
|---|---|
| const RBuf * | iAppFileNameRef |
| TInt | iCApaApplication_Reserved1 |
| TUid | iEComDtorKey |
| TUid | AppDllUid | ( | ) | const [pure virtual] |
Gets the application specific UID.
The UID is used to differentiate between UI applications.
An implementation of this function must be supplied by the UI application.
The application specific UID.
| void | Capability | ( | TDes8 & | aInfo | ) | const [pure 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. |
| CApaDocument * | CreateDocumentL | ( | CApaProcess * | aProcess | ) | [pure 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 TInt | GenerateFileName | ( | RFs & | aFs, |
| TFileName & | aRootName | |||
| ) | [static] | |||
| IMPORT_C void | NewAppServerL | ( | CApaAppServer *& | aAppServer | ) | [virtual] |
| CApaAppServer *& aAppServer |
| CDictionaryStore * | OpenIniFileLC | ( | RFs & | aFs | ) | const [pure 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 |
| void | PreDocConstructL | ( | ) | [pure 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.
| void | SetAppFileNameRef | ( | const RBuf & | aFileName | ) |
| const RBuf & aFileName |