Carbon


PickerGetIconDataProcPtr

Header: ColorPickerComponents.h Carbon status: Supported

Defines a pointer to a color picker-defined icon data retrieval callback function. Your icon data retrieval function returns information about your color picker’s icon family and script code.

typedef ComponentResult(* PickerGetIconDataProcPtr) (
    SInt32 storage, 
    PickerIconData *data
);

You would declare your function like this if you were to name it MyPickerGetIconDataCallback:

ComponentResult MyPickerGetIconDataCallback (
    SInt32 storage, 
    PickerIconData *data
);
Parameter descriptions
storage

A handle to your color picker’s global data.

data

A pointer to a PickerIconData structure returned by your color picker. In the scriptCode field of this structure, your color picker should return its script code, and in the iconSuiteID field, your color picker should return the resource ID of its icon family. The Color Picker manager needs this information to display you picker in the More Choices list.

function result

Your function should return noErr if successful, or an appropriate result code otherwise.

DISCUSSION

If you create a color picker, it must respond to the kGetIconData request code, by calling a color picker-defined subroutine (MyPickerGetIconDataCallback, for example).

When you create a color picker, the Color Picker Manager uses the Component Manager to request services from your color picker. The code for your color picker should be contained in a resource. The Component Manager expects that the entry point into this resource is a color picker-defined dispatch function. For information on how to create this dispatch function, see the Component Manager callback, ComponentRoutineProcPtr.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)