epoc32/include/wngdoor.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files

// 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
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#if !defined(__WNGDOOR_H__)
#define __WNGDOOR_H__

#if !defined(__E32STD_H__)
#include <e32std.h>
#endif

#if !defined(__E32BASE_H__)
#include <e32base.h>
#endif

#if !defined(__APAMDR_H__)
#include <apamdr.h>
#endif

#if !defined(__APAID_H__)
#include <apaid.h>
#endif

//
// Classes defined
class CWordModelHeader;
class TWordModelHeaderFactory;
class CWordModelHeaderV2;
class TWordModelHeaderFactoryV2;
//
// Class referenced
class CWordModel;
class TWordModelStoreResolver;

/** Application UID for word processor application. 
@internalComponent
@deprecated
*/
const TUid KUidWordApp = {0x10003A64};


//
// Takes ownership of the referenced word model
//
class CWordModelHeaderV2 : public CApaModelHeader
/** Wrapper for the word processor application engine.

The class provides the knowledge for internalising and externalising an application 
model's data. It enables word processor documents to be embedded within rich 
text objects.

Compared to CWordModelHeader, it also provides restoration support for objects 
embedded within embedded word documents. 
@publishedAll
@deprecated
*/
	{
	friend class TWordModelHeaderFactoryV2;
public:
	IMPORT_C ~CWordModelHeaderV2();
public:	// from CApaModelHeader
	IMPORT_C void StoreL(CStreamStore& aStore,CStreamDictionary& aDict)const;
	IMPORT_C TApaAppIdentifier AppId()const;
	IMPORT_C void DetachFromStoreL(CPicture::TDetach aDegree);
public:
	IMPORT_C void RestoreL(const CStreamStore& aStore,const CStreamDictionary& aDict);
	IMPORT_C CWordModel* Model();
	void SetFactory(MApaModelHeaderFactory* aFactory); // takes ownership
private:
	CWordModelHeaderV2(CWordModel* aModel);
private:
	CWordModel*	iModel;
	TWordModelStoreResolver* iResolver; // created during restore
	MApaModelHeaderFactory* iHeaderFactory;
	};


//
//

class TWordModelHeaderFactoryV2 : public MApaModelHeaderFactory
/** Factory to construct CWordModelHeaderV2 application wrapper objects.
@publishedAll
@deprecated
*/
	{
public:
	IMPORT_C TWordModelHeaderFactoryV2(const TFileName& aPrintDriverPath);
	IMPORT_C CApaModelHeader* NewHeaderL(const CStreamStore& aStore,const CStreamDictionary& aDict,
										const TApaAppIdentifier& aAppId)const;
private:
	TFileName iPrintDriverPath;
	};



class CWordModelHeaderV3 : public CApaModelHeader
/** Wrapper for the word processor application engine.

The class provides the knowledge for internalising and externalising an application 
model's data. It enables word processor documents to be embedded within rich 
text objects.

Like CWordModelHeaderV2, it provides restoration support for objects embedded 
within embedded word documents. Unlike that class, however, it does not restore 
printer setup information, or process header and footer information. 
@publishedAll
@deprecated
*/
	{
	friend class TWordModelHeaderFactoryV3;
public:
	IMPORT_C ~CWordModelHeaderV3();
public:	// from CApaModelHeader
	IMPORT_C void StoreL(CStreamStore& aStore,CStreamDictionary& aDict)const;
	IMPORT_C TApaAppIdentifier AppId()const;
	IMPORT_C void DetachFromStoreL(CPicture::TDetach aDegree);
public:
	IMPORT_C void RestoreL(const CStreamStore& aStore,const CStreamDictionary& aDict);
	IMPORT_C CWordModel* Model();
	void SetFactory(MApaModelHeaderFactory* aFactory); // takes ownership
private:
	CWordModelHeaderV3(CWordModel* aModel);
private:
	CWordModel*	iModel;
	TWordModelStoreResolver* iResolver; // created during restore
	MApaModelHeaderFactory* iHeaderFactory;
	};


// Mimimal header factory for efficiency
// Does not restore header or footer information from the document
//
class TWordModelHeaderFactoryV3 : public MApaModelHeaderFactory
/** Factory to construct CWordModelHeaderV3 application wrapper objects. 
@publishedAll
@deprecated
*/
	{
public:
	IMPORT_C TWordModelHeaderFactoryV3();
	IMPORT_C CApaModelHeader* NewHeaderL(const CStreamStore& aStore,const CStreamDictionary& aDict,
										const TApaAppIdentifier& aAppId) const;
	};


#endif