Carbon


Editable Text Control Data Tag Constants

Header: ControlDefinitions.h

enum {
    kControlEditTextStyleTag = ''font'',
    kControlEditTextTextTag = ''text'',
    kControlEditTextTEHandleTag = ''than'',
    kControlEditTextKeyFilterTag = ''fltr'',
    kControlEditTextSelectionTag = ''sele'',
    kControlEditTextPasswordTag = ''pass''
};

Constant descriptions

kControlEditTextStyleTag
kControlEditTextTextTag

Gets or sets text in an editable text control.

Data type returned or set: character buffer

kControlEditTextTEHandleTag

Gets a handle to a text edit structure.

Data type returned: TEHandle

kControlEditTextKeyFilterTag
kControlEditTextSelectionTag

Gets or sets the selection in an editable text control.

Data type returned or set: ControlEditTextSelectionRec structure

kControlEditTextPasswordTag

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 (e.g., text in an editable text control). 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 6/30/2000)