Lines Matching refs:element
61 @abstract Creates an element from a dictionary.
64 @param dictionary dictionary containing values in which to create element.
73 @abstract Obtain the device associated with the element.
74 @param element IOHIDElement to be queried.
78 IOHIDDeviceRef IOHIDElementGetDevice(IOHIDElementRef element)
83 @abstract Returns the parent for the element.
84 @discussion The parent element can be an element of type kIOHIDElementTypeCollection.
85 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
86 @result Returns an IOHIDElementRef referencing the parent element.
89 IOHIDElementRef IOHIDElementGetParent(IOHIDElementRef element)
94 @abstract Returns the children for the element.
95 @discussion An element of type kIOHIDElementTypeCollection usually contains children.
96 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
97 @result Returns an CFArrayRef containing element objects of type IOHIDElementRef.
100 CFArrayRef IOHIDElementGetChildren(IOHIDElementRef element)
107 @param element The element to be modified. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
108 @param toAttach The element to be attached. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
111 void IOHIDElementAttach(IOHIDElementRef element, IOHIDElementRef toAttach)
118 @param element The element to be modified. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
119 @param toDetach The element to be detached. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
122 void IOHIDElementDetach(IOHIDElementRef element, IOHIDElementRef toDetach)
129 @param element The element to be modified. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
133 CFArrayRef IOHIDElementCopyAttached(IOHIDElementRef element)
138 @abstract Retrieves the cookie for the element.
139 @discussion The IOHIDElementCookie represent a unique identifier for an element within a device.
140 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
141 @result Returns the IOHIDElementCookie for the element.
144 IOHIDElementCookie IOHIDElementGetCookie(IOHIDElementRef element)
149 @abstract Retrieves the type for the element.
150 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
151 @result Returns the IOHIDElementType for the element.
154 IOHIDElementType IOHIDElementGetType(IOHIDElementRef element)
159 @abstract Retrieves the collection type for the element.
160 @discussion The value returned by this method only makes sense if the element type is kIOHIDElementTypeCollection.
161 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
162 @result Returns the IOHIDElementCollectionType for the element.
165 IOHIDElementCollectionType IOHIDElementGetCollectionType(IOHIDElementRef element)
170 @abstract Retrieves the usage page for an element.
171 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
172 @result Returns the usage page for the element.
175 uint32_t IOHIDElementGetUsagePage(IOHIDElementRef element)
180 @abstract Retrieves the usage for an element.
181 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
182 @result Returns the usage for the element.
185 uint32_t IOHIDElementGetUsage(IOHIDElementRef element)
190 @abstract Returns the virtual property for the element.
191 @discussion Indicates whether the element is a virtual element.
192 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
196 Boolean IOHIDElementIsVirtual(IOHIDElementRef element)
201 @abstract Returns the relative property for the element.
204 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
208 Boolean IOHIDElementIsRelative(IOHIDElementRef element)
213 @abstract Returns the wrap property for the element.
215 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
219 Boolean IOHIDElementIsWrapping(IOHIDElementRef element)
224 @abstract Returns the array property for the element.
225 @discussion Indicates whether the element represents variable or array data values. Variable values represent data from a
231 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
235 Boolean IOHIDElementIsArray(IOHIDElementRef element)
240 @abstract Returns the linear property for the element.
241 @discussion Indicates whether the value for the element has been processed in some way, and no longer represents a linear
243 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
247 Boolean IOHIDElementIsNonLinear(IOHIDElementRef element)
252 @abstract Returns the preferred state property for the element.
253 @discussion Indicates whether the element has a preferred state to which it will return when the user is not physically
255 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
259 Boolean IOHIDElementHasPreferredState(IOHIDElementRef element)
264 @abstract Returns the null state property for the element.
265 @discussion Indicates whether the element has a state in which it is not sending meaningful data.
266 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
270 Boolean IOHIDElementHasNullState(IOHIDElementRef element)
275 @abstract Returns the name for the element.
276 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
277 @result Returns CFStringRef containing the element name.
280 CFStringRef IOHIDElementGetName(IOHIDElementRef element)
285 @abstract Returns the report ID for the element.
286 @discussion The report ID represents what report this particular element belongs to.
287 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
291 uint32_t IOHIDElementGetReportID(IOHIDElementRef element)
296 @abstract Returns the report size in bits for the element.
297 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
301 uint32_t IOHIDElementGetReportSize(IOHIDElementRef element)
306 @abstract Returns the report count for the element.
307 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
311 uint32_t IOHIDElementGetReportCount(IOHIDElementRef element)
316 @abstract Returns the unit property for the element.
319 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
323 uint32_t IOHIDElementGetUnit(IOHIDElementRef element)
328 @abstract Returns the unit exponenet in base 10 for the element.
331 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
335 uint32_t IOHIDElementGetUnitExponent(IOHIDElementRef element)
340 @abstract Returns the minimum value possible for the element.
341 @discussion This corresponds to the logical minimun, which indicates the lower bounds of a variable element.
342 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
346 CFIndex IOHIDElementGetLogicalMin(IOHIDElementRef element)
351 @abstract Returns the maximum value possible for the element.
352 @discussion This corresponds to the logical maximum, which indicates the upper bounds of a variable element.
353 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
357 CFIndex IOHIDElementGetLogicalMax(IOHIDElementRef element)
362 @abstract Returns the scaled minimum value possible for the element.
363 @discussion Minimum value for the physical extent of a variable element. This represents the value for the logical minimum with units applied to it.
364 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
368 CFIndex IOHIDElementGetPhysicalMin(IOHIDElementRef element)
373 @abstract Returns the scaled maximum value possible for the element.
374 @discussion Maximum value for the physical extent of a variable element. This represents the value for the logical maximum with units applied to it.
375 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
379 CFIndex IOHIDElementGetPhysicalMax(IOHIDElementRef element)
384 @abstract Returns the an element property.
386 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
387 @param key The key to be used when querying the element.
391 CFTypeRef IOHIDElementGetProperty(IOHIDElementRef element, CFStringRef key)
396 @abstract Sets an element property.
397 @discussion This method can be used to set arbitrary element properties, such as application specific references.
398 @param element The element to be queried. If this parameter is not a valid IOHIDElementRef, the behavior is undefined.
399 @param key The key to be used when querying the element.
403 Boolean IOHIDElementSetProperty(IOHIDElementRef element, CFStringRef key, CFTypeRef property)