Carbon


User Item and User Pane Control Data Tag Constants

Header: ControlDefinitions.h

enum {
    kControlUserItemDrawProcTag = ''uidp'',
    kControlUserPaneDrawProcTag = ''draw'',
    kControlUserPaneHitTestProcTag = ''hitt'',
    kControlUserPaneTrackingProcTag = ''trak'',
    kControlUserPaneIdleProcTag = ''idle'',
    kControlUserPaneKeyDownProcTag = ''keyd'',
    kControlUserPaneActivateProcTag = ''acti'',
    kControlUserPaneFocusProcTag = ''foci'',
    kControlUserPaneBackgroundProcTag = ''back''
};

Constant descriptions

kControlUserItemDrawProcTag

Gets or sets an application-defined item drawing function. If an embedding hierarchy is established, a user pane drawing function should be used instead of an item drawing function.

Data type returned or set: UserItemUPP

kControlUserPaneDrawProcTag

Gets or sets a user pane drawing function; see ControlUserPaneDrawProcPtr. Indicates that the Control Manager needs to draw a control.

Data type returned or set: ControlUserPaneDrawingUPP

kControlUserPaneHitTestProcTag

Gets or sets a user pane hit-testing function. Indicates that the Control Manager needs to determine if a control part was hit; see ControlUserPaneHitTestProcPtr.

Data type returned or set: ControlUserPaneHitTestUPP

kControlUserPaneTrackingProcTag

Gets or sets a user pane tracking function, which will be called when a control definition function returns the kControlHandlesTracking feature bit in response to a kControlMsgGetFeatures message. Indicates that a user pane handles its own tracking; see ControlUserPaneTrackingProcPtr.

Data type returned or set: ControlUserPaneTrackingUPP

kControlUserPaneIdleProcTag

Gets or sets a user pane idle function, which will be called when a control definition function returns the kControlWantsIdle feature bit in response to a kControlMsgGetFeatures message. Indicates that a user pane performs idle processing; see ControlUserPaneIdleProcPtr.

Data type returned or set: ControlUserPaneIdleUPP

kControlUserPaneKeyDownProcTag

Gets or sets a user pane key down function, which will be called when a control definition function returns the kControlSupportsFocus feature bit in response to a kControlMsgGetFeatures message. Indicates that a user pane performs keyboard event processing; see ControlUserPaneKeyDownProcPtr.

Data type returned or set: ControlUserPaneKeyDownUPP

kControlUserPaneActivateProcTag

Gets or sets a user pane activate function, which will be called when a control definition function returns the kControlWantsActivate feature bit in response to a kControlMsgGetFeatures message. Indicates that a user pane wants to be informed of activate and deactivate events; see ControlUserPaneActivateProcPtr.

Data type returned or set: ControlUserPaneActivateUPP

kControlUserPaneFocusProcTag

Gets or sets a user pane keyboard focus function, which will be called when a control definition function returns the kControlSupportsFocus feature bit in response to a kControlMsgGetFeatures message. Indicates that a user pane handles keyboard focus; see ControlUserPaneFocusProcPtr.

Data type returned or set: ControlUserPaneFocusUPP

kControlUserPaneBackgroundProcTag

Gets or sets a user pane background function, which will be called when a control definition function returns the kControlHasSpecialBackground and kControlSupportsEmbedding feature bits in response to a kControlMsgGetFeatures message. Indicates that a user pane can set its background color or pattern; see ControlUserPaneBackgroundProcPtr.

Data type returned or set: ControlUserPaneBackgroundUPP

You can use the control data tag constants to set or obtain data that is associated with a control. The control data tag constants are passed in the inTagName parameters of SetControlData and GetControlData to specify the piece of data in a control that you wish to set or get. You can also pass these constants in the inTagName parameter of GetControlDataSize if you wish to determine the size of variable-length control data. These constants can also be used by custom control definition functions that return the feature bit kControlSupportsDataAccess in response to a kControlMsgGetFeatures message.

The data that your application sets or obtains can be of various types, dependent upon the control. Therefore, the descriptions of the control data tag constants list the data types for the information that you can set in the inData parameter to the SetControlData function and that you can get in the inBuffer parameter to the GetControlData function.

VERSION NOTES

The control data tag constants are available with Appearance Manager 1.0 and later.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)