TypeSelect.h File Reference

TypeSelect Utilties. More...

#include <Events.h>

Go to the source code of this file.

Data Structures
struct	TypeSelectRecord

Macros
#define	NewIndexToStringUPP(userRoutine)
#define	DisposeIndexToStringUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
#define	InvokeIndexToStringUPP(item, itemsScript, itemsStringPtr, yourDataPtr, userUPP)
#define	NewIndexToStringProc(userRoutine)   NewIndexToStringUPP(userRoutine)
#define	CallIndexToStringProc(userRoutine, item, itemsScript, itemsStringPtr, yourDataPtr)

Typedefs
typedef SInt16	TSCode
typedef struct TypeSelectRecord	TypeSelectRecord
typedef ScriptCode *	itemsScript
typedef ScriptCode StringPtr *	itemsStringPtr
typedef ScriptCode StringPtr void *	yourDataPtr

Enumerations
enum	{ tsPreviousSelectMode = -1 , tsNormalSelectMode = 0 , tsNextSelectMode = 1 }
enum	{ uppIndexToStringProcInfo = 0x00003F90 }

Functions
typedef	CALLBACK_API (Boolean, IndexToStringProcPtr)(short item
typedef	STACK_UPP_TYPE (IndexToStringProcPtr) IndexToStringUPP
void	TypeSelectClear (TypeSelectRecord *tsr)
Boolean	TypeSelectNewKey (const EventRecord *theEvent, TypeSelectRecord *tsr)
short	TypeSelectFindItem (const TypeSelectRecord *tsr, short listSize, TSCode selectMode, IndexToStringUPP getStringProc, void *yourDataPtr)
short	TypeSelectCompare (const TypeSelectRecord *tsr, ScriptCode testStringScript, StringPtr testStringPtr)
IndexToStringUPP	NewIndexToStringUPP (IndexToStringProcPtr userRoutine)
void	DisposeIndexToStringUPP (IndexToStringUPP userUPP)
Boolean	InvokeIndexToStringUPP (short item, ScriptCode *itemsScript, StringPtr *itemsStringPtr, void *yourDataPtr, IndexToStringUPP userUPP)

Detailed Description

TypeSelect Utilties.

Introduced In: Mac OS 9

Avaliable From: Universal Interfaces 3.4.1

Copyright: � 2000-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

CallIndexToStringProc

#define CallIndexToStringProc	(		userRoutine,
			item,
			itemsScript,
			itemsStringPtr,
			yourDataPtr
	)

Value:

  InvokeIndexToStringUPP(item, itemsScript, itemsStringPtr, yourDataPtr,      \
                         userRoutine)

InvokeIndexToStringUPP

#define InvokeIndexToStringUPP	(		item,
			itemsScript,
			itemsStringPtr,
			yourDataPtr,
			userUPP
	)

Value:

  (Boolean)                                                                    \
      CALL_FOUR_PARAMETER_UPP((userUPP), uppIndexToStringProcInfo, (item),     \
                              (itemsScript), (itemsStringPtr), (yourDataPtr))

NewIndexToStringUPP

#define NewIndexToStringUPP

(

userRoutine

)

Value:

  (IndexToStringUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppIndexToStringProcInfo, \
                           GetCurrentArchitecture())

Function Documentation

DisposeIndexToStringUPP()

void DisposeIndexToStringUPP

(

IndexToStringUPP

userUPP

)

DisposeIndexToStringUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

InvokeIndexToStringUPP()

Boolean InvokeIndexToStringUPP	(	short	item,
		ScriptCode *	itemsScript,
		StringPtr *	itemsStringPtr,
		void *	yourDataPtr,
		IndexToStringUPP	userUPP
	)

InvokeIndexToStringUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

NewIndexToStringUPP()

IndexToStringUPP NewIndexToStringUPP

(

IndexToStringProcPtr

userRoutine

)

NewIndexToStringUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

TypeSelectClear()

void TypeSelectClear

(

TypeSelectRecord *

tsr

)

TypeSelectClear()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

TypeSelectCompare()

short TypeSelectCompare	(	const TypeSelectRecord *	tsr,
		ScriptCode	testStringScript,
		StringPtr	testStringPtr
	)

TypeSelectCompare()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

TypeSelectFindItem()

short TypeSelectFindItem	(	const TypeSelectRecord *	tsr,
		short	listSize,
		TSCode	selectMode,
		IndexToStringUPP	getStringProc,
		void *	yourDataPtr
	)

TypeSelectFindItem()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

TypeSelectNewKey()

Boolean TypeSelectNewKey	(	const EventRecord *	theEvent,
		TypeSelectRecord *	tsr
	)

Long ago the implementation of TypeSelectNewKey had a bug that required the high word of D0 to be zero or the function did not work. Although fixed now, we are continuing to clear the high word just in case someone tries to run on an older system. TypeSelectNewKey()

Non-Carbon CFM: not available

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later