cbs/cbsui/UiInc/MSaveMessageController.h
branchRCL_3
changeset 20 987c9837762f
parent 0 ff3b6d0fd310
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/cbs/cbsui/UiInc/MSaveMessageController.h	Wed Sep 01 12:15:03 2010 +0100
@@ -0,0 +1,58 @@
+/*
+* Copyright (c) 2002 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: 
+*    Declares functions needed to save message.
+*
+*
+*/
+
+
+#ifndef __MSaveMessageController_h
+#define __MSaveMessageController_h
+
+//  INCLUDES
+#include    <CbsCommon.h>
+
+
+
+// CLASS DECLARATION
+
+/**
+* Helper class for saving message.
+*/
+class MSaveMessageController
+    {
+    public: // New functions
+
+        /**
+        *   Saves a message (the saved message won't be deleted to make 
+        *   room for new messages).
+        *
+        *   Return codes:
+        *   KErrNone            Message is saved.
+        *   KErrGeneral         Message not saved -- total maximum of saved 
+        *                       messages reached.
+        *   KErrNotFound        Message not saved -- no message associated
+        *                       with the given handle.
+        *   KErrDiskFull        Message not saved -- FFS out of space.
+        *
+        *   @param  aHandle     Handle to the message to be saved.
+        *   @return             Return code.
+        */
+        virtual TInt SaveMessage( const TCbsMessageHandle& aHandle ) = 0;
+    };
+
+#endif // __MSaveMessageController_h
+
+// END OF FILE