Collapse all Symbian^3 Application Developer Library

CCollection Class Reference

class CCollection : public CBase

Collection of HID report descriptor A CCollection represents an individual collection within a HID report descriptor. Each collection may have a number of associated report fields ( CField objects) and a number of child collection objects. The collections within a HID report descriptor form a tree structure, with a CReportRoot collection at the root. The tree is generated by CParser .

generichid.lib

Since: S60 v5.0

Inherits from

CCollection
- CBase

Public Member Functions
	~CCollection ()
CCollection *	AddCollectionL ()
CField *	AddFieldL ()
IMPORT_C const CCollection *	CollectionByIndex ( TInt )
IMPORT_C TInt	CollectionCount ()
IMPORT_C const CField *	FieldByIndex ( TInt )
IMPORT_C TInt	FieldCount ()
IMPORT_C TBool	IsApplication ()
IMPORT_C TBool	IsLogical ()
IMPORT_C TBool	IsNamedArray ()
IMPORT_C TBool	IsPhysical ()
IMPORT_C TBool	IsReport ()
IMPORT_C TBool	IsUsageModifier ()
IMPORT_C TBool	IsUsageSwitch ()
CCollection *	NewL ()
CCollection *	NewLC ()
void	SetType ( TUint32 )
void	SetUsage ( TInt )
void	SetUsagePage ( TInt )
IMPORT_C TUint32	Type ()
IMPORT_C TInt	Usage ()
IMPORT_C TInt	UsagePage ()

Protected Member Functions
	CCollection ()
void	ConstructL ()

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

Public Member Enumerations
enum	TType { EPhysical = 0x00, EApplication = 0x01, ELogical = 0x02, EReport = 0x03, ENamedArray = 0x04, EUsageSwitch = 0x05, EUsageModifier = 0x06 }

Private Attributes
RPointerArray < CCollection >	iCollections
RPointerArray < CField >	iFields
TUint32	iType
TInt	iUsage
TInt	iUsagePage

Constructor & Destructor Documentation

CCollection()

CCollection

(

)

[protected]

~CCollection()

~CCollection

(

)

[virtual]

Destructor.

Member Functions Documentation

AddCollectionL()

CCollection *

AddCollectionL

(

)

Called when a new collection object has been encountered in the report descriptor. This creates a new CCollection object and adds it to the current list

Since: S60 v5.0

AddFieldL()

CField *

AddFieldL

(

)

Called when a new field object has been encountered in the report descriptor. This creates a new field object and adds it the the current list

Since: S60 v5.0

CollectionByIndex(TInt)

IMPORT_C const CCollection *

CollectionByIndex

(

TInt

aIndex

)

const

Returns a pointer to a specific collection from the list of collections

Since: S60 v5.0

Parameters

TInt aIndex

The index of the required collection

CollectionCount()

IMPORT_C TInt

CollectionCount

(

)

const

Get number of collections

Since: S60 v5.0

ConstructL()

void

ConstructL

(

)

[protected]

FieldByIndex(TInt)

IMPORT_C const CField *

FieldByIndex

(

TInt

aIndex

)

const

Returns a pointer to the field object at the given index within the field list

Since: S60 v5.0

Parameters

TInt aIndex

The offset within the current field list

FieldCount()

IMPORT_C TInt

FieldCount

(

)

const

Gets numbers of field stored in collection

Since: S60 v5.0

IsApplication()

IMPORT_C TBool

IsApplication

(

)

const

Check if collection type is application

Since: S60 v5.0

IsLogical()

IMPORT_C TBool

IsLogical

(

)

const

Check if collection type is logical

Since: S60 v5.0

IsNamedArray()

IMPORT_C TBool

IsNamedArray

(

)

const

Check if collection type is name array

Since: S60 v5.0

IsPhysical()

IMPORT_C TBool

IsPhysical

(

)

const

Check if collection type is physical

Since: S60 v5.0

IsReport()

IMPORT_C TBool

IsReport

(

)

const

Check if collection type is report

Since: S60 v5.0

IsUsageModifier()

IMPORT_C TBool

IsUsageModifier

(

)

const

Check if collection type is usage modifier

Since: S60 v5.0

IsUsageSwitch()

IMPORT_C TBool

IsUsageSwitch

(

)

const

Check if collection type is usage switch

Since: S60 v5.0

NewL()

CCollection *

NewL

(

)

[static]

NewLC()

CCollection *

NewLC

(

)

[static]

SetType(TUint32)

void

SetType

(

TUint32

aType

)

Set Collection type

Since: S60 v5.0

Parameters

TUint32 aType

SetUsage(TInt)

void

SetUsage

(

TInt

aUsage

)

Set usage

Since: S60 v5.0

Parameters

TInt aUsage

SetUsagePage(TInt)

void

SetUsagePage

(

TInt

aUsagePage

)

Set usage page

Since: S60 v5.0

Parameters

TInt aUsagePage

Type()

IMPORT_C TUint32

Type

(

)

const

Get collection type

Since: S60 v5.0

Usage()

IMPORT_C TInt

Usage

(

)

const

Get usagepage

Since: S60 v5.0

UsagePage()

IMPORT_C TInt

UsagePage

(

)

const

Get usagepage

Since: S60 v5.0

Member Enumerations Documentation

Enum TType

An enumerations giving the possible types of collection, as given in "USB Device Class Definition for Human Interface Devices (HID)", Firmware Specification, Version 1.11, USB Implementers' Forum, June 2001.

Note that a TUint32 is used for CCollection::iType , as it is possible to have a vendor defined collection type that isn't included in this list.