TCapabilitySet Class Reference

#include <e32cmn.h>

class TCapabilitySet

Public Member Functions
	TCapabilitySet()
	TCapabilitySet(TCapability)
	TCapabilitySet(TCapability, TCapability)
IMPORT_C void	AddCapability(TCapability)
IMPORT_C TBool	HasCapabilities(const TCapabilitySet &)
IMPORT_C TBool	HasCapability(TCapability)
IMPORT_C void	Intersection(const TCapabilitySet &)
TBool	NotEmpty()
IMPORT_C void	Remove(const TCapabilitySet &)
IMPORT_C void	RemoveCapability(TCapability)
void	Set(TCapability)
void	Set(TCapability, TCapability)
IMPORT_C void	SetAllSupported()
IMPORT_C void	SetDisabled()
IMPORT_C void	SetEmpty()
IMPORT_C void	Union(const TCapabilitySet &)

Detailed Description

Class representing an arbitrary set of capabilities.

This class can only contain capabilities supported by the current OS version.

Constructor & Destructor Documentation

TCapabilitySet ( )

TCapabilitySet

(

)

[inline]

Default constructor. This leaves the set in an undefned state.

TCapabilitySet ( TCapability )

TCapabilitySet

(

TCapability

aCapability

)

[inline]

Construct a set consisting of a single capability.

Parameter	Description
aCapability	The single capability

TCapabilitySet ( TCapability, TCapability )

IMPORT_C	TCapabilitySet	(	TCapability	aCapability1,
			TCapability	aCapability2
		)

Construct a set consisting of two capabilities.

Parameter	Description
aCapability1	The first capability.
aCapability2	The second capability.

Member Function Documentation

AddCapability ( TCapability )

IMPORT_C void

AddCapability

(

TCapability

aCapability

)

Add a single capability to the set. If the capability is not supported by this OS version then it is not added and the set is left unchanged.

Parameter	Description
aCapability	Capability to add.

HasCapabilities ( const TCapabilitySet & )

IMPORT_C TBool

HasCapabilities

(

const TCapabilitySet &

aCapabilities

)

const

Test if all the capabilities in a given set are present in this set

Parameter	Description
aCapabilities	The capability set to test

Returns: A non-zero value if all the capabilities are present, zero otherwise.

HasCapability ( TCapability )

IMPORT_C TBool

HasCapability

(

TCapability

aCapability

)

const

Test if a single capability is present in the set. The capability ECapability_None is always treated as being present.

Parameter	Description
aCapability	The capability to test

Returns: 1 if the capability is present, 0 if it is not.

Intersection ( const TCapabilitySet & )

IMPORT_C void

Intersection

(

const TCapabilitySet &

aCapabilities

)

Perform an intersection of this capability set with another. The result replaces the content of 'this'.

Parameter	Description
aCapabilities	A capability set

NotEmpty ( )

TBool

NotEmpty

(

)

const

Remove ( const TCapabilitySet & )

IMPORT_C void

Remove

(

const TCapabilitySet &

aCapabilities

)

Remove a set of capabilities from this set.

Parameter	Description
aCapabilities	The set of capabilities to remove

RemoveCapability ( TCapability )

IMPORT_C void

RemoveCapability

(

TCapability

aCapability

)

Remove a single capability from the set, if it is present.

Parameter	Description
aCapability	Capability to remove.

Set ( TCapability )

void

Set

(

TCapability

aCapability

)

[inline]

Make this set consist of a single capability.

Parameter	Description
aCapability	The single capability.

Set ( TCapability, TCapability )

void	Set	(	TCapability	aCapability1,
			TCapability	aCapability2
		)	[inline]

Make this set consist of two capabilities.

Parameter	Description
aCapability1	The first capability.
aCapability2	The second capability.

SetAllSupported ( )

IMPORT_C void

SetAllSupported

(

)

Make this set consist of all capabilities supported by this OS version.

SetDisabled ( )

IMPORT_C void

SetDisabled

(

)

Make this set consist of the capabilities which are disabled on this platform.

SetEmpty ( )

IMPORT_C void

SetEmpty

(

)

Make this set empty. I.e. Containing no capabilities.

Union ( const TCapabilitySet & )

IMPORT_C void

Union

(

const TCapabilitySet &

aCapabilities

)

Perform a union of this capability set with another. The result replaces the content of 'this'.

Parameter	Description
aCapabilities	A cpability set