RectInIconSuite

RectInIconSuite
Header:	Icons.h		Carbon status:	Supported

Hit-tests a rectangle against the appropriate icon mask from an icon suite for a specified destination rectangle and alignment.

Boolean RectInIconSuite (
    const Rect *testRect, 
    const Rect *iconRect, 
    IconAlignmentType align, 
    IconSuiteRef theIconSuite
);

Parameter descriptions

testRect

A pointer to the rectangle to be tested, specified in local coordinates of the current graphics port.

iconRect

A pointer to the rectangle in which the icon appears, specified in local coordinates of the current graphics port. The rectangle which you specify here should be the same rectangle that you last used to draw the icon. Like the PtInIconSuite function, this function determines, from the size of the rectangle specified in this parameter, which icon mask from the icon suite specified by theIconSuite to test the test rectangle against. For example, if the coordinates of the iconRect parameter are (100,100,116,116) and the icon cache contains entries for each icon family member, RectInIconSuite uses the icon mask defined by the 'ics#' entry.

The function then intersects the rectangle specified by testRect with the icon mask in the iconRect rectangle. Continuing with this example, if the icon mask is left-aligned so that its rightmost pixel appears at coordinates (112,112) and the coordinates of testRect are (114,114,130,130), then RectInIconSuite returns FALSE

align

Specifies how the icon against which to hit-test is aligned within the rectangle specified by iconRect. The alignment which you specify here should be the same alignment that you last used to draw the icon. See “Alignment Type Values” for a description of the values you can use in this parameter.

theIconSuite

A handle to an icon suite.

function result: TRUE if the rectangle intersects the icon and FALSE if it doesn’t.

SPECIAL CONSIDERATIONS

This function may move or purge memory blocks in the application heap. For that reason, your application should not call it at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.