diff -r e1b950c65cb4 -r 837f303aceeb epoc32/include/mw/apgdoor.h --- a/epoc32/include/mw/apgdoor.h Wed Mar 31 12:27:01 2010 +0100 +++ b/epoc32/include/mw/apgdoor.h Wed Mar 31 12:33:34 2010 +0100 @@ -1,9 +1,9 @@ // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). // All rights reserved. // This component and the accompanying materials are made available -// 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 +// under the terms of "Eclipse Public License v1.0" // which accompanies this distribution, and is available -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". +// at the URL "http://www.eclipse.org/legal/epl-v10.html". // // Initial Contributors: // Nokia Corporation - initial contribution. @@ -11,87 +11,55 @@ // Contributors: // // Description: +// apgdoor.h // #ifndef __APGDOOR_H__ #define __APGDOOR_H__ -#if !defined(__E32STD_H__) #include -#endif -#if !defined(__E32BASE_H__) #include -#endif -#if !defined(__S32STD_H__) #include -#endif -#if !defined(__GDI_H__) #include -#endif -#if !defined(__APPARC_H__) #include -#endif -#if !defined(__APADBASE_H__) #include -#endif +#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS /** @internalAll */ -#ifdef _UNICODE -#define KUidApaDoorDocStream KUidApaDoorDocStream16 -#else -#define KUidApaDoorDocStream KUidApaDoorDocStream8 -#endif +const TUid KUidApaDoorDocStream={0x10003A35}; -/** -@internalComponent -@deprecated -*/ -const TUid KUidApaDoorDocStream8={0x10000144}; +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS +// classes referenced +class CEmbeddedStore; -/** -@internalComponent -*/ -const TUid KUidApaDoorDocStream16={0x10003A35}; - -// classes defined: -class CApaDoor; -class TApaPictureFactory; -// -// classes referenced: -class CEmbeddedStore; -// - -class CApaDoor : public CApaDoorBase /** A wrapper for an embedded document that can be displayed in a user interface as an icon or a glass door. @publishedAll @released */ +class CApaDoor : public CApaDoorBase { public: IMPORT_C static CApaDoor* NewLC(RFs& aFs, CApaDocument& aDoc,const TSize& aDefaultIconSizeInTwips); // call to create a new door in iconic format - restoration is achieved with TApaPictureFactory IMPORT_C static CApaDoor* NewL(RFs& aFs, CApaDocument& aDoc,const TSize& aDefaultIconSizeInTwips); // call to create a new door in iconic format - restoration is achieved with TApaPictureFactory IMPORT_C static CApaDoor* NewL(RFs& aFs, const CStreamStore& aStore,TStreamId aStreamId,CApaProcess& aProcess); // restoring constructor called by TApaPictureFactory - // + IMPORT_C void SetFormatToIconL(); IMPORT_C void SetFormatToGlassL(); IMPORT_C void SetFormatToTemporaryIconL(TBool aEnabled=ETrue); - // + IMPORT_C CApaDocument* DocumentL(TBool aCheckPassword=EFalse); // returns a pointer to the doc, restoring it if necessary. Checks password if required. inline TDesC* Caption()const; IMPORT_C TUid AppUidL()const; - // // persistence methods IMPORT_C void RestoreL(const CStreamStore& aStore,TStreamId aHeadStreamId); TStreamId StoreL(CStreamStore& aStore) const; - // + IMPORT_C ~CApaDoor(); - // - // from CPicture - void Draw(CGraphicsContext& aGc,const TPoint& aTopLeft,const TRect& aClipRect, - MGraphicsDeviceMap* aMap)const; // draws according to current iPicFormat +public: // from CPicture + void Draw(CGraphicsContext& aGc,const TPoint& aTopLeft,const TRect& aClipRect, MGraphicsDeviceMap* aMap)const; // draws according to current iPicFormat void DetachFromStoreL(TDetach aDegree=EDetachFull); //lint !e1735 Virtual function has default parameter - Must use the same default as declared by CPicture void GetOriginalSizeInTwips(TSize& aSize)const; void SetScaleFactor(TInt aScaleFactorWidth,TInt aScaleFactorHeight); @@ -104,9 +72,9 @@ CApaDoor(RFs& aFs, CApaProcess& aProcess); CApaDoor(RFs& aFs, CApaDocument& aDoc,const TSize& aDefaultIconSizeInTwips); void ConstructL(); - // + void SetIconSizeInTwips(TSize aSize); // for use of factory - // + void StoreDocL(CPersistentStore& aStore)const; void RestoreDocL(const CPersistentStore& aStore); void RestoreDoorStateL(const CStreamStore& aStore,const CStreamDictionary& streamDic); @@ -114,11 +82,11 @@ static void CopyStoreL(const CEmbeddedStore& aSourceStore,RWriteStream& aTargetStream); void ExternalizeStateStreamL(CStreamStore& aStore,CStreamDictionary& aStreamDict)const; void InternalizeStateStreamL(const CStreamStore& aStore,const CStreamDictionary& aStreamDict,TSize aDefaultIconSize); - // + // required so CPicture's can be swizzled void ExternalizeL(RWriteStream& aStream)const; - // from CApaDoorBase - virtual TSize GlassDoorSize()const; +private: // from CApaDoorBase + TSize GlassDoorSize()const; TUid AppUidFromStreamL() const; private: RFs& iFs; @@ -128,14 +96,12 @@ CPicture* iPicture; // the current view of the door, either iconic or glass CEmbeddedStore* iStore; // store containing the doc CBufSeg* iStoreHost; // the host for the embedded store, if the door has been detached from its originating store - __MUTABLE TSize iIconSizeInTwips; - // + mutable TSize iIconSizeInTwips; +private: friend class TApaPictureFactory; }; -class TApaPictureFactory : public MPictureFactory -// Recognizes KUidPictureTypeDoor and creates CApaDoor pictures /** A factory class for instantiating and restoring an application's door. A door factory object is constructed by the UI environment and can be accessed @@ -145,37 +111,34 @@ @released @see CEikonEnv::PictureFactory() @see CApaDoor */ +class TApaPictureFactory : public MPictureFactory +// Recognizes KUidPictureTypeDoor and creates CApaDoor pictures { public: IMPORT_C TApaPictureFactory(CApaProcess* aAppProcess); inline void SetIconSize(TSize aIconSizeInTwips); - // - // from MPictureFactory +public: // from MPictureFactory IMPORT_C void NewPictureL(TPictureHeader& aPictureHeader,const CStreamStore& aPictureStore)const; // used to create CApaDoor's during document restore only protected: IMPORT_C TApaPictureFactory(); - private: CApaProcess* iApaProcess; TSize iIconSize; TInt iSpare; }; - // // inlines // +/** Gets the name of the application with which the embedded document is associated. +@return A pointer to a descriptor containing the name of the application. */ inline TDesC* CApaDoor::Caption()const - /** Gets the name of the application with which the embedded document is associated. - - @return A pointer to a descriptor containing the name of the application. */ { return iAppCaption; } +/** Sets the size of the icon. +@param aIconSizeInTwips The size of the icon, in twips. */ inline void TApaPictureFactory::SetIconSize(TSize aIconSizeInTwips) - /** Sets the size of the icon. - - @param aIconSizeInTwips The size of the icon, in twips. */ { iIconSize = aIconSizeInTwips; } -#endif +#endif // __APGDOOR_H__