1.1 --- a/epoc32/include/eikapp.h Tue Mar 16 16:12:26 2010 +0000
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,114 +0,0 @@
1.4 -// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 -// All rights reserved.
1.6 -// This component and the accompanying materials are made available
1.7 -// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 -// which accompanies this distribution, and is available
1.9 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 -//
1.11 -// Initial Contributors:
1.12 -// Nokia Corporation - initial contribution.
1.13 -//
1.14 -// Contributors:
1.15 -//
1.16 -// Description:
1.17 -//
1.18 -
1.19 -#ifndef __EIKAPP_H__
1.20 -#define __EIKAPP_H__
1.21 -
1.22 -#include <apparc.h> // class CApaApplication
1.23 -#include <apaflrec.h>
1.24 -
1.25 -class CCoeEnv;
1.26 -
1.27 -/** The base of all Uikon applications.
1.28 -
1.29 -CEikApplication builds on CApaApplication, providing a basis for applications
1.30 -working within the framework provided by Uikon. It also contains an interface
1.31 -to the resource file and the document object belonging to the application.
1.32 -
1.33 -Each Uikon application class is derived from CEikApplication. Application
1.34 -writers must provide at least an implementation of the pure virtual function
1.35 -CreateDocumentL().
1.36 -
1.37 -The application's resource file can be changed from the default by overriding
1.38 -ResourceFileName().
1.39 -
1.40 -@publishedAll
1.41 -@released
1.42 -@see CEikDocument */
1.43 -class CEikApplication : public CApaApplication
1.44 - {
1.45 -public:
1.46 - IMPORT_C ~CEikApplication();
1.47 - inline TInt ResourceFileOffset() const;
1.48 - inline CApaProcess* Process() const;
1.49 - inline const TApaAppCaption& AppCaption() const;
1.50 - IMPORT_C virtual void GetDefaultDocumentFileName(TFileName& aDocumentName) const;
1.51 - IMPORT_C virtual TFileName BitmapStoreName() const;
1.52 -public: // from CApaApplication
1.53 - IMPORT_C CDictionaryStore* OpenIniFileLC(RFs& aFs) const;
1.54 - IMPORT_C void Capability(TDes8& aInfo) const;
1.55 - IMPORT_C void SetToIniFileNameL(TParse& aParser) const;
1.56 -protected: // from CApaApplication
1.57 - IMPORT_C void PreDocConstructL();
1.58 - IMPORT_C CApaDocument* CreateDocumentL(CApaProcess* aProcess);
1.59 - IMPORT_C void NewAppServerL(CApaAppServer*& aAppServer);
1.60 -protected:
1.61 - IMPORT_C CEikApplication();
1.62 - IMPORT_C void EnsureCaptionIsLocalisedL(const TDesC& aLocalisableResourceFile);
1.63 -public:
1.64 - IMPORT_C virtual TFileName ResourceFileName() const;
1.65 -private:
1.66 - IMPORT_C virtual void CEikApplication_Reserved1();
1.67 - IMPORT_C virtual void CEikApplication_Reserved2();
1.68 -private:
1.69 - /**
1.70 - @publishedAll
1.71 - @released
1.72 - */
1.73 - virtual CApaDocument* CreateDocumentL()=0;
1.74 -private: // internal use
1.75 - void InitAppNameParserWithPathAndExt(TParse& aParser, const TDesC& aPath, const TDesC& aExt) const;
1.76 -protected:
1.77 - CCoeEnv* iCoeEnv;
1.78 - TInt iResourceFileOffset;
1.79 -private:
1.80 - enum
1.81 - {
1.82 - EFlagCaptionCorrectlyLocalised = 0x00000001
1.83 - };
1.84 -private:
1.85 - CApaProcess* iProcess;
1.86 - TApaAppCaption iCaption;
1.87 - TApaAppCapabilityBuf* iCapabilityBuf;
1.88 - TUint iAppFlags;
1.89 - TInt iSpare;
1.90 - };
1.91 -
1.92 -/** Gets the offset value defined for this application's default resource file.
1.93 -
1.94 -As the resource file offset can also be accessed through iResourceFileOffset,
1.95 -this function should not be needed by any apps.
1.96 -
1.97 -@return Offset of a resource file. */
1.98 -inline TInt CEikApplication::ResourceFileOffset() const
1.99 - { return iResourceFileOffset; }
1.100 -
1.101 -
1.102 -/** Gets the managing process.
1.103 -
1.104 -@return A pointer to the process object managing this application's documents. */
1.105 -inline CApaProcess* CEikApplication::Process() const
1.106 - { return iProcess; }
1.107 -
1.108 -
1.109 -/** Gets the caption for this application.
1.110 -
1.111 -Captions are displayed in the task list.
1.112 -
1.113 -@return Application caption. */
1.114 -inline const TApaAppCaption& CEikApplication::AppCaption() const
1.115 - { return iCaption; }
1.116 -
1.117 -#endif // __EIKAPP_H__