ipcm_pub/access_point_engine_api/inc/ApNetworkItem.h
author hgs
Wed, 27 Oct 2010 17:43:56 +0300
changeset 70 ac5daea24fb0
permissions -rw-r--r--
201038
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
70
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: 
hgs
parents:
diff changeset
    15
*     Declaration of the CApNetworkItem class.
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef CAPNETWORKITEM_H
hgs
parents:
diff changeset
    21
#define CAPNETWORKITEM_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
// Deprecation warning
hgs
parents:
diff changeset
    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.
hgs
parents:
diff changeset
    25
 
hgs
parents:
diff changeset
    26
 
hgs
parents:
diff changeset
    27
//  INCLUDES
hgs
parents:
diff changeset
    28
#include <commdb.h>
hgs
parents:
diff changeset
    29
#include <ApEngineVer.h>
hgs
parents:
diff changeset
    30
#include <ApEngineConsts.h>
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
// CLASS DECLARATION
hgs
parents:
diff changeset
    33
/**
hgs
parents:
diff changeset
    34
*  Representation of a Network item.
hgs
parents:
diff changeset
    35
*/
hgs
parents:
diff changeset
    36
NONSHARABLE_CLASS( CApNetworkItem ) :public CBase
hgs
parents:
diff changeset
    37
                                         ///< This class is used to hold
hgs
parents:
diff changeset
    38
                                         ///< the main information of a
hgs
parents:
diff changeset
    39
                                         ///< Network item.
hgs
parents:
diff changeset
    40
                                         ///< It is used in CApNetworks.
hgs
parents:
diff changeset
    41
    {
hgs
parents:
diff changeset
    42
    public:  // Constructors and destructor
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
        /**
hgs
parents:
diff changeset
    45
        * Two-phased constructor. Leaves on failure, places instance
hgs
parents:
diff changeset
    46
        * on cleanup stack.
hgs
parents:
diff changeset
    47
        * @return The constructed CApNetworkItem.
hgs
parents:
diff changeset
    48
        *
hgs
parents:
diff changeset
    49
        * @deprecated
hgs
parents:
diff changeset
    50
        */
hgs
parents:
diff changeset
    51
        IMPORT_C static CApNetworkItem* NewLC();
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
        /**
hgs
parents:
diff changeset
    55
        * Two-phased constructor. Leaves on failure, places instance
hgs
parents:
diff changeset
    56
        * on cleanup stack.
hgs
parents:
diff changeset
    57
        * @param aItem a pointer to a CApNetworkItem.
hgs
parents:
diff changeset
    58
        * @return The constructed CApNetworkItem.
hgs
parents:
diff changeset
    59
        *
hgs
parents:
diff changeset
    60
        * @deprecated
hgs
parents:
diff changeset
    61
        */
hgs
parents:
diff changeset
    62
        IMPORT_C static CApNetworkItem* NewLC( CApNetworkItem* aItem );
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
        /**
hgs
parents:
diff changeset
    66
        * Destructor.
hgs
parents:
diff changeset
    67
        *
hgs
parents:
diff changeset
    68
        * @deprecated
hgs
parents:
diff changeset
    69
        */
hgs
parents:
diff changeset
    70
        IMPORT_C virtual ~CApNetworkItem();
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
hgs
parents:
diff changeset
    73
        /**
hgs
parents:
diff changeset
    74
        * Copies the data from another CApNetworkItem
hgs
parents:
diff changeset
    75
        * Substitutes the "Assignment operator."
hgs
parents:
diff changeset
    76
        * @return No return value.
hgs
parents:
diff changeset
    77
        *
hgs
parents:
diff changeset
    78
        * @deprecated
hgs
parents:
diff changeset
    79
        */
hgs
parents:
diff changeset
    80
        IMPORT_C void CopyFromL( const CApNetworkItem& aCopyFrom );
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
hgs
parents:
diff changeset
    83
    private:      // Constructors
hgs
parents:
diff changeset
    84
        /**
hgs
parents:
diff changeset
    85
        * C++ default constructor.
hgs
parents:
diff changeset
    86
        *
hgs
parents:
diff changeset
    87
        * @deprecated
hgs
parents:
diff changeset
    88
        */
hgs
parents:
diff changeset
    89
        IMPORT_C CApNetworkItem();
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
        /**
hgs
parents:
diff changeset
    93
        * Second-phase constructor.
hgs
parents:
diff changeset
    94
        * @param aUid The UID
hgs
parents:
diff changeset
    95
        * @param aName The name
hgs
parents:
diff changeset
    96
        *
hgs
parents:
diff changeset
    97
        * @deprecated
hgs
parents:
diff changeset
    98
        */
hgs
parents:
diff changeset
    99
        IMPORT_C void ConstructL( TUint32 aUid,
hgs
parents:
diff changeset
   100
                                  const TDesC& aName
hgs
parents:
diff changeset
   101
                                  );
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
hgs
parents:
diff changeset
   104
        /**
hgs
parents:
diff changeset
   105
        * Second-phase constructor.
hgs
parents:
diff changeset
   106
        *
hgs
parents:
diff changeset
   107
        * @deprecated
hgs
parents:
diff changeset
   108
        */
hgs
parents:
diff changeset
   109
        IMPORT_C void ConstructL();
hgs
parents:
diff changeset
   110
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
    public: // New functions
hgs
parents:
diff changeset
   113
hgs
parents:
diff changeset
   114
        /**
hgs
parents:
diff changeset
   115
        * Gets the name of the network group
hgs
parents:
diff changeset
   116
        * Ownership of the returned text is not passed.
hgs
parents:
diff changeset
   117
        * @return The name of the network group
hgs
parents:
diff changeset
   118
        *
hgs
parents:
diff changeset
   119
        * @deprecated
hgs
parents:
diff changeset
   120
        */
hgs
parents:
diff changeset
   121
        IMPORT_C const TDesC& Name() const;
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
        /**
hgs
parents:
diff changeset
   125
        * Gets the UID of this network group
hgs
parents:
diff changeset
   126
        * @return The UID of this network group
hgs
parents:
diff changeset
   127
        *
hgs
parents:
diff changeset
   128
        * @deprecated
hgs
parents:
diff changeset
   129
        */
hgs
parents:
diff changeset
   130
        IMPORT_C TUint32 Uid() const;
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
hgs
parents:
diff changeset
   133
hgs
parents:
diff changeset
   134
        /**
hgs
parents:
diff changeset
   135
        * Sets a UID of the network group.
hgs
parents:
diff changeset
   136
        * @param aUid a uid to set.
hgs
parents:
diff changeset
   137
        *
hgs
parents:
diff changeset
   138
        * @deprecated
hgs
parents:
diff changeset
   139
        */
hgs
parents:
diff changeset
   140
        IMPORT_C void SetUid( TUint32 aUid );
hgs
parents:
diff changeset
   141
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
        /**
hgs
parents:
diff changeset
   144
        * Sets the network name
hgs
parents:
diff changeset
   145
        * @param aName The name to set.
hgs
parents:
diff changeset
   146
        *
hgs
parents:
diff changeset
   147
        * @deprecated
hgs
parents:
diff changeset
   148
        */
hgs
parents:
diff changeset
   149
        IMPORT_C void SetNameL( const TDesC& aName );
hgs
parents:
diff changeset
   150
hgs
parents:
diff changeset
   151
hgs
parents:
diff changeset
   152
    private:    // Data
hgs
parents:
diff changeset
   153
        TUint32         iUid;           ///< The ID of the network group
hgs
parents:
diff changeset
   154
        HBufC*          iName;          ///< The name of the network group 
hgs
parents:
diff changeset
   155
hgs
parents:
diff changeset
   156
    };
hgs
parents:
diff changeset
   157
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
hgs
parents:
diff changeset
   160
#endif      // CAPNETWORKITEM_H
hgs
parents:
diff changeset
   161
hgs
parents:
diff changeset
   162
// End of File