Carbon


Mac OS 8.5 Editable Text Control Data Tag Constants

Header: ControlDefinitions.h

enum {
    kControlEditTextKeyScriptBehaviorTag = ''kscr'',
    kControlEditTextLockedTag = ''lock'',
    kControlEditTextFixedTextTag = ''ftxt'',
    kControlEditTextValidationProcTag = ''vali'',
    kControlEditTextInlinePreUpdateProcTag = ''prup'',
    kControlEditTextInlinePostUpdateProcTag = ''poup''
};

Constant descriptions

kControlEditTextKeyScriptBehaviorTag

Gets or sets the kind of behavior to be used in an editable text control with respect to changing and locking the keyboard menu as the field is focused.

Data type retrieved or set: ControlKeyScriptBehavior. The default for password fields is kControlKeyScriptBehaviorPrefersRoman. The default for non-password fields is kControlKeyScriptBehaviorAllowAnyScript. See “Control Key Script Behavior Constants” for descriptions of possible values.

kControlEditTextLockedTag

Gets or sets whether the text in an editable text control is currently editable.

Data type retrieved or set: Boolean; if true, the text is locked and cannot be edited; if false, the text is editable.

kControlEditTextFixedTextTag

Gets or sets inline input text in an editable text control, after confirming any text in the active input area with the Text Services Manager function FixTSMDocument.

Data type retrieved or set: character buffer

kControlEditTextValidationProcTag

Gets or sets a universal procedure pointer to a callback function such as that described in ControlEditTextValidationProcPtr, which can be used to validate editable text after an operation that changes the text, such as inline text entry, a cut, or paste.

Data type retrieved or set: ControlEditTextValidationUPP

kControlEditTextInlinePreUpdateProcTag

Gets or sets a universal procedure pointer to a Text Services Manager pre-update callback function. See Technote TE 27, “Inline Input for TextEdit with TSMTE” for a description of the TSMTEPreUpdateUPP type.

Data type retrieved or set: TSMTEPreUpdateUPP

kControlEditTextInlinePostUpdateProcTag

Gets or sets a universal procedure pointer to a Text Services Manager post-update callback function. See Technote TE 27, “Inline Input for TextEdit with TSMTE” for a description of the TSMTEPostUpdateUPP type.

Data type retrieved or set: TSMTEPostUpdateUPP

The Mac OS 8.5 Control Manager defines these new control data tag constants. These constants are passed in the inTagName parameters of the functions 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 the function GetControlDataSize if you wish to determine the size of variable-length control data (for example, 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 gets or sets can be of various types. The descriptions here show 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.


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