1 /*

     2 * Copyright (c) 2002-2007 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: 

    15 *       Interface to be used by field listbox model for analyzing

    16 *       contact field instances. 

    17 *

    18 */

    19 

    20 

    21 #ifndef MPBK2FIELDANALYZER_H

    22 #define MPBK2FIELDANALYZER_H

    23 

    24 //  FORWARD DECLARATIONS

    25 class MVPbkStoreContactField;

    26 class CPbk2PresentationContactField;

    27 class MVPbkBaseContactFieldCollection;

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32  * @internal Only Phonebook 2 internal use supported!

    33  */

    34 class MPbk2FieldAnalyzer

    35 	{

    36 	

    37     public: // Enumeration used for the voip support flag

    38         enum TVoIPSupport

    39             {

    40             EVoIPSupportSip      = 1,

    41             EVoIPSupportBasic    = 2,

    42             EVoIPSupportXspId    = 4,

    43             EVoIPSupportCallout  = 8    

    44             };

    45 	

    46     public: // Interface

    47         /**

    48          * Analyses if the field has a speed dial definition.

    49          *

    50          * @param aField    The field to analyze.

    51          * @return ETrue if field has speed dial definition, otherwise EFalse.

    52          */	

    53         virtual TBool HasSpeedDialL(

    54                 const MVPbkStoreContactField& aField ) const = 0;

    55 

    56         /**

    57          * Analyses if the field has a voice tag.

    58          *

    59          * @param aField    The field to analyze.

    60          * @return ETrue if field has voice tag definition, otherwise EFalse.

    61          */	

    62         virtual TBool HasVoiceTagL(

    63                 const MVPbkStoreContactField& aField ) const = 0;

    64 

    65         /**

    66          * Analyses is the field hidden, ie. should it not be shown in UI.

    67          *

    68          * @param aField    The field to analyze.

    69          * @return ETrue if field is hidden, EFalse otherwise.

    70          */	

    71         virtual TBool IsHiddenField(

    72                 const CPbk2PresentationContactField& aField ) const = 0;

    73         /**

    74          * Analyses the installed voip capabilities in comparison to

    75          * the details stored in a contact.

    76          *

    77          * @param aFields    The fields from a contact to be analysed

    78          * @return TInt containing MPbk2FieldAnalyzer::TVoIPSupport flags.

    79          */ 

    80         virtual const TInt VoipSupportL( 

    81                 const MVPbkBaseContactFieldCollection& aFields ) const = 0;

    82         /**

    83          * Analyses whether a specific field can be supported by the voip

    84          * capabilities installed. This function is used hand in hand with 

    85          * VoipSupportL()

    86          *

    87          * @param aVpbkFieldResId    The field's FieldTypeResId from contact

    88          *                           details of a contact to be analysed.

    89          * @param aVoipFlag          Voip capabilities available.     

    90          * @return ETrue if the field has voip support installed in the phone.

    91          */

    92         virtual TBool IsFieldVoipCapable( 

    93                 TInt aVpbkFieldResId, const TInt aVoipFlag ) const = 0;

    94         

    95 

    96     };

    97 	

    98 #endif // MPBK2FIELDANALYZER_H

    99 

   100 // End of File