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
| Private Member Functions |
|---|
| CField() |
Constructor & Destructor Documentation
Member Functions Documentation
AddUsageL(TInt)
| IMPORT_C void | AddUsageL | ( | TInt | aUsage | ) | |
Parameters
| TInt aUsage | usage to be added |
ClearUsageList()
| IMPORT_C void | ClearUsageList | ( | ) | |
Count()
| IMPORT_C TInt | Count | ( | ) | const |
DesignatorIndex()
| IMPORT_C TInt | DesignatorIndex | ( | ) | const |
DesignatorMax()
| IMPORT_C TInt | DesignatorMax | ( | ) | const |
Return designator maximium
DesignatorMin()
| IMPORT_C TInt | DesignatorMin | ( | ) | const |
Return designator minimium
IsArray()
| IMPORT_C TBool | IsArray | ( | ) | const |
IsConstant()
| IMPORT_C TBool | IsConstant | ( | ) | const |
IsData()
| IMPORT_C TBool | IsData | ( | ) | const |
IsFeature()
| IMPORT_C TBool | IsFeature | ( | ) | const |
IsInReport(TInt)
Check if reportid is in report
IsInput()
| IMPORT_C TBool | IsInput | ( | ) | const |
IsOutput()
| IMPORT_C TBool | IsOutput | ( | ) | const |
IsVariable()
| IMPORT_C TBool | IsVariable | ( | ) | const |
LastUsage()
| IMPORT_C TInt | LastUsage | ( | ) | const |
LogicalMax()
| IMPORT_C TInt | LogicalMax | ( | ) | const |
LogicalMin()
| IMPORT_C TInt | LogicalMin | ( | ) | const |
Offset()
| IMPORT_C TInt | Offset | ( | ) | const |
PhysicalMax()
| IMPORT_C TInt | PhysicalMax | ( | ) | const |
PhysicalMin()
| IMPORT_C TInt | PhysicalMin | ( | ) | const |
ReportId()
| IMPORT_C TInt | ReportId | ( | ) | const |
SetAttributes(TUint32)
| IMPORT_C void | SetAttributes | ( | TUint32 | aAttributes | ) | |
Parameters
| TUint32 aAttributes | attributes to be set |
SetCount(TInt)
| IMPORT_C void | SetCount | ( | TInt | aCount | ) | |
Parameters
| TInt aCount | Count to be set |
SetDesignatorIndex(TInt)
| IMPORT_C void | SetDesignatorIndex | ( | TInt | aValue | ) | |
Parameters
| TInt aValue | Designator index value |
SetDesignatorMax(TInt)
| IMPORT_C void | SetDesignatorMax | ( | TInt | aValue | ) | |
Set designator maximium value
Parameters
| TInt aValue | designator maximium value |
SetDesignatorMin(TInt)
| IMPORT_C void | SetDesignatorMin | ( | TInt | aValue | ) | |
Parameters
| TInt aValue | designator minimum value |
SetDesignatorRange(TInt, TInt)
| IMPORT_C void | SetDesignatorRange | ( | TInt | aMin, |
| | TInt | aMax |
| | ) | |
Parameters
| TInt aMin | designator range minimium value |
| TInt aMax | designator range maximum value |
SetLogicalMax(TInt)
| IMPORT_C void | SetLogicalMax | ( | TInt | aMax | ) | |
Parameters
| TInt aMax | logical maximum to be used |
SetLogicalMin(TInt)
| IMPORT_C void | SetLogicalMin | ( | TInt | aMin | ) | |
Parameters
| TInt aMin | Logical minimium to be set |
SetLogicalRange(TInt, TInt)
| IMPORT_C void | SetLogicalRange | ( | TInt | aMin, |
| | TInt | aMax |
| | ) | |
Parameters
| TInt aMin | logical range minimium value |
| TInt aMax | logical range maximum value |
SetOffset(TInt)
| IMPORT_C void | SetOffset | ( | TInt | aOffset | ) | |
Parameters
| TInt aOffset | offset to be set |
SetPhysicalMax(TInt)
| IMPORT_C void | SetPhysicalMax | ( | TInt | aValue | ) | |
Parameters
| TInt aValue | physical maximum value |
SetPhysicalMin(TInt)
| IMPORT_C void | SetPhysicalMin | ( | TInt | aValue | ) | |
Parameters
| TInt aValue | physical minimium value |
SetPhysicalRange(TInt, TInt)
| IMPORT_C void | SetPhysicalRange | ( | TInt | aMin, |
| | TInt | aMax |
| | ) | |
Parameters
| TInt aMin | physical range minimium value |
| TInt aMax | physical range maximum value |
SetReportId(TInt)
| IMPORT_C void | SetReportId | ( | TInt | aReportId | ) | |
Parameters
| TInt aReportId | report id to be set |
SetSize(TInt)
| IMPORT_C void | SetSize | ( | TInt | aSize | ) | |
SetStringIndex(TInt)
| IMPORT_C void | SetStringIndex | ( | TInt | aValue | ) | |
SetStringMax(TInt)
| IMPORT_C void | SetStringMax | ( | TInt | aValue | ) | |
Parameters
| TInt aValue | string maximum value to be set |
SetStringMin(TInt)
| IMPORT_C void | SetStringMin | ( | TInt | aValue | ) | |
Set string minimium value
Parameters
| TInt aValue | string minimium value |
SetStringRange(TInt, TInt)
| IMPORT_C void | SetStringRange | ( | TInt | aMin, |
| | TInt | aMax |
| | ) | |
Parameters
| TInt aMin | string range minimium value |
| TInt aMax | string range maximum value |
SetType(const TType &)
| IMPORT_C void | SetType | ( | const TType & | aType | ) | |
Parameters
| const TType & aType | type of field |
SetUnit(TInt)
| IMPORT_C void | SetUnit | ( | TInt | aValue | ) | |
SetUnitExponent(TInt)
| IMPORT_C void | SetUnitExponent | ( | TInt | aValue | ) | |
Parameters
| TInt aValue | unit exponent valut to be set |
SetUsageMax(TInt)
| IMPORT_C void | SetUsageMax | ( | TInt | aMax | ) | |
Parameters
| TInt aMax | usage max to be set |
SetUsageMin(TInt)
| IMPORT_C void | SetUsageMin | ( | TInt | aMin | ) | |
Parameters
| TInt aMin | usage minimium to be set. |
SetUsagePage(TInt)
| IMPORT_C void | SetUsagePage | ( | TInt | aUsagePage | ) | |
Parameters
| TInt aUsagePage | usagepage to be set |
SetUsageRange(TInt, TInt)
| IMPORT_C void | SetUsageRange | ( | TInt | aMin, |
| | TInt | aMax |
| | ) | |
Parameters
| TInt aMin | usage range minimium value |
| TInt aMax | usage range maximum value |
StringIndex()
| IMPORT_C TInt | StringIndex | ( | ) | const |
StringMax()
| IMPORT_C TInt | StringMax | ( | ) | const |
StringMin()
| IMPORT_C TInt | StringMin | ( | ) | const |
Type()
| IMPORT_C TType | Type | ( | ) | const |
UnitExponent()
| IMPORT_C TInt | UnitExponent | ( | ) | const |
Usage(TInt)
Parameters
| TInt aIndex | usage array index |
UsageCount()
| IMPORT_C TInt | UsageCount | ( | ) | const |
UsageMax()
| IMPORT_C TInt | UsageMax | ( | ) | const |
UsageMin()
| IMPORT_C TInt | UsageMin | ( | ) | const |
UsagePage()
| IMPORT_C TInt | UsagePage | ( | ) | const |
Member Enumerations Documentation
Member Data Documentation
TUint32
iAttributes
Flags associated with a main item (e.g. "array")
TInt
iCount
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
Field offset (in bits) from start of report
TInt
iReportId
ID for the HID report containing this field (G)
TInt
iSize
Bit size of each item in the current field (G)
TInt
iStringIndex
|
TInt
| iStringIndex | [private] |
String associated with a control (L)
TInt
iStringMax
Last string index for a group of strings (L)
TInt
iStringMin
First string index for a group of strings (L)
TType
iType
Input, output or feature report
TInt
iUnitExponent
|
TInt
| iUnitExponent | [private] |
Value of the unit exponent in base 10 (G)
RArray< TInt > iUsageList
The usage indexes associated with this field (G)
TInt
iUsageMax
Ending usage associated with array / bitmap (L)L)
TInt
iUsageMin
Starting usage associated with array / bitmap (L)
TInt
iUsagePage
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.