IOHIDElement.h

Overview

IOHIDElement defines a parsed item contained within a Human Interface Device (HID) object. It is used to obtain properties of the parsed. It can also be used to set properties such as calibration settings. IOHIDElement is a CFType object and as such conforms to all the conventions expected such object.

This documentation assumes that you have a basic understanding of the material contained in Accessing Hardware From Applications For definitions of I/O Kit terms used in this documentation, such as matching dictionary, family, and driver, see the overview of I/O Kit terms and concepts in the "Device Access and the I/O Kit" chapter of Accessing Hardware From Applications. This documentation also assumes you have read Human Interface Device & Force Feedback. Please review documentation before using this reference.

All of the information described in this document is contained in the header file IOHIDElement.h found at /System/Library/Frameworks/IOKit.framework/Headers/hid/IOHIDElement.h.

Included Headers

  • <CoreFoundation/CoreFoundation.h>

  • <IOKit/hid/IOHIDKeys.h>

  • <IOKit/hid/IOHIDBase.h>

Topics

Miscellaneous

IOHIDElementAttach

Establish a relationship between one or more elements.

IOHIDElementCollectionType

Retrieves the collection type for the element.

IOHIDElementCopyAttached

Obtain attached elements.

IOHIDElementCreateWithDictionary

Creates an element from a dictionary.

IOHIDElementDetach

Remove a relationship between one or more elements.

IOHIDElementGetChildren

Returns the children for the element.

IOHIDElementGetCollectionType

Retrieves the collection type for the element.

IOHIDElementGetCookie

Retrieves the cookie for the element.

IOHIDElementGetDevice

Obtain the device associated with the element.

IOHIDElementGetLogicalMax

Returns the maximum value possible for the element.

IOHIDElementGetLogicalMin

Returns the minimum value possible for the element.

IOHIDElementGetMax

Returns the maximum value possible for the element.

IOHIDElementGetName

Returns the name for the element.

IOHIDElementGetParent

Returns the parent for the element.

IOHIDElementGetPhysicalMax

Returns the scaled maximum value possible for the element.

IOHIDElementGetPhysicalMin

Returns the scaled minimum value possible for the element.

IOHIDElementGetProperty

Returns the an element property.

IOHIDElementGetReportCount

Returns the report count for the element.

IOHIDElementGetReportID

Returns the report ID for the element.

IOHIDElementGetReportSize

Returns the report size in bits for the element.

IOHIDElementGetType

Retrieves the type for the element.

IOHIDElementGetTypeID

Returns the type identifier of all IOHIDElement instances.

IOHIDElementGetUnit

Returns the unit property for the element.

IOHIDElementGetUnitExponent

Returns the unit exponenet in base 10 for the element.

IOHIDElementGetUsage

Retrieves the usage for an element.

IOHIDElementGetUsagePage

Retrieves the usage page for an element.

IOHIDElementHasNullState

Returns the null state property for the element.

IOHIDElementHasPreferredState

Returns the preferred state property for the element.

IOHIDElementIsArray

Returns the array property for the element.

IOHIDElementIsNonLinear

Returns the linear property for the element.

IOHIDElementIsRelative

Returns the relative property for the element.

IOHIDElementIsVirtual

Returns the virtual property for the element.

IOHIDElementIsWrapping

Returns the wrap property for the element.

IOHIDElementSetProperty

Sets an element property.