vmbx/vmbxengine/inc/vmbxvoipengine.h
branchRCL_3
changeset 19 7d48bed6ce0c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/vmbx/vmbxengine/inc/vmbxvoipengine.h	Tue Aug 31 15:45:17 2010 +0300
@@ -0,0 +1,178 @@
+/*
+* Copyright (c) 2009-2010 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: Access class to VoIp engine implementation
+*  Interface   : Private, CVmbxVoIpEngine
+*
+*/
+
+
+#ifndef C_VMBXVOIPENGINE_H
+#define C_VMBXVOIPENGINE_H
+
+// INCLUDES
+#include <e32std.h>
+#include <e32base.h>
+
+// FORWARD DECLARATIONS
+class CVmbxEngineBase;
+//class CGulIcon;
+class CVmSPSHandler;
+class CVmBSHandler;
+class TVmbxServiceInfo;
+//class CFbsBitmap;
+
+// CLASS DECLARATION
+
+/**
+*  Implements functionality specifig to voip mailbox entry
+*
+*  @lib vmbxengine.lib
+*/
+NONSHARABLE_CLASS( CVmbxVoIpEngine ) : public CVmbxEngineBase
+    {
+
+public:  // Constructors and destructor
+
+    /**
+     * Two-phased constructor
+     * @param aProvider Reference to Ui Utilities
+     */
+    static CVmbxVoIpEngine* NewL( MVmbxResourceProvider& aProvider );
+
+
+    /**
+     * Destructor.
+     */
+    virtual ~CVmbxVoIpEngine();
+
+public: // from base class CVmbxEntryBase
+
+    /**
+     *
+     * @see CVmbxEntryBase::GetL
+     * @param aEntry Reference to store handler
+     */
+    void GetL( CVoiceMailboxEntry*& aEntry );
+
+    /**
+     *
+     * @see CVmbxEntryBase::SaveL
+     * @param aEntry Reference to CVoiceMailboxEntry
+     * @param aShowNotesAllowed Provision mode is used to decide whether show
+     *          saved notification UI dialog. If aShowNotesAllowed is EFalse,
+     *          saved notification UI dialog will not show. 
+     */
+    void SaveL( const CVoiceMailboxEntry& aEntry,
+                TBool aShowNotesAllowed );
+
+    /**
+     * To save mailbox Provisioned entry value
+     *
+     * @param aEntry Provisioned Entry data
+     */
+    void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry );
+
+    /**
+     * see CVmbxEntryBase::CheckConfiguration
+     *
+     */   
+    TBool CheckConfiguration( const TVoiceMailboxParams& aParams,
+                                 const TInt aFlags );
+
+    /**
+     * Displays number query dialog
+     *
+     * @param aEntry CVoiceMailboxEntry
+     */
+    void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );
+
+    /**
+     * Displays number query dialog
+     *
+     * @param aEntry Entry data
+     */
+    void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );
+
+private: // New function
+
+    /**
+     * C++ default constructor.
+     *
+     * @param aProvider Reference to Ui Utilities
+     */
+    CVmbxVoIpEngine( MVmbxResourceProvider& aProvider );
+
+    /**
+     * By default Symbian 2nd phase constructor is private.
+     *
+    */
+    void ConstructL();
+
+    /**
+     * Check from SPSettings if there are VoIP profiles
+     * @param None
+     * @return ETrue if VoIP profiles were found, otherwise EFalse
+     */
+    TBool IsVoIPProfilesFound();
+
+    /**
+     * Checks the Voice Mailbox how many VoIP service Ids
+     *
+     * @param aProfileIds
+     * @return KErrNone if get service Ids successfully.
+     */
+    void GetServiceIdsL( RIdArray& aProfileIds );
+
+    /**
+     * Get branded icon
+     * @param in aBrandingId Brandind Id
+     * @param out aBrandedBitmap Bitmap for branded icon
+     * @param out aBrandedBitmapMask Mask to branded icon
+     */
+    //void GetBrandedIconL( const TDesC8& aBrandingId,
+    //    CFbsBitmap*& aBrandedBitmap, CFbsBitmap*& aBrandedBitmapMask );
+
+    /**
+     * see CVoiceMailbox::GetVmbxImage
+     * 
+     */
+    //CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams );
+
+    /**
+     * Get brand id
+     * @param in aServiceId Used Service
+     * @param out aBrandId On completion, contains Brand Id
+     */
+    void BrandIdL( TInt aServiceId, TDes8& aBrandId );
+
+    /**
+     * Get service ids
+     * @param in&out aServiceInfo On completion contains service ids
+     */
+    TInt GetServiceInfo( TVmbxServiceInfo& aServiceInfo );
+
+private: // data
+
+    /**
+     * Handles Service proviver Settings, Own.
+     */
+    CVmSPSHandler* iVmSpsHandler;
+    
+    /**
+     * Handles Branding Server, Own.
+     */
+    CVmBSHandler* iVmBsHandler;
+    };
+
+#endif  // C_VMBXVOIPENGINE_H