ipcm_pub/access_point_engine_api/inc/ApNetworkItem.h
author Pat Downey <patd@symbian.org>
Wed, 01 Sep 2010 12:23:51 +0100
branchRCL_3
changeset 58 83ca720e2b9a
parent 57 05bc53fe583b
permissions -rw-r--r--
Revert incorrect RCL_3 drop: Revision: 201033 Kit: 201035

/*
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: 
*     Declaration of the CApNetworkItem class.
*
*/


#ifndef CAPNETWORKITEM_H
#define CAPNETWORKITEM_H

// Deprecation warning
#warning This header file has been deprecated. Will be removed in one of the next SDK releases.
 
 
//  INCLUDES
#include <commdb.h>
#include <ApEngineVer.h>
#include <ApEngineConsts.h>

// CLASS DECLARATION
/**
*  Representation of a Network item.
*/
NONSHARABLE_CLASS( CApNetworkItem ) :public CBase
                                         ///< This class is used to hold
                                         ///< the main information of a
                                         ///< Network item.
                                         ///< It is used in CApNetworks.
    {
    public:  // Constructors and destructor

        /**
        * Two-phased constructor. Leaves on failure, places instance
        * on cleanup stack.
        * @return The constructed CApNetworkItem.
        *
        * @deprecated
        */
        IMPORT_C static CApNetworkItem* NewLC();


        /**
        * Two-phased constructor. Leaves on failure, places instance
        * on cleanup stack.
        * @param aItem a pointer to a CApNetworkItem.
        * @return The constructed CApNetworkItem.
        *
        * @deprecated
        */
        IMPORT_C static CApNetworkItem* NewLC( CApNetworkItem* aItem );


        /**
        * Destructor.
        *
        * @deprecated
        */
        IMPORT_C virtual ~CApNetworkItem();


        /**
        * Copies the data from another CApNetworkItem
        * Substitutes the "Assignment operator."
        * @return No return value.
        *
        * @deprecated
        */
        IMPORT_C void CopyFromL( const CApNetworkItem& aCopyFrom );


    private:      // Constructors
        /**
        * C++ default constructor.
        *
        * @deprecated
        */
        IMPORT_C CApNetworkItem();


        /**
        * Second-phase constructor.
        * @param aUid The UID
        * @param aName The name
        *
        * @deprecated
        */
        IMPORT_C void ConstructL( TUint32 aUid,
                                  const TDesC& aName
                                  );


        /**
        * Second-phase constructor.
        *
        * @deprecated
        */
        IMPORT_C void ConstructL();


    public: // New functions

        /**
        * Gets the name of the network group
        * Ownership of the returned text is not passed.
        * @return The name of the network group
        *
        * @deprecated
        */
        IMPORT_C const TDesC& Name() const;


        /**
        * Gets the UID of this network group
        * @return The UID of this network group
        *
        * @deprecated
        */
        IMPORT_C TUint32 Uid() const;



        /**
        * Sets a UID of the network group.
        * @param aUid a uid to set.
        *
        * @deprecated
        */
        IMPORT_C void SetUid( TUint32 aUid );


        /**
        * Sets the network name
        * @param aName The name to set.
        *
        * @deprecated
        */
        IMPORT_C void SetNameL( const TDesC& aName );


    private:    // Data
        TUint32         iUid;           ///< The ID of the network group
        HBufC*          iName;          ///< The name of the network group 

    };



#endif      // CAPNETWORKITEM_H

// End of File