Collapse all Symbian^3 Application Developer Library

CCFContextSourceCommand Class Reference

class CCFContextSourceCommand : public CBase

Context source command interface that can be used, for example, to activate or deactivate context sources.

CFServices

Since: S60 5.0

Inherits from

CCFContextSourceCommand
- CBase

Public Member Functions
	~CCFContextSourceCommand ()
void	AddAttributeL ( CCFKeyValuePair *)
void	AddAttributesL ( RKeyValueArray &)
void	AddParameterL ( CCFContextSourceCommandParameter *)
const RKeyValueArray &	Attributes ()
CCFContextSourceCommand *	CloneL ()
void	ExternalizeL ( RWriteStream &)
void	InternalizeL ( RReadStream &)
const TDesC &	Name ()
IMPORT_C CCFContextSourceCommand *	NewL ()
IMPORT_C CCFContextSourceCommand *	NewLC ()
const RSourceCommandParameterArray &	Parameters ()
const TCFSourceCommandSenderId &	Sender ()
void	SetNameL (const TDesC &)
void	SetSender (const TCFSourceCommandSenderId &)
TInt	Size ()
TUid	SourceUid ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Constructor & Destructor Documentation

~CCFContextSourceCommand()

~CCFContextSourceCommand

(

)

[virtual]

C++ destructor.

Member Functions Documentation

AddAttributeL(CCFKeyValuePair *)

void

AddAttributeL

(

CCFKeyValuePair *

aAttribute

)

[pure virtual]

Adds new key value pair attribute for the command. Attribute's ownership is transferred.

Since: S60 5.0

Parameters

CCFKeyValuePair * aAttribute

Key value pair attribute. Ownership is transferred.

AddAttributesL(RKeyValueArray &)

void

AddAttributesL

(

RKeyValueArray &

aAttributes

)

[pure virtual]

Adds new key value pair attributes for the command. Ownership of the attributes conteined in the array is transferred.

Since: S60 5.0

Parameters

RKeyValueArray & aAttributes

Array of key value pair attributes. Ownership of the key value pairs (array content) is transferred. If a leave occurs the caller is responsible for the key value pairs left on the array.

AddParameterL(CCFContextSourceCommandParameter *)

void

AddParameterL

(

CCFContextSourceCommandParameter *

aParameter

)

[pure virtual]

Adds new parameter for the command. Parameter's ownership is transferred.

Since: S60 5.0

Parameters

CCFContextSourceCommandParameter * aParameter

Parameter for this command. Ownership is transferred.

Attributes()

const RKeyValueArray &

Attributes

(

)

const [pure virtual]

Returns context source command attributes.

Since: S60 5.0

CloneL()

CCFContextSourceCommand *

CloneL

(

)

const [pure virtual]

Returns a clone of this context source command.

Since: S60 5.0

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const [pure virtual]

Externalizes instance.

Since: S60 5.0

Parameters

RWriteStream & aStream

Write stream.

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

aStream

)

[pure virtual]

Internalizes instance.

Since: S60 5.0

Parameters

RReadStream & aStream

Read stream.

Name()

const TDesC &

Name

(

)

const [pure virtual]

Returns context source command name.

Since: S60 5.0

NewL()

IMPORT_C CCFContextSourceCommand *

NewL

(

)

[static]

Symbian two phased constructors.

Since: S60 5.0

NewLC()

IMPORT_C CCFContextSourceCommand *

NewLC

(

)

[static]

Parameters()

const RSourceCommandParameterArray &

Parameters

(

)

const [pure virtual]

Returns parameters related to the context source command.

Since: S60 5.0

Sender()

const TCFSourceCommandSenderId &

Sender

(

)

const [pure virtual]

Returns context source command sender identity.

Since: S60 5.0

SetNameL(const TDesC &)

void

SetNameL

(

const TDesC &

aName

)

[pure virtual]

Sets command name.

Since: S60 5.0

Parameters

const TDesC & aName

New command name.

SetSender(const TCFSourceCommandSenderId &)

void

SetSender

(

const TCFSourceCommandSenderId &

aSender

)

[pure virtual]

Sets context source command sender identity.

Since: S60 5.0

Parameters

const TCFSourceCommandSenderId & aSender

is the new sender identity for the command.

Size()

TInt

Size

(

)

const [pure virtual]

Returns instance size in bytes.

Since: S60 5.0

SourceUid()

TUid

SourceUid

(

)

const [pure virtual]

Returns uid of the context source who is the command target. Uid is taken from the first key value pair attribute whose key is uid.

Since: S60 5.0