Carbon


PickerGetEditMenuStateProcPtr

Header: ColorPickerComponents.h Carbon status: Supported

Defines a pointer to a color picker-defined edit menu state getter callback function. Your edit menu state getter function returns information about the desired state of the Edit menu for your color picker.

typedef ComponentResult(* PickerGetEditMenuStateProcPtr) (
    SInt32 storage, 
    PickerMenuState *mState
);

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

ComponentResult MyPickerGetEditMenuStateCallback (
    SInt32 storage, 
    PickerMenuState *mState
);
Parameter descriptions
storage

A handle to your color picker’s global data.

mState

A PickerMenuState structure, in which your function should return information about your color picker’s Edit menu. The Color Picker Manager sets the Edit menu to this state.

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 kGetEditMenuState request code, by calling a color picker-defined subroutine (MyPickerGetEditMenuStateCallback, 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)