TFavouritesWapAp Class Reference

#include <mw/favouriteswapap.h>

Link against: favouritesengine.lib

class TFavouritesWapAp

Public Member Functions
	TFavouritesWapAp()
IMPORT_C TUint32	ApId()
void	ExternalizeL(RWriteStream &)
void	InternalizeL(RReadStream &)
IMPORT_C TBool	IsDefault()
IMPORT_C TBool	IsNull()
IMPORT_C void	SetApId(TUint32)
IMPORT_C void	SetDefault()
IMPORT_C void	SetNull()
IMPORT_C TFavouritesWapAp &	operator=(const TFavouritesWapAp &)
IMPORT_C TFavouritesWapAp &	operator=(TUint32)

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.

Constructor & Destructor Documentation

TFavouritesWapAp ( )

IMPORT_C

TFavouritesWapAp

(

)

C++ default constructor. Initializes to "Default".

Since: 0.9

Member Function Documentation

ApId ( )

IMPORT_C TUint32

ApId

(

)

const

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

Since: 0.9

Return Value: AP id.

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalize into a stream.

Since: 0.9

Parameters
aStream	The stream to externalize to.

Return Value: void

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aStream

)

Internalize from a stream.

Since: 0.9

Parameters
aStream	The stream to externalize from.

IsDefault ( )

IMPORT_C TBool

IsDefault

(

)

const

Check if value is "Default".

Since: 0.9

Return Value: ETrue if value is "Default".

IsNull ( )

IMPORT_C TBool

IsNull

(

)

const

Check if value is unset.

Since: 0.9

Return Value: ETrue if value is unset.

SetApId ( TUint32 )

IMPORT_C void

SetApId

(

TUint32

aApId

)

Set value. "Null" and "Default" properties cleared.

Since: 0.9

Parameters
aApId	AP id to set.

Return Value: void

SetDefault ( )

IMPORT_C void

SetDefault

(

)

Set value is "Default". Any previous value is lost.

Since: 0.9

Return Value: void

SetNull ( )

IMPORT_C void

SetNull

(

)

Set value is unset. Any previous value is lost.

Since: 0.9

Return Value: void

operator= ( const TFavouritesWapAp & )

IMPORT_C TFavouritesWapAp &

operator=

(

const TFavouritesWapAp &

aAp

)

Assignment operator (from another TFavouritesWapAp).

Since: 0.9

Parameters
aAp	AP to assign from.

Return Value: TFavouritesWapAp

operator= ( TUint32 )

IMPORT_C TFavouritesWapAp &

operator=

(

TUint32

aApId

)

Assignment operator (from TUint32). "Null" and "Default" properties cleared.

Since: 0.9

Parameters
aApId	AP id to assign from.

Return Value: TFavouritesWapAp