appfw/apparchitecture/inc/APACLN.H
changeset 0 2e3d3ce01487
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/appfw/apparchitecture/inc/APACLN.H	Tue Feb 02 10:12:00 2010 +0200
@@ -0,0 +1,68 @@
+// 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 "Eclipse Public License v1.0"
+// which accompanies this distribution, and is available
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+// apacln.h
+//
+
+
+#ifndef __APACLN_H__
+#define __APACLN_H__
+
+#include <apparc.h>
+
+/** Allows CApaDocument-derived objects to be safely put onto the cleanup 
+stack, by calling CApaProcess::DestroyDocument() should a leave or a call 
+to CleanupStack::PopAndDestroy() occur.
+
+It is used as follows.
+@code
+TApaDocCleanupItem cleanup(iEikonEnv->Process(),doc);
+CleanupStack::PushL(cleanup);
+// some potentially leaving code here ...
+CleanupStack::Pop(cleanup);
+@endcode
+@publishedPartner
+@deprecated
+*/
+class TApaDocCleanupItem
+	{
+public:
+	inline TApaDocCleanupItem(CApaProcess* aProcess,CApaDocument* aDoc);
+	inline operator TCleanupItem();
+private:
+	IMPORT_C static void DoCleanup(TAny* aPtr);
+public:
+	/** The process object that will be used to destroy the document. */
+	CApaProcess* iApaProcess;
+	/** The document to destroy as part of cleanup. */
+	CApaDocument* iApaDoc;
+	};
+
+
+/** Constructs a cleanup item object for the specified document.
+
+@param aProcess A pointer to the process object that will be used to destroy the document.
+@param aDoc The document to destroy as part of cleanup. */
+inline TApaDocCleanupItem::TApaDocCleanupItem(CApaProcess* aProcess,CApaDocument* aDoc)
+	: iApaProcess(aProcess), iApaDoc(aDoc)
+	{}
+
+/** A TCleanupItem cast operator that enables the TApaDocCleanupItem object to be pushed to 
+the cleanup stack as a TCleanupItem, so that the document will be properly destroyed 
+(by a call to CApaProcess::DestroyDocument()) should a leave or a call to 
+CleanupStack::PopAndDestroy() occur. */
+inline TApaDocCleanupItem::operator TCleanupItem()
+	{return TCleanupItem(DoCleanup,this);}
+
+#endif	// __APACLN_H__