Collapse all Symbian^3 Application Developer Library

TCapabilitySet Class Reference

class TCapabilitySet

Class representing an arbitrary set of capabilities.

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

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 &)

Private Attributes
TUint32	iCaps

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.

Parameters

TCapability aCapability

The single capability

TCapabilitySet(TCapability, TCapability)

IMPORT_C	TCapabilitySet	(	TCapability	aCapability1,
			TCapability	aCapability2
		)

Construct a set consisting of two capabilities.

Parameters

TCapability aCapability1	The first capability.
TCapability aCapability2	The second capability.

Member Functions 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. TCapabilitySet::SetAllSupported()

Parameters

TCapability 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

Parameters

const TCapabilitySet & aCapabilities

The capability set to test

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.

Parameters

TCapability aCapability

The capability to test

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'.

Parameters

const TCapabilitySet & 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.

Parameters

const TCapabilitySet & 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.

Parameters

TCapability aCapability

Capability to remove.

Set(TCapability)

void

Set

(

TCapability

aCapability

)

[inline]

Make this set consist of a single capability.

Parameters

TCapability aCapability

The single capability.

Set(TCapability, TCapability)

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

Make this set consist of two capabilities.

Parameters

TCapability aCapability1	The first capability.
TCapability 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'.

Parameters

const TCapabilitySet & aCapabilities

A cpability set

Member Data Documentation

TUint32 iCaps

TUint32

iCaps

[private]