TFavouritesWapAp Class Reference

API published in: S60 1st Ed

Link against: favouritesengine.lib

Capability Information

Required Capabilities

ReadUserData WriteUserData

#include <favouriteswapap.h>

Detailed Description

TFavouritesWapAp is the representation one the Access Point used in favourites.

In addition to the AP Uid-s an item may hold "Use default" and "Unset/Null" values.


Public Member Functions
IMPORT_C	TFavouritesWapAp ()
	C++ default constructor.
IMPORT_C TFavouritesWapAp &	operator= (const TFavouritesWapAp &aAp)
	Assignment operator (from another TFavouritesWapAp).
IMPORT_C TFavouritesWapAp &	operator= (TUint32 aApId)
	Assignment operator (from TUint32).
IMPORT_C void	SetNull ()
	Set value is unset.
IMPORT_C void	SetDefault ()
	Set value is "Default".
IMPORT_C void	SetApId (TUint32 aApId)
	Set value.
IMPORT_C TBool	IsNull () const
	Check if value is unset.
IMPORT_C TBool	IsDefault () const
	Check if value is "Default".
IMPORT_C TUint32	ApId () const
	Get the AP id.
void	ExternalizeL (RWriteStream &aStream) const
	Externalize into a stream.
void	InternalizeL (RReadStream &aStream)
	Internalize from a stream.
Friends
class	RFavouritesSrvTable
	RFavouritesTable writes this into database.

Constructor & Destructor Documentation

IMPORT_C TFavouritesWapAp::TFavouritesWapAp

(

)

C++ default constructor.

Initializes to "Default".

Member Function Documentation

IMPORT_C TUint32 TFavouritesWapAp::ApId

(

)

const

Get the AP id.

If the value is "Null" or "Default", this method panics. Check those before calling this method!

Returns:: AP id.

void TFavouritesWapAp::ExternalizeL

(

RWriteStream &

aStream

)

const

Externalize into a stream.

Parameters:

aStream

The stream to externalize to.

Returns:: void

void TFavouritesWapAp::InternalizeL

(

RReadStream &

aStream

)

Internalize from a stream.

Parameters:

aStream

The stream to externalize from.

IMPORT_C TBool TFavouritesWapAp::IsDefault

(

)

const

Check if value is "Default".

Returns:: ETrue if value is "Default".

IMPORT_C TBool TFavouritesWapAp::IsNull

(

)

const

Check if value is unset.

Returns:: ETrue if value is unset.

IMPORT_C TFavouritesWapAp& TFavouritesWapAp::operator=

(

TUint32

aApId

)

Assignment operator (from TUint32).

"Null" and "Default" properties cleared.

Parameters:

aApId

AP id to assign from.

Returns:: TFavouritesWapAp

IMPORT_C TFavouritesWapAp& TFavouritesWapAp::operator=

(

const TFavouritesWapAp &

aAp

)

Assignment operator (from another TFavouritesWapAp).

Parameters:

aAp

AP to assign from.

Returns:: TFavouritesWapAp

IMPORT_C void TFavouritesWapAp::SetApId

(

TUint32

aApId

)

Set value.

"Null" and "Default" properties cleared.

Parameters:

aApId

AP id to set.

Returns:: void

IMPORT_C void TFavouritesWapAp::SetDefault

(

)

Set value is "Default".

Any previous value is lost.

Returns:: void

IMPORT_C void TFavouritesWapAp::SetNull

(

)

Set value is unset.

Any previous value is lost.

Returns:: void

Friends And Related Function Documentation

friend class RFavouritesSrvTable [friend]

RFavouritesTable writes this into database.

The documentation for this class was generated from the following file:

favouriteswapap.h

TFavouritesWapAp Class Reference

Capability Information

Detailed Description

Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation