epoc32/include/mw/apnetworkitem.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002 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@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.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: 
williamr@2
    15
*     Declaration of the CApNetworkItem class.
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
#ifndef CAPNETWORKITEM_H
williamr@2
    21
#define CAPNETWORKITEM_H
williamr@2
    22
williamr@2
    23
// Deprecation warning
williamr@2
    24
#warning This header file has been deprecated. Will be removed in one of the next SDK releases.
williamr@2
    25
 
williamr@2
    26
 
williamr@2
    27
//  INCLUDES
williamr@2
    28
#include <commdb.h>
williamr@2
    29
#include <ApEngineVer.h>
williamr@2
    30
#include <ApEngineConsts.h>
williamr@2
    31
williamr@2
    32
// CLASS DECLARATION
williamr@2
    33
/**
williamr@2
    34
*  Representation of a Network item.
williamr@2
    35
*/
williamr@2
    36
NONSHARABLE_CLASS( CApNetworkItem ) :public CBase
williamr@2
    37
                                         ///< This class is used to hold
williamr@2
    38
                                         ///< the main information of a
williamr@2
    39
                                         ///< Network item.
williamr@2
    40
                                         ///< It is used in CApNetworks.
williamr@2
    41
    {
williamr@2
    42
    public:  // Constructors and destructor
williamr@2
    43
williamr@2
    44
        /**
williamr@2
    45
        * Two-phased constructor. Leaves on failure, places instance
williamr@2
    46
        * on cleanup stack.
williamr@2
    47
        * @return The constructed CApNetworkItem.
williamr@2
    48
        *
williamr@2
    49
        * @deprecated
williamr@2
    50
        */
williamr@2
    51
        IMPORT_C static CApNetworkItem* NewLC();
williamr@2
    52
williamr@2
    53
williamr@2
    54
        /**
williamr@2
    55
        * Two-phased constructor. Leaves on failure, places instance
williamr@2
    56
        * on cleanup stack.
williamr@2
    57
        * @param aItem a pointer to a CApNetworkItem.
williamr@2
    58
        * @return The constructed CApNetworkItem.
williamr@2
    59
        *
williamr@2
    60
        * @deprecated
williamr@2
    61
        */
williamr@2
    62
        IMPORT_C static CApNetworkItem* NewLC( CApNetworkItem* aItem );
williamr@2
    63
williamr@2
    64
williamr@2
    65
        /**
williamr@2
    66
        * Destructor.
williamr@2
    67
        *
williamr@2
    68
        * @deprecated
williamr@2
    69
        */
williamr@2
    70
        IMPORT_C virtual ~CApNetworkItem();
williamr@2
    71
williamr@2
    72
williamr@2
    73
        /**
williamr@2
    74
        * Copies the data from another CApNetworkItem
williamr@2
    75
        * Substitutes the "Assignment operator."
williamr@2
    76
        * @return No return value.
williamr@2
    77
        *
williamr@2
    78
        * @deprecated
williamr@2
    79
        */
williamr@2
    80
        IMPORT_C void CopyFromL( const CApNetworkItem& aCopyFrom );
williamr@2
    81
williamr@2
    82
williamr@2
    83
    private:      // Constructors
williamr@2
    84
        /**
williamr@2
    85
        * C++ default constructor.
williamr@2
    86
        *
williamr@2
    87
        * @deprecated
williamr@2
    88
        */
williamr@2
    89
        IMPORT_C CApNetworkItem();
williamr@2
    90
williamr@2
    91
williamr@2
    92
        /**
williamr@2
    93
        * Second-phase constructor.
williamr@2
    94
        * @param aUid The UID
williamr@2
    95
        * @param aName The name
williamr@2
    96
        *
williamr@2
    97
        * @deprecated
williamr@2
    98
        */
williamr@2
    99
        IMPORT_C void ConstructL( TUint32 aUid,
williamr@2
   100
                                  const TDesC& aName
williamr@2
   101
                                  );
williamr@2
   102
williamr@2
   103
williamr@2
   104
        /**
williamr@2
   105
        * Second-phase constructor.
williamr@2
   106
        *
williamr@2
   107
        * @deprecated
williamr@2
   108
        */
williamr@2
   109
        IMPORT_C void ConstructL();
williamr@2
   110
williamr@2
   111
williamr@2
   112
    public: // New functions
williamr@2
   113
williamr@2
   114
        /**
williamr@2
   115
        * Gets the name of the network group
williamr@2
   116
        * Ownership of the returned text is not passed.
williamr@2
   117
        * @return The name of the network group
williamr@2
   118
        *
williamr@2
   119
        * @deprecated
williamr@2
   120
        */
williamr@2
   121
        IMPORT_C const TDesC& Name() const;
williamr@2
   122
williamr@2
   123
williamr@2
   124
        /**
williamr@2
   125
        * Gets the UID of this network group
williamr@2
   126
        * @return The UID of this network group
williamr@2
   127
        *
williamr@2
   128
        * @deprecated
williamr@2
   129
        */
williamr@2
   130
        IMPORT_C TUint32 Uid() const;
williamr@2
   131
williamr@2
   132
williamr@2
   133
williamr@2
   134
        /**
williamr@2
   135
        * Sets a UID of the network group.
williamr@2
   136
        * @param aUid a uid to set.
williamr@2
   137
        *
williamr@2
   138
        * @deprecated
williamr@2
   139
        */
williamr@2
   140
        IMPORT_C void SetUid( TUint32 aUid );
williamr@2
   141
williamr@2
   142
williamr@2
   143
        /**
williamr@2
   144
        * Sets the network name
williamr@2
   145
        * @param aName The name to set.
williamr@2
   146
        *
williamr@2
   147
        * @deprecated
williamr@2
   148
        */
williamr@2
   149
        IMPORT_C void SetNameL( const TDesC& aName );
williamr@2
   150
williamr@2
   151
williamr@2
   152
    private:    // Data
williamr@2
   153
        TUint32         iUid;           ///< The ID of the network group
williamr@2
   154
        HBufC*          iName;          ///< The name of the network group 
williamr@2
   155
williamr@2
   156
    };
williamr@2
   157
williamr@2
   158
williamr@2
   159
williamr@2
   160
#endif      // CAPNETWORKITEM_H
williamr@2
   161
williamr@2
   162
// End of File