S60 3rd Edition API Reference: CApListItem Class Reference

CApListItem Class Reference

API published in: S60 1st Ed

Link against: apengine.lib

Capability Information

Required Capabilities

ReadDeviceData ReadUserData WriteDeviceData WriteUserData

Exceptions

none

#include <aplistitem.h>

Detailed Description

< This class is used to hold the main information of an access point.

It is used in CApSelect.


Public Member Functions

virtual IMPORT_C ~CApListItem ()
 Destructor.
IMPORT_C void CopyFromL (const CApListItem &aCopyFrom)
 Copies the data from another CApListItem Substitutes the "Assignment operator.".
IMPORT_C void SetItemL (TCommsDbIspType aIspType, TUint32 aUid, const TDesC &aName, TApBearerType aBearerType)
 NOTE: This function is deprecated, use the one with the additional aStartPage parameter below.
IMPORT_C void SetItemL (TCommsDbIspType aIspType, TUint32 aUid, const TDesC &aName, TApBearerType aBearerType, const TDesC &aStartpage)
 Sets item values of the access point.
IMPORT_C const TDesC & Name ()
 Gets the name of the 'current' access point Ownership of the returned text is not passed.
IMPORT_C TUint32 Uid ()
 Gets the UID of the current access point.
IMPORT_C TCommsDbIspType Type ()
 Gets the ISP-type of the current access point.
IMPORT_C TApBearerType BearerType ()
 Gets the bearer-type of the current access point.
IMPORT_C const TDesC & StartPage () const
 Returns the startpage of the current access point if any, otherwise, an empty string is returned.
IMPORT_C TBool IsReadOnly () const
 Returns whether the access point is read-only or not.
TBool IsVpnAp () const
 Returnes whether the given access point is a VPN ap or not.
void SetVpnFlag (TBool aIsVpn)
 Sets whether the given access point is a VPN ap or not.

Static Public Member Functions

static IMPORT_C CApListItem * NewLC ()
 Two-phased constructor.
static IMPORT_C CApListItem * NewLC (TCommsDbIspType aIspType, TUint32 aUid, const TDesC &aName, TApBearerType aBearerType)
 NOTE: This function is deprecated, use the one with the additional aStartPage parameter below.
static IMPORT_C CApListItem * NewLC (TCommsDbIspType aIspType, TUint32 aUid, const TDesC &aName, TApBearerType aBearerType, const TDesC &aStartPage, TBool aReadOnly=ETrue)
 Two-phased constructor.
static IMPORT_C CApListItem * NewLC (CApListItem *aItem)
 Two-phased constructor.

Protected Member Functions

IMPORT_C CApListItem ()
 C++ default constructor.
IMPORT_C void ConstructL (TCommsDbIspType aIspType, TUint32 aUid, const TDesC &aName, TApBearerType aBearerType)
 NOTE: This function is deprecated, use the one with the additional aStartPage parameter below.
IMPORT_C void ConstructL (TCommsDbIspType aIspType, TUint32 aUid, const TDesC &aName, TApBearerType aBearerType, const TDesC &aStartPage)
 Second-phase constructor.
IMPORT_C void ConstructL ()
 Second-phase constructor.
void CreateExtraL ()
 Construct the extra data.

Friends

class CApSelect
class TApListItemUidKey

Constructor & Destructor Documentation

virtual IMPORT_C CApListItem::~CApListItem (   )  [virtual]
 

Destructor.

IMPORT_C CApListItem::CApListItem (   )  [protected]
 

C++ default constructor.

Member Function Documentation

IMPORT_C TApBearerType CApListItem::BearerType (   ) 
 

Gets the bearer-type of the current access point.

Returns:
The bearer-type of the current access point.
IMPORT_C void CApListItem::ConstructL (   )  [protected]
 

Second-phase constructor.

IMPORT_C void CApListItem::ConstructL ( TCommsDbIspType  aIspType,
TUint32  aUid,
const TDesC &  aName,
TApBearerType  aBearerType,
const TDesC &  aStartPage
)  [protected]
 

Second-phase constructor.

Parameters:
aIspType The type of the access point (Internet only, Wap only, Internet AND Wap)
aUid The ID of the access point
aName The name of the access point
aBearerType The bearer type of the access point
aStartpage The starting page of the access point
IMPORT_C void CApListItem::ConstructL ( TCommsDbIspType  aIspType,
TUint32  aUid,
const TDesC &  aName,
TApBearerType  aBearerType
)  [protected]
 

NOTE: This function is deprecated, use the one with the additional aStartPage parameter below.

Second-phase constructor.

Parameters:
aIspType The type of the access point (Internet only, Wap only, Internet AND Wap)
aUid The ID of the access point
aName The name of the access point
aBearerType The bearer type of the access point
IMPORT_C void CApListItem::CopyFromL ( const CApListItem &  aCopyFrom  ) 
 

Copies the data from another CApListItem Substitutes the "Assignment operator.".

Returns:
No return value.
void CApListItem::CreateExtraL (   )  [protected]
 

Construct the extra data.

IMPORT_C TBool CApListItem::IsReadOnly (   )  const
 

Returns whether the access point is read-only or not.

Returns:
Whether the access point is read-only or not.
TBool CApListItem::IsVpnAp (   )  const
 

Returnes whether the given access point is a VPN ap or not.

Returns:
whether the given access point is a VPN ap or not.
IMPORT_C const TDesC& CApListItem::Name (   ) 
 

Gets the name of the 'current' access point Ownership of the returned text is not passed.

Returns:
The name of the current access point
static IMPORT_C CApListItem* CApListItem::NewLC ( CApListItem *  aItem  )  [static]
 

Two-phased constructor.

Leaves on failure, places instance on cleanup stack.

Parameters:
aItem a pointer to a CApListItem.
Returns:
The constructed CApListItem.
static IMPORT_C CApListItem* CApListItem::NewLC ( TCommsDbIspType  aIspType,
TUint32  aUid,
const TDesC &  aName,
TApBearerType  aBearerType,
const TDesC &  aStartPage,
TBool  aReadOnly = ETrue
)  [static]
 

Two-phased constructor.

Leaves on failure, places instance on cleanup stack.

Parameters:
aIspType The type of the access point (Internet only, Wap only, Internet AND Wap)
aUid The ID of the access point
aName The name of the access point
aBearerType The bearer type of the access point
aStartpage The starting page of the access point
aReadOnly Whether the given item is read-only or not
Returns:
The constructed CApListItem.
static IMPORT_C CApListItem* CApListItem::NewLC ( TCommsDbIspType  aIspType,
TUint32  aUid,
const TDesC &  aName,
TApBearerType  aBearerType
)  [static]
 

NOTE: This function is deprecated, use the one with the additional aStartPage parameter below.

Two-phased constructor. Leaves on failure, places instance on cleanup stack.

Parameters:
aIspType The type of the access point (Internet only, Wap only, Internet AND Wap)
aUid The ID of the access point
aName The name of the access point
aBearerType The bearer type of the access point
Returns:
The constructed CApListItem.
static IMPORT_C CApListItem* CApListItem::NewLC (   )  [static]
 

Two-phased constructor.

Leaves on failure, places instance on cleanup stack.

Returns:
The constructed CApListItem.
IMPORT_C void CApListItem::SetItemL ( TCommsDbIspType  aIspType,
TUint32  aUid,
const TDesC &  aName,
TApBearerType  aBearerType,
const TDesC &  aStartpage
) 
 

Sets item values of the access point.

Leaves on failure.

Parameters:
aIspType The type of the access point (Internet only, Wap only, Internet AND Wap)
aUid The ID of the access point
aName The name of the access point
aBearerType The bearer type of the access point
aStartpage The starting page of the access point
IMPORT_C void CApListItem::SetItemL ( TCommsDbIspType  aIspType,
TUint32  aUid,
const TDesC &  aName,
TApBearerType  aBearerType
) 
 

NOTE: This function is deprecated, use the one with the additional aStartPage parameter below.

Sets item values of the access point. Leaves on failure.

Parameters:
aIspType The type of the access point (Internet only, Wap only, Internet AND Wap)
aUid The ID of the access point
aName The name of the access point
aBearerType The bearer type of the access point
void CApListItem::SetVpnFlag ( TBool  aIsVpn  ) 
 

Sets whether the given access point is a VPN ap or not.

IMPORT_C const TDesC& CApListItem::StartPage (   )  const
 

Returns the startpage of the current access point if any, otherwise, an empty string is returned.

Ownership of the returned text is not passed.

Returns:
The startpage of the current access point.
IMPORT_C TCommsDbIspType CApListItem::Type (   ) 
 

Gets the ISP-type of the current access point.

Returns:
The ISP-type of the current access point.
IMPORT_C TUint32 CApListItem::Uid (   ) 
 

Gets the UID of the current access point.

Returns:
The UID of the current access point

Friends And Related Function Documentation

friend class CApSelect [friend]
 
friend class TApListItemUidKey [friend]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top