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