Symbian^3 Application Developer Library >

CField Class Reference

class CField : public CBase

HID report field presentation Represents an individual field in a HID report, ie. the attributes of an input, output or feature Main item defined in the HID report descriptor.

The CField contains information such as the usage IDs sent in the the report, the type of the report (input, output or feature) and the logical range.

generichid.lib
Since
S60 v5.0

Inherits from

Public Member Functions
~CField ()
IMPORT_C void AddUsageL ( TInt )
IMPORT_C TUint32 Attributes ()
IMPORT_C void ClearUsageList ()
IMPORT_C TInt Count ()
IMPORT_C TInt DesignatorIndex ()
IMPORT_C TInt DesignatorMax ()
IMPORT_C TInt DesignatorMin ()
IMPORT_C TBool HasUsage ( TInt )
IMPORT_C TBool IsArray ()
IMPORT_C TBool IsConstant ()
IMPORT_C TBool IsData ()
IMPORT_C TBool IsFeature ()
IMPORT_C TBool IsInReport ( TInt )
IMPORT_C TBool IsInput ()
IMPORT_C TBool IsOutput ()
IMPORT_C TBool IsVariable ()
IMPORT_C TInt LastUsage ()
IMPORT_C TInt LogicalMax ()
IMPORT_C TInt LogicalMin ()
CField * NewL ()
CField * NewLC ()
IMPORT_C TInt Offset ()
IMPORT_C TInt PhysicalMax ()
IMPORT_C TInt PhysicalMin ()
IMPORT_C TInt ReportId ()
IMPORT_C void SetAttributes ( TUint32 )
IMPORT_C void SetCount ( TInt )
IMPORT_C void SetDesignatorIndex ( TInt )
IMPORT_C void SetDesignatorMax ( TInt )
IMPORT_C void SetDesignatorMin ( TInt )
IMPORT_C void SetDesignatorRange ( TInt , TInt )
IMPORT_C void SetLogicalMax ( TInt )
IMPORT_C void SetLogicalMin ( TInt )
IMPORT_C void SetLogicalRange ( TInt , TInt )
IMPORT_C void SetOffset ( TInt )
IMPORT_C void SetPhysicalMax ( TInt )
IMPORT_C void SetPhysicalMin ( TInt )
IMPORT_C void SetPhysicalRange ( TInt , TInt )
IMPORT_C void SetReportId ( TInt )
IMPORT_C void SetSize ( TInt )
IMPORT_C void SetStringIndex ( TInt )
IMPORT_C void SetStringMax ( TInt )
IMPORT_C void SetStringMin ( TInt )
IMPORT_C void SetStringRange ( TInt , TInt )
IMPORT_C void SetType (const TType &)
IMPORT_C void SetUnit ( TInt )
IMPORT_C void SetUnitExponent ( TInt )
IMPORT_C void SetUsageMax ( TInt )
IMPORT_C void SetUsageMin ( TInt )
IMPORT_C void SetUsagePage ( TInt )
IMPORT_C void SetUsageRange ( TInt , TInt )
IMPORT_C TInt Size ()
IMPORT_C TInt StringIndex ()
IMPORT_C TInt StringMax ()
IMPORT_C TInt StringMin ()
IMPORT_C TType Type ()
IMPORT_C TInt Unit ()
IMPORT_C TInt UnitExponent ()
IMPORT_C TInt Usage ( TInt )
IMPORT_C TArray < TInt > UsageArray ()
IMPORT_C TInt UsageCount ()
IMPORT_C TInt UsageMax ()
IMPORT_C TInt UsageMin ()
IMPORT_C TInt UsagePage ()
Private Member Functions
CField ()
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 { EInput , EOutput , EFeature }
Private Attributes
TUint32 iAttributes
TInt iCount
TInt iDesignatorIndex
TInt iDesignatorMax
TInt iDesignatorMin
TInt iLogicalMax
TInt iLogicalMin
TInt iPhysicalMax
TInt iPhysicalMin
TInt iPos
TInt iReportId
TInt iSize
TInt iStringIndex
TInt iStringMax
TInt iStringMin
TType iType
TInt iUnit
TInt iUnitExponent
RArray < TInt > iUsageList
TInt iUsageMax
TInt iUsageMin
TInt iUsagePage

Constructor & Destructor Documentation

CField()

CField ( ) [private]

~CField()

~CField ( ) [virtual]

Destructor.

Member Functions Documentation

AddUsageL(TInt)

IMPORT_C void AddUsageL ( TInt aUsage )

Add usage

Since
S60 v5.0

Parameters

TInt aUsage usage to be added

Attributes()

IMPORT_C TUint32 Attributes ( ) const

Return attributes

Since
S60 v5.0

ClearUsageList()

IMPORT_C void ClearUsageList ( )

Clear usage list

Since
S60 v5.0

Count()

IMPORT_C TInt Count ( ) const

Return count

Since
S60 v5.0

DesignatorIndex()

IMPORT_C TInt DesignatorIndex ( ) const

Return Designator index

Since
S60 v5.0

DesignatorMax()

IMPORT_C TInt DesignatorMax ( ) const

Return designator maximium

Since
S60 v5.0

DesignatorMin()

IMPORT_C TInt DesignatorMin ( ) const

Return designator minimium

Since
S60 v5.0

HasUsage(TInt)

IMPORT_C TBool HasUsage ( TInt aUsage ) const

Check if usage exsist

Since
S60 v5.0

Parameters

TInt aUsage Usage id

IsArray()

IMPORT_C TBool IsArray ( ) const

Return array status

Since
S60 v5.0

IsConstant()

IMPORT_C TBool IsConstant ( ) const

Return constant status

Since
S60 v5.0

IsData()

IMPORT_C TBool IsData ( ) const

Return data status

Since
S60 v5.0

IsFeature()

IMPORT_C TBool IsFeature ( ) const

Return feature status

Since
S60 v5.0

IsInReport(TInt)

IMPORT_C TBool IsInReport ( TInt aReportId ) const

Check if reportid is in report

Since
S60 v5.0

Parameters

TInt aReportId report id

IsInput()

IMPORT_C TBool IsInput ( ) const

Return input status

Since
S60 v5.0

IsOutput()

IMPORT_C TBool IsOutput ( ) const

Return output status

Since
S60 v5.0

IsVariable()

IMPORT_C TBool IsVariable ( ) const

Return variable status

Since
S60 v5.0

LastUsage()

IMPORT_C TInt LastUsage ( ) const

Return last usage

Since
S60 v5.0

LogicalMax()

IMPORT_C TInt LogicalMax ( ) const

Return logical maximum

Since
S60 v5.0

LogicalMin()

IMPORT_C TInt LogicalMin ( ) const

Return logical minimium

Since
S60 v5.0

NewL()

CField * NewL ( ) [static]

NewLC()

CField * NewLC ( ) [static]

Offset()

IMPORT_C TInt Offset ( ) const

Return offset

Since
S60 v5.0

PhysicalMax()

IMPORT_C TInt PhysicalMax ( ) const

Return Physical max

Since
S60 v5.0

PhysicalMin()

IMPORT_C TInt PhysicalMin ( ) const

Return Physical minimum

Since
S60 v5.0

ReportId()

IMPORT_C TInt ReportId ( ) const

Return report id

Since
S60 v5.0

SetAttributes(TUint32)

IMPORT_C void SetAttributes ( TUint32 aAttributes )

Set attributes

Since
S60 v5.0

Parameters

TUint32 aAttributes attributes to be set

SetCount(TInt)

IMPORT_C void SetCount ( TInt aCount )

Set count

Since
S60 v5.0

Parameters

TInt aCount Count to be set

SetDesignatorIndex(TInt)

IMPORT_C void SetDesignatorIndex ( TInt aValue )

Set Designator index

Since
S60 v5.0

Parameters

TInt aValue Designator index value

SetDesignatorMax(TInt)

IMPORT_C void SetDesignatorMax ( TInt aValue )

Set designator maximium value

Since
S60 v5.0

Parameters

TInt aValue designator maximium value

SetDesignatorMin(TInt)

IMPORT_C void SetDesignatorMin ( TInt aValue )

Set designator minimium

Since
S60 v5.0

Parameters

TInt aValue designator minimum value

SetDesignatorRange(TInt, TInt)

IMPORT_C void SetDesignatorRange ( TInt aMin,
TInt aMax
)

Set designator range

Since
S60 v5.0

Parameters

TInt aMin designator range minimium value
TInt aMax designator range maximum value

SetLogicalMax(TInt)

IMPORT_C void SetLogicalMax ( TInt aMax )

Set logical maximum

Since
S60 v5.0

Parameters

TInt aMax logical maximum to be used

SetLogicalMin(TInt)

IMPORT_C void SetLogicalMin ( TInt aMin )

Set logical minimium

Since
S60 v5.0

Parameters

TInt aMin Logical minimium to be set

SetLogicalRange(TInt, TInt)

IMPORT_C void SetLogicalRange ( TInt aMin,
TInt aMax
)

Set Logical range

Since
S60 v5.0

Parameters

TInt aMin logical range minimium value
TInt aMax logical range maximum value

SetOffset(TInt)

IMPORT_C void SetOffset ( TInt aOffset )

Set offset

Since
S60 v5.0

Parameters

TInt aOffset offset to be set

SetPhysicalMax(TInt)

IMPORT_C void SetPhysicalMax ( TInt aValue )

Set Physical maximum

Since
S60 v5.0

Parameters

TInt aValue physical maximum value

SetPhysicalMin(TInt)

IMPORT_C void SetPhysicalMin ( TInt aValue )

Set physical minimium

Since
S60 v5.0

Parameters

TInt aValue physical minimium value

SetPhysicalRange(TInt, TInt)

IMPORT_C void SetPhysicalRange ( TInt aMin,
TInt aMax
)

Set Physical range

Since
S60 v5.0

Parameters

TInt aMin physical range minimium value
TInt aMax physical range maximum value

SetReportId(TInt)

IMPORT_C void SetReportId ( TInt aReportId )

Set Report ID

Since
S60 v5.0

Parameters

TInt aReportId report id to be set

SetSize(TInt)

IMPORT_C void SetSize ( TInt aSize )

Set size

Since
S60 v5.0

Parameters

TInt aSize size to be set

SetStringIndex(TInt)

IMPORT_C void SetStringIndex ( TInt aValue )

Set string index

Since
S60 v5.0

Parameters

TInt aValue string index

SetStringMax(TInt)

IMPORT_C void SetStringMax ( TInt aValue )

Set string maximum value

Since
S60 v5.0

Parameters

TInt aValue string maximum value to be set

SetStringMin(TInt)

IMPORT_C void SetStringMin ( TInt aValue )

Set string minimium value

Since
S60 v5.0

Parameters

TInt aValue string minimium value

SetStringRange(TInt, TInt)

IMPORT_C void SetStringRange ( TInt aMin,
TInt aMax
)

Set string range

Since
S60 v5.0

Parameters

TInt aMin string range minimium value
TInt aMax string range maximum value

SetType(const TType &)

IMPORT_C void SetType ( const TType & aType )

Set type

Since
S60 v5.0

Parameters

const TType & aType type of field

SetUnit(TInt)

IMPORT_C void SetUnit ( TInt aValue )

Set unit value

Since
S60 v5.0

Parameters

TInt aValue unit value

SetUnitExponent(TInt)

IMPORT_C void SetUnitExponent ( TInt aValue )

Set unit exponent

Since
S60 v5.0

Parameters

TInt aValue unit exponent valut to be set

SetUsageMax(TInt)

IMPORT_C void SetUsageMax ( TInt aMax )

Set usage maximum

Since
S60 v5.0

Parameters

TInt aMax usage max to be set

SetUsageMin(TInt)

IMPORT_C void SetUsageMin ( TInt aMin )

Set usage min

Since
S60 v5.0

Parameters

TInt aMin usage minimium to be set.

SetUsagePage(TInt)

IMPORT_C void SetUsagePage ( TInt aUsagePage )

Set usage page

Since
S60 v5.0

Parameters

TInt aUsagePage usagepage to be set

SetUsageRange(TInt, TInt)

IMPORT_C void SetUsageRange ( TInt aMin,
TInt aMax
)

Set Usage range

Since
S60 v5.0

Parameters

TInt aMin usage range minimium value
TInt aMax usage range maximum value

Size()

IMPORT_C TInt Size ( ) const

Return size

Since
S60 v5.0

StringIndex()

IMPORT_C TInt StringIndex ( ) const

Return string index

Since
S60 v5.0

StringMax()

IMPORT_C TInt StringMax ( ) const

Return string maximum

Since
S60 v5.0

StringMin()

IMPORT_C TInt StringMin ( ) const

Return string minimum

Since
S60 v5.0

Type()

IMPORT_C TType Type ( ) const

Return type

Since
S60 v5.0

Unit()

IMPORT_C TInt Unit ( ) const

Return unit

Since
S60 v5.0

UnitExponent()

IMPORT_C TInt UnitExponent ( ) const

Return unit exponent

Since
S60 v5.0

Usage(TInt)

IMPORT_C TInt Usage ( TInt aIndex ) const

Return usage

Since
S60 v5.0

Parameters

TInt aIndex usage array index

UsageArray()

IMPORT_C TArray < TInt > UsageArray ( ) const

Return usage array

Since
S60 v5.0

UsageCount()

IMPORT_C TInt UsageCount ( ) const

Return usage count

Since
S60 v5.0

UsageMax()

IMPORT_C TInt UsageMax ( ) const

Return usage max

Since
S60 v5.0

UsageMin()

IMPORT_C TInt UsageMin ( ) const

Return usage min

Since
S60 v5.0

UsagePage()

IMPORT_C TInt UsagePage ( ) const

Set Report root

Since
S60 v5.0

Member Enumerations Documentation

Enum TType

Enumerators

EInput
EOutput
EFeature

Member Data Documentation

TUint32 iAttributes

TUint32 iAttributes [private]

Flags associated with a main item (e.g. "array")

TInt iCount

TInt iCount [private]

Number of items in the report field (G)

TInt iDesignatorIndex

TInt iDesignatorIndex [private]

Body part used for a control (L)

TInt iDesignatorMax

TInt iDesignatorMax [private]

Ending designator index (L)

TInt iDesignatorMin

TInt iDesignatorMin [private]

Starting designator index (L)

TInt iLogicalMax

TInt iLogicalMax [private]

Maximum extent value in logical units (G)

TInt iLogicalMin

TInt iLogicalMin [private]

Minimum extent value in logical units (G)

TInt iPhysicalMax

TInt iPhysicalMax [private]

Maximum physical extent for a variable item (G)

TInt iPhysicalMin

TInt iPhysicalMin [private]

Minimum physical extent for a variable item (G)

TInt iPos

TInt iPos [private]

Field offset (in bits) from start of report

TInt iReportId

TInt iReportId [private]

ID for the HID report containing this field (G)

TInt iSize

TInt iSize [private]

Bit size of each item in the current field (G)

TInt iStringIndex

TInt iStringIndex [private]

String associated with a control (L)

TInt iStringMax

TInt iStringMax [private]

Last string index for a group of strings (L)

TInt iStringMin

TInt iStringMin [private]

First string index for a group of strings (L)

TType iType

TType iType [private]

Input, output or feature report

TInt iUnit

TInt iUnit [private]

Unit value (G)

TInt iUnitExponent

TInt iUnitExponent [private]

Value of the unit exponent in base 10 (G)

RArray< TInt > iUsageList

RArray < TInt > iUsageList [private]

The usage indexes associated with this field (G)

TInt iUsageMax

TInt iUsageMax [private]

Ending usage associated with array / bitmap (L)L)

TInt iUsageMin

TInt iUsageMin [private]

Starting usage associated with array / bitmap (L)

TInt iUsagePage

TInt iUsagePage [private]

The usage page this field is associated with (G)

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.