TCapabilitySet Class Reference

Class representing an arbitrary set of capabilities. More...

#include <e32cmn.h>

Public Member Functions
	TCapabilitySet ()
	Default constructor.
	TCapabilitySet (TCapability aCapability)
	Construct a set consisting of a single capability.
IMPORT_C	TCapabilitySet (TCapability aCapability1, TCapability aCapability2)
	Construct a set consisting of two capabilities.
IMPORT_C void	SetEmpty ()
	Make this set empty.
void	Set (TCapability aCapability)
	Make this set consist of a single capability.
void	Set (TCapability aCapability1, TCapability aCapability2)
	Make this set consist of two capabilities.
IMPORT_C void	SetAllSupported ()
	Make this set consist of all capabilities supported by this OS version.
IMPORT_C void	AddCapability (TCapability aCapability)
	Add a single capability to the set.
IMPORT_C void	RemoveCapability (TCapability aCapability)
	Remove a single capability from the set, if it is present.
IMPORT_C void	Union (const TCapabilitySet &aCapabilities)
	Perform a union of this capability set with another.
IMPORT_C void	Intersection (const TCapabilitySet &aCapabilities)
	Perform an intersection of this capability set with another.
IMPORT_C void	Remove (const TCapabilitySet &aCapabilities)
	Remove a set of capabilities from this set.
IMPORT_C TBool	HasCapability (TCapability aCapability) const
	Test if a single capability is present in the set.
IMPORT_C TBool	HasCapabilities (const TCapabilitySet &aCapabilities) const
	Test if all the capabilities in a given set are present in this set.
IMPORT_C void	SetDisabled ()
TBool	NotEmpty () const

Detailed Description

Class representing an arbitrary set of capabilities.

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

API status

Published to all clients. Released API.

Definition at line 3615 of file e32cmn.h.

Constructor & Destructor Documentation

TCapabilitySet() [1/3]

TCapabilitySet::TCapabilitySet ( )

inline

Default constructor.

This leaves the set in an undefned state.

(generated from Symbian Developer Library)

TCapabilitySet() [2/3]

TCapabilitySet::TCapabilitySet ( TCapability  aCapability )

inline

Construct a set consisting of a single capability.

Parameters

aCapability

The single capability

(generated from Symbian Developer Library)

TCapabilitySet() [3/3]

IMPORT_C TCapabilitySet::TCapabilitySet	(	TCapability	aCapability1,
		TCapability	aCapability2
	)

Construct a set consisting of two capabilities.

Parameters

aCapability1	The first capability.
aCapability2	The second capability.

(generated from Symbian Developer Library)

Member Function Documentation

AddCapability()

IMPORT_C void TCapabilitySet::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

aCapability

Capability to add.

(generated from Symbian Developer Library)

HasCapabilities()

IMPORT_C TBool TCapabilitySet::HasCapabilities

(

const TCapabilitySet &

aCapabilities

)

const

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

Parameters

aCapabilities

The capability set to test

(generated from Symbian Developer Library)

HasCapability()

IMPORT_C TBool TCapabilitySet::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

aCapability

The capability to test

(generated from Symbian Developer Library)

Intersection()

IMPORT_C void TCapabilitySet::Intersection

(

const TCapabilitySet &

aCapabilities

)

Perform an intersection of this capability set with another.

The result replaces the content of 'this'.

Parameters

aCapabilities

A capability set

(generated from Symbian Developer Library)

NotEmpty()

TBool TCapabilitySet::NotEmpty

(

)

const

API status

Internal component API.

Remove()

IMPORT_C void TCapabilitySet::Remove

(

const TCapabilitySet &

aCapabilities

)

Remove a set of capabilities from this set.

Parameters

aCapabilities

The set of capabilities to remove

(generated from Symbian Developer Library)

RemoveCapability()

IMPORT_C void TCapabilitySet::RemoveCapability

(

TCapability

aCapability

)

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

Parameters

aCapability

Capability to remove.

(generated from Symbian Developer Library)

Set() [1/2]

void TCapabilitySet::Set ( TCapability  aCapability )

inline

Make this set consist of a single capability.

Parameters

aCapability

The single capability.

(generated from Symbian Developer Library)

Set() [2/2]

void TCapabilitySet::Set ( TCapability  aCapability1, TCapability  aCapability2  )

inline

Make this set consist of two capabilities.

Parameters

aCapability1	The first capability.
aCapability2	The second capability.

(generated from Symbian Developer Library)

SetAllSupported()

IMPORT_C void TCapabilitySet::SetAllSupported

(

)

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

(generated from Symbian Developer Library)

SetDisabled()

IMPORT_C void TCapabilitySet::SetDisabled

(

)

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

API status

Internal technology API.

SetEmpty()

IMPORT_C void TCapabilitySet::SetEmpty

(

)

Make this set empty.

I.e. Containing no capabilities.

(generated from Symbian Developer Library)

Union()

IMPORT_C void TCapabilitySet::Union

(

const TCapabilitySet &

aCapabilities

)

Perform a union of this capability set with another.

The result replaces the content of 'this'.

Parameters

aCapabilities

A cpability set

(generated from Symbian Developer Library)

---

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

• e32cmn.h
• e32cmn.h.dox