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