williamr@2: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // 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
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: //
williamr@2: 
williamr@2: 
williamr@2: #if !defined(__APACLN_H__)
williamr@2: #define __APACLN_H__
williamr@2: 
williamr@2: #if !defined(__APPARC_H__)
williamr@2: #include <apparc.h>
williamr@2: #endif
williamr@2: 
williamr@2: 
williamr@2: class TApaDocCleanupItem
williamr@2: /** Allows CApaDocument-derived objects to be safely put onto the cleanup 
williamr@2: stack, by calling CApaProcess::DestroyDocument() should a leave or a call 
williamr@2: to CleanupStack::PopAndDestroy() occur.
williamr@2: 
williamr@2: It is used as follows.
williamr@2: @code
williamr@2: TApaDocCleanupItem cleanup(iEikonEnv->Process(),doc);
williamr@2: CleanupStack::PushL(cleanup);
williamr@2: // some potentially leaving code here ...
williamr@2: CleanupStack::Pop(cleanup);
williamr@2: @endcode
williamr@2: @publishedPartner
williamr@2: @deprecated
williamr@2: */
williamr@2: 	{
williamr@2: public:
williamr@2: 	inline TApaDocCleanupItem(CApaProcess* aProcess,CApaDocument* aDoc);
williamr@2: 	inline operator TCleanupItem();
williamr@2: private:
williamr@2: 	IMPORT_C static void DoCleanup(TAny* aPtr);
williamr@2: public:
williamr@2: 	/** The process object that will be used to destroy the document. */
williamr@2: 	CApaProcess* iApaProcess;
williamr@2: 	/** The document to destroy as part of cleanup. */
williamr@2: 	CApaDocument* iApaDoc;
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: inline TApaDocCleanupItem::TApaDocCleanupItem(CApaProcess* aProcess,CApaDocument* aDoc)
williamr@2: 	: iApaProcess(aProcess), iApaDoc(aDoc)
williamr@2: /** Constructs a cleanup item object for the specified document.
williamr@2: 
williamr@2: @param aProcess A pointer to the process object that will be used to destroy the document.
williamr@2: @param aDoc The document to destroy as part of cleanup. */
williamr@2: 	{}
williamr@2: 
williamr@2: inline TApaDocCleanupItem::operator TCleanupItem()
williamr@2: /** A TCleanupItem cast operator that enables the TApaDocCleanupItem object to be pushed to 
williamr@2: the cleanup stack as a TCleanupItem, so that the document will be properly destroyed 
williamr@2: (by a call to CApaProcess::DestroyDocument()) should a leave or a call to 
williamr@2: CleanupStack::PopAndDestroy() occur. */
williamr@2: 	{return TCleanupItem(DoCleanup,this);}
williamr@2: 
williamr@2: #endif