1 /*

     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Base class for different mailbox entries

    15 *  Interface   : Private, CVmbxEngineBase

    16 *

    17 */

    18 

    19 

    20 #ifndef C_VMBXENGINEBASE_H

    21 #define C_VMBXENGINEBASE_H

    22 

    23 // INCLUDES

    24 #include <e32base.h>

    25 #include <cvoicemailbox.h>

    26 

    27 #include "mvmbxresourceprovider.h"

    28 

    29 //FORWARD DECLARATIONS

    30 

    31 // CLASS DECLARATION

    32 /**

    33 *  Implemets mailbox entry base class functionality

    34 *

    35 *  @lib vmbxengine.lib

    36 *  @since S60 v5.2

    37 */

    38 NONSHARABLE_CLASS( CVmbxEngineBase ) : public CBase

    39     {

    40 

    41 public:  // Constructors and destructor

    42 

    43     /**

    44      * C++ default constructor.

    45      * @param aProvider Reference to CVmbxUiUtilities

    46      */

    47     CVmbxEngineBase( MVmbxResourceProvider& aProvider );

    48 

    49     /**

    50      * Destructor.

    51      */

    52     virtual ~CVmbxEngineBase();

    53 

    54 public: // New functions

    55     /**

    56      * To get mailbox entry value

    57      * Leave if no number got or Symbian OS error code

    58      *

    59      * @since S60 v5.2

    60      * @param aEntry Entry data

    61      */

    62     virtual void GetL( CVoiceMailboxEntry*& aEntry ) = 0;

    63 

    64     /**

    65      * To save mailbox entry value

    66      * Leave with Symbian OS error code

    67      *

    68      * @since S60 v5.2

    69      * @param aEntry Entry data

    70      */

    71     virtual void SaveL( const CVoiceMailboxEntry& aEntry ) = 0;

    72 

    73     /**

    74      * To save mailbox Provisioned entry value

    75      * Leave with Symbian OS error code

    76      *

    77      * @since S60 v5.2

    78      * @param aEntry Provisioned Entry data

    79      */

    80     virtual void SaveProvisionedEntryL( const CVoiceMailboxEntry& aEntry ) = 0;

    81 

    82     /**

    83      * Checks the Voice Mailbox how many VoIP service Ids

    84      * Leave with Symbian OS error code

    85      *

    86      * @since S60 v5.2

    87      * @param aProfileIds id of voip profile

    88      */

    89     virtual void GetServiceIdsL( RIdArray& aProfileIds );

    90 

    91     /**

    92      * see CVoiceMailbox::GetVmbxImage

    93      * 

    94      * @since S60 v5.2

    95      */

    96     //virtual CGulIcon* GetVmbxImageL( const TVoiceMailboxParams& aParams );

    97 

    98     /**

    99      * Sets the Voice Mailbox current service id.

   100      *

   101      * @since S60 v5.2

   102      * @param aVmbxServiceId Voice Mailbox service id.

   103      */

   104     virtual void SetCurrentServiceId( const TServiceId& aVmbxServiceId );

   105 

   106     /**

   107      * Checks the Voice Mailbox configuration to find out if a features

   108      * are disabled or enabled.

   109      *

   110      * @since S60 v5.2

   111      * @param aParams Specifies which mailbox capabilities,

   112      *          the caller wants to check.

   113      * @param aFlags Use TVmbxFeatureCapability values for this parameter.

   114      *          Specifies what features client wants to check.

   115 

   116      * @return True if feature(s) enabled.

   117      */

   118     virtual TBool CheckConfiguration( const TVoiceMailboxParams& 

   119             aParams, const TInt aFlags );

   120     

   121     /**

   122      * Displays number query dialog

   123      * Leave if user don't select or Symbian OS error code

   124      *

   125      * @since S60 v5.2

   126      * @param aEntry CVoiceMailboxEntry

   127      */

   128     virtual void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );

   129 

   130     /**

   131      * Displays number query dialog

   132      * Leave if user don't select or Symbian OS error code

   133      *

   134      * @since S60 v5.2

   135      * @param aEntry Entry data

   136      */

   137     virtual void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );

   138 

   139 

   140 protected: // data

   141 

   142     /**

   143      * Reference to CVmbxUiUtilities

   144      */

   145     MVmbxResourceProvider& iProvider;

   146 

   147     /**

   148      * Mailbox service id.

   149      */

   150     TServiceId iVmbxServiceId;

   151     };

   152 

   153 #endif  // C_VMBXENGINEBASE_H