Carbon


Scrolling Text Box Control Data Tag Constants

Header: ControlDefinitions.h

enum {
    kControlScrollTextBoxDelayBeforeAutoScrollTag = ''stdl'',
    kControlScrollTextBoxDelayBetweenAutoScrollTag = ''scdl'',
    kControlScrollTextBoxAutoScrollAmountTag = ''samt'',
    kControlScrollTextBoxContentsTag = ''tres''
};

Constant descriptions

kControlScrollTextBoxDelayBeforeAutoScrollTag

Gets or sets the number of ticks to delay before the initial scrolling of an auto-scrolling text box control begins.

Data type retrieved or set: UInt32

kControlScrollTextBoxDelayBetweenAutoScrollTag

Gets or sets the number of ticks to delay between each unit of scrolling, for an auto-scrolling text box control. (The unit of scrolling for the auto-scrolling text box control is one pixel at a time, unless your application changes this value by calling the SetControlData function.)

Data type retrieved or set: UInt32

kControlScrollTextBoxAutoScrollAmountTag

Gets or sets the number of pixels by which an auto-scrolling text box control scrolls; default is 1.

Data type retrieved or set: UInt16

kControlScrollTextBoxContentsTag

Sets the ID of a 'TEXT' resource—and, optionally, a 'styl' resource—to be used as the content in a scrolling or auto-scrolling text box control.

Data type set: SInt16

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. 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)