epoc32/include/mw/senidentityprovideridarray8.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:        Array utility class for listing pre-known ProviderIDs
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
#ifndef SEN_IDENTITY_PROVIDER_ID_ARRAY_8_H
williamr@2
    26
#define SEN_IDENTITY_PROVIDER_ID_ARRAY_8_H
williamr@2
    27
williamr@2
    28
//  INCLUDES
williamr@2
    29
#include <e32base.h>
williamr@2
    30
#include <badesca.h>
williamr@2
    31
#include <e32std.h>
williamr@2
    32
#include <MSenIdentityProviderIdArray.h>
williamr@2
    33
williamr@2
    34
// CLASS DECLARATION
williamr@2
    35
williamr@2
    36
/**
williamr@2
    37
*  Array utility class for listing pre-known ProviderIDs
williamr@2
    38
*  Typical use of this class is to define a strict list
williamr@2
    39
*  of ProviderIDs pointing to certain IDPs, which are to
williamr@2
    40
*  be accepted as only suitable services when initiating
williamr@2
    41
*  an new service connection.
williamr@2
    42
*  Other possiblity is to instantiate a non-strict array,
williamr@2
    43
*  which only acts as "recommendation" of those Identity
williamr@2
    44
*  Providers, that should be first checked when initiating
williamr@2
    45
*  new service connection. In such case, because it is a
williamr@2
    46
*  non-strict list, also other IDPs may be used, if none
williamr@2
    47
*  matching with this "recommendation" is found.
williamr@2
    48
*  @lib SenServDesc.lib
williamr@2
    49
*  @since Series60 3.0
williamr@2
    50
*/
williamr@2
    51
class CSenIdentityProviderIdArray8 :    public CDesC8ArraySeg,
williamr@2
    52
                                        public MSenIdentityProviderIdArray
williamr@2
    53
{
williamr@2
    54
    public:  // Constructors and destructor
williamr@2
    55
        
williamr@2
    56
        /**
williamr@2
    57
        *   Constructor with no arguments create non-strict arrays.. 
williamr@2
    58
        *   (iStrict = EFalse)
williamr@2
    59
        */ 
williamr@2
    60
        IMPORT_C static CSenIdentityProviderIdArray8* NewL();
williamr@2
    61
williamr@2
    62
        /**
williamr@2
    63
        *   Constructor with no arguments create non-strict arrays.. 
williamr@2
    64
        *   (iStrict = EFalse)
williamr@2
    65
        */ 
williamr@2
    66
        IMPORT_C static CSenIdentityProviderIdArray8* NewLC();
williamr@2
    67
williamr@2
    68
        /**
williamr@2
    69
        * Basic constructor with a default value for iStrict.
williamr@2
    70
        * @since Series60 3.0
williamr@2
    71
        * @param aStrict the value to be set to iStrict
williamr@2
    72
        */
williamr@2
    73
        IMPORT_C static CSenIdentityProviderIdArray8* NewL(const TBool aStrict);
williamr@2
    74
williamr@2
    75
        /**
williamr@2
    76
        * Basic constructor with a default value for iStrict.
williamr@2
    77
        * @since Series60 3.0
williamr@2
    78
        * @param aStrict the value to be set to iStrict
williamr@2
    79
        */
williamr@2
    80
        IMPORT_C static CSenIdentityProviderIdArray8* NewLC(const TBool aStrict);
williamr@2
    81
williamr@2
    82
        /**
williamr@2
    83
        * Destructor.
williamr@2
    84
        */
williamr@2
    85
        IMPORT_C virtual ~CSenIdentityProviderIdArray8();
williamr@2
    86
williamr@2
    87
        // Functions from base classes
williamr@2
    88
williamr@2
    89
        // From MSenIdentityProviderIdArray
williamr@2
    90
        
williamr@2
    91
        /**
williamr@2
    92
        * Getter for iStrict
williamr@2
    93
        * @since Series60 3.0
williamr@2
    94
        * @return ETrue if iStrict is true, otherwise EFalse
williamr@2
    95
        */
williamr@2
    96
        IMPORT_C virtual TBool IsStrict() const;
williamr@2
    97
        
williamr@2
    98
        /**
williamr@2
    99
        * Setter for iStrict
williamr@2
   100
        * @since Series60 3.0
williamr@2
   101
        * @param aStrict the value to be set to iStrict
williamr@2
   102
        */
williamr@2
   103
        IMPORT_C void SetStrict(TBool aStrict);
williamr@2
   104
        
williamr@2
   105
    protected:  // New functions
williamr@2
   106
        
williamr@2
   107
        /**
williamr@2
   108
        * C++ default constructor.
williamr@2
   109
        */
williamr@2
   110
        CSenIdentityProviderIdArray8(const TBool aStrict);  
williamr@2
   111
        
williamr@2
   112
        /**
williamr@2
   113
        * Default 2nd phase constructor
williamr@2
   114
        * @since Series60 3.0
williamr@2
   115
        */
williamr@2
   116
        void ConstructL();
williamr@2
   117
williamr@2
   118
    private:    // Data
williamr@2
   119
        TBool iStrict;         
williamr@2
   120
    };
williamr@2
   121
    
williamr@2
   122
#endif // SEN_IDENTITY_PROVIDER_ID_ARRAY_8_H
williamr@2
   123
williamr@2
   124
// End of File
williamr@2
   125
williamr@2
   126
williamr@2
   127