epoc32/include/mw/apnetworks.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     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 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:  Declaration of the CApNetworks class.
    15 *
    16 */
    17 
    18 
    19 #ifndef CAPNETWORKS_H
    20 #define CAPNETWORKS_H
    21 
    22 // Deprecation warning
    23 #warning This header file has been deprecated. Will be removed in one of the next SDK releases.
    24  
    25  
    26 //  INCLUDES
    27 #include <commdb.h>
    28 #include <ApEngineVer.h>
    29 #include <ApEngineConsts.h>
    30 
    31 // FORWARD DECLARATIONS
    32 class CApNetworkItem;
    33 class CApNetworkItemList;
    34 
    35 // CLASS DECLARATION
    36 
    37 /**
    38 *  This class is used to help client's network selection.
    39 *
    40 */
    41 NONSHARABLE_CLASS( CApNetworks ) :public CBase
    42     {
    43     public:  // Constructors and destructor
    44 
    45         /**
    46         * Two-phased constructor. Leaves on failure, places instance
    47         * on cleanup stack.
    48         * @param aDb a reference to a CCommsDataBase.
    49         * @return The constructed CApNetworks.
    50         *
    51         * @deprecated
    52         */
    53         IMPORT_C static CApNetworks* NewLC( CCommsDatabase& aDb );
    54 
    55 
    56         /**
    57         * Destructor.
    58         *
    59         * @deprecated
    60         */
    61         IMPORT_C virtual ~CApNetworks();
    62 
    63 
    64     private:      // Constructors
    65 
    66         /**
    67         * C++ default constructor.
    68         *
    69         * @deprecated
    70         */
    71         IMPORT_C CApNetworks();
    72 
    73         /**
    74         * Second-phase constructor.
    75         * @param aDb The database
    76         *
    77         * @deprecated
    78         */
    79         IMPORT_C void ConstructL( CCommsDatabase& aDb );
    80 
    81 
    82 
    83     public: // New functions
    84 
    85         /**
    86         * Counts the items in the list
    87         * @return The number of items in the list.
    88         *
    89         * @deprecated
    90         */
    91         IMPORT_C TUint32 Count() const;
    92 
    93 
    94         /**
    95         * Gets the name of the network group with the given UID
    96         * Ownership of the returned text is not passed.
    97         * @param aUid The uid of the network item 
    98         * @return The name of the network group
    99         *
   100         * @deprecated
   101         */
   102         IMPORT_C const TDesC& NameL( TUint32 aUid ) const;
   103 
   104 
   105 
   106         /**
   107         * Provides all data in a CApNetworkItemList array.
   108         * @param aList A reference to a CApNetworkItemList object
   109         * to hold the values.
   110         * @return The number of items in the list.
   111         * All elements in the aList array and their memory
   112         * will be freed inside the routine.
   113         * The routine expands or shrinks the array as necessary
   114         * to minimize memory consumption.
   115         *
   116         * @deprecated
   117         */
   118         IMPORT_C TInt AllListItemDataL( CApNetworkItemList& aList );
   119 
   120 
   121     private:
   122         /**
   123         * This function updates the member data according to the
   124         * current filter settings.
   125         * @return Error code.
   126         */
   127         TInt DoUpdateL();
   128 
   129 
   130 
   131     private:    // Data
   132         CCommsDatabase*             iDb;    // Does not own it!
   133         CApNetworkItemList*         iApList;
   134         TInt                        iCount;
   135     };
   136 
   137 #endif      // CAPNETWORKS_H
   138 
   139 // End of File