1 /*

     2 * Copyright (c) 2009-2010 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 */

    37 NONSHARABLE_CLASS( CVmbxEngineBase ) : public CBase

    38     {

    39 

    40 public:  // Constructors and destructor

    41 

    42     /**

    43      * C++ default constructor.

    44      * @param aProvider Reference to CVmbxUiUtilities

    45      */

    46     CVmbxEngineBase( MVmbxResourceProvider& aProvider );

    47 

    48     /**

    49      * Destructor.

    50      */

    51     virtual ~CVmbxEngineBase();

    52 

    53 public: // New functions

    54     /**

    55      * To get mailbox entry value

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

    57      *

    58      * @param aEntry Entry data

    59      */

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

    61 

    62     /**

    63      * To save mailbox entry value

    64      * Leave with Symbian OS error code

    65      *

    66      * @param aEntry Entry data

    67      * @param aShowNotesAllowed Provision mode is used to decide whether show

    68      *          saved notification UI dialog. If aShowNotesAllowed is EFalse,

    69      *          saved notification UI dialog will not show. 

    70      */

    71     virtual void SaveL( const CVoiceMailboxEntry& aEntry,

    72                         TBool aShowNotesAllowed ) = 0;

    73 

    74     /**

    75      * To save mailbox Provisioned entry value

    76      * Leave with Symbian OS error code

    77      *

    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      * @param aProfileIds id of voip profile

    87      */

    88     virtual void GetServiceIdsL( RIdArray& aProfileIds );

    89 

    90     /**

    91      * see CVoiceMailbox::GetVmbxImage

    92      * 

    93      */

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

    95 

    96     /**

    97      * Sets the Voice Mailbox current service id.

    98      *

    99      * @param aVmbxServiceId Voice Mailbox service id.

   100      */

   101     virtual void SetCurrentServiceId( const TServiceId& aVmbxServiceId );

   102 

   103     /**

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

   105      * are disabled or enabled.

   106      *

   107      * @param aParams Specifies which mailbox capabilities,

   108      *          the caller wants to check.

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

   110      *          Specifies what features client wants to check.

   111 

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

   113      */

   114     virtual TBool CheckConfiguration( const TVoiceMailboxParams& 

   115             aParams, const TInt aFlags );

   116     

   117     /**

   118      * Displays number query dialog

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

   120      *

   121      * @param aEntry CVoiceMailboxEntry

   122      */

   123     virtual void QueryDefineNumberL( CVoiceMailboxEntry& aEntry );

   124 

   125     /**

   126      * Displays number query dialog

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

   128      *

   129      * @param aEntry Entry data

   130      */

   131     virtual void QueryChangeNumberL( CVoiceMailboxEntry& aEntry );

   132 

   133 

   134 protected: // data

   135 

   136     /**

   137      * Reference to CVmbxUiUtilities

   138      */

   139     MVmbxResourceProvider& iProvider;

   140 

   141     /**

   142      * Mailbox service id.

   143      */

   144     TServiceId iVmbxServiceId;

   145     };

   146 

   147 #endif  // C_VMBXENGINEBASE_H