Mac Developer Library

Developer

AXValue.h Reference

Options
Deployment Target:

On This Page

AXValue.h Reference

This header contains functions and data types for working with AXValueType wrappers.

Included Headers

  • <AvailabilityMacros.h>

  • <CoreServices/CoreServices.h>

  • <CoreFoundation/CoreFoundation.h>

Functions

  • Declaration

    extern AXValueRef AXValueCreate ( AXValueType theType, const void *valuePtr);

    Parameters

    theType
    valuePtr

    Discussion

    Encodes a structure pointed to by valuePtr into a CFTypeRef.

  • Declaration

    extern AXValueType AXValueGetType( AXValueRef value);

    Parameters

    value

    Discussion

    Returns the structure type encoded in value. If the type is not recognized, it returns kAXValueIllegalType.

  • Declaration

    extern CFTypeID AXValueGetTypeID();

  • Declaration

    extern Boolean AXValueGetValue( AXValueRef value, AXValueType theType, void *valuePtr);

    Parameters

    value

    Discussion

    Decodes the structure stored in value and copies it into valuePtr. If the structure stored in value is not the same as requested by theType, the function returns false.

Data Types

See the Overview section above for header-level documentation.

  • Declaration

    typedef const struct __AXValue *AXValueRef;

    Import Statement

  • Declaration

    typedef enum { kAXValueCGPointType = 1, kAXValueCGSizeType = 2, kAXValueCGRectType = 3, kAXValueCFRangeType = 4, kAXValueAXErrorType = 5, kAXValueIllegalType = 0 } AXValueType;

    Constants

    • kAXValueCGPointType

      a wrapper for CGPoint; see CoreGraphics.h

    • kAXValueCGSizeType

      a wrapper for CGSize; see CoreGraphics.h

    • kAXValueCGRectType

      a wrapper for CGRect; see CoreGraphics.h

    • kAXValueCFRangeType

      a wrapper for CFRange; see CFBase.h

    • kAXValueAXErrorType

      See AXError.h

    • kAXValueIllegalType

      a wrapper for unsupported structures

    Discussion

    These are AXValueType wrappers for other structures. You must use the AXValueCreate and AXValueGetValue functions to convert between the wrapped structure and the native structure.

    Import Statement