ipcm_pub/access_point_engine_api/inc/ApNetworkItem.h
changeset 71 9f263f780e41
parent 70 ac5daea24fb0
child 72 0c32cf868819
equal deleted inserted replaced
70:ac5daea24fb0 71:9f263f780e41
     1 /*
       
     2 * Copyright (c) 2002 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 *     Declaration of the CApNetworkItem class.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef CAPNETWORKITEM_H
       
    21 #define CAPNETWORKITEM_H
       
    22 
       
    23 // Deprecation warning
       
    24 #warning This header file has been deprecated and will be fully removed between weeks 12 and 18 of 2010. See Polonium CR #153 for details.
       
    25  
       
    26  
       
    27 //  INCLUDES
       
    28 #include <commdb.h>
       
    29 #include <ApEngineVer.h>
       
    30 #include <ApEngineConsts.h>
       
    31 
       
    32 // CLASS DECLARATION
       
    33 /**
       
    34 *  Representation of a Network item.
       
    35 */
       
    36 NONSHARABLE_CLASS( CApNetworkItem ) :public CBase
       
    37                                          ///< This class is used to hold
       
    38                                          ///< the main information of a
       
    39                                          ///< Network item.
       
    40                                          ///< It is used in CApNetworks.
       
    41     {
       
    42     public:  // Constructors and destructor
       
    43 
       
    44         /**
       
    45         * Two-phased constructor. Leaves on failure, places instance
       
    46         * on cleanup stack.
       
    47         * @return The constructed CApNetworkItem.
       
    48         *
       
    49         * @deprecated
       
    50         */
       
    51         IMPORT_C static CApNetworkItem* NewLC();
       
    52 
       
    53 
       
    54         /**
       
    55         * Two-phased constructor. Leaves on failure, places instance
       
    56         * on cleanup stack.
       
    57         * @param aItem a pointer to a CApNetworkItem.
       
    58         * @return The constructed CApNetworkItem.
       
    59         *
       
    60         * @deprecated
       
    61         */
       
    62         IMPORT_C static CApNetworkItem* NewLC( CApNetworkItem* aItem );
       
    63 
       
    64 
       
    65         /**
       
    66         * Destructor.
       
    67         *
       
    68         * @deprecated
       
    69         */
       
    70         IMPORT_C virtual ~CApNetworkItem();
       
    71 
       
    72 
       
    73         /**
       
    74         * Copies the data from another CApNetworkItem
       
    75         * Substitutes the "Assignment operator."
       
    76         * @return No return value.
       
    77         *
       
    78         * @deprecated
       
    79         */
       
    80         IMPORT_C void CopyFromL( const CApNetworkItem& aCopyFrom );
       
    81 
       
    82 
       
    83     private:      // Constructors
       
    84         /**
       
    85         * C++ default constructor.
       
    86         *
       
    87         * @deprecated
       
    88         */
       
    89         IMPORT_C CApNetworkItem();
       
    90 
       
    91 
       
    92         /**
       
    93         * Second-phase constructor.
       
    94         * @param aUid The UID
       
    95         * @param aName The name
       
    96         *
       
    97         * @deprecated
       
    98         */
       
    99         IMPORT_C void ConstructL( TUint32 aUid,
       
   100                                   const TDesC& aName
       
   101                                   );
       
   102 
       
   103 
       
   104         /**
       
   105         * Second-phase constructor.
       
   106         *
       
   107         * @deprecated
       
   108         */
       
   109         IMPORT_C void ConstructL();
       
   110 
       
   111 
       
   112     public: // New functions
       
   113 
       
   114         /**
       
   115         * Gets the name of the network group
       
   116         * Ownership of the returned text is not passed.
       
   117         * @return The name of the network group
       
   118         *
       
   119         * @deprecated
       
   120         */
       
   121         IMPORT_C const TDesC& Name() const;
       
   122 
       
   123 
       
   124         /**
       
   125         * Gets the UID of this network group
       
   126         * @return The UID of this network group
       
   127         *
       
   128         * @deprecated
       
   129         */
       
   130         IMPORT_C TUint32 Uid() const;
       
   131 
       
   132 
       
   133 
       
   134         /**
       
   135         * Sets a UID of the network group.
       
   136         * @param aUid a uid to set.
       
   137         *
       
   138         * @deprecated
       
   139         */
       
   140         IMPORT_C void SetUid( TUint32 aUid );
       
   141 
       
   142 
       
   143         /**
       
   144         * Sets the network name
       
   145         * @param aName The name to set.
       
   146         *
       
   147         * @deprecated
       
   148         */
       
   149         IMPORT_C void SetNameL( const TDesC& aName );
       
   150 
       
   151 
       
   152     private:    // Data
       
   153         TUint32         iUid;           ///< The ID of the network group
       
   154         HBufC*          iName;          ///< The name of the network group 
       
   155 
       
   156     };
       
   157 
       
   158 
       
   159 
       
   160 #endif      // CAPNETWORKITEM_H
       
   161 
       
   162 // End of File