| Tool Locator Calls | ||
|---|---|---|
| Routine | # | Description |
| TLBootInit | $0101 | Initializes Tool Locator and all other ROM-based tools sets - not called by application |
| TLStartUp | $0201 | Starts up the Tool Locator for use by an application |
| TLShutDown | $0301 | Shuts down the Tool Locator when an application quits |
| TLVersion | $0401 | Returns the version number of the Tool Locator |
| TLReset | $0501 | Resets the Tool Locator & all other ROM-based tool sets on system reset - not by appl. |
| TLStatus | $0601 | Indicates whether Tool Locator is active |
| GetTSPtr | $0901 | Returns the pointer to the function pointer table of a specified tool set |
| SetTSPtr | $0A01 | Installs the pointer to a function ptr table in the appropriate tool pointer table |
| GetFuncPtr | $0B01 | Returns entry in the function ptr table for a specified function in a specified tool set |
| GetWAP | $0C01 | Gets the pointer to the work area for a specified tool set |
| SetWAP | $0D01 | Sets the pointer to the work area for a specified tool set |
| LoadTools | $0E01 | Ensures that specified system tool sets are available & have specified minimum version numbers |
| LoadOneTool | $0F01 | Ensures that specified system tool set is available & has a specified minimum version number |
| UnloadOneTool | $1001 | Unloads a specified tool set from memory |
| TLMountVolume | $1101 | Displays on SHR screen a simulated dialog box to prompt user to mount a volume |
| TLTextMountVol | $1201 | Displays on 40-column text screen a simulated dialog box to prompt user to mount volume |
| SaveTextState | $1301 | Saves state of text scrn & forces hardware to display text scrn regardless of current mode |
| RestoreTextState | $1401 | Restores state of text screen from a specified handle and disposes of the handle |
| MessageCenter | $1501 | Allows applications to communicate with each other (Tool Locator version >= 2.1) |
| SetDefaultTPT | $1601 | Sets default Tool Pointer Table (TPT) to current TPT - Used to install a tool patch - not called by application |
| MessageByName | $1701 | Creates and associates a name with a new message, providing a mechanism for passing messages between programs |
| StartUpTools | $1801 | Starts and loads the tools specified in the input StartStop record |
| ShutDownTools | $1901 | Shuts down the tools specified in the input StartStop record |
| GetMsgHandle | $1A01 | Returns the handle to a message in the Message Center |
| AcceptRequests | $1B01 | Call AcceptRequests to notify the system that you can receive requests |
| SendRequest | $1C01 | Sends the specified request to zero or more qualifying registered request procedures (IPC) |
Initializes Tool Locator and all other ROM-based tools sets - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Tool Locator for use by an application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void TLStartUp()
Shuts down the Tool Locator when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void TLShutDown()
Returns the version number of the Tool Locator
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of Tool Locator | |
| ← | SP |
None
extern pascal Word TLVersion()
Resets the Tool Locator & all other ROM-based tool sets on system reset - not by appl.
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether Tool Locator is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE (Tool Locator is always active) | |
| ← | SP |
None
extern pascal Boolean TLStatus()
Returns the pointer to the function pointer table of a specified tool set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| userOrSystem | Word — $0000 = system tool set; $8000 = user tool set | |
| tsNum | Word — Tool set number of tool set whose pointer is to be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fptPtr | Long — POINTER to function table pointer of tool set | |
| ← | SP |
$0001 toolNotFoundErr Specified tool set not found
extern pascal Pointer GetTSPtr(userOrSystem,tsNum)
Installs the pointer to a function ptr table in the appropriate tool pointer table
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userOrSystem | Word — $0000 = system tool set; $8000 = user tool set | |
| tsNum | Word — Tool set number of tool set | |
| fptPtr | Long — POINTER to function table pointer of tool set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0001 toolNotFoundErr Specified tool set not found
extern pascal void SetTSPtr(userOrSystem,tsNum, fptPtr)
Returns entry in the function ptr table for a specified function in a specified tool set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| userOrSystem | Word — $0000 = system tool set; $8000 = user tool set | |
| funcNum | tsNum | Byte — Funtion number | Byte — Tool set number | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fptEntry | Long — Entry in function pointer table | |
| ← | SP |
$0001 toolNotFoundErr Specified tool set not found
$0002 funcNotFoundErr Specified routine not found
extern pascal Pointer GetFuncPtr(userOrSystem,funcTsNum)
Gets the pointer to the work area for a specified tool set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| userOrSystem | Word — $0000 = system tool set; $8000 = user tool set | |
| tsNum | Word — Tool set number | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| waptPtr | Long — POINTER to work area of tool set | |
| ← | SP |
$0001 toolNotFoundErr Specified tool set not found
extern pascal Pointer GetWAP(userOrSystem,tsNum)
Sets the pointer to the work area for a specified tool set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userOrSystem | Word — $0000 = system tool set; $8000 = user tool set | |
| tsNum | Word — Tool set number | |
| waptPtr | Long — POINTER to work area of tool set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0001 toolNotFoundErr Specified tool set not found
extern pascal void SetWAP(userOrSystem,tsNum,waptPtr)
Ensures that specified system tool sets are available & have specified minimum version numbers
| Stack before call | ||
|---|---|---|
| previous contents | ||
| toolTablePtr | Long — POINTER to table of tool set numbers | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0001 toolNotFoundErr Specified tool set not found
$0010 toolVersionErr Specified minimum version not found
System Loader errors Returned unchanged
ProDOS 16 errors Returned unchanged
extern pascal void LoadTools(toolTablePtr)
Ensures that specified system tool set is available & has a specified minimum version number
| Stack before call | ||
|---|---|---|
| previous contents | ||
| toolNumber | Word — INTEGER; tool set number of tool set to load | |
| minVersion | Word — Minimum version number of tool set needed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0001 toolNotFoundErr Specified tool set not found
$0010 toolVersionErr Specified minimum version not found
System Loader errors Returned unchanged
ProDOS 16 errors Returned unchanged
extern pascal void LoadOneTool(toolNumber,minVersion)
Unloads a specified tool set from memory
| Stack before call | ||
|---|---|---|
| previous contents | ||
| toolNumber | Word — INTEGER; tool set number of tool set to load | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0001 toolNotFoundErr Specified tool set not found
extern pascal void UnloadOneTool(toolNumber)
Displays on SHR screen a simulated dialog box to prompt user to mount a volume
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| whereX | Word — INTEGER; upper lext X coordinate for box | |
| whereY | Word — INTEGER; upper lext Y coordinate for box | |
| line1Ptr | Long — POINTER to Pascal-type string to appear at top of box | |
| line2Ptr | Long — POINTER to Pascal-type string to appear just below line 1 | |
| but1Ptr | Long — POINTER to Pascal-type string to appear inside button 1 | |
| but2Ptr | Long — POINTER to Pascal-type string to appear inside button 2 | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| whichButton | Word — Button number chosen; Return = 1, Esc = 2 | |
| ← | SP |
None
extern pascal Word TLMountVolume(whereX,whereY,line1Ptr,line2Ptr,but1Ptr,but2Ptr)
Displays on 40-column text screen a simulated dialog box to prompt user to mount volume
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| line1Ptr | Long — POINTER to Pascal-type string to appear at top of box | |
| line2Ptr | Long — POINTER to Pascal-type string to appear just below line 1 | |
| but1Ptr | Long — POINTER to Pascal-type string to appear inside button 1 | |
| but2Ptr | Long — POINTER to Pascal-type string to appear inside button 2 | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| whichButton | Word — Button number chosen; Return = 1, Esc = 2 | |
| ← | SP |
None
extern pascal Word TLTextMountVolume(line1Ptr,line2Ptr,but1Ptr,but2Ptr)
Saves state of text scrn & forces hardware to display text scrn regardless of current mode
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| stateHandle | Long — HANDLE to state record (see Toolbox Ref Vol2, Table 24-4) | |
| ← | SP |
None
extern pascal Handle SaveTextState()
Restores state of text screen from a specified handle and disposes of the handle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| stateHandle | Long — HANDLE to state record to restore | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void RestoreTextState(stateHandle)
Allows applications to communicate with each other (Tool Locator version >= 2.1)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| action | Word — 1 = add, 2 = get, 3 = delete (see Toolbox Ref Vol2, Table 24-3) | |
| type | Word — Message ID number | |
| messageHandle | Long — HANDLE to message | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0111 messNotFoundErr Specified message not found
extern pascal void MessageCenter(action,type,messageHandle)
Sets default Tool Pointer Table (TPT) to current TPT - Used to install a tool patch - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SetDefaultTPT()
Creates and associates a name with a new message, providing a mechanism for passing messages between programs
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| createItFlag | Word — BOOLEAN; indicates whether or not to create the message | |
| recordPointer | Long — POINTER to input record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| responseRecord | Long — Response record from call | |
| ← | SP |
$0111 messNotFoundErr Specified message not found
$0112 messageOvfl No message numbers available
$0113 srqNameTooLong Message name too long; it must be <= 62 characters.
Memory Manager errors Returned unchanged
extern pascal responseRecord MessageByName(createItFlag,recordPointer)
Starts and loads the tools specified in the input StartStop record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| userID | Word — Application user ID for system calls | |
| startStopRefDesc | Word — Type of reference stored in startStopRef | |
| startStopRef | Long — Reference to the StartStop record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| startStopRefRet | Long — Reference to resulting StartStop record | |
| ← | SP |
$0103 tlBadRecFlag StartStop record invalid
$0104 tlCantLoad A tool can't be loaded - check StartStop input record for valid tool numbers and versions and numTools value
System Loader errors Returned unchanged
Memory Manager errors Returned unchanged
GS/OS errors Returned unchanged
extern pascal long StartUpTools(userID,startStopRefDesc,startStopRef)
Shuts down the tools specified in the input StartStop record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| startStopRefDesc | Word — Type of reference stored in startStopRef | |
| startStopRef | Long — Reference to the StartStop record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ShutDownTools(startStopRefDesc,startStopRef)
Returns the handle to a message in the Message Center
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| flags | Word — Command flags | |
| messageRef | Long — Specifies which message to fetch | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — Handle of the specified message | |
| ← | SP |
$0111 messNotFoundErr Specified message not found
extern pascal Handle GetMsgHandle(flags,messageRef)
Call AcceptRequests to notify the system that you can receive requests
| Stack before call | ||
|---|---|---|
| previous contents | ||
| nameString | Long — Pointer to Pascal name string | |
| userID | Word — User ID associated with this request procedure | |
| requestProc | Long — Address of the request procedure to install | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0113 srqNameTooLong Message name too long; it must be <= 62 characters.
$0121 srqDuplicateName The name has already been used
extern pascal void AcceptRequests(nameString,userID,requestProc)
Sends the specified request to zero or more qualifying registered request procedures (IPC)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| reqCode | Word — Request code | |
| sendHow | Word — Specifies how to send the request | |
| target | Long — Specifies recipient of request | |
| dataIn | Long — Input data or pointer to input data | |
| dataOut | Long — POINTER to output buffer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0120 reqNotAccepted Nobody accepted the request
$0122 invalidSendRequest Bad combination of reqCode and target
extern pascal void SendRequest(reqCode,sendHow,target,dataIn,dataOut)
| Memory Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| MMBootInit | $0102 | Called ONLY by the Tool Locator when Memory Manager is initialized - not called by application |
| MMStartUp | $0202 | Starts up the Memory Manager for use by an application |
| MMShutDown | $0302 | Shuts down the Memory Manager when the application quits |
| MMVersion | $0402 | Returns the version number of the Memory Manager |
| MMReset | $0502 | Called ONLY when the system is Reset - not called by application |
| MMStatus | $0602 | Indicates whether or not the Memory Manager is active |
| NewHandle | $0902 | Creates a new block and returns the handle to the block |
| ReAllocHandle | $0A02 | Reallocates a purged block, using new attributes |
| RestoreHandle | $0B02 | Reallocates purged blk with same attrib, user ID, & size as the purged handle |
| AddToOOMQueue | $0C02 | Adds the specified out-of-memory routine to the head of the out-of-memory queue |
| RemoveFromOOMQ | $0D02 | Removes the specified out-of-memory routine from the queue |
| DisposeHandle | $1002 | Discards a specified block and deallocates its handle. The block is purged regardless of locked status and purge level. |
| DisposeAll | $1102 | Discards all of the handles and blocks belonging to a specifed user ID |
| PurgeHandle | $1202 | Purges a specified purgeable, unlocked block, but doesn't deallocate handle |
| PurgeAll | $1302 | Purges all of the purgeable, unlocked blocks for a specified user ID |
| GetHandleSize | $1802 | Returns the size of a block |
| SetHandleSize | $1902 | Changes the size of a specified block |
| FindHandle | $1A02 | Returns the handle of a block containing a specified address. If the block is not locked, it may later move. |
| FreeMem | $1B02 | Returns the total number of free bytes in memory |
| MaxBlock | $1C02 | Returns size of largest free mem block, but not mem that can be freed by purge or compact |
| TotalMem | $1D02 | Returns the size of all memory, including the main 256k |
| CheckHandle | $1E02 | Checks a specified handle to see whether it is valid |
| CompactMem | $1F02 | Compacts memory space |
| HLock | $2002 | Locks a block, specified by handle |
| HLockAll | $2102 | Locks all of the blocks belonging to a specified user ID |
| HUnlock | $2202 | Unlocks a specified block |
| HUnlockAll | $2302 | Unlocks all of the blocks belonging to a specified user ID |
| SetPurge | $2402 | Sets the purge level of a specified block. 0=Not, 1=Least, 2=Next Most, 3=Most (3 is only for System Loader, use levels 0-2) |
| SetPurgeAll | $2502 | Sets the purge level of all blocks belonging to a specified user ID |
| PtrToHand | $2802 | Copies spec. # of bytes from src to dest., w/src spec. by pointer, & dest. spec. by handle |
| HandToPtr | $2902 | Copies spec. # of bytes from src to dest., w/src spec. by handle, & dest. spec. by pointer |
| HandToHand | $2A02 | Copies spec. # of bytes from src to dest., w/src spec. by handle, & dest. spec. by handle |
| BlockMove | $2B02 | Copies a specified number of bytes from a source to a destination |
| RealFreeMem | $2F02 | Returns number of free bytes in memory, plus number that could be made free by purging |
| SetHandleID | $3002 | Provides a supported way to determine and optionally change the User ID associated with a Memory Manager handle |
Called ONLY by the Tool Locator when Memory Manager is initialized - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Memory Manager for use by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID assigned to the application by the operating system | |
| ← | SP |
$0207 idErr Invalid user ID
extern pascal Word MMStartUp()
Shuts down the Memory Manager when the application quits
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID of the application to be shut down | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MMShutDown(userID)
Returns the version number of the Memory Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Memory Manager | |
| ← | SP |
None
extern pascal Word MMVersion()
Called ONLY when the system is Reset - not called by application
The stack is not affected by this call. There are no input or output parameters.
$0201 memErr Unable to allocate memory
Call must not be made by an application.
Indicates whether or not the Memory Manager is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Memory Manager is active, FALSE if inactive | |
| ← | SP |
None
extern pascal Boolean MMStatus()
Creates a new block and returns the handle to the block
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| blockSize | Long — Size in bytes of block to create | |
| userID | Word — User ID to be associated with the block | |
| attributes | Word — Attributes (see Toolbox Ref Vol1 Figure 12-9) | |
| locationPtr | Long — POINTER to where in memory the block is to begin | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — HANDLE of new block; empty if block of 0 bytes created | |
| ← | SP |
$0201 memErr Unable to allocate memory
$0204 lockErr Illegal operation on a locked or immovable block
$0207 idErr Invalid user ID
extern pascal Handle NewHandle(blockSize,userID,attributes,locationPtr)
Reallocates a purged block, using new attributes
| Stack before call | ||
|---|---|---|
| previous contents | ||
| blockSize | Long — Size in bytes of block to create | |
| userID | Word — User ID to be associated with the block | |
| attributes | Word — Attributes (see Toolbox Ref Vol1 Figure 12-9) | |
| locationPtr | Long — POINTER to where in memory the block is to begin | |
| theHandle | Long — HANDLE of the block to reallocate | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0201 memErr Unable to allocate memory
$0203 notEmptyErr Illegal operation on a handle that is not empty
$0204 lockErr Illegal operation on a locked or immovable block
$0206 handleErr Invalid handle
$0207 idErr Invalid user ID
extern pascal void ReallocHandle(blockSize,userID,attributes,locationPtr,theHandle)
Reallocates purged blk with same attrib, user ID, & size as the purged handle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — HANDLE of the block to restore | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0201 memErr Unable to allocate memory
$0203 notEmptyErr Illegal operation on a handle that is not empty
$0206 handleErr Invalid handle
$0208 attrErr Illegal operation for the specified attributes
extern pascal void RestoreHandle(theHandle)
Adds the specified out-of-memory routine to the head of the out-of-memory queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| headerPtr | Long — POINTER to out-of-memory routine | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0381 invalidTag The correct signature value was not found in the header
extern pascal void AddToOOMQueue(headerPtr)
Removes the specified out-of-memory routine from the queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| headerPtr | Long — POINTER to out-of-memory routine | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0380 notInList Specified routine not found in queue
$0381 invalidTag The correct signature value was not found in the header
extern pascal void RemoveFromOOMQueue(headerPtr)
Discards a specified block and deallocates its handle. The block is purged regardless of locked status and purge level.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — HANDLE of the block to be discarded | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0206 handleErr Invalid handle
extern pascal void DisposeHandle(theHandle)
Discards all of the handles and blocks belonging to a specifed user ID
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID whose handles will be discarded | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0207 idErr Invalid user ID
extern pascal void DisposeAll(userID)
Purges a specified purgeable, unlocked block, but doesn't deallocate handle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — HANDLE of the block to be purged | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0204 lockErr Illegal operation on a locked or immovable block
$0205 purgeErr Attempt to purge an unpurgeable block
$0206 handleErr Invalid handle
extern pascal void PurgeHandle(theHandle)
Purges all of the purgeable, unlocked blocks for a specified user ID
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID whose blocks will be purged | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0202 emptyErr Illegal operation on an empty handle
$0206 handleErr Invalid handle
$0207 idErr Invalid user ID
extern pascal void PurgeAll(userID)
Returns the size of a block
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theHandle | Long — HANDLE of block whose size is to be retrieved | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| blockSize | Long — Size of block, in bytes | |
| ← | SP |
$0206 handleErr Invalid handle
extern pascal LongWord GetHandleSize(theHandle)
Changes the size of a specified block
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newSize | Long — New size of blocks in bytes | |
| theHandle | Long — HANDLE of the block whose size is to be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0201 memErr Unable to allocate memory
$0202 emptyErr Illegal operation on an empty handle
$0204 lockErr Illegal operation on a locked or immovable block
$0206 handleErr Invalid handle
extern pascal void SetHandleSize(newSize,theHandle)
Returns the handle of a block containing a specified address. If the block is not locked, it may later move.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| locationPtr | Long — POINTER whose handle will be found | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — HANDLE of locationPtr; NIL if not found | |
| ← | SP |
None
extern pascal Handle FindHandle(locationPtr)
Returns the total number of free bytes in memory
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| freeSize | Long — Total number of free bytes in memory | |
| ← | SP |
None
extern pascal LongWord FreeMem()
Returns size of largest free mem block, but not mem that can be freed by purge or compact
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| blockSize | Long — Size in bytes of largest free block in memory | |
| ← | SP |
None
extern pascal LongWord MaxBlock()
Returns the size of all memory, including the main 256k
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| totalSize | Long — Total size in bytes of memory, including main 256K | |
| ← | SP |
None
extern pascal LongWord TotalMem()
Checks a specified handle to see whether it is valid
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — HANDLE whose validity will be checked | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0206 handleErr Invalid handle
extern pascal void CheckHandle(theHandle)
Compacts memory space
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void CompactMem()
Locks a block, specified by handle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — HANDLE of the block to be locked | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0206 handleErr Invalid handle
extern pascal void HLock(theHandle)
Locks all of the blocks belonging to a specified user ID
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID whose blocks will be locked | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0207 idErr Invalid user ID
extern pascal void HLockAll(userID)
Unlocks a specified block
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theHandle | Long — HANDLE of the block to be locked | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0206 handleErr Invalid handle
extern pascal void HUnlock(theHandle)
Unlocks all of the blocks belonging to a specified user ID
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID whose blocks will be unlocked | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0207 idErr Invalid user ID
extern pascal void HUnlockAll(userID)
Sets the purge level of a specified block. 0=Not, 1=Least, 2=Next Most, 3=Most (3 is only for System Loader, use levels 0-2)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newPurgeLevel | Word — New purge level of block (bits 1-0 only; set others to 0) | |
| theHandle | Long — HANDLE of the block whose purge level is to be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0206 handleErr Invalid handle
extern pascal void SetPurge(newPurgeLevel,theHandle)
Sets the purge level of all blocks belonging to a specified user ID
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newPurgeLevel | Word — New purge level of block (bits 1-0 only; set others to 0) | |
| userID | Word — User ID whose blocks are to be set to newPurgeLevel | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0207 idErr Invalid user ID
extern pascal void SetPurgeAll(newPurgeLevel,userID)
Copies spec. # of bytes from src to dest., w/src spec. by pointer, & dest. spec. by handle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sourcePtr | Long — POINTER specifying start of bytes to be copied | |
| destHandle | Long — HANDLE specifying starting adress where bytes will be written | |
| count | Long — Number of bytes to be copied | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0202 emptyErr Illegal operation on an empty handle
$0206 handleErr Invalid handle
extern pascal void PtrToHand(sourcePtr,destHandle,count)
Copies spec. # of bytes from src to dest., w/src spec. by handle, & dest. spec. by pointer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sourceHandle | Long — HANDLE specifying start of bytes to be copied | |
| destPtr | Long — POINTER to starting adress where bytes will be written | |
| count | Long — Number of bytes to be copied | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0202 emptyErr Illegal operation on an empty handle
$0206 handleErr Invalid handle
extern pascal void HandToPtr(sourceHandle,destPtr,count)
Copies spec. # of bytes from src to dest., w/src spec. by handle, & dest. spec. by handle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sourceHandle | Long — HANDLE specifying start of bytes to be copied | |
| destHandle | Long — HANDLE specifying starting adress where bytes will be written | |
| count | Long — Number of bytes to be copied | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0202 emptyErr Illegal operation on an empty handle
$0206 handleErr Invalid handle
extern pascal void HandToHand(sourceHandle,destHandle,count)
Copies a specified number of bytes from a source to a destination
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sourcePtr | Long — POINTER to start of bytes to be copied | |
| destPtr | Long — POINTER to starting adress where bytes will be written | |
| count | Long — Number of bytes to be copied | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void BlockMove(sourcePtr,destPtr,count)
Returns number of free bytes in memory, plus number that could be made free by purging
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| freeBytes | Long — Number of bytes available in memory | |
| ← | SP |
None
extern pascal Long RealFreeMem()
Provides a supported way to determine and optionally change the User ID associated with a Memory Manager handle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for old ID | |
| newID | Word — New ID for handle (0 to leave it unchanged) | |
| theHandle | Long — Handle to be updated | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| oldID | Word — Handle's previous ID | |
| ← | SP |
None
extern pascal word SetHandleID(newID,theHandle)
| Misc Tools Calls | ||
|---|---|---|
| Routine | # | Description |
| MTBootInit | $0103 | Initializes the Miscellaneous Tools Set; called only by Tool Locator |
| MTStartUp | $0203 | Starts up the Miscellaneous Tool Set for use by an application |
| MTShutDown | $0303 | Shuts down the Miscellaneous Tool Set when an application quits |
| MTVersion | $0403 | Returns the version number of the Miscellaneous Tool Set |
| MTReset | $0503 | Resets the Miscellaneous Tool Set; called only when the system is reset |
| MTStatus | $0603 | Indicates whether the Miscellaneous Tools Set is active |
| WriteBRam | $0903 | Writes 252 bytes of data from a specified mem loc, plus 4 checksum bytes, to Battery RAM |
| ReadBRam | $0A03 | Reads 252 bytes of data from Battery RAM, plus 4 checksum bytes, & writes to specified mem loc |
| WriteBParam | $0B03 | Writes data to a specified paramameter in Battery RAM |
| ReadBParam | $0C03 | Reads data from a specified parameter in Battery RAM |
| ReadTimeHex | $0D03 | Returns current time in hexadecimal format |
| WriteTimeHex | $0E03 | Sets the current time in hexadecimal format |
| ReadAsciiTime | $0F03 | Reads elapsed time since 00:00:00, Jan 1, 1904, converts it to ASCII output at specified address |
| SetVector | $1003 | Sets the vector address for a specified interrupt manager or handler |
| GetVector | $1103 | Returns the vector address for a specified interrupt manager or handler |
| SetHeartBeat | $1203 | Installs a specified task into the HeartBeat Interrupt Task queue |
| DelHeartBeat | $1303 | Deletes a specified task from the HeartBeat Interrupt Task queue |
| ClrHeartBeat | $1403 | Removes all tasks from the Heartbeat Interrupt Task queue by clearing Heartbeat Task pointer |
| SysFailMgr | $1503 | Displays system failure message and halts program execution |
| GetAddr | $1603 | Returns an address of a byte, word, or long parameter referenced by the firmware |
| ReadMouse | $1703 | Returns mouse position, status, and mode |
| InitMouse | $1803 | Initializes mouse clamp values to $000 min & $3FF max & clears mouse mode & status |
| SetMouse | $1903 | Sets the mouse mode |
| HomeMouse | $1A03 | Positions the mouse at the minimum clamp position |
| ClearMouse | $1B03 | Sets X & Y axis to $0000 if min clamps are negative or to the min clamp pos if positive |
| ClampMouse | $1C03 | Sets new clamp values & then sets the mouse position to the minimum clamp values |
| GetMouseClamp | $1D03 | Returns the current mouse clamp values |
| PosMouse | $1E03 | Positions the mouse at specified coordinates |
| ServeMouse | $1F03 | Returns the mouse interrupt status |
| GetNewID | $2003 | Creates a new user ID |
| DeleteID | $2103 | Deletes all references to a specified user ID |
| StatusID | $2203 | Indicates whether a specified user ID is active |
| IntSource | $2303 | Enables or disables certain interrupt sources |
| FWentry | $2403 | Allows some Apple II emulation-mode entry points to be supported from full native mode |
| GetTick | $2503 | Returns the current value of the tick counter |
| PackBytes | $2603 | Packs bytes into a special format that uses less storage space |
| UnPackBytes | $2703 | Umpacks data from the packed format used by PackBytes |
| Munger | $2803 | Manipulates bytes in a string of bytes (like find and replace) |
| GetIRQEnable | $2903 | Returns w/hardware interrupt enable states for interrupt sources that Misc.Tool can control |
| SetAbsClamp | $2A03 | Sets the clamp values for an absolute device to new values |
| GetAbsClamp | $2B03 | Returns the current values of the absolute device clamps |
| SysBeep | $2C03 | Calls the Apple II monitor entry point BELL1 |
| BasicInit | $2D03 | Unofficial call to set up the clamp flags when calling from BASICMOUSE |
| AddToQueue | $2E03 | Adds the specified entry to a queue |
| DeleteFromQueue | $2F03 | Deletes a specified element from a queue |
| SetInterruptState | $3003 | Copies the specified number of bytes from the input interrupt state record into the system interrupt variables |
| GetInterruptState | $3103 | Copies the specified number of bytes into an input interrupt record from the system interrupt variables |
| GetIntStateRecSize | $3203 | Returns the size (in bytes) of the interrupt state record |
| ReadMouse2 | $3303 | Returns the mouse position, status, and mode |
| GetCodeResConverter | $3403 | Returns the address of a routine that loads code resources |
| GetROMResource | $3503 | This call is for use only by system firmware |
| ReleaseROMResource | $3603 | This call is for use only by system firmware |
| ConvSeconds | $3703 | Allows conversion to and from a long integer containing the number of seconds since January 1, 1904 |
| SysBeep2 | $3803 | SysBeep2 takes an integer parameter indicating what sound to make |
| VersionString | $3903 | Converts a 32-bit Version number into a Pascal string |
| WaitUntil | $3A03 | Provides an upper limit on the frequency of repeating actions |
| StringToText | $3B03 | StringToText translates 8-bit-character text into similar text that can be displayed on the Apple IIGS text screen |
| ShowBootInfo | $3C03 | Provides a way for special system extensions to make their presence known while the system is starting up |
| ScanDevices | $3D03 | Provides easy access to a GS/OS system service vector which checks for disk insertions |
| AlertMessage | $3E03 | Displays a message on either the text screen or the Super Hi-Res screen and makes the user choose 1 of up to 3 buttons |
| DoSysPrefs | $3F03 | Clears and then sets specified bits in the GS/OS system preferences word |
Initializes the Miscellaneous Tools Set; called only by Tool Locator
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Miscellaneous Tool Set for use by an application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void MTStartUp()
Shuts down the Miscellaneous Tool Set when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void MTShutDown()
Returns the version number of the Miscellaneous Tool Set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Miscellaneous Tool Set | |
| ← | SP |
None
extern pascal Word MTVersion()
Resets the Miscellaneous Tool Set; called only when the system is reset
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the Miscellaneous Tools Set is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Miscellaneous Tool Set is active, FALSE if not | |
| ← | SP |
None
extern pascal Boolean MTStatus()
Writes 252 bytes of data from a specified mem loc, plus 4 checksum bytes, to Battery RAM
| Stack before call | ||
|---|---|---|
| previous contents | ||
| bufferPtr | Long — POINTER to the 252 bytes to be written to Battery RAM | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void WriteBRam(bufferPtr)
Reads 252 bytes of data from Battery RAM, plus 4 checksum bytes, & writes to specified mem loc
| Stack before call | ||
|---|---|---|
| previous contents | ||
| bufferPtr | Long — POINTER to the 256 bytes to be written to application | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ReadBRam(bufferPtr)
Writes data to a specified paramameter in Battery RAM
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theData | Word — Data to be written (low-order byte only)on | |
| paramRefNum | Word — Parameter reference number (see Toolbox Ref Vol1, Table 14-3) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void WriteBParam(theData,paramRefNum)
Reads data from a specified parameter in Battery RAM
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| paramRefNum | Word — Parameter reference number (see Toolbox Ref Vol1, Table 14-3) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theData | Word — Data that was read (low-order byte only) | |
| ← | SP |
None
extern pascal word ReadBParam(paramRefNum)
Returns current time in hexadecimal format
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| weekDay | null | Byte — Day of week (1-7, with 1=Sunday...) | Byte — Padding the word | |
| month | day | Byte — Month (0-11, with 1=January...) | Byte — Date (0-30) | |
| curYear | hour | Byte — Current year minus 1900 | Byte — Hour (0-23) | |
| minute | second | Byte — Minute (0-59) | Byte — Second (0-59) | |
| ← | SP |
None
extern pascal TimeRec ReadTimeHex()
Sets the current time in hexadecimal format
| Stack before call | ||
|---|---|---|
| previous contents | ||
| month | day | Byte — Month (0-11, with 1=January...) | Byte — Date (0-30) | |
| curYear | hour | Byte — Current year minus 1900 | Byte — Hour (0-23) | |
| minute | second | Byte — Minute (0-59) | Byte — Second (0-59) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void WriteTimeHex(month,day,curYear,hour,minute,second)
Reads elapsed time since 00:00:00, Jan 1, 1904, converts it to ASCII output at specified address
| Stack before call | ||
|---|---|---|
| previous contents | ||
| bufferPtr | Long — POINTER to start of buffer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ReadAsciiTime(bufferPtr)
Sets the vector address for a specified interrupt manager or handler
| Stack before call | ||
|---|---|---|
| previous contents | ||
| vectorRefNum | Word — Vector to be set (see Toolbox Ref Vol1 Figure 14-9) | |
| vectorPtr | Long — POINTER to the manager or handle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetVector(vectorRefNum,vectorAddrPtr)
Returns the vector address for a specified interrupt manager or handler
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| vectorRefNum | Word — Vector reference number of manager or handler | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| vectorPtr | Long — POINTER to the manager or handle | |
| ← | SP |
None
extern pascal Pointer GetVector(vectorRefNum)
Installs a specified task into the HeartBeat Interrupt Task queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| taskPtr | Long — POINTER to task header | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0303 taskInstlErr Specified task already in heartbeat queue
$0304 noSigTaskErr No signature detected in the task header
$0305 queueDmgdErr Damaged Heartbeat queue detected
extern pascal void SetHeartBeat(taskPtr)
Deletes a specified task from the HeartBeat Interrupt Task queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| taskPtr | Long — POINTER to task header | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0305 queueDmgdErr Damaged Heartbeat queue detected
$0306 queueDmgdErr Specified task not in queue
extern pascal void DelHeartBeat(taskPtr)
Removes all tasks from the Heartbeat Interrupt Task queue by clearing Heartbeat Task pointer
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ClrHeartBeat()
Displays system failure message and halts program execution
| Stack before call | ||
|---|---|---|
| previous contents | ||
| errorCode | Word — Error code (see Toolbox Ref Vol1 Figure 14-8) | |
| strPtr | Long — POINTER to ASCII string to be displayed as system failure message | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SysFailMgr(errorCode,strPtr)
Returns an address of a byte, word, or long parameter referenced by the firmware
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| refNum | Word — Parameter reference number (see Toolbox Ref Vol1, Table 14-5) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| paramPtr | Long — POINTER to parameter | |
| ← | SP |
$0301 badInputErr Bad input parameter
extern pascal Pointer GetAddr(refNum)
Returns mouse position, status, and mode
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| xPosition | Word — X position of the mouse | |
| yPosition | Word — Y position of the mouse | |
| status | mode | Byte — Mouse status | Byte — Mouse mode | |
| ← | SP |
$0309 unCnctdDevErr Dispatch attempted to unconnected device
extern pascal MouseRec ReadMouse()
Initializes mouse clamp values to $000 min & $3FF max & clears mouse mode & status
| Stack before call | ||
|---|---|---|
| previous contents | ||
| mouseSlot | Word — Requests search for mouse ($0000) or slot for mouse ($0001-7) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0302 noDevParamErr device for the input parameter
extern pascal void InitMouse(mouseSlot)
Sets the mouse mode
| Stack before call | ||
|---|---|---|
| previous contents | ||
| mouseMode | Word — Mouse mode, low-order byte only (see Toolbox Ref V1, Table 14-7) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMouse(mouseMode)
Positions the mouse at the minimum clamp position
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void HomeMouse()
Sets X & Y axis to $0000 if min clamps are negative or to the min clamp pos if positive
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ClearMouse()
Sets new clamp values & then sets the mouse position to the minimum clamp values
| Stack before call | ||
|---|---|---|
| previous contents | ||
| xMinClamp | Word — Minimum clamp value for the X axis | |
| xMaxClamp | Word — Maximum clamp value for the X axis | |
| yMinClamp | Word — Minimum clamp value for the Y axis | |
| yMaxClamp | Word — Maximum clamp value for the Y axis | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ClampMouse(xMinClamp,xMaxClamp,yMinClamp,yMaxClamp)
Returns the current mouse clamp values
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| xMinClamp | Word — Minimum clamp value for the X axis | |
| xMaxClamp | Word — Maximum clamp value for the X axis | |
| yMinClamp | Word — Minimum clamp value for the Y axis | |
| yMaxClamp | Word — Maximum clamp value for the Y axis | |
| ← | SP |
None
extern pascal ClampRec GetMouseClamp()
Positions the mouse at specified coordinates
| Stack before call | ||
|---|---|---|
| previous contents | ||
| xPos | Word — X axis (horizontal) position of mouse | |
| yPos | Word — Y axis (vertical) position of mouse | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PosMouse(xPos,yPos)
Returns the mouse interrupt status
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| intStatus | Word — Mouse interrupt status (see Toolbox Ref Vol1 Figure 14-2) | |
| ← | SP |
None
extern pascal Word ServeMouse()
Creates a new user ID
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| idTag | Word — High-order byte = type and auxID fields; low-order byte = $0000 | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| userID | Word — Complete user ID | |
| ← | SP |
$0301 badInputErr Bad input parameter
$030B idTagNtAvlErr No ID tag available
extern pascal Word GetNewID(idTag)
Deletes all references to a specified user ID
| Stack before call | ||
|---|---|---|
| previous contents | ||
| idTag | Word — The type and mainID fields of the user ID to delete | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DeleteID(idTag)
Indicates whether a specified user ID is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| idTag | Word — The type and mainID fields of the desired user ID | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$030B idTagNtAvlErr No ID tag available
extern pascal void StatusID(idTag)
Enables or disables certain interrupt sources
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcRefNum | Word — Source reference number of interrupt (see Toolbox Ref Vol1 Figure 14-6) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void IntSource(srcRefNum)
Allows some Apple II emulation-mode entry points to be supported from full native mode
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| aRegValue | Word — Accumulator at entry (low-order byte only) | |
| xRegValue | Word — X register at entry (low-order byte only) | |
| yRegValue | Word — Y register at entry (low-order byte only) | |
| eModeEntryPt | Word — Emulation mode entry point | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| status | Word — Processor status at exit (high-order byte only) | |
| aRegExit | Word — Accumulator at exit (low-order byte only) | |
| xRegExit | Word — X register at exit (low-order byte only) | |
| yRegExit | Word — Y register at exit (low-order byte only) | |
| ← | SP |
None
extern pascal FWRec FWEntry(aRegValue,xRegValue,yRegValue,eModeEntryPt)
Returns the current value of the tick counter
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| tickCounter | Long — Current value of the tick counter | |
| ← | SP |
None
extern pascal LongWord GetTick()
Packs bytes into a special format that uses less storage space
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| startHandle | Long — POINTER to POINTER to start of area to be packed | |
| sizePtr | Long — POINTER to Word containing size of the area | |
| bufferPtr | Long — POINTER to the start of the output buffer area | |
| bufferSize | Word — Size of the output buffer area | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| numPackbytes | Word — Number of packed bytes generated | |
| ← | SP |
None
extern pascal Word PackBytes(startHandle,sizePtr,bufferPtr,bufferSize)
Umpacks data from the packed format used by PackBytes
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| bufferPtr | Long — POINTER to the buffer containing the packed data | |
| bufferSize | Word — Size of the packed data buffer | |
| startHandle | Long — POINTER to POINTER to area where the data will be unpacked | |
| sizePtr | Long — POINTER to Word containing size of area for unpacked data | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| numUnpackbytes | Word — Number of source bytes unpacked | |
| ← | SP |
None
extern pascal Word UnPackBytes(bufferPtr,bufferSize,startHandle,sizePtr)
Manipulates bytes in a string of bytes (like find and replace)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| destPtr | Long — POINTER to the tect to be manipulated | |
| destLenPtr | Long — POINTER to number of bytes to manipulate | |
| targPtr | Long — POINTER to be searched for from destPtr | |
| targLen | Word — Number of bytes for targPtr | |
| replPtr | Long — POINTER to string to replace when targPtr found | |
| replLen | Word — Number of bytes for replPtr | |
| padPtr | Long — POINTER to character value to be added to short input | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| padBytesFound | Word — Number of bytes padded or truncated; 0 if target found; negative if not found | |
| ← | SP |
None
extern pascal Word Munger(destPtr,destLenPtr,targPtr,targLen,replPtr,replLen,padPtr)
Returns w/hardware interrupt enable states for interrupt sources that Misc.Tool can control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| hdIntStatus | Word — Status of hardware interrupts (see Toolbox Ref Vol1 Figure 14-1) | |
| ← | SP |
None
extern pascal Word GetIRQEnable()
Sets the clamp values for an absolute device to new values
| Stack before call | ||
|---|---|---|
| previous contents | ||
| xMinClamp | Word — Minimum clamp value for the X axis | |
| xMaxClamp | Word — Maximum clamp value for the X axis | |
| yMinClamp | Word — Minimum clamp value for the Y axis | |
| yMaxClamp | Word — Maximum clamp value for the Y axis | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetAbsClamp(xMinClamp,xMaxClamp,yMinClamp,yMaxClamp)
Returns the current values of the absolute device clamps
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| xMinClamp | Word — Minimum clamp value for the X axis | |
| xMaxClamp | Word — Maximum clamp value for the X axis | |
| yMinClamp | Word — Minimum clamp value for the Y axis | |
| yMaxClamp | Word — Maximum clamp value for the Y axis | |
| ← | SP |
None
extern pascal ClampRec GetAbsClamp()
Calls the Apple II monitor entry point BELL1
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SysBeep()
Unofficial call to set up the clamp flags when calling from BASICMOUSE
Adds the specified entry to a queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newEntryPtr | Long — POINTER to element to add to queue | |
| headerPtr | Long — POINTER to first queue element | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0381 invalidTag The correct signature value was not found in the header
$0382 alreadyInQueue Specified element already in queue
extern pascal void AddToQueue(newEntryPtr,headerPtr)
Deletes a specified element from a queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| entryPtr | Long — POINTER to element to delete from queue | |
| headerPtr | Long — POINTER to first queue element | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0380 notInList Specified routine not found in queue
$0381 invalidTag The correct signature value was not found in the header
extern pascal void DeleteFromQueue(entryPtr,headerPtr)
Copies the specified number of bytes from the input interrupt state record into the system interrupt variables
| Stack before call | ||
|---|---|---|
| previous contents | ||
| intStateRcdPtr | Long — POINTER to interrupt state record | |
| bytesDesired | Word — Number of bytes to copy from record to system | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetInterruptState(intStateRcdPtr,bytesDesired)
Copies the specified number of bytes into an input interrupt record from the system interrupt variables
| Stack before call | ||
|---|---|---|
| previous contents | ||
| intStateRcdPtr | Long — POINTER to interrupt state record | |
| bytesDesired | Word — Number of bytes to copy from system to record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetlnterruptState(intStateRcdPtr,bytesDesired)
Returns the size (in bytes) of the interrupt state record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| sizeOfRecord | Word — Length of interrupt state record, in bytes | |
| ← | SP |
None
extern pascal Word GetIntStateRecSize()
Returns the mouse position, status, and mode
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| xPosition | Word — X position of the mouse | |
| yPosition | Word — Y position of the mouse | |
| statusMode | Word — Status and mode bytes | |
| ← | SP |
$0309 unCnctdDevErr Dispatch attempted to unconnected device
extern pascal MouseRec ReadMouse2()
Returns the address of a routine that loads code resources
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| pointer | Long — POINTER to code resource converter routine | |
| ← | SP |
None
extern pascal Pointer GetCodeResConverter()
This call is for use only by system firmware
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
This call is for use only by system firmware
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Allows conversion to and from a long integer containing the number of seconds since January 1, 1904
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| convVerb | Word — Direction and type of conversion | |
| seconds | Long — Number of seconds since January 1, 1904 | |
| datePtr | Long — POINTER to buffer for converted date | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| secondsOut | Long — Resulting number of seconds | |
| ← | SP |
$0390 badTimeVerb Invalid convVerb value
$0391 badTimeData Invalid date or time to be converted
extern pascal unsigned long ConvSeconds(convVerb,seconds,datePtr)
SysBeep2 takes an integer parameter indicating what sound to make
| Stack before call | ||
|---|---|---|
| previous contents | ||
| beepType | Word — Beep type | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SysBeep2(beepType)
Converts a 32-bit Version number into a Pascal string
| Stack before call | ||
|---|---|---|
| previous contents | ||
| flags | Word — Reserved (pass 0) | |
| theVersion | Long — The version number to convert | |
| stringPtr | Long — POINTER to a 10-byte buffer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void VersionString(flags,theVersion,stringPtr)
Provides an upper limit on the frequency of repeating actions
| Stack before call | ||
|---|---|---|
| previous contents | ||
| space | Word — Space for result | |
| delayFrom | Word — Anchor point to delay from | |
| delayAmount | Word — Specifies how long to wait for anchor | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| newTime | Word — New anchor point for next call | |
| ← | SP |
None
extern pascal Word WaitUntil(delayFrom,delayAmount)
StringToText translates 8-bit-character text into similar text that can be displayed on the Apple IIGS text screen
| Stack before call | ||
|---|---|---|
| previous contents | ||
| space | Word — Space for result | |
| space | Word — Space for result | |
| flags | Word — Flags | |
| textPtr | Long — POINTER to source text | |
| textLen | Word — Length of text | |
| resultPtr | Long — POINTER to result buffer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| resultFlags | Word — Result flags | |
| printableLength | Word — Number of printing charachters in result | |
| ← | SP |
$034F mtBufferTooSmall The buffer is too small
extern pascal Long StringToText(flags,textPtr,textLen,resultPtr)
Provides a way for special system extensions to make their presence known while the system is starting up
| Stack before call | ||
|---|---|---|
| previous contents | ||
| cStringPtr | Long — POINTER to zero-terminated string (or NIL) | |
| iconPtr | Long — POINTER to DrawIcon-style icon (or NIL) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ShowBootInfo(cStringPtr,iconPtr)
Provides easy access to a GS/OS system service vector which checks for disk insertions
| Stack before call | ||
|---|---|---|
| previous contents | ||
| space | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| deviceNumber | Word — Device number | |
| ← | SP |
None
extern pascal Word ScanDevices()
Displays a message on either the text screen or the Super Hi-Res screen and makes the user choose 1 of up to 3 buttons
| Stack before call | ||
|---|---|---|
| previous contents | ||
| space | Word — Space for result | |
| tablePtr | Long — POINTER to the message table | |
| msgNumber | Word — Message index number (0, 1, 2...) | |
| substitutions | Long — POINTER to the string substitution table | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| buttonNum | Word — Button chosen by the user | |
| ← | SP |
$0377 onlyFromGSOS You called AlertMessage from ProDOS 8
extern pascal Word AlertMessage(tablePtr,msgNumber,substitutions)
Clears and then sets specified bits in the GS/OS system preferences word
| Stack before call | ||
|---|---|---|
| previous contents | ||
| space | Word — Space for result | |
| bitsToClear | Word — System preference bits to clear | |
| bitsToSet | Word — System preference bits to set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| oldSysPrefs | Word — Previous system preference word | |
| ← | SP |
$0301 badInputErr Bad input parameter
extern pascal Word DoSysPrefs(bitsToClear,bitsToSet)
| QuickDraw Calls | ||
|---|---|---|
| Routine | # | Description |
| QDBootInit | $0104 | Initializes QuickDraw II; called only by the Tool Locator - not by application |
| QDStartUp | $0204 | Starts up QuickDraw II for use by an application |
| QDShutDown | $0304 | Shuts down QuickDraw II when an application quits |
| QDVersion | $0404 | Returns the version number of QuickDraw II |
| QDReset | $0504 | Resets QuickDraw II; called only when the system is reset - not by application |
| QDStatus | $0604 | Indicates whether QuickDraw II is active |
| GetAddress | $0904 | Returns a pointer to a specified table |
| GrafOn | $0A04 | Turns on Super Hi-Res graphics mode |
| GrafOff | $0B04 | Turns off Super Hi-Res graphics mode |
| GetStandardSCB | $0C04 | Returns a copy of the standard scan line control byte (SCB) |
| InitColorTable | $0D04 | Returns a copy of the standard color table for the current mode |
| SetColorTable | $0E04 | Sets a specified color table to specified values |
| GetColorTable | $0F04 | Fills a specified color table with the contents of another color table |
| SetColorEntry | $1004 | Sets the value of a color in a specified color table |
| GetColorEntry | $1104 | Returns the value of a specified color in a specified color table |
| SetSCB | $1204 | Sets the SCB to a specified value |
| GetSCB | $1304 | Returns the value of a specified SCB |
| SetAllSCBs | $1404 | Sets all SCBs to a specified value |
| ClearScreen | $1504 | Sets the words in screen memory to a specified value |
| SetMasterSCB | $1604 | Sets the master SCB to a specified value |
| GetMasterSCB | $1704 | Returns a copy of the master SCB |
| OpenPort | $1804 | Initializes specified memory as a standard GrafPort, allocate a new visible region and clipping region, and set as current GrafPort. |
| InitPort | $1904 | Initializes specified memory locations as a standard port |
| ClosePort | $1A04 | Deallocates the clipping and visible regions in a port |
| SetPort | $1B04 | Makes a specified port the current GrafPort |
| GetPort | $1C04 | Returns a pointer to the current GrafPort |
| SetPortLoc | $1D04 | Sets the current port's locInfo record to specified location information |
| GetPortLoc | $1E04 | Gets the current port's locInfo record and puts it at the specified location |
| SetPortRect | $1F04 | Sets the current GrafPort's port rectangle to the specified rectangle |
| GetPortRect | $2004 | Returns the current GrafPort's port rectangle |
| SetPortSize | $2104 | Changes the size of the current Grafport's port rectangle |
| MovePortTo | $2204 | Changes the location of the current GrafPort's port rectangle |
| SetOrigin | $2304 | Adjust contents of port & bounds rectangles so up/left corner of port rect is set at specified point |
| SetClip | $2404 | Copies a specified region into the clipping region |
| GetClip | $2504 | Copies the clipping region to a specified region |
| ClipRect | $2604 | Changes clipping region of current GrafPort to a rectangle equal to a specified rectangle |
| HidePen | $2704 | Decrements the pen level |
| ShowPen | $2804 | Increments the pen level |
| GetPen | $2904 | Returns the pen location |
| SetPenState | $2A04 | Sets the pen state in the GrafPort to specified values |
| GetPenState | $2B04 | Returns the pen state from the GrafPort to a specified location |
| SetPenSize | $2C04 | Sets the current pen size to a specified pen size |
| GetPenSize | $2D04 | Returns the current pen size to a specified location |
| SetPenMode | $2E04 | Sets the current pen mode to a specified pen mode |
| GetPenMode | $2F04 | Returns the pen mode from the current GrafPort |
| SetPenPat | $3004 | Sets the current pen pattern to a specified pen pattern |
| GetPenPat | $3104 | Copies the current pen pattern from the current GrafPort to a specified location |
| SetPenMask | $3204 | Sets the pen mask to a specified mask |
| GetPenMask | $3304 | Returns the pen mask to a specified location |
| SetBackPat | $3404 | Sets the background pattern to a specified pattern |
| GetBackPat | $3504 | Copies current background pen pattern from current GrafPort to a specified location |
| PenNormal | $3604 | Sets the pen state to the standard state; pen location and visibility are not changed |
| SetSolidPenPat | $3704 | Sets the pen pattern to a solid pattern using the specified color |
| SetSolidBackPat | $3804 | Sets the background pattern to a solid pattern using a specified color |
| SolidPattern | $3904 | Sets a specified pattern to a solid pattern using a specified color |
| MoveTo | $3A04 | Moves the current pen location to a specified point |
| Move | $3B04 | Moves the current pen location by specified horizontal & vertical displacements |
| LineTo | $3C04 | Draws a line from the current pen location to a specified point |
| Line | $3D04 | Draws a line from current pen location to a new point specified by the horizontal and vertical displacements |
| SetPicSave | $3E04 | Sets the picSave field in the GrafPort to a specified value |
| GetPicSave | $3F04 | Returns the value of the picSave field of the GrafPort |
| SetRgnSave | $4004 | Sets the rgnSave field in the GrafPort ot a specified value |
| GetRgnSave | $4104 | Returns the value of the rgnSave field of the GrafPort |
| SetPolySave | $4204 | Sets the polySave field in the GrafPort to a specified value - not called by an application |
| GetPolySave | $4304 | Returns the value of the polySave field of the GrafPort |
| SetGrafProcs | $4404 | Sets the grafProcs field of the current GrafPort to a specified value |
| GetGrafProcs | $4504 | Returns the pointer to the grafProcs record associated witht the GrafPort |
| SetUserField | $4604 | Sets the userField in the GrafPort to a specified value |
| GetUserField | $4704 | Returns the value of the userField field of the GrafPort |
| SetSysField | $4804 | Sets the sysField field in GrafPort to a specified value - not called by an application |
| GetSysField | $4904 | Returns the value of the sysField field of the GrafPort |
| SetRect | $4A04 | Sets a specified rectangle to specified values |
| OffsetRect | $4B04 | Offsets a specified rectangle by specified displacements |
| InsetRect | $4C04 | Insets a specified rectangle by specified displacements |
| SectRect | $4D04 | Calculates intersection of two rectangles & places intersection in destination rectangle |
| UnionRect | $4E04 | Calculates smallest rectangle that contains both src rect & places results in dest rect |
| PtInRect | $4F04 | Detects whether the pixel below and to the right of specified point is in a specified rectangle |
| Pt2Rect | $5004 | Copies specified pt to uppr left corner of specified rect & another pt to lower right corner of rect |
| EqualRect | $5104 | Indicates whether two rectangles are equal |
| NotEmptyRect | $5204 | Indicates whether a specified rectangle is empty |
| FrameRect | $5304 | Draws the frame of a specified rectangle using the current pen mode, pattern, & size |
| PaintRect | $5404 | Paints the interior of specified rectangle using the current pen mode & pattern |
| EraseRect | $5504 | Erases the interior of a specified rectangle by filling it in with the background pattern |
| InvertRect | $5604 | Inverts the pixels in the interior of a specified rectangle |
| FillRect | $5704 | Fills the interior of a specified rectangle with a specified pen pattern |
| FrameOval | $5804 | Draws the frame of a specified oval using the current pen mode, pattern, & size |
| PaintOval | $5904 | Paints the interior of a specified oval using the current pen mode & pattern |
| EraseOval | $5A04 | Erases the interior of a specified oval by filling it in with the backround pattern |
| InvertOval | $5B04 | Inverts the pixels in the interior of a specified oval |
| FillOval | $5C04 | Fills the interior of a specified oval with a specified pen pattern |
| FrameRRect | $5D04 | Draws the frame of a specified round rectangle using the current pen mode, pattern & size |
| PaintRRect | $5E04 | Paints interior of specified round rectangle using the current pen mode & pattern |
| EraseRRect | $5F04 | Erases interior of a specified round rectangle by filling it in with the backround pattern |
| InvertRRect | $6004 | Inverts the pixels in the interior of a specified round rectangle |
| FillRRect | $6104 | Fills the interior of a specified round rectangle with a specified pen pattern |
| FrameArc | $6204 | Draws the frame of a specified arc using the current pen mode, pattern, & size |
| PaintArc | $6304 | Paints the interior of specified arc using the current pen mode & pattern |
| EraseArc | $6404 | Erases the interior of a specified arc by filling it in with the backround pattern |
| InvertArc | $6504 | Inverts the pixels in the interior of a specified arc |
| FillArc | $6604 | Fills the interior of a specified arc with a specified pen pattern |
| NewRgn | $6704 | Allocates space for a new region & initializes it to empty - only way to create new region |
| DisposeRgn | $6804 | Deallocates the memory for a specified region |
| CopyRgn | $6904 | Copies the region definition from one region to another |
| SetEmptyRgn | $6A04 | Destroys previous region information by setting a specified region to an empty region |
| SetRectRgn | $6B04 | Destroys previous region information by setting a specified region to a specified rectangle |
| RectRgn | $6C04 | Destroys previous region information by setting a specified region to a specified rectangle |
| OpenRgn | $6D04 | Allocates temp space & starts saving lines & framed shapes for later processing as a region definition. |
| CloseRgn | $6E04 | Completes the region definition process started by an OpenRgn call |
| OffsetRgn | $6F04 | Moves a region on the coordinate plane a specified distance |
| InsetRgn | $7004 | Shrinks or expands a specified region |
| SectRgn | $7104 | Calculates intersection of two regions & places intersection in a destination region |
| UnionRgn | $7204 | Calculates smallest region that contains every point that's in either source region and places result in destination region |
| DiffRgn | $7304 | Calculates the difference of two regions and places difference in a destination region |
| XorRgn | $7404 | Calculates the difference between the union and the intersection of two regions and places result in a destination region |
| PtInRgn | $7504 | Checks to see whether the pixel below & to right of a specified point1 is within a specified region |
| RectInRgn | $7604 | Checks whether a specified rectangle intersects a specified region |
| EqualRgn | $7704 | Indicates whether two regions are equal |
| EmptyRgn | $7804 | Indicates whether a specified region is empty |
| FrameRgn | $7904 | Draws the frame of a specified region using current pen mode, pattern & size |
| PaintRgn | $7A04 | Paints the interior of a specified region using the current pen mode & pattern |
| EraseRgn | $7B04 | Erases the interior of a specified region by filling it with the background pattern |
| InvertRgn | $7C04 | Inverts the pixels in the interior of a specified region |
| FillRgn | $7D04 | Fills the interior of a specified region with a specified pen pattern |
| ScrollRect | $7E04 | Shifts pixels inside intersect of specified rect, visble region, clip region, port rect, and bounds rect |
| PaintPixels | $7F04 | Transfers a region of pixels |
| AddPt | $8004 | Adds two specified points together and leaves result in destination point |
| SubPt | $8104 | Subtracts source point from destination point and leaves result in the destination point |
| SetPt | $8204 | Sets a point to specified horizontal and vertical values |
| EqualPt | $8304 | Indicates whether two points are equal |
| LocalToGlobal | $8404 | Converts a point from local coordinates to global coordinates |
| GlobalToLocal | $8504 | Converts a point from global coordinates to local coordinates |
| Random | $8604 | Returns a pseudorandom number in the range -32768 to 32767 |
| SetRandSeed | $8704 | Sets the seed value for the random number generator |
| GetPixel | $8804 | Returns the pixel below and to the right of a specified point |
| ScalePt | $8904 | Scales a specified point from a source rectangle to a destination rectangle |
| MapPt | $8A04 | Maps a specified point from a source rectangle to a destination rectangle |
| MapRect | $8B04 | Maps a specified rectangle from a source rectangle to a destination rectangle |
| MapRgn | $8C04 | Maps a specified region from a source rectangle to a destination rectangle |
| SetStdProcs | $8D04 | Sets up a specified record of pointers for customizing QuickDraw II operations |
| SetCursor | $8E04 | Sets the cursor to an image passed in a specified cursor record |
| GetCursorAdr | $8F04 | Returns a pointer to the current cursor record |
| HideCursor | $9004 | Hides the cursor by decrementing the cursor level |
| ShowCursor | $9104 | Shows the cursor by incrementing the cursor level |
| ObscureCursor | $9204 | Hides the cursor until the mouse moves |
| SetFont | $9404 | Sets the current font to a specified font |
| GetFont | $9504 | Returns a handle to the current font |
| GetFontInfo | $9604 | Returns information about the current font in a specified record |
| GetFontGlobals | $9704 | Returns information about the current font in a specified record |
| SetFontFlags | $9804 | Sets the font flags word to a specified value |
| GetFontFlags | $9904 | Returns the current font flags word |
| SetTextFace | $9A04 | Sets the text face to a specified value |
| GetTextFace | $9B04 | Returns the current text face |
| SetTextMode | $9C04 | Sets the text mode to a specified value |
| GetTextMode | $9D04 | Returns the current text mode |
| SetSpaceExtra | $9E04 | Sets the spExtra field in the GrafPort to a specified value |
| GetSpaceExtra | $9F04 | Returns the value of the spExtra field from the GrafPort |
| SetForeColor | $A004 | Sets the fgColor field (foreground color) in the GrafPort to a specified value |
| GetForeColor | $A104 | Returns the value of the current fgColor field (foreground color) from the GrafPort |
| SetBackColor | $A204 | Sets the bgColor field (background color) in the GrafPort to a specified value |
| GetBackColor | $A304 | Returns the value of the current bgColor field (background color) from the GrafPort |
| DrawChar | $A404 | Draws a specified character at current pen location and updates pen location |
| DrawString | $A504 | Draws a specified Pascal-type string at the current pen location and updates the pen location. |
| DrawCString | $A604 | Draws a specified C string at the current pen location and updates the pen location |
| DrawText | $A704 | Draws specified text at the current pen location and updates pen location |
| CharWidth | $A804 | Returns the character width, in pixels (pen displacement), of a specified character |
| StringWidth | $A904 | Returns sum of all char widths, in pixels (pen displacements), of specified Pascal-type string. |
| CStringWidth | $AA04 | Returns sum of all char widths, in pixels (pen displacements), of specified C string |
| TextWidth | $AB04 | Returns the character width, in pixels (pen displacements), of specified text |
| CharBounds | $AC04 | Puts the character bounds rectangle of a specified character into a specified buffer |
| StringBounds | $AD04 | Puts the character bounds rectangle of a specified Pascal-type string into specified buffer |
| CStringBounds | $AE04 | Puts char bounds rectangle of a specified C string into a specified buffer |
| TextBounds | $AF04 | Puts the character bounds rectangle of specified text into a specified buffer |
| SetArcRot | $B004 | Sets the arcRot field in the GrafPort to a specified value |
| GetArcRot | $B104 | Returns the value of the arcRot field in the current GrafPort |
| SetSysFont | $B204 | Sets a specified font as the system font |
| GetSysFont | $B304 | Returns a handle to the current system font |
| SetVisRgn | $B404 | Copies specified region into the visible region (but does not change the visRgn field of the GrafPort). |
| GetVisRgn | $B504 | Copies the contents of the visible region into a specified region. The region must have already been created with a NewRgn call. |
| SetIntUse | $B604 | Indicates to the cursor drawing code whether the code should use scan line interrupts. |
| OpenPicture | $B704 | Allocates memory for the recording of drawing commands into a picture definition, and returns a handle to the picture. |
| PicComment | $B804 | Inserts a specified comment into the currently open picture. |
| ClosePicture | $B904 | Completes the picture definition process begun by OpenPicture call. |
| DrawPicture | $BA04 | Takes drawing commands recorded in pic definition, maps them from picture frame into destination rectangle, and draws them. |
| KillPicture | $BB04 | Releases all memory occupied by a specifed picture. |
| FramePoly | $BC04 | Draws the frame of a specified polygon using the current pen mode, pattern, & size. Poly is framed with a series of LineTo calls. |
| PaintPoly | $BD04 | Paints the interior of a specified polygon using the current pen mode & pattern. |
| ErasePoly | $BE04 | Erases the interior of a specified polygon by filling it with the background pattern |
| InvertPoly | $BF04 | Inverts the pixels in the interior of a specified polygon. |
| FillPoly | $C004 | Fills the interior of a specified polygon with a specified pen pattern. |
| OpenPoly | $C104 | Returns a handle to a polygon data structure that will be updated by future LineTo calls. |
| ClosePoly | $C204 | Completes the polygon definition process started with an OpenPoly call. |
| KillPoly | $C304 | Disposes of a specified polygon. |
| OffsetPoly | $C404 | Offsets a specified polygon by specified horizontal & vertical displacements. |
| MapPoly | $C504 | Maps a specified polygon from a source rectangle to a destination rectangle |
| SetClipHandle | $C604 | Sets the clipRgn handle field in the GrafPort to a specified value. |
| GetClipHandle | $C704 | Returns a copy of the handle to the clipping region. |
| SetVisHandle | $C804 | Sets the visRgn field in the GrafPort to a specified value. |
| GetVisHandle | $C904 | Returns a copy of the handle to the visible region. |
| InitCursor | $CA04 | Reinitializes the cursor. The cursor is set to the arrow cursor and made visible. |
| SetBufDims | $CB04 | Sets size of QD II clipping and text buffers, padding to allow mods to chExtra & spExtra |
| ForceBufDims | $CC04 | Sets size of QD II clipping and text buffers, but doesn't pad maxFBRExtent in any way. |
| SaveBufDims | $CD04 | Saves QD II's buffer-sizing information in eight-byte record. |
| RestoreBufDims | $CE04 | Restores QD II's internal buffers to sizes described in an 8-byte record created by SaveBufDims |
| GetFGSize | $CF04 | Returns the size of the font globals record. |
| SetFontID | $D004 | Sets the fontID field in the GrafPort. |
| GetFontID | $D104 | Returns the fontID field of the GrafPort. |
| SetTextSize | $D204 | Sets the txSize field of the GrafPort to a specified value. |
| GetTextSize | $D304 | Returns current value of the txSize field of the GrafPort. |
| SetCharExtra | $D404 | Sets the chExtra field in the GrafPort to a specified value. |
| GetCharExtra | $D504 | Returns the chExtra field from the GrafPort |
| PPToPort | $D604 | Transfers pixels from a source pixel map to current port & clips pixels to current visble region & clipping region |
| InflateTextBuffer | $D704 | Ensures that the text buffer is big enough to handle a font with the specified width and height, increasing it if necessary. |
| GetROMFont | $D804 | Fills a specified buffer with information about the font in ROM |
| GetFontLore | $D904 | Returns info, up to a specified number of bytes, about the current font in a specified buffer |
| Get640Colors | $DA04 | Returns a pointer to a 512-byte table of 32 $00s, 32 $11s, ..., 32 $FFs, to be used as solid pen patterns. |
| Set640Color | $DB05 | Sets the current grafport's pen pattern to any of the 16 "solid" 640-mode dithered colors |
Initializes QuickDraw II; called only by the Tool Locator - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up QuickDraw II for use by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dPageAddr | Word — Bank $0 starting address for 3 pages of direct-page space | |
| masterSCB | Word — Master SCB for super Hi-Res graphics | |
| maxWidth | Word — INTEGER; size in bytes of largest pixel map, 0 for screen width | |
| userID | Word — User ID of application | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0401 alreadyInitialized QuickDraw II is already initialized
$0410 screenReserved Screen reserved
Memory Manager errors Returned unchanged
extern pascal void QDStartUp(dPageAddr,masterSCB,maxWidth,userID)
Shuts down QuickDraw II when an application quits
The stack is not affected by this call. There are no input or output parameters.
Memory Manager errors Returned unchanged
extern pascal void QDShutDown()
Returns the version number of QuickDraw II
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of QuickDraw II | |
| ← | SP |
None
extern pascal Word QDVersion()
Resets QuickDraw II; called only when the system is reset - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether QuickDraw II is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if QuickDraw II is active, FALSE if not | |
| ← | SP |
None
extern pascal Boolean QDStatus()
Returns a pointer to a specified table
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| tableID | Word — ID of table whose pointer will be retrieved | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| tablePtr | Long — POINTER to table in ROM | |
| ← | SP |
None
extern pascal Pointer GetAddress(tableID)
Turns on Super Hi-Res graphics mode
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void GrafOn()
Turns off Super Hi-Res graphics mode
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void GrafOff()
Returns a copy of the standard scan line control byte (SCB)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| scb | Word — Standard SCB (see Toolbox Ref Vol2 Figure 16-34) | |
| ← | SP |
None
extern pascal Word GetStandardSCB()
Returns a copy of the standard color table for the current mode
| Stack before call | ||
|---|---|---|
| previous contents | ||
| tablePtr | Long — POINTER to space for standard color table (see Toolbox Ref Vol2 Figure 16-7) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InitColorTable(tablePtr)
Sets a specified color table to specified values
| Stack before call | ||
|---|---|---|
| previous contents | ||
| tableNumber | Word — INTEGER; number of table whose color values will be set | |
| srcTablePtr | Long — POINTER to color table | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0450 badTableNum Invalid color table number; 0 to 15 are valid
extern pascal void SetColorTable(tableNumber,srcTablePtr)
Fills a specified color table with the contents of another color table
| Stack before call | ||
|---|---|---|
| previous contents | ||
| tableNumber | Word — INTEGER; color table to be copied | |
| destTablePtr | Long — POINTER to color table to receive new values | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0450 badTableNum Invalid color table number; 0 to 15 are valid
extern pascal void GetColorTable(tableNumber,destTablePtr)
Sets the value of a color in a specified color table
| Stack before call | ||
|---|---|---|
| previous contents | ||
| tableNumber | Word — INTEGER; number of color table | |
| entryNumber | Word — INTEGER; number of color to be changed | |
| newColor | Word — INTEGER; master color value for color | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0450 badTableNum Invalid color table number; 0 to 15 are valid
$0451 badColorNum Invalid color number; 0 to 15 are valid
extern pascal void SetColorEntry(tableNumber,entryNumber,newColor)
Returns the value of a specified color in a specified color table
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| tableNumber | Word — INTEGER; number of color table | |
| entryNumber | Word — INTEGER; number of color to be examined | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0450 badTableNum Invalid color table number; 0 to 15 are valid
$0451 badColorNum Invalid color number; 0 to 15 are valid
extern pascal Word GetColorEntry(tableNumber,entryNumber)
Sets the SCB to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| scanLine | Word — INTEGER; scan line whose SCB is to be set | |
| newSCB | Word — INTEGER; new value for SCB | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0452 badScanLine Invalid scan line number; 0 to 199 are valid
extern pascal void SetSCB(scanLine,newSCB)
Returns the value of a specified SCB
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| scanLine | Word — INTEGER; new value for SCB | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| scb | Word — Value of SCB | |
| ← | SP |
$0452 badScanLine Invalid scan line number; 0 to 199 are valid
extern pascal Word GetSCB(scanLine)
Sets all SCBs to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newSCB | Word — new value for SCB | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetAllSCBs(newSCB)
Sets the words in screen memory to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| colorWord | Word — Color as offset into current color table | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ClearScreen(colorWord)
Sets the master SCB to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| masterSCB | Word — Value for master SCB (low-order byte only; high-order byte=0) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMasterSCB(masterSCB)
Returns a copy of the master SCB
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| masterSCB | Word — Master SCB value | |
| ← | SP |
None
extern pascal Word GetMasterSCB()
Initializes specified memory as a standard GrafPort, allocate a new visible region and clipping region, and set as current GrafPort.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| portPtr | Long — POINTER to space for GrafPort record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void OpenPort(portPtr)
Initializes specified memory locations as a standard port
| Stack before call | ||
|---|---|---|
| previous contents | ||
| portPtr | Long — POINTER to port | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InitPort(portPtr)
Deallocates the clipping and visible regions in a port
| Stack before call | ||
|---|---|---|
| previous contents | ||
| portPtr | Long — POINTER to port | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void ClosePort(portPtr)
Makes a specified port the current GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| portPtr | Long — POINTER to port | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPort(portPtr)
Returns a pointer to the current GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| resultPtr | Long — POINTER to GrafPort | |
| ← | SP |
None
extern pascal GrafPortPtr GetPort()
Sets the current port's locInfo record to specified location information
| Stack before call | ||
|---|---|---|
| previous contents | ||
| locInfoPtr | Long — POINTER to location information | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPortLoc(locInfoPtr)
Gets the current port's locInfo record and puts it at the specified location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| locInfoPtr | Long — POINTER to space for locInfo record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetPortLoc(locInfoPtr)
Sets the current GrafPort's port rectangle to the specified rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPortRect(rectPtr)
Returns the current GrafPort's port rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetPortRect(rectPtr)
Changes the size of the current Grafport's port rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| portWidth | Word — INTEGER; width of active area in pixels | |
| portHeight | Word — INTEGER; height of active area in pixels | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPortSize(portWidth,portHeight)
Changes the location of the current GrafPort's port rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| h | Word — INTEGER; horizontal coordinate of upper left corner | |
| v | Word — INTEGER; vertical coordinate of upper left corner | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MovePortTo(h,v)
Adjust contents of port & bounds rectangles so up/left corner of port rect is set at specified point
| Stack before call | ||
|---|---|---|
| previous contents | ||
| h | Word — INTEGER; horizontal coordinate of upper left corner | |
| v | Word — INTEGER; vertical coordinate of upper left corner | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void SetOrigin(h,v)
Copies a specified region into the clipping region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void SetClip(rgnHandle)
Copies the clipping region to a specified region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void GetClip(rgnHandle)
Changes clipping region of current GrafPort to a rectangle equal to a specified rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void ClipRect(rectPtr)
Decrements the pen level
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void HidePen()
Increments the pen level
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ShowPen()
Returns the pen location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| pointPtr | Long — POINTER to POINT | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetPen(pointPtr)
Sets the pen state in the GrafPort to specified values
| Stack before call | ||
|---|---|---|
| previous contents | ||
| penStatePtr | Long — POINTER to pen state record (see Toolbox Ref Vol2 Figure 16-38) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPenState(penStatePtr)
Returns the pen state from the GrafPort to a specified location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| penStatePtr | Long — POINTER to space for pen state record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetPenState(penStatePtr)
Sets the current pen size to a specified pen size
| Stack before call | ||
|---|---|---|
| previous contents | ||
| penWidth | Word — INTEGER; width of pen in pixels | |
| penHeight | Word — INTEGER; height of pen in pixels | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPenSize(penWidth,penHeight)
Returns the current pen size to a specified location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| penStatePtr | Long — POINTER to space for POINT | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetPenSize(pointPtr)
Sets the current pen mode to a specified pen mode
| Stack before call | ||
|---|---|---|
| previous contents | ||
| penMode | Word — INTEGER; new pen mode (see Toolbox Ref Vol2 Figure 16-9) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPenMode(penMode)
Returns the pen mode from the current GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| penMode | Word — INTEGER; pen mode value (see Toolbox Ref Vol2 Figure 16-9) | |
| ← | SP |
None
extern pascal Word GetPenMode()
Sets the current pen pattern to a specified pen pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPenPat(patternPtr)
Copies the current pen pattern from the current GrafPort to a specified location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| patternPtr | Long — POINTER to space for pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetPenPat(patternPtr)
Sets the pen mask to a specified mask
| Stack before call | ||
|---|---|---|
| previous contents | ||
| maskPtr | Long — POINTER to pen mask | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPenMask(maskPtr)
Returns the pen mask to a specified location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| maskPtr | Long — POINTER to space for mask | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetPenMask(maskPtr)
Sets the background pattern to a specified pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetBackPat(patternPtr)
Copies current background pen pattern from current GrafPort to a specified location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| patternPtr | Long — POINTER to location for pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetBackPat(patternPtr)
Sets the pen state to the standard state; pen location and visibility are not changed
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void PenNormal()
Sets the pen pattern to a solid pattern using the specified color
| Stack before call | ||
|---|---|---|
| previous contents | ||
| colorNum | Word — INTEGER; new color value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetSolidPenPat(colorNum)
Sets the background pattern to a solid pattern using a specified color
| Stack before call | ||
|---|---|---|
| previous contents | ||
| colorNum | Word — INTEGER; new color value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetSolidBackPat(colorNum)
Sets a specified pattern to a solid pattern using a specified color
| Stack before call | ||
|---|---|---|
| previous contents | ||
| colorNum | Word — INTEGER; new color value | |
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SolidPattern(colorNum,patternPtr)
Moves the current pen location to a specified point
| Stack before call | ||
|---|---|---|
| previous contents | ||
| h | Word — INTEGER; horizontal point in local coordinates | |
| v | Word — INTEGER; vertical point in local coordinates | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MoveTo(h,v)
Moves the current pen location by specified horizontal & vertical displacements
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dH | Word — INTEGER; horizontal displacement | |
| dV | Word — INTEGER; vertical displacement | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void Move(dH,dV)
Draws a line from the current pen location to a specified point
| Stack before call | ||
|---|---|---|
| previous contents | ||
| h | Word — INTEGER; horizontal point to which line will be drawn | |
| v | Word — INTEGER; vertical point to which line will be drawn | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void LineTo(h,v)
Draws a line from current pen location to a new point specified by the horizontal and vertical displacements
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dH | Word — INTEGER; horizontal displacement in points | |
| dV | Word — INTEGER; vertical displacement in points | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void Line(dH,dV)
Sets the picSave field in the GrafPort to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| picSaveValue | Long — New value for picSave field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPicSave(picSaveValue)
Returns the value of the picSave field of the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| picSaveValue | Long — Current picSave value | |
| ← | SP |
None
extern pascal Longint GetPicSave()
Sets the rgnSave field in the GrafPort ot a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnSaveValue | Long — HANDLE; new value of rgnSave field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetRgnSave(rgnSaveValue)
Returns the value of the rgnSave field of the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| rgnSaveValue | Long — Current rgnSave value | |
| ← | SP |
None
extern pascal LongWord GetRgnSave()
Sets the polySave field in the GrafPort to a specified value - not called by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polySaveValue | Long — New value for polySave field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPolySave(polySaveValue)
Returns the value of the polySave field of the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| polySaveValue | Long — Current polySave value | |
| ← | SP |
None
extern pascal LongWord GetPolySave()
Sets the grafProcs field of the current GrafPort to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| grafProcsPtr | Long — POINTER to grafProcs record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetGrafProcs(grafProcsPtr)
Returns the pointer to the grafProcs record associated witht the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| grafProcsPtr | Long — POINTER to grafProcs record | |
| ← | SP |
None
extern pascal QDProcsPtr GetGraphProcs()
Sets the userField in the GrafPort to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userFieldValue | Long — New value for userField field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetUserField(userFieldValue)
Returns the value of the userField field of the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| userField | Long — Current userField value | |
| ← | SP |
None
extern pascal Longint GetUserField()
Sets the sysField field in GrafPort to a specified value - not called by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sysFieldValue | Long — New value for sysField field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetSysField(sysFieldValue)
Returns the value of the sysField field of the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| sysField | Long — Current sysField value | |
| ← | SP |
None
extern pascal Longint GetSysField()
Sets a specified rectangle to specified values
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to space for RECT defining rectangle to be set | |
| left | Word — INTEGER; left X coordinate for rectangle | |
| top | Word — INTEGER; top Y coordinate for rectangle | |
| right | Word — INTEGER; right X coordinate for rectangle | |
| bottom | Word — INTEGER; bottom Y coordinate for rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetRect(rectPtr,left,top,right,bottom)
Offsets a specified rectangle by specified displacements
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to rectangle | |
| dH | Word — INTEGER; horizontal displacement in pixels | |
| dV | Word — INTEGER; vertical displacement in pixels | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void OffsetRect(rectPtr,dH,dV)
Insets a specified rectangle by specified displacements
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to rectangle | |
| dH | Word — INTEGER; horizontal displacement | |
| dV | Word — INTEGER; vertical displacement | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void InsetRect(rectPtr,dH,dV)
Calculates intersection of two rectangles & places intersection in destination rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| rect1Ptr | Long — POINTER to RECT defining first source rectangle | |
| rect2Ptr | Long — POINTER to RECT defining second source rectangle | |
| intersectRectPtr | Long — POINTER to RECT defining destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| notEmptyFlag | Word — BOOLEAN; TRUE if rectangle not empty, FALSE if empty | |
| ← | SP |
None
extern pascal Boolean SectRect(rect1Ptr,rect2Ptr,intersectRectPtr)
Calculates smallest rectangle that contains both src rect & places results in dest rect
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rect1Ptr | Long — POINTER to first source rectangle | |
| rect2Ptr | Long — POINTER to second source rectangle | |
| unionRectPtr | Long — POINTER to destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void UnionRect(rect1Ptr,rect2Ptr,unionRectPtr)
Detects whether the pixel below and to the right of specified point is in a specified rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| pointPtr | Long — POINTER to POINT | |
| rectPtr | Long — POINTER to RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| pointFlag | Word — BOOLEAN; TRUE if pixel in rectangle, FALSE if not | |
| ← | SP |
None
extern pascal Boolean PtInRect(pointPtr,rectPtr)
Copies specified pt to uppr left corner of specified rect & another pt to lower right corner of rect
| Stack before call | ||
|---|---|---|
| previous contents | ||
| point1Ptr | Long — POINTER to first source POINT | |
| point2Ptr | Long — POINTER to second source POINT | |
| rectPtr | Long — POINTER to destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void Pt2Rect(point1Ptr,point2Ptr,rectPtr)
Indicates whether two rectangles are equal
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| rect1Ptr | Long — POINTER to RECT defining one rectangle | |
| rect2Ptr | Long — POINTER to RECT defining other rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| equalFlag | Word — BOOLEAN; TRUE if rectangles are equal, FALSE if not | |
| ← | SP |
None
extern pascal Boolean EqualRect(rect1Ptr,rect2Ptr)
Indicates whether a specified rectangle is empty
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| rectPtr | Long — POINTER to RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| notEmptyFlag | Word — BOOLEAN; TRUE if rectangle not empty, FALSE if empty | |
| ← | SP |
None
extern pascal Boolean NotEmptyRect(rectPtr)
Draws the frame of a specified rectangle using the current pen mode, pattern, & size
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void FrameRect(rectPtr)
Paints the interior of specified rectangle using the current pen mode & pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PaintRect(rectPtr)
Erases the interior of a specified rectangle by filling it in with the background pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void EraseRect(rectPtr)
Inverts the pixels in the interior of a specified rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InvertRect(rectPtr)
Fills the interior of a specified rectangle with a specified pen pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to rectangle | |
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FillRect(rectPtr,patternPtr)
Draws the frame of a specified oval using the current pen mode, pattern, & size
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void FrameOval(rectPtr)
Paints the interior of a specified oval using the current pen mode & pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PaintOval(rectPtr)
Erases the interior of a specified oval by filling it in with the backround pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void EraseOval(rectPtr)
Inverts the pixels in the interior of a specified oval
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InvertOval(rectPtr)
Fills the interior of a specified oval with a specified pen pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FillOval(rectPtr,patternPtr)
Draws the frame of a specified round rectangle using the current pen mode, pattern & size
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ovalWidth | Word — INTEGER; width, in pixels, of oval defining rounded corners | |
| ovalHeight | Word — INTEGER; height, in pixels, of oval defining rounded corners | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void FrameRRect(rectPtr,ovalWidth,ovalHeight)
Paints interior of specified round rectangle using the current pen mode & pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ovalWidth | Word — INTEGER; width, in pixels, of oval defining rounded corners | |
| ovalHeight | Word — INTEGER; height, in pixels, of oval defining rounded corners | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PaintRRect(rectPtr,ovalWidth,ovalHeight)
Erases interior of a specified round rectangle by filling it in with the backround pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ovalWidth | Word — INTEGER; width, in pixels, of oval defining rounded corners | |
| ovalHeight | Word — INTEGER; height, in pixels, of oval defining rounded corners | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void EraseRRect(rectPtr,ovalWidth,ovalHeight)
Inverts the pixels in the interior of a specified round rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ovalWidth | Word — INTEGER; width, in pixels, of oval defining rounded corners | |
| ovalHeight | Word — INTEGER; height, in pixels, of oval defining rounded corners | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InvertRRect(rectPtr,ovalWidth,ovalHeight)
Fills the interior of a specified round rectangle with a specified pen pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| ovalWidth | Word — INTEGER; width, in pixels, of oval defining rounded corners | |
| ovalHeight | Word — INTEGER; height, in pixels, of oval defining rounded corners | |
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FillRRect(rectPtr,ovalWidth,ovalHeight,patternPtr)
Draws the frame of a specified arc using the current pen mode, pattern, & size
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| startAngle | Word — INTEGER; starting angle in degrees | |
| arcAngle | Word — INTEGER; arc angle in degrees | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FrameArc(rectPtr,startAngle,arcAngle)
Paints the interior of specified arc using the current pen mode & pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| startAngle | Word — INTEGER; starting angle in degrees | |
| arcAngle | Word — INTEGER; arc angle in degrees | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PaintArc(rectPtr,startAngle,arcAngle)
Erases the interior of a specified arc by filling it in with the backround pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| startAngle | Word — INTEGER; starting angle in degrees | |
| arcAngle | Word — INTEGER; arc angle in degrees | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void EraseArc(rectPtr,startAngle,arcAngle)
Inverts the pixels in the interior of a specified arc
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| startAngle | Word — INTEGER; starting angle in degrees | |
| arcAngle | Word — INTEGER; arc angle in degrees | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InvertArc(rectPtr,startAngle,arcAngle)
Fills the interior of a specified arc with a specified pen pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining enclosing rectangle | |
| startAngle | Word — INTEGER; starting angle in degrees | |
| arcAngle | Word — INTEGER; arc angle in degrees | |
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FillArc(rectPtr,startAngle,arcAngle,patternPtr)
Allocates space for a new region & initializes it to empty - only way to create new region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to new region | |
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal RgnHandle NewRgn()
Deallocates the memory for a specified region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE of region being disposed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void DisposeRgn(rgnHandle)
Copies the region definition from one region to another
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcRgnHandle | Long — HANDLE to source region | |
| destRgnHandle | Long — HANDLE to destination region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CopyRgn(srcRgnHandle,destRgnHandle)
Destroys previous region information by setting a specified region to an empty region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region being modified | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void SetEmptyRgn(rgnHandle)
Destroys previous region information by setting a specified region to a specified rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region being set | |
| left | Word — INTEGER; left X coordinate for rectangle | |
| top | Word — INTEGER; top Y coordinate for rectangle | |
| right | Word — INTEGER; right X coordinate for rectangle | |
| bottom | Word — INTEGER; bottom Y coordinate for rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void SetRectRgn(rgnHandle,left,top,right,bottom)
Destroys previous region information by setting a specified region to a specified rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region being set | |
| rectPtr | Long — POINTER to RECT defining rectangle used as source | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void RectRgn(rgnHandle,rectPtr)
Allocates temp space & starts saving lines & framed shapes for later processing as a region definition.
The stack is not affected by this call. There are no input or output parameters.
$0430 rgnAlreadyOpen Region already open
Memory Manager errors Returned unchanged
extern pascal void openRgn()
Completes the region definition process started by an OpenRgn call
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region being set to a collection of points | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0431 rgnNotOpen Region not open
Memory Manager errors Returned unchanged
extern pascal void CloseRgn(rgnHandle)
Moves a region on the coordinate plane a specified distance
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region being offset | |
| dH | Word — INTEGER; horizontal displacement in pixels | |
| dV | Word — INTEGER; vertical displacement in pixels | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void OffsetRgn(rgnHandle,dH,dV)
Shrinks or expands a specified region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region being inset | |
| dH | Word — INTEGER; horizontal displacement in pixels | |
| dV | Word — INTEGER; vertical displacement in pixels | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void InsetRgn(rgnHandle,dH,dV)
Calculates intersection of two regions & places intersection in a destination region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgn1Handle | Long — HANDLE to one source region | |
| rgn2Handle | Long — HANDLE to another source region | |
| destRgnHandle | Long — HANDLE to destination region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void SectRgn(rgn1Handle,rgn2Handle,destRgnHandle)
Calculates smallest region that contains every point that's in either source region and places result in destination region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgn1Handle | Long — HANDLE to one source region | |
| rgn2Handle | Long — HANDLE to another source region | |
| unionRgnHandle | Long — HANDLE to destination region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void UnionRgn(rgn1Handle,rgn2Handle,unionRgnHandle)
Calculates the difference of two regions and places difference in a destination region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgn1Handle | Long — HANDLE to one source region | |
| rgn2Handle | Long — HANDLE to another source region | |
| diffRgnHandle | Long — HANDLE to destination region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void DiffRgn(rgn1Handle,rgn2Handle,diffRgnHandle)
Calculates the difference between the union and the intersection of two regions and places result in a destination region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgn1Handle | Long — HANDLE to one source region | |
| rgn2Handle | Long — HANDLE to another source region | |
| xorRgnHandle | Long — HANDLE to destination region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void XorRgn(rgn1Handle,rgn2Handle,xorRgnHandle)
Checks to see whether the pixel below & to right of a specified point1 is within a specified region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| pointPtr | Long — POINTER to POINT | |
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| pixelFlag | Word — BOOLEAN; TRUE if pixel in region, FALSE if not | |
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal Boolean PtInRgn(pointPtr,rgnHandle)
Checks whether a specified rectangle intersects a specified region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| rectPtr | Long — POINTER to RECT defining rectangle | |
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| encloseFlag | Word — BOOLEAN; TRUE if intersection encloses at least a pixel, FALSE if not | |
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal Boolean RectInRgn(rectPtr,rgnHandle)
Indicates whether two regions are equal
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| rgn1Handle | Long — HANDLE to one region | |
| rgn2Handle | Long — HANDLE to other region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| equalFlag | Word — BOOLEAN; TRUE if regions are equal, FALSE if not | |
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal Boolean EqualRgn(rgn1Handle,rgn2Handle)
Indicates whether a specified region is empty
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| emptyFlag | Word — BOOLEAN; TRUE if regions is empty, FALSE if not | |
| ← | SP |
None
extern pascal Boolean EmptyRgn(rgnHandle)
Draws the frame of a specified region using current pen mode, pattern & size
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void FrameRgn(rgnHandle)
Paints the interior of a specified region using the current pen mode & pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PaintRgn(rgnHandle)
Erases the interior of a specified region by filling it with the background pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void EraseRgn(rgnHandle)
Inverts the pixels in the interior of a specified region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InvertRgn(rgnHandle)
Fills the interior of a specified region with a specified pen pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FillRgn(rgnHandle,patternPtr)
Shifts pixels inside intersect of specified rect, visble region, clip region, port rect, and bounds rect
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to RECT defining rectangle | |
| dH | Word — INTEGER; horizontal distance to scroll in pixels | |
| dV | Word — INTEGER; vertical distance to scroll in pixels | |
| updateRgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void ScrollRect(rectPtr,dH,dV,updateRgnHandle)
Transfers a region of pixels
| Stack before call | ||
|---|---|---|
| previous contents | ||
| paintParamPtr | Long — POINTER to parameter block (see Toolbox Ref Vol2, Table 16-35) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0420 notEqualChunkiness Chunkiness not equal
extern pascal void PaintPixels(paintParamPtr)
Adds two specified points together and leaves result in destination point
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcPtPtr | Long — POINTER to POINT | |
| destPtPtr | Long — POINTER to POINT used as source and destination | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void AddPt(srcPtPtr,destPtPtr)
Subtracts source point from destination point and leaves result in the destination point
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcPtPtr | Long — POINTER to POINT | |
| destPtPtr | Long — POINTER to POINT used as source and destination | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SubPt(srcPtPtr,destPtPtr)
Sets a point to specified horizontal and vertical values
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcPtPtr | Long — POINTER to POINT | |
| h | Word — INTEGER; horizontal value of point | |
| v | Word — INTEGER; vertical value of point | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPt(srcPtPtr,h,v)
Indicates whether two points are equal
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| point1Ptr | Long — POINTER to first POINT | |
| point2Ptr | Long — POINTER to second POINT | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| equalFlag | Word — BOOLEAN; TRUE if points are equal, FALSE if not | |
| ← | SP |
None
extern pascal Boolean EqualPt(point1Ptr,point2Ptr)
Converts a point from local coordinates to global coordinates
| Stack before call | ||
|---|---|---|
| previous contents | ||
| point1Ptr | Long — POINTER to POINT to be converted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void LocalToGlobal(pointPtr)
Converts a point from global coordinates to local coordinates
| Stack before call | ||
|---|---|---|
| previous contents | ||
| pointPtr | Long — POINTER to POINT to be converted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GlobalToLocal(pointPtr)
Returns a pseudorandom number in the range -32768 to 32767
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal Integer Random()
Sets the seed value for the random number generator
| Stack before call | ||
|---|---|---|
| previous contents | ||
| randomSeed | Long — LONGINT; seed value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetRandSeed(randomSeed)
Returns the pixel below and to the right of a specified point
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| h | Word — Horizontal value of point, in global coordinates | |
| v | Word — Vertical value of point, in global coordinates | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal Word GetPixel(h,v)
Scales a specified point from a source rectangle to a destination rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| pointPtr | Long — POINTER to POINT to be scaled | |
| srcRectPtr | Long — POINTER to RECT defining source rectangle | |
| destRectPtr | Long — POINTER to RECT defining destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ScalePt(pointPtr,srcRectPtr,destRectPtr)
Maps a specified point from a source rectangle to a destination rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| pointPtr | Long — POINTER to POINT | |
| srcRectPtr | Long — POINTER to RECT defining source rectangle | |
| destRectPtr | Long — POINTER to RECT defining destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MapPt(pointPtr,srcRectPtr,destRectPtr)
Maps a specified rectangle from a source rectangle to a destination rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| pointPtr | Long — POINTER to RECT defining rectangle to be mapped | |
| srcRectPtr | Long — POINTER to RECT defining source rectangle | |
| destRectPtr | Long — POINTER to RECT defining destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MapRect(rectPtr,srcRectPtr,destRectPtr)
Maps a specified region from a source rectangle to a destination rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| mapRgnHandle | Long — HANDLE to region to be mapped | |
| srcRectPtr | Long — POINTER to RECT defining source rectangle | |
| destRectPtr | Long — POINTER to RECT defining destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MapRgn(mapRgnHandle,srcRectPtr,destRectPtr)
Sets up a specified record of pointers for customizing QuickDraw II operations
| Stack before call | ||
|---|---|---|
| previous contents | ||
| stdProcRecPtr | Long — POINTER to stdProcs record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetStdProcs(stdProcRecPtr)
Sets the cursor to an image passed in a specified cursor record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| cursorPtr | Long — POINTER to cursor record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void SetCursor(cursorPtr)
Returns a pointer to the current cursor record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| cursorPtr | Long — POINTER to current cursor record | |
| ← | SP |
None
extern pascal Pointer GetCursorAdr()
Hides the cursor by decrementing the cursor level
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void HideCursor()
Shows the cursor by incrementing the cursor level
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ShowCursor()
Hides the cursor until the mouse moves
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ObscureCursor()
Sets the current font to a specified font
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newFontHandle | Long — HANDLE to font | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetFont(newFontHandle)
Returns a handle to the current font
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fontHandle | Long — HANDLE to font | |
| ← | SP |
None
extern pascal FontHndl GetFont()
Returns information about the current font in a specified record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| fontInfoRecPtr | Long — POINTER to space for fontInfo record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetFontInfo(fontInfoRecPtr)
Returns information about the current font in a specified record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| fgRecPtr | Long — POINTER to space for font globals record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetFontGlobals(fgRecPtr)
Sets the font flags word to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| fontFlags | Word — INTEGER; font flags (see Toolbox Ref Vol2 Figure 16-37) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetFontFlags(fontFlags)
Returns the current font flags word
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fontFlags | Word — INTEGER; font flags (see Toolbox Ref Vol2 Figure 16-37) | |
| ← | SP |
None
extern pascal Word GetFontFlags()
Sets the text face to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| textFace | Word — INTEGER; text face (see Toolbox Ref Vol2 Figure 16-39) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetTextFace(textFace)
Returns the current text face
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| textFace | Word — INTEGER; text face (see Toolbox Ref Vol2 Figure 16-39) | |
| ← | SP |
None
extern pascal TextStyle GetTextFace()
Sets the text mode to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| textMode | Word — INTEGER; text mode (see Toolbox Ref Vol2 Table 16-10) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetTextMode(textMode)
Returns the current text mode
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| textMode | Word — INTEGER; text mode (see Toolbox Ref Vol2 Table 16-10) | |
| ← | SP |
None
extern pascal Word GetTextMode()
Sets the spExtra field in the GrafPort to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| spaceExtra | Long — FIXED; new value for spExtra field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetSpaceExtra(spaceExtra)
Returns the value of the spExtra field from the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| spaceExtra | Long — FIXED; value of spExtra field | |
| ← | SP |
None
extern pascal Fixed GetSpaceExtra()
Sets the fgColor field (foreground color) in the GrafPort to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| foreColor | Word — INTEGER; foreground color | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetForeColor(foreColor)
Returns the value of the current fgColor field (foreground color) from the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| foreColor | Word — INTEGER; value of fgColor field | |
| ← | SP |
None
extern pascal Word GetForeColor()
Sets the bgColor field (background color) in the GrafPort to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| backColor | Word — INTEGER; background color | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetBackColor(backColor)
Returns the value of the current bgColor field (background color) from the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| backColor | Word — INTEGER; value of bgColor field | |
| ← | SP |
None
extern pascal Word GetBackColor()
Draws a specified character at current pen location and updates pen location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theChar | Word — ASCII code of character to be drawn (0-255) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DrawChar(theChar)
Draws a specified Pascal-type string at the current pen location and updates the pen location.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| stringPtr | Long — POINTER to Pascal-type string to be drawn | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DrawString(stringPtr)
Draws a specified C string at the current pen location and updates the pen location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| cStringPtr | Long — POINTER to C string to be drawn | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DrawCString(cStringPtr)
Draws specified text at the current pen location and updates pen location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| textPtr | Long — POINTER to text to be drawn | |
| textLength | Word — INTEGER; number of bytes in text to be drawn | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DrawText(textPtr,textLength)
Returns the character width, in pixels (pen displacement), of a specified character
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| theChar | Word — Character to be measured | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| charWidth | Word — INTEGER; width of character in pixels | |
| ← | SP |
None
extern pascal Integer CharWidth(theChar)
Returns sum of all char widths, in pixels (pen displacements), of specified Pascal-type string.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| stringPtr | Long — POINTER to Pascal-type string | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| stringWidth | Word — INTEGER; width of string in pixels | |
| ← | SP |
None
extern pascal Integer StringWidth(stringPtr)
Returns sum of all char widths, in pixels (pen displacements), of specified C string
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| cStringPtr | Long — POINTER to C string | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| cStringWidth | Word — INTEGER; width of C string in pixels | |
| ← | SP |
None
extern pascal Integer CStringWidth(cStringPtr)
Returns the character width, in pixels (pen displacements), of specified text
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| textPtr | Long — POINTER to text | |
| textLength | Word — INTEGER; length of text in bytes | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| textWidth | Word — INTEGER; width of text in pixels | |
| ← | SP |
None
extern pascal Integer TextWidth(textPtr,textLength)
Puts the character bounds rectangle of a specified character into a specified buffer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theChar | Word — Character to use to set bounds | |
| resultPtr | Long — POINTER to space for rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CharBounds(theChar,resultPtr)
Puts the character bounds rectangle of a specified Pascal-type string into specified buffer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| stringPtr | Long — POINTER to Pascal-type string | |
| resultPtr | Long — POINTER to space for RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void StringBounds(stringPtr,resultPtr)
Puts char bounds rectangle of a specified C string into a specified buffer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| cStringPtr | Long — POINTER to C string | |
| resultPtr | Long — POINTER to space for RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CStringBounds(cStringPtr,resultPtr)
Puts the character bounds rectangle of specified text into a specified buffer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| textPtr | Long — POINTER to text | |
| textLength | Long — INTEGER; length of text in bytes | |
| resultPtr | Long — POINTER to space for RECT defining rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void TextBounds(textPtr,textLength,resultPtr)
Sets the arcRot field in the GrafPort to a specified value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| arcRotValue | Word — INTEGER; new value of arcRot field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void setArcRot(arcRotValue)
Returns the value of the arcRot field in the current GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| arcRot | Word — INTEGER; value of arcRot field | |
| ← | SP |
None
extern pascal Integer getArcRot()
Sets a specified font as the system font
| Stack before call | ||
|---|---|---|
| previous contents | ||
| fontHandle | Long — HANDLE to font that will be system font | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void setSysFont(fontHandle)
Returns a handle to the current system font
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fontHandle | Long — HANDLE to current system font | |
| ← | SP |
None
extern pascal FontHndl GetSysFont()
Copies specified region into the visible region (but does not change the visRgn field of the GrafPort).
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetVisRgn(rgnHandle)
Copies the contents of the visible region into a specified region. The region must have already been created with a NewRgn call.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetVisRgn(rgnHandle)
Indicates to the cursor drawing code whether the code should use scan line interrupts.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| useInt | Word — BOOLEAN; TRUE for cursor to use scan line interrupts, FALSE if not | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetIntUse(useInt)
Allocates memory for the recording of drawing commands into a picture definition, and returns a handle to the picture.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| picFrame | Long — POINTER to RECT defining picture frame | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| picHandle | Long — Handle to picture | |
| ← | SP |
None
extern pascal Handle OpenPicture(picFrame)
Inserts a specified comment into the currently open picture.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| commentKind | Word — Type of comment | |
| dataSize | Word — Size of additional data; 0 if none | |
| dataHandle | Long — Handle to additional data; NIL if none | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PicComment(commentKind,dataSize,dataHandle)
Completes the picture definition process begun by OpenPicture call.
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ClosePicture
Takes drawing commands recorded in pic definition, maps them from picture frame into destination rectangle, and draws them.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| picHandle | Long — Handle to picture | |
| destRect | Long — POINTER to RECT defining destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DrawPicture(picHandle,destRect)
Releases all memory occupied by a specifed picture.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| picHandle | Long — Handle to picture | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void KillPicture(picHandle)
Draws the frame of a specified polygon using the current pen mode, pattern, & size. Poly is framed with a series of LineTo calls.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void FramePoly(polyHandle)
Paints the interior of a specified polygon using the current pen mode & pattern.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void PaintPoly(polyHandle)
Erases the interior of a specified polygon by filling it with the background pattern
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void ErasePoly(polyHandle)
Inverts the pixels in the interior of a specified polygon.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void InvertPoly(polyHandle)
Fills the interior of a specified polygon with a specified pen pattern.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon | |
| patternPtr | Long — POINTER to pattern | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void FillPoly(polyHandle,patternPtr)
Returns a handle to a polygon data structure that will be updated by future LineTo calls.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon | |
| ← | SP |
$0440 polyAlreadyOpen Polygon already open
extern pascal Handle OpenPoly()
Completes the polygon definition process started with an OpenPoly call.
The stack is not affected by this call. There are no input or output parameters.
$0441 polyNotOpen No polygon open in current GrafPort
Memory Manager errors Returned unchanged
extern pascal void ClosePoly()
Disposes of a specified polygon.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon to be killed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void KillPoly()
Offsets a specified polygon by specified horizontal & vertical displacements.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon | |
| dH | Word — INTEGER; horizontal displacement in pixels | |
| dV | Word — INTEGER; vertical displacement in pixels | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void OffsetPoly(polyHandle,dH,dV)
Maps a specified polygon from a source rectangle to a destination rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| polyHandle | Long — Handle to polygon to be mapped | |
| srcRectPtr | Long — POINTER to RECT defining source rectangle | |
| destRectPtr | Long — POINTER to RECT defining destination rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void MapPoly(polyHandle,srcRectPtr,destRectPtr)
Sets the clipRgn handle field in the GrafPort to a specified value.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — Handle to clipping region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetClipHandle(rgnHandle)
Returns a copy of the handle to the clipping region.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — Handle to clipping region | |
| ← | SP |
None
extern pascal RgnHandle GetClipHandle()
Sets the visRgn field in the GrafPort to a specified value.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rgnHandle | Long — HANDLE to visible region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetVisHandle(rgnHandle)
Returns a copy of the handle to the visible region.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| visRgnHandle | Long — HANDLE to region | |
| ← | SP |
None
extern pascal RgnHandle GetVisHandle()
Reinitializes the cursor. The cursor is set to the arrow cursor and made visible.
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void InitCursor()
Sets size of QD II clipping and text buffers, padding to allow mods to chExtra & spExtra
| Stack before call | ||
|---|---|---|
| previous contents | ||
| maxWidth | Word — INTEGER; width, in bytes, of widest pixel image to be used | |
| maxFontHeight | Word — INTEGER; height, in pixels, of tallest font application will use | |
| maxFBRExtent | Word — INTEGER; greatest fbrExtent, in pixels, of any font to be used | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void SetBufDims(maxWidth,maxFontHeight,maxFBRExtent)
Sets size of QD II clipping and text buffers, but doesn't pad maxFBRExtent in any way.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| maxWidth | Word — INTEGER; width, in bytes, of widest pixel image to be used | |
| maxFontHeight | Word — INTEGER; height, in pixels, of tallest font application will use | |
| maxFBRExtent | Word — INTEGER; greatest fbrExtent, in pixels, of any font to be used | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void ForceBufDims(maxWidth,maxFontHeight,maxFBRExtent)
Saves QD II's buffer-sizing information in eight-byte record.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sizeInfoPtr | Long — POINTER to space for record (see Toolbox Ref Vol2 Figure 16-36) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SaveBufDims(sizeInfoPtr)
Restores QD II's internal buffers to sizes described in an 8-byte record created by SaveBufDims
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sizeInfoPtr | Long — POINTER to record to be restored | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void RestoreBufDims(sizeInfoPtr)
Returns the size of the font globals record.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fgSize | Word — INTEGER; size of font globals record | |
| ← | SP |
None
extern pascal Word GetFGSize()
Sets the fontID field in the GrafPort.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| fontID | Long — Font ID | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetFontID(fontID)
Returns the fontID field of the GrafPort.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fontID | Long — Value of fontID field in GrafPort | |
| ← | SP |
None
extern pascal LongWord GetFontID()
Sets the txSize field of the GrafPort to a specified value.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| textSize | Word — INTEGER; value for txSize field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetTextSize(textSize)
Returns current value of the txSize field of the GrafPort.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| textSize | Word — Current value of txSize field | |
| ← | SP |
None
extern pascal Integer GetTextSize()
Sets the chExtra field in the GrafPort to a specified value.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| charExtra | Long — FIXED; value for chExtra field | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetCharExtra(charExtra)
Returns the chExtra field from the GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| charExtra | Long — FIXED; value of chExtra field | |
| ← | SP |
None
extern pascal Fixed GetCharExtra()
Transfers pixels from a source pixel map to current port & clips pixels to current visble region & clipping region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcLocPtr | Long — POINTER to source LocInfo record | |
| srcRectPtr | Long — POINTER to RECT defining source rectangle | |
| destX | Word — INTEGER; X coordinate of upper left corner of destination | |
| destY | Word — INTEGER; Y coordinate of upper left corner of destination | |
| transferMode | Word — Same as pen mode (see Toolbox Ref Vol2, Table 16-9) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0420 notEqualChunkiness Chunkiness not equal
extern pascal void PPToPort(srcLocPtr,srcRectPtr,destX,destY,transferMode)
Ensures that the text buffer is big enough to handle a font with the specified width and height, increasing it if necessary.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newWidth | Word — INTEGER; width of font | |
| newHeight | Word — INTEGER; height of font | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InflateTextBuffer(newWidth,newHeight)
Fills a specified buffer with information about the font in ROM
| Stack before call | ||
|---|---|---|
| previous contents | ||
| recordPtr | Long — POINTER to space for ROM font record (see Toolbox Ref Vol2 Figure 16-33) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetROMFont(recordPtr)
Returns info, up to a specified number of bytes, about the current font in a specified buffer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| recordPtr | Long — POINTER to space for record | |
| recordSize | Word — Maximum number of bytes to transfer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| numBytesXfer | Word — INTEGER; number of bytes tranferred | |
| ← | SP |
None
extern pascal word GetFontLore(recordPtr,recordSize)
Returns a pointer to a 512-byte table of 32 $00s, 32 $11s, ..., 32 $FFs, to be used as solid pen patterns.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| tablePtr | Long — POINTER to pattern table | |
| ← | SP |
None
extern pascal Pointer Get640Colors()
Sets the current grafport's pen pattern to any of the 16 "solid" 640-mode dithered colors
| Stack before call | ||
|---|---|---|
| previous contents | ||
| colorNum | Word — Color number | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void Set640Color(colorNum)
| Desk Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| DeskBootInit | $0105 | Initializes the Desk Manager; called only by Tool Locator (not by application) |
| DeskStartUp | $0205 | Starts up the Desk Manager for use by an application |
| DeskShutDown | $0305 | Shuts down the Desk Manager when an application quits |
| DeskVersion | $0405 | Returns the version number of the Desk Manager |
| DeskReset | $0505 | Resets the Desk Manager; called only on reset - not by application |
| DeskStatus | $0605 | Indicates whether the Desk Manager is active |
| SaveScrn | $0905 | Saves the 80-column text screens in banks $00, $01, $E0, & $E1 - not called by application |
| RestScrn | $0A05 | Restores the screen area saved by the Desk Manager - not called by application |
| SaveAll | $0B05 | Saves all variables that Desk Manager preserves when CDA menu is activated - not called by application |
| RestAll | $0C05 | Restores all variables that Desk Manager preserves when CDA menu is activated - not called by application |
| InstallNDA | $0E05 | Installs a specified NDA in the system |
| InstallCDA | $0F05 | Installs a specified CDA in the system |
| ChooseCDA | $1105 | Activates the Desk Manager and displays the CDA menu - not called by application |
| SetDAStrPtr | $1305 | Changes the names of the built-in CDAs |
| GetDAStrPtr | $1405 | Returns the pointer to the names of the built-in CDAs |
| OpenNDA | $1505 | Opens a specified NDA |
| CloseNDA | $1605 | Closes a specified NDA |
| SystemClick | $1705 | Handles mouse-down events in a system (that is, desk accessory) window |
| SystemEdit | $1805 | Passes standard menu edits to system windows. Valid: 1=undo, 2=cut, 3=copy, 4=paste, 5=clear |
| SystemTask | $1905 | Causes a desk accessory to perform its periodic action |
| SystemEvent | $1A05 | Previews all events returned to application & indicates if event was processed by a desk accessory |
| GetNumNDAs | $1B05 | Returns the total number of NDAs currently installed |
| CloseNDAByWinPtr | $1C05 | Closes an NDA with a specified window pointer |
| CloseAllNDAs | $1D05 | Closes all open NDAs |
| FixAppleMenu | $1E05 | Adds the names of the NDAs to a specified menu |
| AddToRunQ | $1F05 | Adds the specified routine to the head of the run queue |
| RemoveFromRunQ | $2005 | Removes the specified run item from the run queue |
| RemoveCDA | $2105 | Removes the specified CDA from the Desk Manager CDA list (does not dispose of memory used by CDA) |
| RemoveNDA | $2205 | Removes the specified NDA from the Desk Manager NDA list (does not dispose of memory used by NDA nor rebuild Apple menu) |
| GetDeskAccInfo | $2305 | Provides safe access to certain information about DAs currently installed in the system |
| CallDeskAcc | $2405 | Calls a NDA's Action or Init routine with the specified values |
| GetDeskGlobal | $2505 | GetDeskGlobal retrieves information from the Desk Manager |
Initializes the Desk Manager; called only by Tool Locator (not by application)
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Desk Manager for use by an application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void DeskStartUp()
Shuts down the Desk Manager when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void DeskShutDown()
Returns the version number of the Desk Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Desk Manager | |
| ← | SP |
None
extern pascal Word DeskVersion()
Resets the Desk Manager; called only on reset - not by application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void DeskShutDown()
Indicates whether the Desk Manager is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Desk Manager is active, FALSE if not | |
| ← | SP |
None
extern pascal Boolean DeskStatus()
Saves the 80-column text screens in banks $00, $01, $E0, & $E1 - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Restores the screen area saved by the Desk Manager - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Saves all variables that Desk Manager preserves when CDA menu is activated - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Restores all variables that Desk Manager preserves when CDA menu is activated - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Installs a specified NDA in the system
| Stack before call | ||
|---|---|---|
| previous contents | ||
| idHandle | Long — HANDLE to NDA header section | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InstallNDA(idHandle)
Installs a specified CDA in the system
| Stack before call | ||
|---|---|---|
| previous contents | ||
| idHandle | Long — HANDLE to CDA header section | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InstallCDA(idHandle)
Activates the Desk Manager and displays the CDA menu - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Changes the names of the built-in CDAs
| Stack before call | ||
|---|---|---|
| previous contents | ||
| altDispHandle | Long — HANDLE to new alternate display desk accessory | |
| stringTablePtr | Long — POINTER to table of strings | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetDAStrPtr(altDispHandle,stringTablePtr)
Returns the pointer to the names of the built-in CDAs
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| stringTablePtr | Long — POINTER to table of strings for the built-in CDA names | |
| ← | SP |
None
extern pascal Pointer GetDAStrPtr()
Opens a specified NDA
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| idNum | Word — ID number returned from Menu Manager | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| refNum | Word — Reference number to use when apllication closes NDA | |
| ← | SP |
$0510 daNotFound Specified DA not available
extern pascal Word OpenNDA(idNum)
Closes a specified NDA
| Stack before call | ||
|---|---|---|
| previous contents | ||
| refNum | Word — As returned by the OpenNDA routine | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CloseNDA(refNum)
Handles mouse-down events in a system (that is, desk accessory) window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| eventRecPtr | Long — POINTER to event record | |
| theWindowPtr | Long — POINTER to system window | |
| findWndwResult | Word — Result of the FindWindow call | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SystemClick(eventRecPtr,theWindowPtr,findWndwResult)
Passes standard menu edits to system windows. Valid: 1=undo, 2=cut, 3=copy, 4=paste, 5=clear
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| editType | Word — Edit type | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| processedFlag | Word — BOOLEAN; TRUE if frontmost window and DA has to handle call, otherwise FALSE | |
| ← | SP |
None
extern pascal Boolean SystemEdit(editType)
Causes a desk accessory to perform its periodic action
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SystemTask()
Previews all events returned to application & indicates if event was processed by a desk accessory
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| eventWhat | Word — From event record | |
| eventMessage | Long — From event record | |
| eventWhen | Long — From event record | |
| eventWhere | Long — From event record | |
| eventMods | Long — From event record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| processFlag | Word — BOOLEAN; TRUE if if event is to be processed by DA, otherwise FALSE - not called by application | |
| ← | SP |
None
Call must not be made by an application.
Returns the total number of NDAs currently installed
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| numberofNDAs | Word — INTEGER; total number of open NDAs | |
| ← | SP |
None
extern pascal unsigned int GetNumNDAs()
Closes an NDA with a specified window pointer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window to close | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0510 daNotFound Specified DA not available
$0511 notSysWindow The window parameter is not a pointer to a system window owned by an NDA
extern pascal void CloseNDAByWinPtr(theWindowPtr)
Closes all open NDAs
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void CloseAllNDAs()
Adds the names of the NDAs to a specified menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| startingID | Word — ID of menu that will display NDAs | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FixAppleMenu(startingID)
Adds the specified routine to the head of the run queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| runItemPtr | Long — POINTER to run item to add | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void AddToRunQ(runItemPtr)
Removes the specified run item from the run queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| runItemPtr | Long — POINTER to run item to remove | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void RemoveFromRunQ(runItemPtr)
Removes the specified CDA from the Desk Manager CDA list (does not dispose of memory used by CDA)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| idHandle | Long — HANDLE to CDA header | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0510 daNotFound Specified DA not available
extern pascal void RemoveCDA(idHandle)
Removes the specified NDA from the Desk Manager NDA list (does not dispose of memory used by NDA nor rebuild Apple menu)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| idHandle | Long — HANDLE to NDA header | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0510 daNotFound Specified DA not available
extern pascal void RemoveNDA(idHandle)
Provides safe access to certain information about DAs currently installed in the system
| Stack before call | ||
|---|---|---|
| previous contents | ||
| flags | Word — Flags | |
| daReference | Long — Specifies which desk accessory to get information about | |
| buffSize | Word — Size of the result buffer | |
| bufferPtr | Long — Pointer to the result buffer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0520 deskBadSelector Selector out of range
extern pascal void GetDeskAccInfo(flags,daReference,buffSize,bufferPtr)
Calls a NDA's Action or Init routine with the specified values
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| flags | Word — Flags | |
| daReference | Long — Specifies which desk accessory to call | |
| action | Word — Action code to pass to desk accessory | |
| data | Long — Data value to pass to desk accessory | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| result | Word — Result returned from desk accessory | |
| ← | SP |
$0520 deskBadSelector Selector out of range
extern pascal Word CallDeskAcc(flags,daReference,action,data)
GetDeskGlobal retrieves information from the Desk Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| selector | Word — Selects which value to retrieve | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| value | Long — The selected value | |
| ← | SP |
$0520 deskBadSelector Selector out of range
extern pascal Long GetDeskGlobal(selector)
| Event Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| EMBootInit | $0106 | Initializes the Event Manager; called only by Tool Locator - not called by application |
| EMStartUp | $0206 | Starts up the Event Manager, sets size of event queue, and sets minimum and maximum mouse clamp values. |
| EMShutDown | $0306 | Shuts down the Event Manager when an application quits |
| EMVersion | $0406 | Returns the version number of the Event Manager |
| EMReset | $0506 | Resets the Event Manager; called only on reset - not called by application |
| EMStatus | $0606 | Indicates whether the Event Manager is active |
| DoWindows | $0906 | Returns the address of the direct page used by the Event Manager - not called by application |
| GetNextEvent | $0A06 | Returns next avail event of specified type(s); if event is in queue, GetNextEvent removes it |
| EventAvail | $0B06 | Allows an application to look at the next available event of a specified type or types. |
| GetMouse | $0C06 | Returns the current mouse location (in the local coordinate system of the current GrafPort) |
| Button | $0D06 | Returns the current status of a specified button on the mouse |
| StillDown | $0E06 | Tests whether the specified mouse button is still down |
| WaitMouseUp | $0F06 | Tests whether specified mouse button is still down. If not, removes preceding mouse-up event from queue and returns FALSE. |
| TickCount | $1006 | Returns current number of ticks (in sixtieths of a second) since system was last started |
| GetDblTime | $1106 | Returns max difference (in ticks) allowed for mouse clicks to be considered a double-click |
| GetCaretTime | $1206 | Returns time (in ticks) between blicks of caret marking insertion point in text to be edited |
| SetSwitch | $1306 | Generates a switch event - only switcher-type applications should make this call |
| PostEvent | $1406 | Posts an event into the event queue |
| FlushEvents | $1506 | Removes all queue events of type(s) specified by mask up to the first event of type specified by stop mask |
| GetOSEvent | $1606 | Returns next available queue event of a specified type(s) and removes it from the queue |
| OSEventAvail | $1706 | Allows application to look at next available queue event of specified type(s), but leaves event in queue |
| SetEventMask | $1806 | Specifies the system event mask |
| FakeMouse | $1906 | Allows use of alternative pointing device, like graphics tablet, in place/conjuction of mouse |
| SetAutoKeyLimit | $1A06 | Controls how repeated keystrokes are inserted into the event queue |
| GetKeyTranslation | $1B06 | Returns the identifier for the currently selected keystroke translation table |
| SetKeyTranslation | $1C06 | Sets a new keystroke translation table |
Initializes the Event Manager; called only by Tool Locator - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Event Manager, sets size of event queue, and sets minimum and maximum mouse clamp values.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dPageAddr | Word — Bank $0 starting address for one page of direct-page space | |
| queueSize | Word — Maximum number of event records in queue (0=default of 20) | |
| xMinClamp | Word — Minimum X clamp value for the mouse | |
| xMaxClamp | Word — Maximum X clamp value for the mouse | |
| yMinClamp | Word — Minimum Y clamp value for the mouse | |
| yMaxClamp | Word — Maximum Y clamp value for the mouse | |
| userID | Word — ID number Event Manager will use to get memory | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0601 emDupStrtUpErr The Event Manager has already been started
$0606 emQSiz2LrgErr The size of the event queue is larger than 3639
$0607 emNoMemQueueErr Insufficient memory for the event queue
extern pascal void EMStartUp(dPageAddr,queueSize,xMinClamp,xMaxClamp,yMinClamp,yMaxClamp,userID)
Shuts down the Event Manager when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void EMShutDown()
Returns the version number of the Event Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Event Manager | |
| ← | SP |
None
extern pascal Word EMVersion()
Resets the Event Manager; called only on reset - not called by application
The stack is not affected by this call. There are no input or output parameters.
%!s(<nil>)
Call must not be made by an application.
Indicates whether the Event Manager is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Event Manager is active, FALSE if not | |
| ← | SP |
None
extern pascal Boolean EMStatus()
Returns the address of the direct page used by the Event Manager - not called by application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| dPageAddr | Word — Bank $0 starting address for Event Manager's one-page work area | |
| ← | SP |
None
Call must not be made by an application.
Returns next avail event of specified type(s); if event is in queue, GetNextEvent removes it
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| eventMask | Word — Specifies which types of events are of interest | |
| eventPtr | Long — POINTER to the event record in which event will be placed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| handleEventFlag | Word — BOOLEAN; TRUE if even should be handled by application; FALSE if not | |
| ← | SP |
None
extern pascal Boolean GetNextEvent(eventMask,eventPtr)
Allows an application to look at the next available event of a specified type or types.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| eventMask | Word — Specifies which types of events are of interest | |
| eventPtr | Long — POINTER to the event record in which event will be placed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| gotEventFlag | Word — BOOLEAN; TRUE if any specified event types available; FALSE if not | |
| ← | SP |
None
extern pascal Boolean EventAvail(eventMask,eventPtr)
Returns the current mouse location (in the local coordinate system of the current GrafPort)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| mouseLocPtr | Long — POINTER to POINT for current mouse location | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetMouse(mouseLocPtr)
Returns the current status of a specified button on the mouse
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| buttonNum | Word — Number of button (0 or 1) to check | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| buttonDown | Word — BOOLEAN; TRUE if button is down, or FALSE if it isn't | |
| ← | SP |
$0605 emBadBttnNoErr The button number given was not 0 or 1
extern pascal Boolean Button(buttonNum)
Tests whether the specified mouse button is still down
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| buttonNum | Word — Number of button (0 or 1) to check | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| buttonDown | Word — BOOLEAN; TRUE if button down and no mouse events are pending in event queue for specifed button, FALSE if not | |
| ← | SP |
$0605 emBadBttnNoErr The button number given was not 0 or 1
extern pascal Boolean StillDown(buttonNum)
Tests whether specified mouse button is still down. If not, removes preceding mouse-up event from queue and returns FALSE.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| buttonNum | Word — Number of button (0 or 1) to check | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| buttonDownFlag | Word — BOOLEAN; TRUE if button down and no mouse events are pending in event queue for specifed button, FALSE if not | |
| ← | SP |
$0605 emBadBttnNoErr The button number given was not 0 or 1
extern pascal Boolean WaitMouseUp(buttonNum)
Returns current number of ticks (in sixtieths of a second) since system was last started
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| numTicks | Long — Number of ticks since system startup | |
| ← | SP |
$0605 emBadBttnNoErr The button number given was not 0 or 1
extern pascal LongWord TickCount()
Returns max difference (in ticks) allowed for mouse clicks to be considered a double-click
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| maxTicks | Long — Maximum number of ticks between mouse clicks | |
| ← | SP |
None
extern pascal LongWord GetDblTime()
Returns time (in ticks) between blicks of caret marking insertion point in text to be edited
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| numTicks | Long — Number of ticks between blinks of the caret | |
| ← | SP |
None
extern pascal LongWord GetCaretTime()
Generates a switch event - only switcher-type applications should make this call
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SetSwitch()
Posts an event into the event queue
Removes all queue events of type(s) specified by mask up to the first event of type specified by stop mask
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| eventMask | Word — Types of events to be removed from queue | |
| stopMask | Word — Event types to stop removal process | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| resultCode | Word — 0 = all events removed from queue, or event code = type of event that stopped process | |
| ← | SP |
None
extern pascal Word FlushEvents(eventMask,stopMask)
Returns next available queue event of a specified type(s) and removes it from the queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| eventMask | Word — Types of events to be removed from queue | |
| eventPtr | Long — POINTER to the event record in which event will be placed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| gotEventFlag | Word — BOOLEAN; TRUE if any specified event types available; FALSE if null event | |
| ← | SP |
None
extern pascal Boolean GetOSEvent(eventMask,eventPtr)
Allows application to look at next available queue event of specified type(s), but leaves event in queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| eventMask | Word — Specifies which types of queue events are of interest | |
| eventPtr | Long — POINTER to the event record in which event will be placed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| gotEventFlag | Word — BOOLEAN; TRUE if any specified event types available; FALSE if null event | |
| ← | SP |
None
extern pascal Boolean OSEventAvail(eventMask,eventPtr)
Specifies the system event mask
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sysEventMask | Word — System event mask | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetEventMask(sysEventMask)
Allows use of alternative pointing device, like graphics tablet, in place/conjuction of mouse
| Stack before call | ||
|---|---|---|
| previous contents | ||
| changedFlag | Word — Indicates device's position and/or button state has changed | |
| modLatch | padding | Byte — Keyboard modifiers latch | Byte — Set to 0 | |
| xPosition | Word — Device's clamped absolute X position | |
| yPosition | Word — Device's clamped absolute Y position | |
| buttonStatus | Word — Device's button status | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
Call must not be made by an application.
Controls how repeated keystrokes are inserted into the event queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newLimit | Word — Limit for inserted auto-key events | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetAutoKeyLimit(newLimit)
Returns the identifier for the currently selected keystroke translation table
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| kTransID | Word — Keyboard translation identifier ($0000 to $00FF) | |
| ← | SP |
None
extern pascal Word GetKeyTranslation()
Sets a new keystroke translation table
| Stack before call | ||
|---|---|---|
| previous contents | ||
| kTransID | Word — Keyboard translation identifier (low-order byte) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetKeyTranslation(kTransID)
| Scheduler Calls | ||
|---|---|---|
| Routine | # | Description |
| SchBootInit | $0107 | Initializes the Scheduler; called only by Tool Locator - not called by application |
| SchStartUp | $0207 | Starts up the Scheduler for use by an application |
| SchShutDown | $0307 | Shuts down the Scheduler when an application quits |
| SchVersion | $0407 | Returns the version number of the Scheduler |
| SchReset | $0507 | Resets the Scheduler; called only when system is reset - not called by application |
| SchStatus | $0607 | Indicates whether the Scheduler is active |
| SchAddTask | $0907 | Adds a task to the Scheduler queue |
| SchFlush | $0A07 | Flushes all tasks in the Scheduler queue - must not be called by an application |
Initializes the Scheduler; called only by Tool Locator - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Scheduler for use by an application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SchStartUp()
Shuts down the Scheduler when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SchShutDown()
Returns the version number of the Scheduler
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Scheduler | |
| ← | SP |
None
extern pascal Word SchVersion()
Resets the Scheduler; called only when system is reset - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SchReset()
Indicates whether the Scheduler is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Scheduler active, FALSE if inactive | |
| ← | SP |
None
extern pascal Boolean SchStatus()
Adds a task to the Scheduler queue
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| taskPtr | Long — POINTER to task to be added | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| onQueueFlag | Word — BOOLEAN; TRUE if task added to Scheduler's queue, FALSE if queue was full | |
| ← | SP |
None
extern pascal Boolean SchAddTask(taskPtr)
Flushes all tasks in the Scheduler queue - must not be called by an application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
| Sound Tool Set Calls | ||
|---|---|---|
| Routine | # | Description |
| SoundBootInit | $0108 | Initializes the Sound Tool Set; called only by Tool Locator (not by application) |
| SoundStartUp | $0208 | Starts up the Sound Tool Set for use by an application |
| SoundShutDown | $0308 | Shuts down the Sound Tool Set when an application quits |
| SoundVersion | $0408 | Returns the version number of the Sound Tool Set |
| SoundReset | $0508 | Resets the Sound Tool Set; called only on reset - not called by application |
| SoundToolStatus | $0608 | Indicates whether the Sound Tool Set is active |
| WriteRamBlock | $0908 | Writes a specified number of bytes from system RAM into DOC RAM |
| ReadRamBlock | $0A08 | Reads a specified number of bytes from DOC RAM into system RAM |
| GetTableAddres | $0B08 | Returns the jump table address for the low-level routines (see Toolbox Ref Vol2, Table 21-5) |
| GetSoundVolume | $0C08 | Reads the volume setting for a generator ($00 to $FF) |
| SetSoundVolume | $0D08 | Changes volume setting for the volume registers in the DOC or changes system volume |
| FFStartSound | $0E08 | Enables the DOC to start generating sound on a particular generator |
| FFStopSound | $0F08 | Halts any specified sound generators that are generating sound |
| FFSoundStatus | $1008 | Returns the status of all 15 sound generators |
| FFGeneratorStatus | $1108 | Reads the first two bytes of the generator control block corresponding to a specified generator |
| SetSoundMIRQV | $1208 | Sets up the entry point into the sound-interrupt handler |
| SetUserSoundIRQV | $1308 | Sets up the entry point for an application-defined synthesizer interrupt handler |
| FFSoundDoneStatus | $1408 | Returns the current Free-Form Synthesizer playing status |
| FFSetUpSound | $1508 | Identical to the FFStartSound tool call but does not actually start playing the specified sound |
| FFStartPlaying | $1608 | Starts playing the sound specified by the FFSetUpSound tool call on a specified set of generators |
| SetDOCReg | $1708 | Sets the DOC registers for a generator's oscillator from register contents stored in a special format |
| ReadDOCReg | $1808 | Reads the DOC registers for a generator's oscillator and stores them in the target memory location |
Initializes the Sound Tool Set; called only by Tool Locator (not by application)
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Sound Tool Set for use by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dPageAddr | Word — Bank $0 starting address for one page of direct-page space | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0810 noDOCFndErr The DOC or RAM was not found
$0818 sndAlreadyStrtErr The Sound Tool Set is already started
extern pascal void SoundStartUp(dPageAddr)
Shuts down the Sound Tool Set when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SoundShutDown()
Returns the version number of the Sound Tool Set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Sound Tool Set | |
| ← | SP |
None
extern pascal Word SoundVersion()
Resets the Sound Tool Set; called only on reset - not called by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the Sound Tool Set is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Sound Tool Set active, FALSE if inactive | |
| ← | SP |
None
extern pascal Word SoundToolStatus()
Writes a specified number of bytes from system RAM into DOC RAM
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcPtr | Long — POINTER to data to be written from RAM | |
| docStart | Long — Starting address of DOC buffer to receive data | |
| byteCount | Word — Number of bytes to be written | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0810 noDOCFndErr The DOC or RAM was not found
$0811 docAddrRngErr DOC address range error
extern pascal void WriteRamBlock(srcPtr,docStart,byteCount)
Reads a specified number of bytes from DOC RAM into system RAM
| Stack before call | ||
|---|---|---|
| previous contents | ||
| destPtr | Long — POINTER to starting RAM address where data will be written | |
| docStart | Long — Starting DOC address from which data will be read | |
| byteCount | Word — Number of bytes to be copied | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0810 noDOCFndErr The DOC or RAM was not found
$0811 docAddrRngErr DOC address range error
extern pascal void ReadRamBlock(destPtr,docStart,byteCount)
Returns the jump table address for the low-level routines (see Toolbox Ref Vol2, Table 21-5)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| jumpTableAddr | Long — Jump table address for low-level routines | |
| ← | SP |
None
extern pascal Pointer GetTableAddress()
Reads the volume setting for a generator ($00 to $FF)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| genNumber | Word — Number of generator whose volume will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| volSetting | Word — Volume setting, from $00 to $FF; high nibble of low-order byte significant | |
| ← | SP |
None
extern pascal Word GetSoundVolume(genNumber)
Changes volume setting for the volume registers in the DOC or changes system volume
| Stack before call | ||
|---|---|---|
| previous contents | ||
| volume | Word — Generator or system volume setting; $00-$FF | |
| genNumber | Word — Generator whose volume will be set; $00-$0E sets DOC, $0F-$FF sets system volume | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal Word SetSoundVolume(volume,genNumber)
Enables the DOC to start generating sound on a particular generator
| Stack before call | ||
|---|---|---|
| previous contents | ||
| genNumFFSynth | Word — Channel, generator, and type (see Toolbox Ref Vol2, Figure 21-4) | |
| pBlockPtr | Long — POINTER to parameter block for sound (see Toolbox Ref Vol2, Figure 21-5) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0812 noSAddrInitErr The Sound Tool Set is not active
$0813 invalGenNumErr Invalid generator number
$0814 synthModeErr Synthesizer mode error
$0815 genBusyErr The generator is already in user
extern pascal void FFStartSound(genNumFFSynth,pBlockPtr)
Halts any specified sound generators that are generating sound
| Stack before call | ||
|---|---|---|
| previous contents | ||
| genMask | Word — Mask to stop generators (see Toolbox Ref Vol2, Figure 21-6) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FFStopSound(genMask)
Returns the status of all 15 sound generators
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| genStatusInfo | Word — Status of all generators (bit 0 = generator 0 and so on) | |
| ← | SP |
None
extern pascal Word FFSoundStatus()
Reads the first two bytes of the generator control block corresponding to a specified generator
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| genNumber | Word — Number of generator whose status will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| genStatus | Word — Status of genNumber (see Toolbox Ref Vol2, Figure 21-3) | |
| ← | SP |
None
extern pascal Word FFGeneratorStatus()
Sets up the entry point into the sound-interrupt handler
| Stack before call | ||
|---|---|---|
| previous contents | ||
| sMasterIRQ | Long — New master sound IRQ vector | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetSoundMIRQV(sMasterIRQ)
Sets up the entry point for an application-defined synthesizer interrupt handler
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| userIRQVector | Long — New user sound IRQ vector | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| oldIRQVector | Long — Old user sound IRQ vector | |
| ← | SP |
None
extern pascal Word SetUserSoundIRQV(userIRQVector)
Returns the current Free-Form Synthesizer playing status
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| genNumber | Word — Number of generator whose status will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| genDoneFlag | Word — BOOLEAN; status of genNumber: TRUE if done playing, FALSE if playing | |
| ← | SP |
$0813 invalGenNumErr Invalid generator number
extern pascal Boolean FFSoundDoneStatus(genNumber)
Identical to the FFStartSound tool call but does not actually start playing the specified sound
| Stack before call | ||
|---|---|---|
| previous contents | ||
| channelGen | Word — Channel, generator type word | |
| genNumber | Long — POINTER to FFStartSound parameter block | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FFSetUpSound(channelGen,paramBlockPtr)
Starts playing the sound specified by the FFSetUpSound tool call on a specified set of generators
| Stack before call | ||
|---|---|---|
| previous contents | ||
| genWord | Word — Flag word indicating which generators to start ($0000 is illegal and will cause system hang) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void FFStartPlaying(genWord)
Sets the DOC registers for a generator's oscillator from register contents stored in a special format
| Stack before call | ||
|---|---|---|
| previous contents | ||
| pBlockPtr | Long — POINTER to DOC register parameter block | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetDOCReg(pBlockPtr)
Reads the DOC registers for a generator's oscillator and stores them in the target memory location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| pBlockPtr | Long — POINTER to DOC register parameter block | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ReadDOCReg(pBlockPtr)
| ADB Tools Calls | ||
|---|---|---|
| Routine | # | Description |
| ADBBootInit | $0109 | Initializes the ADB Tool Set; called only by Tool Locator (not by application) |
| ADBStartUp | $0209 | Starts up the ADB Tool Set |
| ADBShutDown | $0309 | Shuts down the ADB Tool Set |
| ADBVersion | $0409 | Returns the version number of the ADB Tool Set |
| ADBReset | $0509 | Resets the ADB Tool Set; called only on system reset - not by application |
| ADBStatus | $0609 | Indicates whether the ADB Tool Set is active |
| SendInfo | $0909 | Sends data to the keyboard microcontroller or to an ADB device |
| ReadKeyMicroData | $0A09 | Receives data from the keyboard microcontroller |
| ReadKeyMicroMemory | $0B09 | Reads a data byte from the keyboard microcontroller memory |
| AsyncADBReceive | $0D09 | Receives data from an ADB device |
| SyncADBReceive | $0E09 | Receives data from an ADB device |
| AbsOn | $0F09 | Enables automatic polling of an absolute device (not implemented - reserved for future use) |
| AbsOff | $1009 | Disables automatic polling of an absolute device (not implemented - reserved for future use) |
| ReadAbs | $1109 | Determines whether automatic polling of an absolute device is on or off (not implemented - reserved for future use) |
| GetAbsScale | $1209 | Reads absolute device scaling values (reserved for future use) |
| SetAbsScale | $1309 | Sets up scaling for absolute devices (reserved for future use) |
| SRQPoll | $1409 | Adds a device to the SRQ list (if the device exists) so that an application can be notified when this device has data. |
| SRQRemove | $1509 | Removes a device previously installed by the SRQPoll routine from the SRQ list |
| ClearSRQTable | $1609 | Clears the SRQ list of all entries |
Initializes the ADB Tool Set; called only by Tool Locator (not by application)
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the ADB Tool Set
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ADBStartUp()
Shuts down the ADB Tool Set
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ADBShutDown()
Returns the version number of the ADB Tool Set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the ADB Tool Set | |
| ← | SP |
None
extern pascal Word ADBVersion()
Resets the ADB Tool Set; called only on system reset - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the ADB Tool Set is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if ADB Tool Set is active; FALSE if not | |
| ← | SP |
None
extern pascal Boolean ADBStatus()
Sends data to the keyboard microcontroller or to an ADB device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dataLength | Word — Number of bytes of data to be sent (see Toolbox Ref Vol1, Table 3-4) | |
| dataPtr | Long — POINTER to data; NIL if no data (see Toolbox Ref Vol1, Table 3-4) | |
| adbCommand | Word — ADB command to be issued | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0910 cmndIncomplete Command not completed
extern pascal void Sendinfo(dataLength,dataPtr,adbCommand)
Receives data from the keyboard microcontroller
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dataLength | Word — Number of bytes of data to be received (see Toolbox Ref Vol1, Table 3-3) | |
| dataPtr | Long — POINTER to data; NIL if no data (see Toolbox Ref Vol1, Table 3-3) | |
| adbCommand | Word — ADB command to be issued | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0910 cmndIncomplete Command not completed
extern pascal void ReadKeyMicroData(dataLength,dataPtr,adbCommand)
Reads a data byte from the keyboard microcontroller memory
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dataOutPtr | Long — POINTER to location to store results of read | |
| dataInPtr | Long — POINTER to keyboard memory location to be read | |
| adbCommand | Word — ADB command to be issued, equal to $0009 | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0910 cmndIncomplete Command not completed
extern pascal void ReadKeyMicroMem(dataOutPtr,dataInPtr,adbCommand)
Receives data from an ADB device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| compPtr | Long — POINTER to completion routine | |
| adbCommand | Word — ADB command, in form $C0+xyabcd, where $C0 is the Talk command, xy is the register, and abcd is the address | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0910 cmndIncomplete Command not completed
$0982 adbBusy ADB busy (command pending)
extern pascal void AsyncADBReceive(compPtr,adbCommand)
Receives data from an ADB device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| inputWord | Word — ADB device command with high and low nibbles swapped | |
| compPtr | Long — POINTER to completion routine | |
| adbCommand | Word — ADB command to be issued, equal to $0048 | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0910 cmndIncomplete Command not completed
$0982 adbBusy ADB busy (command pending)
extern pascal void SyncADBReceive(inputWord,compPtr,adbCommand)
Enables automatic polling of an absolute device (not implemented - reserved for future use)
Disables automatic polling of an absolute device (not implemented - reserved for future use)
Determines whether automatic polling of an absolute device is on or off (not implemented - reserved for future use)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| autoABSPoll | Word — BOOLEAN; TRUE if polling on, FALSE if polling off | |
| ← | SP |
Call must not be made by an application.
Reads absolute device scaling values (reserved for future use)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dataInPtr | Long — POINTER to ScaleRec; see "SetAbsScale" | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetAbsScale(dataInPtr)
Sets up scaling for absolute devices (reserved for future use)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dataInPtr | Long — POINTER to scale record (see Figure 3-2) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetAbsScale(dataOutPtr)
Adds a device to the SRQ list (if the device exists) so that an application can be notified when this device has data.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| compPtr | Long — POINTER to completion routine | |
| adbRegAddr | Word — ADB register and address | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0910 cmndIncomplete Command not completed
$0983 devNotAtAddr Device not at present address
$0984 sqrListFull SQR list is full
extern pascal void SRQPoll(compPtr,adbRegAddr)
Removes a device previously installed by the SRQPoll routine from the SRQ list
| Stack before call | ||
|---|---|---|
| previous contents | ||
| adbRegAddr | Word — ADB register and address | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0910 cmndIncomplete Command not completed
$0982 adbBusy ADB busy (command pending)
extern pascal void SRQRemove(adbRegAddr)
Clears the SRQ list of all entries
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ClearSRQTable()
| SANE Calls | ||
|---|---|---|
| Routine | # | Description |
| SANEBootInit | $010A | Initializes the SANE Tool Set; called only by Tool Locator (not by application) |
| SANEStartup | $020A | Starts up the SANE Tool Set for use by an application |
| SANEShutDown | $030A | Shuts down the SANE Tool Set when application quits |
| SANEVersion | $040A | Returns the version number of the SANE Tool Set |
| SANEReset | $050A | Resets the SANE Tool Set; called only on system reset - not by application |
| SANEStatus | $060A | Indicates whether the SANE Tool Set is active |
| SANEFP816 | $090A | Contains basic arithmetic operations, comparisons, conversions, environmental control, and IEEE auxiliary operations. |
| SANEDecStr816 | $0A0A | Contains numeric scanners and formatters |
| SANEElems816 | $0B0A | Contains elementary functions, financial functions, and a random-number generator |
Initializes the SANE Tool Set; called only by Tool Locator (not by application)
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the SANE Tool Set for use by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dPageAddr | Word — Bank $0 starting address for one page of direct-page space | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
The call is made automatically in APW C.
Shuts down the SANE Tool Set when application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void SANEShutDown()
Returns the version number of the SANE Tool Set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the SANE Tool Set | |
| ← | SP |
None
extern pascal Word SANEVersion()
Resets the SANE Tool Set; called only on system reset - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the SANE Tool Set is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if SANE Tool Set active, FALSE if inactive | |
| ← | SP |
None
extern pascal Boolean SANEStatus()
Contains basic arithmetic operations, comparisons, conversions, environmental control, and IEEE auxiliary operations.
See the Apple Numerics Manual for details.
None
extern pascal void SANEFP816()
Contains numeric scanners and formatters
See the Apple Numerics Manual for details.
None
extern pascal void SANEDecStr816()
Contains elementary functions, financial functions, and a random-number generator
See the Apple Numerics Manual for details.
None
extern pascal void SANEElems816()
| Integer Math Calls | ||
|---|---|---|
| Routine | # | Description |
| IMBootInit | $010B | Initializes the Integer Math Tool Set; called only by Tool Locator (not by application) |
| IMStartUp | $020B | Starts up the Integer Math Tool Set for use by an application |
| IMShutDown | $030B | Shuts down the Integer Math Tool Set when application quits |
| IMVersion | $040B | Returns the version number of the Integer Math Tool Set |
| IMReset | $050B | Resets the Integer Math Tool Set; called only on system reset - not by application |
| IMStatus | $060B | Indicates whether the Integer Math Tool Set is active |
| Multiply | $090B | Multiplies two Integer inputs and produces a Longint result |
| SDivide | $0A0B | Divides two Integers & produces a signed Integer quotient & a signed Integer remainder |
| UDivide | $0B0B | Divides two unsigned Integer inputs and produces an unsigned Integer quotient & an unsigned Integer remainder |
| LongMul | $0C0B | Multiplies two Longint values & produces a 64-bit result |
| LongDivide | $0D0B | Divides two unsigned Longint inputs and produces a Longint unsigned quotient and a Longint unsigned remainder. |
| FixRatio | $0E0B | Takes 2 signed Integers & produces a Fixed number as ratio of the numerator & denominator |
| FixMul | $0F0B | Multiplies two 32-bit Fixed inputs and produces a 32-bit Fixed result |
| FracMul | $100B | Multiplies two Frac inputs and returns a rounded Frac result. Overflows are pinned to the most positive or negative value, depending on the XOR of the signs of the input. |
| FixDiv | $110B | Divides two like inputs and returns a rounded Fixed result (no remainder) |
| FracDiv | $120B | Divides two like inputs and returns a rounded Frac result (no remainder) |
| FixRound | $130B | Takes a Fixed input and returns a rounded Integer result |
| FracSqrt | $140B | Takes a Frac input and returns a rounded Frac square root |
| FracCos | $150B | Takes a Fixed input (in radians) and returns its Frac cosine |
| FracSin | $160B | Takes a Fixed input (in radians) and returns its Frac sine |
| FixAtan2 | $170B | Takes two like inputs & returns a Fixed arc tangent (in radians) of their coordinates |
| HiWord | $180B | Returns high-order word of a Long input |
| LoWord | $190B | Returns low-order word of a long input |
| Long2Fix | $1A0B | Converts a specified Longint value to its corresponding Fixed value |
| Fix2Long | $1B0B | Converts a Fixed value to its corresponding Longint value |
| Fix2Frac | $1C0B | Converts a Fixed value to its corresponding Frac value |
| Frac2Fix | $1D0B | Converts a specifed Frac value to its corresponding Fixed value |
| Fix2X | $1E0B | Converts a Fixed value to its corresponding Extended value |
| Frac2X | $1F0B | Converts a specified Frac value to its corresponding Extended value |
| X2Fix | $200B | Converts an Extended value to its corresponding Fixed value |
| X2Frac | $210B | Converts an Extended value to its corresponding Frac value |
| Int2Hex | $220B | Takes unsigned int & produces an Integer Math string representing the value in hexadecimal format |
| Long2Hex | $230B | Takes unsigned Longint value & produces an Integer Math string representing the value in hex format |
| Hex2Int | $240B | Takes an Integer Math string representing a hex value & returns an unsigned integer |
| Hex2Long | $250B | Takes Integer Math string representing a hex value & returns an unsigned Longint |
| Int2Dec | $260B | Takes signed or unsigned integer & produces IM string representing value in decimal format |
| Long2Dec | $270B | Takes a signed or unsigned Longint value and produces an Integer Math string representing the value in decimal format. |
| Dec2Int | $280B | Takes Integer Math string representing a decimal value & returns a signed/unsigned integer |
| Dec2Long | $290B | Takes Integer Math string representing a decimal value & produces a Longint value |
| Hexit | $2A0B | Takes unsigned integer & returns a 4-byte Int Math string representing value in hex format (on the stack) |
Initializes the Integer Math Tool Set; called only by Tool Locator (not by application)
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Integer Math Tool Set for use by an application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void IMStartUp()
Shuts down the Integer Math Tool Set when application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void IMShutDown()
Returns the version number of the Integer Math Tool Set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Integer Math Tool Set | |
| ← | SP |
None
extern pascal Word IMVersion()
Resets the Integer Math Tool Set; called only on system reset - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the Integer Math Tool Set is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Integer Math is active, FALSE if inactive | |
| ← | SP |
None
extern pascal Boolean IMStatus()
Multiplies two Integer inputs and produces a Longint result
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| multiplicand | Word — First INTEGER input | |
| multiplier | Word — Second INTEGER input | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| longIntResult | Long — LONGINT result | |
| ← | SP |
None
extern pascal Longint Multiply(multiplicand,multiplier)
Divides two Integers & produces a signed Integer quotient & a signed Integer remainder
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| dividend | Word — INTEGER dividend | |
| divisor | Word — INTEGER divisor | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| remainder | Word — INTEGER remainder | |
| quotient | Word — INTEGER quotient | |
| ← | SP |
$0B01 imBadInptParam Bad input parameter
extern pascal IntDivRec SDivide(dividend,divisor)
Divides two unsigned Integer inputs and produces an unsigned Integer quotient & an unsigned Integer remainder
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| dividend | Word — INTEGER dividend | |
| divisor | Word — INTEGER divisor | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| remainder | Word — INTEGER remainder | |
| quotiend | Word — INTEGER quotient | |
| ← | SP |
$0B01 imBadInptParam Bad input parameter
extern pascal WordDivReec UDivide(dividend,divisor)
Multiplies two Longint values & produces a 64-bit result
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| longspace | Long — Space for result | |
| multiplicand | Long — First LONGINT input | |
| multiplier | Long — Second LONGINT input | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| msResult | Long — Most significant 32 bits of the result | |
| lsResult | Long — Least significant 32 bits of the result | |
| ← | SP |
None
extern pascal LongMulRec LongMul(multiplicand,multiplier)
Divides two unsigned Longint inputs and produces a Longint unsigned quotient and a Longint unsigned remainder.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| longspace | Long — Space for result | |
| dividend | Long — Unsigned LONGINT dividend | |
| divisor | Long — Unsigned LONGINT divisor | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| remainder | Long — Most significant 32 bits of the result | |
| quotient | Long — Least significant 32 bits of the result | |
| ← | SP |
None
extern pascal LongDivRec LongDivide(dividend,divisor)
Takes 2 signed Integers & produces a Fixed number as ratio of the numerator & denominator
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| numerator | Word — INTEGER specifying the input numerator | |
| denominator | Word — INTEGER specifying the input denominator | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fixedResult | Long — FIXED result | |
| ← | SP |
None
extern pascal Fixed FixRatio(numerator,denominator)
Multiplies two 32-bit Fixed inputs and produces a 32-bit Fixed result
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| multiplicand | Long — First FIXED input | |
| multiplier | Long — Second FIXED input | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| product | Long — FIXED result | |
| ← | SP |
None
extern pascal Fixed FixMul(multiplicand,multiplier)
Multiplies two Frac inputs and returns a rounded Frac result. Overflows are pinned to the most positive or negative value, depending on the XOR of the signs of the input.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| multiplicand | Long — First FRAC input | |
| multiplier | Long — Second FRAC input | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fracResult | Long — Rounded FRAC result; pinned if out-of-range | |
| ← | SP |
None
extern pascal Frac FracMul(multiplicand,multiplier)
Divides two like inputs and returns a rounded Fixed result (no remainder)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| dividend | Long — First input | |
| divisor | Long — Second input (must be same type as dividend) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fixedResult | Long — Rounded FIXED result; pinned if out-of-range | |
| ← | SP |
None
extern pascal Fixed FixDiv(dividend,divisor)
Divides two like inputs and returns a rounded Frac result (no remainder)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| dividend | Long — First input | |
| divisor | Long — Second input (must be same type as dividend) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fracResult | Long — Rounded FRAC result; pinned if out-of-range | |
| ← | SP |
None
extern pascal Frac FracDiv(dividend,divisor)
Takes a Fixed input and returns a rounded Integer result
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| fixedValue | Long — Original FIXED value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| intResult | Word — Rounded INTEGER result | |
| ← | SP |
None
extern pascal Integer FixRound(fixedValue)
Takes a Frac input and returns a rounded Frac square root
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| dividend | Long — Original FRAC value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fracResult | Long — Rounded FRAC square root | |
| ← | SP |
None
extern pascal Frac FracSqrt(fracValue)
Takes a Fixed input (in radians) and returns its Frac cosine
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| angle | Long — Angle in radians, as a FIXED value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fracCosineResult | Long — FRAC cosine result | |
| ← | SP |
None
extern pascal Frac FracCos(angle)
Takes a Fixed input (in radians) and returns its Frac sine
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| angle | Long — Angle in radians, as a FIXED value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fracCosineResult | Long — FRAC sine result | |
| ← | SP |
None
extern pascal Frac FracSin(angle)
Takes two like inputs & returns a Fixed arc tangent (in radians) of their coordinates
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| input1 | Long — First input | |
| input2 | Long — Second input (must be same type as first) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| arcTanResult | Long — FIXED arc tangent, in radians, of input1 and input2 | |
| ← | SP |
None
extern pascal Fixed FixATan2(input1,input2)
Returns high-order word of a Long input
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| longValue | Long — Value whose high-order word will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wordResult | Word — High-order word of longValue | |
| ← | SP |
None
extern pascal Word HiWord(longValue)
Returns low-order word of a long input
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| longValue | Long — Value whose low-order word will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wordResult | Word — Low-order word of longValue | |
| ← | SP |
None
extern pascal Word LoWord(longValue)
Converts a specified Longint value to its corresponding Fixed value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| longIntValue | Long — LONGINT value to be converted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fixedResult | Long — FIXED result of the conversion; pinned if out-of-range | |
| ← | SP |
None
extern pascal Fixed Long2Fix(longValue}
Converts a Fixed value to its corresponding Longint value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| fixedValue | Long — FIXED value to be converted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| longIntResult | Long — Rounded LONGINT result of conversion | |
| ← | SP |
None
extern pascal Longint Fix2Long(fixedValue}
Converts a Fixed value to its corresponding Frac value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| fixedValue | Long — FIXED value to be converted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fracResult | Long — FRAC result of conversion; pinned if out-of-range | |
| ← | SP |
None
extern pascal Frac Fix2Frac(fixedValue)
Converts a specifed Frac value to its corresponding Fixed value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| fracValue | Long — FRAC value to be converted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fracResult | Long — Rounded FIXED result | |
| ← | SP |
None
extern pascal Fixed Frac2Fix(fracValue)
Converts a Fixed value to its corresponding Extended value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| fixedValue | Long — FIXED input | |
| extendPtr | Long — POINTER to space for EXTENDED value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void Fix2X(fixedValue,extendPtr)
Converts a specified Frac value to its corresponding Extended value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| fracValue | Long — FRAC input | |
| extendPtr | Long — POINTER to space for EXTENDED value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void Frac2X(fracValue,extendPtr)
Converts an Extended value to its corresponding Fixed value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| extendPtr | Long — POINTER to EXTENDED value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fixedResult | Long — Rounded FIXED result; pinned if out-of-range | |
| ← | SP |
None
extern pascal Longint X2Fix(extendPtr)
Converts an Extended value to its corresponding Frac value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| extendPtr | Long — POINTER to EXTENDED value | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| fracResult | Long — Rounded FRAC result; pinned if out-of-range | |
| ← | SP |
None
extern pascal Longint X2Frac(extendPtr)
Takes unsigned int & produces an Integer Math string representing the value in hexadecimal format
| Stack before call | ||
|---|---|---|
| previous contents | ||
| intValue | Word — Unsigned INTEGER to be converted | |
| strPtr | Long — POINTER to space for Integer Math string | |
| strLength | Word — Length of Integer Math string | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0B04 imStrOverflow Length of string is too short to represent the value
extern pascal void Int2Hex(intValue,strPtr,strLength)
Takes unsigned Longint value & produces an Integer Math string representing the value in hex format
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longValue | Long — Unsigned LONGINT value to be converted | |
| strPtr | Long — POINTER to space for Integer Math string | |
| strLength | Word — Length of Integer Math string | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0B04 imStrOverflow Length of string is too short to represent the value
extern pascal void Long2Hex(longValue,strPtr,strLength)
Takes an Integer Math string representing a hex value & returns an unsigned integer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| strPtr | Long — POINTER to space for Integer Math string | |
| strLength | Word — Length of Integer Math string | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| intResult | Word — Unsigned INTEGER equivalent of the Integer Math string | |
| ← | SP |
$0B02 imIllegalChar Illegal character in the string
$0B03 imOverflow Integer or longint overflow
extern pascal word Hex2Int(strPtr,strLength)
Takes Integer Math string representing a hex value & returns an unsigned Longint
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| strPtr | Long — POINTER to space for Integer Math string | |
| strLength | Word — Length of Integer Math string | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| longIntResult | Long — Unsigned LONGINT equivalent of the Integer Math string | |
| ← | SP |
$0B02 imIllegalChar Illegal character in the string
$0B03 imOverflow Integer or longint overflow
extern pascal LongWord Hex2Long(strPtr,strLength)
Takes signed or unsigned integer & produces IM string representing value in decimal format
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordValue | Word — INTEGER to be converted | |
| strPtr | Long — POINTER to space for Integer Math string | |
| strLength | Word — Length of Integer Math string | |
| signedFlag | Word — BOOLEAN; TRUE if wordValue is signed, FALSE if unsigned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0B04 imStrOverflow Length of string is too short to represent the value
extern pascal void Int2Dec(wordValue,strPtr,strLength,signedFlag)
Takes a signed or unsigned Longint value and produces an Integer Math string representing the value in decimal format.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longValue | Long — LONGINT to be converted | |
| strPtr | Long — POINTER to space for Integer Math string | |
| strLength | Word — Length of Integer Math string | |
| signedFlag | Word — BOOLEAN; TRUE if wordValue is signed, FALSE if unsigned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0B04 imStrOverflow Length of string is too short to represent the value
extern pascal void Long2Dec(longValue,strPtr,strLength,signedFlag)
Takes Integer Math string representing a decimal value & returns a signed/unsigned integer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| strPtr | Long — POINTER to Integer Math string | |
| strLength | Word — Length of Integer Math string | |
| signedFlag | Word — 0 if intResult is unsigned, nonzero if intResult is signed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| intResult | Word — INTEGER equivalent of the Integer Math string | |
| ← | SP |
$0B02 imIllegalChar Illegal character in the string
$0B03 imOverflow Integer or longint overflow
extern pascal Integer Dec2Int(strPtr,strLength,signedFlag)
Takes Integer Math string representing a decimal value & produces a Longint value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| strPtr | Long — POINTER to Integer Math string | |
| strLength | Word — Length of Integer Math string | |
| signedFlag | Word — 0 if longIntResult is unsigned, nonzero if longIntResult is signed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| longIntResult | Word — LONGINT equivalent of the Integer Math string | |
| ← | SP |
$0B02 imIllegalChar Illegal character in the string
$0B03 imOverflow Integer or longint overflow
extern pascal Longint Dec2long(strPtr,strLength,signedFlag)
Takes unsigned integer & returns a 4-byte Int Math string representing value in hex format (on the stack)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| intValue | Word — Unsigned INTEGER to be converted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| hexResult | Long — 4-byte Integer Math string representing value in hex format | |
| ← | SP |
None
extern pascal LongWord HexIt(intValue)
| Text Tools Calls | ||
|---|---|---|
| Routine | # | Description |
| TextBootInit | $010C | Initializes the Text Tool Set; called only by Tool Locator |
| TextStartUp | $020C | Starts up the Text Tool Set for use by an application |
| TextShutDown | $030C | Shuts down the Text Tool Set when an application quits |
| TextVersion | $040C | Returns the version number of the Text Tool Set |
| TextReset | $050C | Resets the Text Tool Set; called only when the system is reset |
| TextStatus | $060C | Indicates whether the Text Tools Set is active |
| SetInGlobals | $090C | Sets the global parameters for the input device |
| SetOutGlobals | $0A0C | Sets the global parameters for the output device |
| SetErrGlobals | $0B0C | Sets the global parameters for the error output device |
| GetInGlobals | $0C0C | Returns the current values for the input device global parameters |
| GetOutGlobals | $0D0C | Returns the current values for the output device global parameters |
| GetErrGlobals | $0E0C | Returns the current values for the error output device global parameters |
| SetInputDevice | $0F0C | Sets the input device to a specified type and location |
| SetOutputDevice | $100C | Sets the output device to a specified type and location |
| SetErrorDevice | $110C | Sets the error output device to a specified type and location |
| GetInputDevice | $120C | Returns the type of driver installed as the input device |
| GetOutputDevice | $130C | Returns the type of driver installed as the output device |
| GetErrorDevice | $140C | Returns the type of driver installed as the error output device |
| InitTextDev | $150C | Initializes a specified text device |
| CtlTextDev | $160C | Passes a control code to a specified text device. Errors other than $0C01 can only occur for Pascal devices. |
| StatusTextDev | $170C | Executes a status call to a specified text device |
| WriteChar | $180C | Combines a character with output global AND mask and OR mask and writes to output device |
| ErrWriteChar | $190C | Combines a character with output global AND & OR mask & writes to error output text device |
| WriteLine | $1A0C | Combines pointed-to Pascal-type string with out global mask, + CR, then output |
| ErrWriteLine | $1B0C | Combines pointed-to Pascal-type string with output global masks & write to error out |
| WriteString | $1C0C | Combines a pointed-to Pascal-type string (first byte = length) with output global masks & write to output device |
| ErrWriteString | $1D0C | Combines a pointed-to Pascal-type string (first byte = length) with the output global masks and writes to the error output text device. |
| TextWriteBlock | $1E0C | Combines a char string with output global masks & writes to output text device |
| ErrWriteBlock | $1F0C | Combines a char string with output global masks & write to error out |
| WriteCString | $200C | Combines a pointed-to C string with output global masks & write to output text device |
| ErrWriteCString | $210C | Combines a pointed-to C-type string (terminated with $00) with output global masks and writes the string to the error output text device. |
| ReadChar | $220C | Reads a char from input text device, combines with input global mask, and puts char on stack |
| TextReadBlock | $230C | Reads a block of characters from the input text device, combines with input global masks, and writes block to mem location at bufferPtr + offset |
| ReadLine | $240C | Reads char string from input txt device, combines w/input global mask, & writes to mem loc |
Initializes the Text Tool Set; called only by Tool Locator
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Text Tool Set for use by an application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void TextStartUp()
Shuts down the Text Tool Set when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void TextShutDown()
Returns the version number of the Text Tool Set
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Text Tool Set | |
| ← | SP |
None
extern pascal Word TextVersion()
Resets the Text Tool Set; called only when the system is reset
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the Text Tools Set is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Text Tool Set is active; FALSE if not | |
| ← | SP |
None
extern pascal Boolean TextStatus()
Sets the global parameters for the input device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| andMask | Word — Global AND mask for input device (low-order byte only) | |
| orMask | Word — Global OR mask for input device (low-order byte only) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetInGlobals(andMask,orMask)
You can also use the following alternate form of the call:
extern pascal void SetInGlobals(mask)
Sets the global parameters for the output device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| andMask | Word — Global AND mask for output device (low-order byte only) | |
| orMask | Word — Global OR mask for output device (low-order byte only) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetOutGlobals(andMask,orMask)
You can also use the following alternate form of the call:
extern pascal void SetOutGlobals(mask)
Sets the global parameters for the error output device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| andMask | Word — Global AND mask for error device (low-order byte only) | |
| orMask | Word — Global OR mask for error device (low-order byte only) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetErrGlobals(andMask,orMask)
You can also use the following alternate form of the call:
extern pascal void SetErrGlobals(mask)
Returns the current values for the input device global parameters
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| andMask | Word — Global AND mask for input device (low-order byte only) | |
| orMask | Word — Global OR mask for input device (low-order byte only) | |
| ← | SP |
None
extern pascal TxtMaskRec GetInGlobals()
Returns the current values for the output device global parameters
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| andMask | Word — Global AND mask for output device (low-order byte only) | |
| orMask | Word — Global OR mask for output device (low-order byte only) | |
| ← | SP |
None
extern pascal TxtMaskRec GetOutGlobals()
Returns the current values for the error output device global parameters
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| andMask | Word — Global AND mask for error device (low-order byte only) | |
| orMask | Word — Global OR mask for error device (low-order byte only) | |
| ← | SP |
None
extern pascal TxtMaskRec GetErrGlobals()
Sets the input device to a specified type and location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| deviceType | Word — Input device type (0 = BASIC, 1 = Pascal, 2 = RAM based) | |
| ptrOrSlot | Long — Slot number for BASIC or Pascal driver, or POINTER to jump table for RAM-based driver | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0C01 badDevType Illegal device type
extern pascal void SetInputDevice(deviceType,ptrOrSlot)
You can also use the following alternate form of the call:
extern pascal void SetInputDevice(deviceRec)
Sets the output device to a specified type and location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| deviceType | Word — Output device type (0 = BASIC, 1 = Pascal, 2 = RAM based) | |
| ptrOrSlot | Long — Slot number for BASIC or Pascal driver, or POINTER to jump table for RAM-based driver | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0C01 badDevType Illegal device type
extern pascal void SetOutputDevice(deviceType,ptrOrSlot)
You can also use the following alternate form of the call:
extern pascal void SetOutputDevice(deviceRec)
Sets the error output device to a specified type and location
| Stack before call | ||
|---|---|---|
| previous contents | ||
| deviceType | Word — Error device type (0 = BASIC, 1 = Pascal, 2 = RAM based) | |
| ptrOrSlot | Long — Slot number for BASIC or Pascal driver, or POINTER to jump table for RAM-based driver | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0C01 badDevType Illegal device type
extern pascal void SetErrortDevice(deviceType,ptrOrSlot)
You can also use the following alternate form of the call:
extern pascal void SetErrortDevice(deviceRec)
Returns the type of driver installed as the input device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| deviceType | Word — Input device type (0 = BASIC, 1 = Pascal, 2 = RAM based) | |
| ptrOrSlot | Long — Slot number for BASIC or Pascal driver, or POINTER to jump table for RAM-based driver | |
| ← | SP |
None
extern pascal DeviceRec GetInputDevice()
Returns the type of driver installed as the output device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| deviceType | Word — Output device type (0 = BASIC, 1 = Pascal, 2 = RAM based) | |
| ptrOrSlot | Long — Slot number for BASIC or Pascal driver, or POINTER to jump table for RAM-based driver | |
| ← | SP |
None
extern pascal DeviceRec GetOutputDevice()
Returns the type of driver installed as the error output device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| deviceType | Word — Error device type (0 = BASIC, 1 = Pascal, 2 = RAM based) | |
| ptrOrSlot | Long — Slot number for BASIC or Pascal driver, or POINTER to jump table for RAM-based driver | |
| ← | SP |
None
extern pascal DeviceRec GetErrorDevice()
Initializes a specified text device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| deviceNum | Word — Device to initialize (0 = input, 1 = output, 2 = error output) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0C01 badDevType Illegal device type
extern pascal void InitTextDev(deviceNum)
Passes a control code to a specified text device. Errors other than $0C01 can only occur for Pascal devices.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| deviceNum | Word — Device to initialize (0 = input, 1 = output, 2 = error output) | |
| controlCode | Word — Control code (in low-order byte) to pass to device | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0C01 badDevType Illegal device type
$0C02 badDevNum Illegal device number
$0C03 badMode Illegal operation
$0C04 unDefHW Undefined hardware error
$0C06 lostFile File is not longer available
$0C06 lostFile File is not longer available
$0C07 badTitle Illegal file name
$0C08 noRoom Insufficient space on the specified diskette
$0C09 noDevice Specified volume is not on line
$0C0A noFile Specified file is not in the directory given
$0C0B dupFile Duplicate file
$0C0C notClosed Attempt to open a file that is already open
$0C0D notOpen Attempt to access a closed file
$0C0E badFormat Error reading real or integer number
$0C0F ringBufOFlo Ring buffer overflow
$0C10 writeProtected The specified disk is write protected
$0C40 devErr The device did not complete a read or write
extern pascal void InitTextDev(deviceNum)
Executes a status call to a specified text device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| deviceNum | Word — Device to initialize (0 = input, 1 = output, 2 = error output) | |
| requestCode | Word — Request code (in low-order byte) to pass to deviceNum | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void StatusTextDev(deviceNum,requestCode)
Combines a character with output global AND mask and OR mask and writes to output device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theChar | Word — Character to write (in low-order byte) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void WriteChar(theChar)
Combines a character with output global AND & OR mask & writes to error output text device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theChar | Word — Character to write (in low-order byte) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void ErrWriteChar(theChar)
Combines pointed-to Pascal-type string with out global mask, + CR, then output
| Stack before call | ||
|---|---|---|
| previous contents | ||
| strPtr | Long — POINTER to Pascal-type string to be written | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void WriteLine(strPtr)
Combines pointed-to Pascal-type string with output global masks & write to error out
| Stack before call | ||
|---|---|---|
| previous contents | ||
| strPtr | Long — POINTER to Pascal-type string | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void ErrWriteLine(strPtr)
Combines a pointed-to Pascal-type string (first byte = length) with output global masks & write to output device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| strPtr | Long — POINTER to Pascal-type string to be written | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void WriteString(strPtr)
Combines a pointed-to Pascal-type string (first byte = length) with the output global masks and writes to the error output text device.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| strPtr | Long — POINTER to Pascal-type string to be written | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void ErrWriteString(strPtr)
Combines a char string with output global masks & writes to output text device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| textPtr | Long — POINTER to start of ASCII text | |
| offset | Word — Offset within ASCII text | |
| count | Word — String length | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void Text WriteBlock(textPtr,offset,count)
Combines a char string with output global masks & write to error out
| Stack before call | ||
|---|---|---|
| previous contents | ||
| textPtr | Long — POINTER to start of ASCII text | |
| offset | Word — Offset within ASCII text | |
| count | Word — String length | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void Text ErrWriteBlock(textPtr,offset,count)
Combines a pointed-to C string with output global masks & write to output text device
| Stack before call | ||
|---|---|---|
| previous contents | ||
| cStrPtr | Long — POINTER to C-type string to be written | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void WriteCString(strPtr)
Combines a pointed-to C-type string (terminated with $00) with output global masks and writes the string to the error output text device.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| cStrPtr | Long — POINTER to C-type string to be written | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void ErrWriteCString(strPtr)
Reads a char from input text device, combines with input global mask, and puts char on stack
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| echoFlag | Word — Echo or don't echo character to output device (see Toolbox Ref Vol2, Figure 23-1) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal Word ReadChar(echoFlag)
Reads a block of characters from the input text device, combines with input global masks, and writes block to mem location at bufferPtr + offset
| Stack before call | ||
|---|---|---|
| previous contents | ||
| bufferPtr | Long — POINTER to start of block | |
| offset | Word — Offset to start of block to be read | |
| blockSize | Word — Size of block to read | |
| echoFlag | Word — Echo or don't echo character to output device (see Toolbox Ref Vol2, Figure 23-1) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal void TextReadBlock(bufferPtr,offset,blockSize,echoFlag)
Reads char string from input txt device, combines w/input global mask, & writes to mem loc
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| bufferPtr | Long — POINTER to start of buffer.where characters will be written | |
| maxCount | Word — Maximum line length | |
| eolChar | Word — End-of-line character in low byte | |
| echoFlag | Word — Echo or don't echo character to output device (see Toolbox Ref Vol2, Figure 23-1) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| charCount | Word — Count of characters received | |
| ← | SP |
Pascal device errors Any of the errors $0C02-$0C40 listed in Toolbox Ref. Vol3 section 'Text Tool Set Summary' (or see CtlTextDev Tool Call)
extern pascal Word ReadLine(bufferPtr,maxCount,eolChar,echoFlag)
| RAMDisk Tool Calls | ||
|---|---|---|
| Routine | # | Description |
| RDBootInit | $010D | This routine does nothing. It just returns to the caller. Do not use. |
| RDStartUp | $020D | This routine does nothing. It just returns to the caller. Do not use. |
| RDShutDown | $030D | This routine does nothing. It just returns to the caller. Do not use. |
| RDVersion | $040D | Returns the current version number of the RAMDisk tool set. The version is the same as the Memory Manager one. |
| RDReset | $050D | This routine does nothing. It just returns to the caller. Do not use. |
| RDStatus | $060D | Indicates whether the RAMDisk Tool set is active |
| Kill | $090D | This routine does nothing. It just returns to the caller. Do not use. |
| RDExecPCCmd | $0A0D | This routine executes normal or extended SmartPort commands, using data from the zero page. See the IIgs Firmware Ref. |
| RDSetDiskSize | $0B0D | This routine does nothing. It just returns to the caller. Do not use. |
| RDGetDiskSize | $0C0D | This routine returns the current size of the RAMDisk in bytes |
This routine does nothing. It just returns to the caller. Do not use.
The stack is not affected by this call. There are no input or output parameters.
None
This routine does nothing. It just returns to the caller. Do not use.
The stack is not affected by this call. There are no input or output parameters.
None
This routine does nothing. It just returns to the caller. Do not use.
The stack is not affected by this call. There are no input or output parameters.
None
Returns the current version number of the RAMDisk tool set. The version is the same as the Memory Manager one.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| version | Word — Version number of tool set | |
| ← | SP |
None
extern pascal Word RDVersion()
This routine does nothing. It just returns to the caller. Do not use.
The stack is not affected by this call. There are no input or output parameters.
None
Indicates whether the RAMDisk Tool set is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE ($FFFF) = active. False ($0000) = not active. | |
| ← | SP |
None
extern pascal Boolean RDStatus()
This routine does nothing. It just returns to the caller. Do not use.
The stack is not affected by this call. There are no input or output parameters.
None
This routine executes normal or extended SmartPort commands, using data from the zero page. See the IIgs Firmware Ref.
The stack is not affected by this call. There are no input or output parameters.
$01 Bad command number
$21 Bad Ctl or Status code
$27 I/O error
$28 No device error
$2D Bad block number
extern pascal void RDExecPCCmd()
This routine does nothing. It just returns to the caller. Do not use.
The stack is not affected by this call. There are no input or output parameters.
None
This routine returns the current size of the RAMDisk in bytes
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| size | Long — Size in bytes (unconfirmed) | |
| ← | SP |
None
| Window Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| WindBootInit | $010E | Initializes the Window Manager; called only by Tool Locator - not by application |
| WindStartUp | $020E | Starts up the Window Manager for use by an application |
| WindShutDown | $030E | Shuts down the Window Manager when an application quits |
| WindVersion | $040E | Returns the version number of the Window Manager |
| WindReset | $050E | Resets the Window Manager; called only when system reset - not by application |
| WindStatus | $060E | Indicates whether the Window Manager is active |
| NewWindow | $090E | Creates specified window per its params, adds to window list, returns pointer to new window's GrafPort |
| CheckUpdate | $0A0E | Looks from top to bottom in window list for visible window that needs updating - normally called by EventManager |
| CloseWindow | $0B0E | Removes a specified window from the screen, disposes of all controls and RAM associated with that window, and deletes it from the window list. |
| DeskTop | $0C0E | Controls the addition of regions to and subtraction of regions from the desktop and controls the current desktop pattern. |
| SetWTitle | $0D0E | Changes the title of a specified window to a specified title and redraw the window |
| GetWTitle | $0E0E | Returns the pointer to a specified window's title |
| SetFrameColor | $0F0E | Sets the color of a specified window's frame. Does not redraw. Call HideWindow, SetFrameColor, then ShowWindow to redraw in new colors |
| GetFrameColor | $100E | Returns the color of a specifed window's frame |
| SelectWindow | $110E | Makes a specified window the active window |
| HideWindow | $120E | Makes a specified window invisible |
| ShowWindow | $130E | Makes a specified window visible if it was invisible and then draws the window |
| SendBehind | $140E | Changes position of a specified window, redrawing any exposed windows |
| FrontWindow | $150E | Returns a ptr to the first visible window in the windows list (that is, the active window) |
| SetInfoDraw | $160E | Sets pointer to routine that draws information bar for specified window |
| FindWindow | $170E | Indicates which part of which window, if any, cursor was in when mouse button was pressed |
| TrackGoAway | $180E | Tracks mouse until button released, highlighting the go-away region as the mouse stays inside of it |
| MoveWindow | $190E | Moves a specified window to another part of the screen without affecting its size |
| DragWindow | $1A0E | Pulls around a dotted outline of a specified window, following movements of mouse until button is released |
| GrowWindow | $1B0E | Pulls around a grow image of a specified window, following the movements of the mouse until the mouse button is released |
| SizeWindow | $1C0E | Enlarges or shrinks port rectangle of specified window's GrafPort to a specified width & height |
| TaskMaster | $1D0E | Calls GetNextEvent & looks in event part of task record to see if it can handle the event |
| BeginUpdate | $1E0E | Replaces visible region of window's GrafPort with intersection of visible & update region. Use pattern is BeginUpdate, draw window contents, EndUpdate. |
| EndUpdate | $1F0E | Restores normal visible region of specified window's GrafPort that was changed by BeginUpdate |
| GetWMgrPort | $200E | Returns a pointer to the Window Manager's port |
| PinRect | $210E | Pins a specified point inside a specified rectangle |
| HiliteWindow | $220E | Highlights or unhighlights a specified window |
| ShowHide | $230E | Shows or hides a window |
| BringToFront | $240E | Brings specified window to front of all windows and redraws windows as necessary (no highlight) |
| WindNewRes | $250E | Closes Window Manager's GrafPort & opens new GrafPort in the other SHR resolution (call after resolution change) |
| TrackZoom | $260E | Tracks mouse until button released, hi-lighting zoom region if mouse location is inside it |
| ZoomWindow | $270E | Switches size & position of specified window between its current size and position & its max size |
| SetWRefCon | $280E | Sets value that is inside specified window record & is reserved for the application's use |
| GetWRefCon | $290E | Returns value from specified window's record that was passed to either NewWindow or SetWRefCon |
| GetNextWindow | $2A0E | Returns pointer to next window in window list after specified window; NIL if last window in list |
| GetWKind | $2B0E | Indicates whether a specified window is a system window or an application window |
| GetWFrame | $2C0E | Returns the bit flag that describes a specified window's frame type |
| SetWFrame | $2D0E | Sets the bit flag that describes a specified window's frame type |
| GetStructRgn | $2E0E | Returns a handle to a specified window's structure region |
| GetContentRgn | $2F0E | Returns a handle to a specified window's content region |
| GetUpdateRgn | $300E | Returns a handle to a specified window's update region |
| GetDefProc | $310E | Returns pointer to routine that's called to draw, hit test, & define window's frame & behavior |
| SetDefProc | $320E | Sets pointer to routine that defines drawing, hit test, window's frame and behavior |
| GetWControls | $330E | Returns the handle to the first control in the window's control list |
| SetOriginMask | $340E | Specifies the mask used to put the horizontal origin on a grid (very useful for preserving dithered colors in 640 mode) |
| GetInfoRefCon | $350E | Returns value associated with the draw information bar routine for a specified window |
| SetInfoRefCon | $360E | Sets value associated with the draw information bar routine for a specified window |
| GetZoomRect | $370E | Returns pointer to rectangle used as content's zoomed or unzoomed size for a specified window |
| SetZoomRect | $380E | Sets rectangle to be used as content's zoomed or unzoomed size for a specified window |
| RefreshDesktop | $390E | Redraws the entire desktop and all the windows |
| InvalRect | $3A0E | Accumulates specified rectangle into update region of window whose GrafPort is current port (tells WM it needs updating) |
| InvalRgn | $3B0E | Accumulates specified region into update region of window whose GrafPort is current port (tells WM it needs updating) |
| ValidRect | $3C0E | Removes specified rectangle from update region of current GrafPort window & cancels updates |
| ValidRgn | $3D0E | Removes specified region from update region of current GrafPort window & cancels updates |
| GetContentOrig | $3E0E | Returns value used by TaskMaster to set origin of window's GrafPort when update event |
| SetContentOrig | $3F0E | Sets the origin of the window's GrafPort when handling an update event |
| GetDataSize | $400E | Returns the height and width of the data area of a specified window |
| SetDataSize | $410E | Sets the height and width of the data area of a specifed window |
| GetMaxGrow | $420E | Returns the maximum values to which a specified window's content region can grow |
| SetMaxGrow | $430E | Sets the maximum values to which a specified window's content region can grow |
| GetScroll | $440E | Returns the number of pixels that TaskMaster will scroll content region when arrow scroll bar selected |
| SetScroll | $450E | Sets the number of pixels that TaskMaster will scroll content region when arrow scroll bar selected |
| GetPage | $460E | Returns the number of pixels that TaskMaster will scroll content region when selected on scroll bar |
| SetPage | $470E | Sets the number of pixels that TaskMaster will scroll content region when selected on scroll bar |
| GetContentDraw | $480E | Returns pointer to routine that draws content region of a specified window |
| SetContentDraw | $490E | Sets pointer to routine that draws content region of a specified window |
| GetInfoDraw | $4A0E | Returns pointer to routine that draws information bar for specified window |
| SetSysWindow | $4B0E | Marks a specified window as a system window |
| GetSysWFlag | $4C0E | Indicate whether a specified window is a a system or an application window |
| StartDrawing | $4D0E | Makes a specified window the current port and sets its origin |
| SetWindowIcons | $4E0E | Sets the icon font for the Window Manager |
| GetRectInfo | $4F0E | Sets information rectangle to coordinates of the information bar rectangle |
| StartInfoDrawing | $500E | Allows application to draw or hit test outside of information bar definition procedure |
| EndInfoDrawing | $510E | Puts the Window Manager back into a global coordinate system |
| GetFirstWindow | $520E | Returns pointer to first window in the window list (window may not be the active window) |
| WindDragRect | $530E | Pulls dotted outline of specified rectangle around screen, following the movements of the mouse until the mouse button is released |
| GetDragRect | $540E | Returns the address of the internal DragRect routine (undocumented?) |
| DrawInfoBar | $550E | Redraws the info bar of the window specified by grafPortPtr |
| WindowGlobal | $560E | Specifies a mask that determines how Window Manager performs tasks and retuns windowGlobalFlag |
| SetContentOrigin | $570E | Sets origin of windows GrafPort when hndlng updt event & ctrls scrolling of content region |
| GetWindowMgrGlobals | $580E | Returns a pointer to the Window Manager global data area - call not made by application |
| AlertWindow | $590E | Creates an alert window that displays a message pointed to by alertStrPtr |
| StartFrameDrawing | $5A0E | Sets up to draw a window frame - should be called only be window definition procedures |
| EndFrameDrawing | $5B0E | Restores Window Manager variables after a call to StartFrameDrawing |
| ResizeWindow | $5C0E | Moves, resizes, and draws the window specified by grafPortPtr |
| TaskMasterContent | $5D0E | Internal routine that handles events inside the content region of a window. Your program should never issue this call. |
| TaskMasterKey | $5E0E | Internal routine that handles keystroke events inside the content region of a window. Your program should never issue this call. |
| TaskMaskerDA | $5F0E | This call is the TaskMaster entry point for desk accessories |
| CompileText | $600E | Combines source text with either custom or standard strings to compile a result text string |
| NewWindow2 | $610E | Performs the same function as NewWindow but allows the input window template as a resource |
| ErrorWindow | $620E | Creates a dialog box displaying an error message for a specified error code |
| GetAuxWindInfo | $630E | Returns a pointer to a block of auxiliary data for a specified window |
| DoModalWindow | $640E | Handles user interaction in a window containing extended controls |
| MWGetCtlPart | $650E | Returns the part code from any TrackControl call made by the most recent DoModalWindow call |
| MWSetMenuProc | $660E | Informs DoModalWindow of the address of a routine to be called when the frontmost window changes inside a DoModalWindow call |
| MWStdDrawProc | $670E | MWStdDrawProc is what DoModalWindow calls to update a modal window if you do not supply your own update procedure |
| MWSetUpEditMenu | $680E | Sets the sate of the standard emenu items based on the frontmost window |
| FindCursorCtl | $690E | Returns the handle for the control beneath a given point |
| ResizeInfoBar | $6A0E | Sets the vertical size of a standard window's information bar |
| HandleDiskInsert | $6B0E | Lets an application know about disks the user has inserted or ejected |
| UpdateWindow | $6C0E | Updates the specified window if it has a content draw routine and the environment permits |
Initializes the Window Manager; called only by Tool Locator - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Window Manager for use by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — ID number of the application | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void WindStartUp(UserID)
Shuts down the Window Manager when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void WindShutDown()
Returns the version number of the Window Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Window Manager | |
| ← | SP |
None
extern pascal Word WindVersion()
Resets the Window Manager; called only when system reset - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the Window Manager is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Window Manager is active; FALSE if not | |
| ← | SP |
None
extern pascal Word WindStatus()
Creates specified window per its params, adds to window list, returns pointer to new window's GrafPort
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| paramListPtr | Long — POINTER to parameter list (see Toolbox Ref Vol2, Table 25-9) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theWindow | Long — POINTER to window's GrafPort; NIL if error | |
| ← | SP |
$0E01 paramLenErr The first word of the parameter list is the wrong size
$0E02 allocateErr Unable to allocate the window record
extern pascal GrafPortPtr NewWindow(paramListPtr)
Looks from top to bottom in window list for visible window that needs updating - normally called by EventManager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| theEventPtr | Long — POINTER to an event record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| updateFlag | Word — BOOLEAN; TRUE if update event found, otherwise FALSE | |
| ← | SP |
None
extern pascal Boolean CheckUpdate(theEventPtr)
Removes a specified window from the screen, disposes of all controls and RAM associated with that window, and deletes it from the window list.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CloseWindow(theWindowPtr)
Controls the addition of regions to and subtraction of regions from the desktop and controls the current desktop pattern.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| deskTopOP | Word — Operation to perform | |
| dtParam | Long — Parameter needed for operation | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| retParam | Long — Possible return parameter (see Toolbox Ref Vol2, Table 25-5) | |
| ← | SP |
None
extern pascal Pointer Desktop(deskTopOP,dtParam)
Changes the title of a specified window to a specified title and redraw the window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| titlePtr | Long — POINTER to new title | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetWTitle(titlePtr,theWindowPtr)
Returns the pointer to a specified window's title
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| titlePtr | Long — POINTER to window's title string | |
| ← | SP |
None
extern pascal Pointer GetWTitle(theWindowPtr)
Sets the color of a specified window's frame. Does not redraw. Call HideWindow, SetFrameColor, then ShowWindow to redraw in new colors
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newColorPtr | Long — POINTER to five-word pattern/color table; NIL for default table | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetFrameColor(newColorPtr,theWindowPtr)
Returns the color of a specifed window's frame
| Stack before call | ||
|---|---|---|
| previous contents | ||
| colorPtr | Long — POINTER to five-word pattern/color table to be filled with window's color table | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetFrameColor(colorPtr,theWindowPtr)
Makes a specified window the active window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SelectWindow(theWindowPtr)
Makes a specified window invisible
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void HideWindow(theWindowPtr)
Makes a specified window visible if it was invisible and then draws the window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ShowWindow(theWindowPtr)
Changes position of a specified window, redrawing any exposed windows
| Stack before call | ||
|---|---|---|
| previous contents | ||
| behindWindowPtr | Long — POINTER to GrafFort or $FFFFFFFF=top, $FFFFFFFE=bottom | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SendBehind(behindWindowPtr,theWindowPtr)
Returns a ptr to the first visible window in the windows list (that is, the active window)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to active window's GrafPort; NIL if none visible | |
| ← | SP |
None
extern pascal GrafPortPtr FrontWindow()
Sets pointer to routine that draws information bar for specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| infoDrawPtr | Long — POINTER to draw information bar routine | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetInfoDraw(infoDrawPtr,theWindowPtr)
Indicates which part of which window, if any, cursor was in when mouse button was pressed
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| whichWindowPtr | Long — POINTER to space to store pointer to window; NIL if not found | |
| pointX | Word — X point to check, in global coordinates | |
| pointY | Word — Y point to check, in global coordinates | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| location | Word — Mouse-down event location (see Toolbox Ref Vol2, Table 25-8) | |
| ← | SP |
None
extern pascal Word FindWindow(whichWindowPtr,pointX,pointY)
Tracks mouse until button released, highlighting the go-away region as the mouse stays inside of it
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| startX | Word — Starting X coordinate of cursor, in global coordinates | |
| startY | Word — Starting Y coordinate of cursor, in global coordinates | |
| whichWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| goAway | Word — BOOLEAN; TRUE if go-away selected when button released, FALSE if not | |
| ← | SP |
None
extern pascal Boolean TrackGoAway(startX,startY,theWindowPtr)
Moves a specified window to another part of the screen without affecting its size
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newX | Word — New X coordinate of content region's upper left corner (global) | |
| newY | Word — New Y coordinate of content region's upper left corner (global) | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MoveWindow(newX,newY,theWindowPtr)
Pulls around a dotted outline of a specified window, following movements of mouse until button is released
| Stack before call | ||
|---|---|---|
| previous contents | ||
| grid | Word — Drag resolution, zero for default (see Table 25-7) | |
| startX | Word — Starting X coordinate of cursor, in global coordinates | |
| startY | Word — Starting Y coordinate of cursor, in global coordinates | |
| grace | Word — Grace buffer around bounds | |
| boundsRectPtr | Long — POINTER to RECT structure for cursor boundary, NIL for default | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DragWindow(grid,startX,startY,grace,boundsRectPtr,theWindowPtr)
Pulls around a grow image of a specified window, following the movements of the mouse until the mouse button is released
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| minWidth | Word — Minimum width of content region | |
| minHeight | Word — Minimum height of content region | |
| startX | Word — Starting X coordinate of cursor, in global coordinates | |
| startY | Word — Starting Y coordinate of cursor, in global coordinates | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| newSize | Long — High word = new width; low word = new height | |
| ← | SP |
None
extern pascal LongWord GrowWindow(minWidth,minHeight,startX,startY,theWindowPtr)
Enlarges or shrinks port rectangle of specified window's GrafPort to a specified width & height
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newWidth | Word — New width of window in pixels | |
| newHeight | Word — New height of window in pixels | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SizeWindow(newWidth,newHeight,theWindowPtr)
Calls GetNextEvent & looks in event part of task record to see if it can handle the event
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| taskMask | Word — Mask used by TaskMaster to call GetNextEvent | |
| taskRecPtr | Long — POINTER to Window Manager task record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| taskCode | Word — Code indicating action to be taken; 0=no further task to perform | |
| ← | SP |
$0E03 taskMaskErr Some reserved bits were not clear in the wmTaskMask field of the wmTaskRec record
extern pascal Word TaskMaster(taskMask,taskRecPtr)
Replaces visible region of window's GrafPort with intersection of visible & update region. Use pattern is BeginUpdate, draw window contents, EndUpdate.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void BeginUpdate(theWindowPtr)
Restores normal visible region of specified window's GrafPort that was changed by BeginUpdate
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void EndUpdate(theWindowPtr)
Returns a pointer to the Window Manager's port
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wPortPtr | Long — POINTER to Window Manager's GrafPort | |
| ← | SP |
None
extern pascal GrafPortPtr GetWMgrPort()
Pins a specified point inside a specified rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theXPt | Word — X coordinate of point to be pinned | |
| theYPt | Word — Y coordinate of point to be pinned | |
| theRectPtr | Long — POINTER to RECT data structure defining boundary of point | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| pinnedPt | Long — POINT; high word = X coordinate, low word = Y coordinate | |
| ← | SP |
None
extern pascal Long PinRect(theXPt,theYPt,theRectPtr)
You can also use the following alternate form of the call:
extern pascal Long PinRect(thePoint,theRectPtr)
Highlights or unhighlights a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| fHiliteFlag | Word — BOOLEAN; TRUE to highlight window, FALSE to unhighlight | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void HiliteWindow(fHiliteFlag,theWindowPtr)
Shows or hides a window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| showFlag | Word — BOOLEAN; TRUE to show, FALSE to hide | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ShowHide(showFlag,theWindowPtr)
Brings specified window to front of all windows and redraws windows as necessary (no highlight)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void BringToFront(theWindowPtr)
Closes Window Manager's GrafPort & opens new GrafPort in the other SHR resolution (call after resolution change)
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void WindNewRes
Tracks mouse until button released, hi-lighting zoom region if mouse location is inside it
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| startX | Word — Starting X coordinate of cursor, in global coordinates | |
| startY | Word — Starting Y coordinate of cursor, in global coordinates | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| zoom | Word — BOOLEAN; TRUE if zoom region was selected, FALSE if not | |
| ← | SP |
None
extern pascal Boolean TrackZoom(startX,startY,theWindowPtr)
You can also use the following alternate form of the call:
extern pascal Boolean TrackZoom(start,theWindowPtr)
Switches size & position of specified window between its current size and position & its max size
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ZoomWindow(theWindowPtr)
Sets value that is inside specified window record & is reserved for the application's use
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wRefCon | Long — Value of wRefCon field | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetWRefCon(wRefCon,theWindowPtr)
Returns value from specified window's record that was passed to either NewWindow or SetWRefCon
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wRefCon | Long — Current value of wRefCon field | |
| ← | SP |
None
extern pascal Longword GetWRefCon(theWindowPtr)
Returns pointer to next window in window list after specified window; NIL if last window in list
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| nextWindowPtr | Long — POINTER to next window's GrafPort in list; NIL if last window | |
| ← | SP |
None
extern pascal GrafPortPtr GetNextWindow(theWindowPtr)
Indicates whether a specified window is a system window or an application window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| windowKind | Word — Bit 15 is for application window, 1 for system window | |
| ← | SP |
None
extern pascal Word GetWKind(theWindowPtr)
Returns the bit flag that describes a specified window's frame type
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wFrame | Word — Bit flag with window's frame type | |
| ← | SP |
None
extern pascal Word GetWFrame(theWindowPtr)
Sets the bit flag that describes a specified window's frame type
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wFrame | Word — Bit flag with window's frame type | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal Word SetWFrame(wFrame,theWindowPtr)
Returns a handle to a specified window's structure region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wStructHandle | Long — HANDLE to window's structure region | |
| ← | SP |
None
extern pascal RgnHandle GetStructRgn(theWindowPtr)
Returns a handle to a specified window's content region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wContHandle | Long — HANDLE to window's content region | |
| ← | SP |
None
extern pascal RgnHandle GetContentRgn(theWindowPtr)
Returns a handle to a specified window's update region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wUpdateHandle | Long — HANDLE to window's update region | |
| ← | SP |
None
extern pascal RgnHandle GetUpdateRgn(theWindowPtr)
Returns pointer to routine that's called to draw, hit test, & define window's frame & behavior
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wDefProcPtr | Long — POINTER to window's definition procedure | |
| ← | SP |
None
extern pascal LongProcPtr GetDefProc(theWindowPtr)
Sets pointer to routine that defines drawing, hit test, window's frame and behavior
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wDefProcPtr | Long — POINTER to window's definition procedure | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetDefProc(wDefProcPtr,theWindowPtr)
Returns the handle to the first control in the window's control list
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| controlHandle | Long — HANDLE to first control in window's control list; NIL if none | |
| ← | SP |
None
extern pascal CtlRecHndl GetWControls(theWindowPtr)
Specifies the mask used to put the horizontal origin on a grid (very useful for preserving dithered colors in 640 mode)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| originMask | Word — Mask used to place horizontal origin on a grid | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetOriginMask(originMask,theWindowPtr)
Returns value associated with the draw information bar routine for a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| infoRefCon | Long — Value passed to draw information bar routine | |
| ← | SP |
None
extern pascal Longword GetinfoRefCon(theWindowPtr)
Sets value associated with the draw information bar routine for a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| infoRefCon | Long — Value passed to draw information bar routine | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal SetinfoRefCon(infoRefCon,theWindowPtr)
Returns pointer to rectangle used as content's zoomed or unzoomed size for a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| wZoomSizePtr | Long — POINTER to RECT data structure used as content's zoomed size | |
| ← | SP |
None
extern pascal Rect* GetZoomRect(theWindowPtr)
Sets rectangle to be used as content's zoomed or unzoomed size for a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wZoomSizePtr | Long — POINTER to rectangle to be used as content's zoomed size | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetZoomRect(wZoomSizePtr,theWindowPtr)
Redraws the entire desktop and all the windows
| Stack before call | ||
|---|---|---|
| previous contents | ||
| redrawRect | Long — POINTER to RECT of rectangle to redraw; NIL for entire screen | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void RefreshDesktop(redrawRect)
Accumulates specified rectangle into update region of window whose GrafPort is current port (tells WM it needs updating)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| badRectPtr | Long — POINTER to RECT data structure of rectangle to be added | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InvalRect(badRectPtr)
Accumulates specified region into update region of window whose GrafPort is current port (tells WM it needs updating)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| badRgnHandle | Long — HANDLE to region to be added to update region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InvalRgn(badRgnHandle)
Removes specified rectangle from update region of current GrafPort window & cancels updates
| Stack before call | ||
|---|---|---|
| previous contents | ||
| goodRectPtr | Long — POINTER to RECT data structure of rectangle to be removed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ValidRect(goodRectPtr)
Removes specified region from update region of current GrafPort window & cancels updates
| Stack before call | ||
|---|---|---|
| previous contents | ||
| goodRgnHandle | Long — HANDLE to region to be subtracted from update region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ValidRgn(goodRgnHandle)
Returns value used by TaskMaster to set origin of window's GrafPort when update event
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| origin | Long — POINT; low word = Y origin, high word = X origin | |
| ← | SP |
None
extern pascal Long GetContentOrigin(theWindowPtr)
Sets the origin of the window's GrafPort when handling an update event
| Stack before call | ||
|---|---|---|
| previous contents | ||
| xOrigin | Word — Content region's horizontal offset into data area | |
| yOrigin | Word — Content region's vertical offset into data area | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetContentOrigin(xOrigin,yOrigin,theWindowPtr)
Returns the height and width of the data area of a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| dataSize | Long — Low word = height; high word = width | |
| ← | SP |
None
extern pascal LongWord GetDataSize(theWindowPtr)
Sets the height and width of the data area of a specifed window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| dataWidth | Word — Width of data area in pixels | |
| dataHeight | Word — Height of data area in pixels | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetDataSize(dataWidth,dataHeight,theWindowPtr)
Returns the maximum values to which a specified window's content region can grow
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| maxGrow | Long — Low word = maxHeight; high word = maxWidth | |
| ← | SP |
None
extern pascal LongWord GetMaxGrow(theWindowPtr)
Sets the maximum values to which a specified window's content region can grow
| Stack before call | ||
|---|---|---|
| previous contents | ||
| maxWidth | Word — Maximum content width in pixels | |
| maxHeight | Word — Maximum content height in pixels | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMaxGrow(maxWidth,maxHeight,theWindowPtr)
Returns the number of pixels that TaskMaster will scroll content region when arrow scroll bar selected
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| scrollAmount | Long — Low word = vertical amount; high word = horizontal amount | |
| ← | SP |
None
extern pascal LongWord GetScroll(theWindowPtr)
Sets the number of pixels that TaskMaster will scroll content region when arrow scroll bar selected
| Stack before call | ||
|---|---|---|
| previous contents | ||
| hScroll | Word — Number of pixels to scroll horizontally | |
| vScroll | Word — Number of pixels to scroll vertically | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetScroll(hScroll,vScroll,theWindowPtr)
Returns the number of pixels that TaskMaster will scroll content region when selected on scroll bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| pageAmount | Long — Low word = vertical amount; high word = horizontal amount | |
| ← | SP |
None
extern pascal void GetPage(theWindowPtr)
Sets the number of pixels that TaskMaster will scroll content region when selected on scroll bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| hPage | Word — Number of pixels to page horizontally | |
| vPage | Word — Number of pixels to page vertically | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetPage(hPage,vPage,theWindowPtr)
Returns pointer to routine that draws content region of a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| contentDrawPtr | Long — POINTER to routine called to draw content region | |
| ← | SP |
None
extern pascal VoidProcPtr GetContentDraw(theWindowPtr)
Sets pointer to routine that draws content region of a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| contentDrawPtr | Long — POINTER to routine to draw content region | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetContentDraw(contentDrawPtr,theWindowPtr)
Returns pointer to routine that draws information bar for specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| infoDrawPtr | Long — POINTER to routine called to draw information bar | |
| ← | SP |
None
extern pascal VoidProcPtr GetContentDraw(theWindowPtr)
Marks a specified window as a system window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetSysWindow(theWindowPtr)
Indicate whether a specified window is a a system or an application window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| sysFlag | Word — BOOLEAN; TRUE if system window, FALSE if application window | |
| ← | SP |
None
extern pascal Boolean GetSysWFlag(theWindowPtr)
Makes a specified window the current port and sets its origin
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void StartDrawing(theWindowPtr)
Sets the icon font for the Window Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| newFontHandle | Long — HANDLE to new icon font; negative to not replace font | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| oldFontHandle | Long — HANDLE to icon font before call | |
| ← | SP |
None
extern pascal FontHndl SetWindowicons(newFontHandle)
Sets information rectangle to coordinates of the information bar rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| infoRectPtr | Long — POINTER to destination RECT where rectangle will be stored | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void GetRectinfo(infoRectPtr,theWindowPtr)
Allows application to draw or hit test outside of information bar definition procedure
| Stack before call | ||
|---|---|---|
| previous contents | ||
| infoRectPtr | Long — POINTER to destination RECT where information bar's data will be stored | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void StartInfoDrawing(infoRectPtr,theWindowPtr)
Puts the Window Manager back into a global coordinate system
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void EndInfoDrawing()
Returns pointer to first window in the window list (window may not be the active window)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| firstWindowPtr | Long — POINTER to first window, or NIL | |
| ← | SP |
None
extern pascal GrafPortPtr GetFirstWindow()
Pulls dotted outline of specified rectangle around screen, following the movements of the mouse until the mouse button is released
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| actionProcPtr | Long — POINTER to routine; NIL for default | |
| dragPatternPtr | Long — POINTER to pattern to use for drag outline | |
| startX | Word — X coordinate of starting point, in global coordinates | |
| startY | Word — Y coordinate of starting point, in global coordinates | |
| dragRectPtr | Long — POINTER to RECT data structure of rectangle to be dragged | |
| limitRectPtr | Long — POINTER to RECT of limit rectangle | |
| slopRectPtr | Long — POINTER to RECT of slop rectangle | |
| dragFlag | Word — Bit flag customizing drag rectangle (see Toolbox Ref Vol1 Figure 4-25) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| moveDelta | Long — High word = amount X changed; low word = amount Y changed | |
| ← | SP |
None
extern pascal Longword WindDragRect(actionProcPtr,dragPatternPtr,startX,startY,dragRectPtr,limitRectPtr,slopRectPtr,dragFlag)
Returns the address of the internal DragRect routine (undocumented?)
The stack is not affected by this call. There are no input or output parameters.
Call must not be made by an application.
Redraws the info bar of the window specified by grafPortPtr
| Stack before call | ||
|---|---|---|
| previous contents | ||
| grafPortPtr | Long — Pointer to GrafPort for window | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DrawInfoBar(grafPortPtr)
Specifies a mask that determines how Window Manager performs tasks and retuns windowGlobalFlag
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| windowGlobalMask | Word — Global mask (see Toolbox Ref Vol2, Table 25-11) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| windowGlobalFlag | Word — Current state of window global flag (see Toolbox Ref Vol2, Table 25-11) | |
| ← | SP |
None
extern pascal Word WindowGlobal(windowGlobalMask)
Sets origin of windows GrafPort when hndlng updt event & ctrls scrolling of content region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| xOrigin | Word — Content region's horizontal offset into data area | |
| yOrigin | Word — Content region's vertical offset into data area | |
| theWindowPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal SetContentOrigin(xOrigin,yOrigin,theWindowPtr)
Returns a pointer to the Window Manager global data area - call not made by application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| globalDataPtr | Long — Pointer to the global data area | |
| ← | SP |
None
extern pascal Pointer GetWindowMgrGlobals()
Creates an alert window that displays a message pointed to by alertStrPtr
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| alertFlags | Word — Flag word for call | |
| subStrPtr | Long — POINTER to substitution array | |
| alertStrRef | Long — Reference to alert string; alertFlags indicates type | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| result | Word — Button number selected (0 relative, in order created | |
| ← | SP |
None
extern pascal Word AlertWindow(alertFlags,subStrPtr,alertStrRef)
Sets up to draw a window frame - should be called only be window definition procedures
| Stack before call | ||
|---|---|---|
| previous contents | ||
| windowPtr | Long — Pointer to the window to be drawn | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void StartFrameDrawing(windowPtr)
Restores Window Manager variables after a call to StartFrameDrawing
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void EndFrameDrawing()
Moves, resizes, and draws the window specified by grafPortPtr
| Stack before call | ||
|---|---|---|
| previous contents | ||
| hiddenFlag | Word — BOOLEAN; whether to hide covered area | |
| rectPtr | Long — POINTER to new content rectangle | |
| grafPortPtr | Long — POINTER to window's GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ResizeWindow(hiddenFlag,rectPtr,grafPortPtr)
Internal routine that handles events inside the content region of a window. Your program should never issue this call.
Internal routine that handles keystroke events inside the content region of a window. Your program should never issue this call.
This call is the TaskMaster entry point for desk accessories
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| eventMask | Word — Not used | |
| taskRecPtr | Long — POINTER to extended task record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| taskCode | Word — TaskMaster result code | |
| ← | SP |
None
extern pascal Word TaskMasterDA(eventMask,taskRecPtr)
Combines source text with either custom or standard strings to compile a result text string
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| subType | Word — Type of custom substitution strings | |
| subStringsPtr | Long — POINTER to substitution array | |
| srcStringPtr | Long — POINTER to source string | |
| srcSize | Word — Length of source string being pointed to by srcStringPtr | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| stringHandle | Long — HANDLE to result string | |
| ← | SP |
$0E04 compileTooLarge Compiled text is larger than 64K
extern pascal Handle CompileText(subType,subStringsPtr,srcStringPtr,srcSize)
Performs the same function as NewWindow but allows the input window template as a resource
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| titlePtr | Long — POINTER to replacement title | |
| refCon | Long — RefCon to replace value in template | |
| contentDrawPtr | Long — POINTER to replacement content-draw routine | |
| defProcPtr | Long — POINTER to replacement window definition procedure | |
| paramTableDesc | Word — Type of reference in paramTableRef | |
| paramTableRef | Long — Reference to window template | |
| resourceType | Word — Resource type of template referred to by paramTableRef | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| grafPortPtr | Long — POINTER to window's GrafPort; NIL if error | |
| ← | SP |
Resource Manager errors Returned unchanged
Memory Manager errors Returned unchanged
Window Manager errors Returned unchanged
Control Manager errors Returned unchanged
extern pascal Pointer NewWindow2(titlePtr,refCon,contentDrawPtr,defProcPtr,paramTableDesc,paramTableRef,resourceType)
Creates a dialog box displaying an error message for a specified error code
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| subType | Word — Type of custom substitution string | |
| subStringPtr | Long — POINTER to substitution string | |
| errNum | Word — GS/OS error number | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| buttonNumber | Word — Number of the button clicked by the user | |
| ← | SP |
Resource Manager errors Returned unchanged
extern pascal Word ErrorWindow(subType,subStringPtr,errNum)
Returns a pointer to a block of auxiliary data for a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — Window pointer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| auxInfoPtr | Long — POINTER to auxiliary window record | |
| ← | SP |
$0201 memErr Unable to allocate memory
extern pascal Pointer GetAuxWindInfo(theWindowPtr)
Handles user interaction in a window containing extended controls
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| eventPtr | Long — POINTER to an extended task record | |
| updateProc | Long — POINTER to update procedure; NIL if for standard | |
| eventHook | Long — POINTER to event hook routine; NIL for none | |
| beepProc | Long — POINTER to beep procedure | |
| flags | Word — Flags | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ID | Long — ID of control or menu item that was selected | |
| ← | SP |
None
extern pascal Long DoModalWindow(eventPtr,updateProc,eventHook,beepProc,flags)
Returns the part code from any TrackControl call made by the most recent DoModalWindow call
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlPart | Word — Part code | |
| ← | SP |
None
extern pascal Word MWGetCtlPart()
Informs DoModalWindow of the address of a routine to be called when the frontmost window changes inside a DoModalWindow call
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| newMenuProc | Long — Pointer to new menu procedure or $FFFFFFFF | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| oldMenuProc | Long — Pointer to previous menu procedure | |
| ← | SP |
None
extern pascal VoidProcPtr MWSetMenuProc(newMenuProc)
MWStdDrawProc is what DoModalWindow calls to update a modal window if you do not supply your own update procedure
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void MWStdDrawProc()
Sets the sate of the standard emenu items based on the frontmost window
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void MWSetUpEditMenu()
Returns the handle for the control beneath a given point
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ctlHandlePtr | Long — POINTER to space for control handle | |
| xLoc | Word — Local X coordinate of point | |
| yLoc | Word — Local Y coordinate of point | |
| theWindowPtr | Long — POINTER to the window to check; NIL for front window | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| partCode | Word — Part code for the control beneath the given point | |
| ← | SP |
None
extern pascal unsigned int FindCursorCtl(ctlHandlePtr,xLoc,yLoc,theWindowPtr)
Sets the vertical size of a standard window's information bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| flags | Word — Flags (reserved, use 0) | |
| newHeight | Word — New information bar height | |
| theWindowPtr | Long — POINTER to the window | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ResizeInfoBar(flags,newHeight,theWindowPtr)
Lets an application know about disks the user has inserted or ejected
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| flags | Word — Input flags | |
| devNum | Word — GS/OS device number | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| resultFlags | Word — Resulting flags | |
| resultFlags | Word — Resulting device number | |
| ← | SP |
GS/OS errors Returned unchanged
extern pascal long HandleDiskInsert(flags,devNum)
Updates the specified window if it has a content draw routine and the environment permits
| Stack before call | ||
|---|---|---|
| previous contents | ||
| flags | Word — Input flags | |
| theWindowPtr | Long — Window to update | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0E05 cantUpdateErr Cannot update the specified window in the current environment
extern pascal void UpdateWindow(flags,theWindowPtr)
| Menu Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| MenuBootInit | $010F | Initializes the Menu Manager; called only by Tool Locator - not by application |
| MenuStartUp | $020F | Starts up the Menu Manager for use by an application |
| MenuShutDown | $030F | Shuts down the Menu Manager when an application quits |
| MenuVersion | $040F | Returns the version number of the Menu Manager |
| MenuReset | $050F | Resets the Menu Manager; called only when system reset - not by application |
| MenuStatus | $060F | Indicates whether the Menu Manager is active |
| MenuKey | $090F | Maps a character to the associated menu and item for that character |
| GetMenuBar | $0A0F | Returns the handle of the current menu bar |
| MenuRefresh | $0B0F | Attempts to refresh the screen. |
| FlashMenuBar | $0C0F | Flashes the entire current menu bar |
| InsertMenu | $0D0F | Inserts a specified menu into the menu list after a specified menu item or at front of list |
| DeleteMenu | $0E0F | Removes a specified menu from the menu list |
| InsertMItem | $0F0F | Inserts a menu item into a menu after a specified menu item or at the front of the list |
| DeleteMItem | $100F | Removes a specified item from the current menu |
| GetSysBar | $110F | Returns the handle of the current system menu bar |
| SetSysBar | $120F | Sets a new system bar; the system menu bar becomes the current menu bar |
| FixMenuBar | $130F | Computes standard sizes for the menu bar and menus |
| CountMItems | $140F | Returns the number of items, including any dividing lines, in a specified menu |
| NewMenuBar | $150F | Creates a default menu bar with no menus |
| GetMHandle | $160F | Returns a handle to a menu record |
| SetBarColors | $170F | Sets the normal, inverse, and outline colors of the current menu bar |
| GetBarColors | $180F | Returns the colors for the current menu bar |
| SetMTitleStart | $190F | Sets the starting position for the leftmost title within the current menu bar |
| GetMTitleStart | $1A0F | Returns the starting position of the leftmost title within the current menu bar |
| GetMenuMgrPort | $1B0F | Returns a pointer to the Menu Manager's port |
| CalcMenuSize | $1C0F | Sets menu dimensions, either manually or automatically |
| SetMTitleWidth | $1D0F | Sets the width of a title |
| GetMTitleWidth | $1E0F | Returns the width of a menu title |
| SetMenuFlag | $1F0F | Sets the menu to a specified state |
| GetMenuFlag | $200F | Returns the menu flag for a specified menu |
| SetMenuTitle | $210F | Specifies the title for a menu |
| GetMenuTitle | $220F | Returns a pointer to the title of a menu |
| MenuGlobal | $230F | Turns menu help on/off or returns state of menu help; help user know inactive to active |
| SetMItem | $240F | Specifies the name for a menu item by pointing to an item line |
| GetMItem | $250F | Returns a pointer to the name of an item |
| SetMItemFlag | $260F | Sets specified item number to be underlined or not underlined & sets the highlighting style |
| GetMItemFlag | $270F | Returns values for a specified item, such as whether it is disabled, underlined or highlighted |
| SetMItemBlink | $280F | Determines how many times all menu items should blink when selected |
| MenuNewRes | $290F | Adjusts screen resolution and redraws the current system menu bar |
| DrawMenuBar | $2A0F | Draws the current menu bar, along with any menu titles on the bar |
| MenuSelect | $2B0F | Draws highlighted titles, pulls down menus, and handles user interaction when a mouse button is clicked on a menu bar (see FindWindow routine if using Window Manager). |
| HiliteMenu | $2C0F | Highlights or unhighlights the title of a specified menu |
| NewMenu | $2D0F | Allocates space for a menu list and its items |
| DisposeMenu | $2E0F | Frees the memory allocated by NewMenu |
| InitPalette | $2F0F | Reinitializes the palettes needed for the colored Apple logo in system menu bar (changes SCB for lines 2 through 9 to the first color from color tables 1 through 6) |
| EnableMItem | $300F | Sets a specified menu item to display normally and allows it to be selected |
| DisableMItem | $310F | Sets specified menu item to display in dimmed characters & does not allow it to be selected |
| CheckMItem | $320F | Sets specified menu item to display or to not display a check mark to the left of the item |
| SetMItemMark | $330F | Sets a specified menu item to display or to not display a specified character to the left of item |
| GetMItemMark | $340F | Returns the current character that is displayed to the left of a specified menu item |
| SetMItemStyle | $350F | Sets the text style for a specified menu item |
| GetMItemStyle | $360F | Returns the text style for a specified menu item |
| SetMenuID | $370F | Specifies a new menu number |
| SetMItemID | $380F | Specifies the ID number of a menu item |
| SetMenuBar | $390F | Sets the current menu bar |
| SetMItemName | $3A0F | Specifies the aname of a menu item by pointing to a Pascal-type string |
| GetPopUpDefProc | $3B0F | Returns a pointer to the control definition procedure for pop-up menus (called during Control Manager startup) - application should not call |
| PopUpMenuSelect | $3C0F | Draws highlighted titles and handles user interaction when the user clicks on a pop-up menu |
| NewMenu2 | $3E0F | Allocates space for a menu list and its items |
| InsertMItem2 | $3F0F | Inserts an item into a menu after a specified menu item or at the top of the menu |
| SetMenuTitle2 | $400F | Specifies the title of a menu |
| SetMItem2 | $410F | Specifies the title of a menu item |
| SetMItemName2 | $420F | Specifies the name of a menu item |
| NewMenuBar2 | $430F | Creates a menu bar using a menu bar template as its input specification |
| GetResMTitle | $440F | Returns pointer to the menu title (undocumented?) |
| HideMenuBar | $450F | Hides the system menu bar by adding the menu bar to the desktop region |
| ShowMenuBar | $460F | Reveals the system menu bar by subtracting the menu bar from the desktop region, setting visible, and updating SCBs |
| SetMItemIcon | $470F | Set the ItemIconRef field in the itemStruct record for the menu item indicated |
| GetMItemIcon | $480F | Returns the reference to the icon associated with menu item indicated |
| SetMItemStruct | $490F | Sets the ItemTitleRef field of the item record to the reference for the itemStruct record passed |
| GetMItemStruct | $4A0F | Returns the reference to the itemStruct record of the menu item specified |
| RemoveMItemStruct | $4B0F | Removes the itemStruct record from the item record |
| GetMItemFlag2 | $4C0F | Returns the itemFlag2 field for the itemStruct record associated with the menu item indicated |
| SetMItemFlag2 | $4D0F | Sets the itemFlag2 field for the itemStruct record of the indicated menu item to the value passed |
| GetMItemWidth | $4E0F | Computes the default size of a specified menu item (undocumented?) |
| GetMItemBlink | $4F0F | GetMItemBlink returns the current menu item blink setting, as set with SetMItemBlink |
| InsertPathMItem | $500F | Takes a GS/OS pathname and inserts one menu item into the specified menu for each segment of the pathname |
Initializes the Menu Manager; called only by Tool Locator - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Menu Manager for use by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — ID assigned to the application | |
| dPageAddr | Word — Bank $0 starting address for one page of direct-page space | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MenuStartUp(userID,dPageAddr)
Shuts down the Menu Manager when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void MenuShutDown()
Returns the version number of the Menu Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of Menu Manager | |
| ← | SP |
None
extern pascal Word MenuVersion()
Resets the Menu Manager; called only when system reset - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the Menu Manager is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Menu Manager is active; FALSE if not | |
| ← | SP |
None
extern pascal Boolean MenuStatus()
Maps a character to the associated menu and item for that character
| Stack before call | ||
|---|---|---|
| previous contents | ||
| taskRecPtr | Long — POINTER to a task record containing character to check | |
| barHandle | Long — HANDLE to menu bar, or 0 for system menu bar | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MenuKey(taskRecPtr,barHandle)
Returns the handle of the current menu bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| barHandle | Long — HANDLE to current menu bar | |
| ← | SP |
None
extern pascal CtlRecHndl GetMenuBar()
Attempts to refresh the screen.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| redrawRoutinePtr | Long — POINTER to redraw routine in the application | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MenuRefresh(redrawRoutinPtr)
Flashes the entire current menu bar
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void FlashMenuBar()
Inserts a specified menu into the menu list after a specified menu item or at front of list
| Stack before call | ||
|---|---|---|
| previous contents | ||
| addMenuHandle | Long — HANDLE to menu to insert | |
| insertAfter | Word — Menu is inserted after this menu; if 0, menu inserted at front | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InsertMenu(addMenuHandle,insertAfter)
Removes a specified menu from the menu list
| Stack before call | ||
|---|---|---|
| previous contents | ||
| menuNum | Word — ID of menu to be deleted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DeleteMenu(menuNum)
Inserts a menu item into a menu after a specified menu item or at the front of the list
| Stack before call | ||
|---|---|---|
| previous contents | ||
| addItemPtr | Long — POINTER to item to insert | |
| insertAfter | Word — Item after which item is inserted; 0 to add to front, $FFFF at end | |
| menuNum | Word — Menu ID of menu to contain new item, 0 for first menu | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InsertMItem(additemPtr,insertAfter,menuNum)
Removes a specified item from the current menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| itemNum | Word — Item ID of item to be deleted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DeleteMItem(itemNum)
Returns the handle of the current system menu bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| barHandle | Long — HANDLE to current system bar | |
| ← | SP |
None
extern pascal CtlRecHndl GetSysBar()
Sets a new system bar; the system menu bar becomes the current menu bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| barHandle | Long — HANDLE to new system bar | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetSysBar(barHandle)
Computes standard sizes for the menu bar and menus
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuHght | Word — Height of the menu bar | |
| ← | SP |
None
extern pascal Word FixMenuBar()
Returns the number of items, including any dividing lines, in a specified menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| menuNum | Word — Menu ID of menu whose items will be counted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| numberItems | Word — Number of items in the menu | |
| ← | SP |
None
extern pascal Word CountMItems(menuNum)
Creates a default menu bar with no menus
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window's GrafPort; NIL if system | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| barHandle | Long — HANDLE to menu bar | |
| ← | SP |
None
extern pascal CtlRecHndl NewMenuBar(theWindowPtr)
Returns a handle to a menu record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| menuNum | Word — Menu whose handle will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuHandle | Long — HANDLE to specified menu; 0 if menu not found | |
| ← | SP |
None
extern pascal CtlRecHndl GetMHandle(menuNum)
Sets the normal, inverse, and outline colors of the current menu bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newBarColor | Word — Normal color (see Toolbox Ref Vol1, Table 13-11) | |
| newInvertColor | Word — Selected color (see Toolbox Ref Vol1, Table 13-11) | |
| newOutColor | Word — Outline color (see Toolbox Ref Vol1, Table 13-11) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetBarColors(newBarcolor,newInvertColor,newOutColor)
Returns the colors for the current menu bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuBarColor | Long — Current menu bar colors (see Toolbox Ref Vol1, Table 13-10) | |
| ← | SP |
None
extern pascal LongWord GetBarColors()
Sets the starting position for the leftmost title within the current menu bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| xStart | Word — Starting position of first title from left in pixels (0-127) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMTitleStart(xStart)
Returns the starting position of the leftmost title within the current menu bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| xStart | Word — Starting position of first title in number of pixels from left | |
| ← | SP |
None
extern pascal Word GetMTitleStart()
Returns a pointer to the Menu Manager's port
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuMgrPtr | Long — POINTER to Menu Manager port | |
| ← | SP |
None
extern pascal GrafPortPtr GetMenuMgrPort()
Sets menu dimensions, either manually or automatically
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newWidth | Word — Menu width in pixels, or 0 for automatic calculation | |
| newHeight | Word — Menu height in pixels, or 0 for automatic calculation | |
| menuNum | Word — ID number of the menu whose width and height will be calculated | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CalcMenuSize(newWidth,newHeight,menuNum)
Sets the width of a title
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newWidth | Word — Width of title in pixels | |
| menuNum | Word — Number of menu whose width will be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMTitleWidth(newWidth,menuNum)
Returns the width of a menu title
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| menuNum | Word — Number of menu whose title width will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| currentWidth | Word — Width of the title in pixels | |
| ← | SP |
None
extern pascal Word GetMTitleWidth(menuNum)
Sets the menu to a specified state
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newValue | Word — New bit value to set (see Toolbox Ref Vol1, Table 13-8) | |
| menuNum | Word — Number of menu whose state will be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMenuFlag(newValue,menuNum)
Returns the menu flag for a specified menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| menuNum | Word — Number of menu whose state will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuState | Word — Current state of menu bar ctlFlag | |
| ← | SP |
None
extern pascal Word GetMenuFlag(menuNum)
Specifies the title for a menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newStrPtr | Long — POINTER to string to become new title | |
| menuNum | Word — Number of menu whose title will be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMenuTitle(newStrPtr,menuNum)
Returns a pointer to the title of a menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| menuNum | Word — Number of menu whose title pointer will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuTitlePtr | Long — POINTER to the title of the menu | |
| ← | SP |
None
extern pascal Pointer GetMenuTitle(menuNum)
Turns menu help on/off or returns state of menu help; help user know inactive to active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| menuGlobalMask | Word — Global mask (see Toolbox Ref Vol1, Table 13-6) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuGlobalFlag | Word — Current state of menu global flag (see Toolbox Ref Vol1, Table 13-7) | |
| ← | SP |
None
extern pascal Word MenuGlobal(menuGlobalMask)
Specifies the name for a menu item by pointing to an item line
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newItemLinePtr | Long — POINTER to an item line | |
| itemNum | Word — Number of item whose name will be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItem(newItemLinePtr,itemNum)
Returns a pointer to the name of an item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| itemNum | Word — Number of item whose name pointer will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| itemNamePtr | Long — POINTER to the name of the item | |
| ← | SP |
None
extern pascal Pointer GetMItem(itemNum)
Sets specified item number to be underlined or not underlined & sets the highlighting style
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newValue | Word — New bits to set (see Toolbox Ref Vol1, Table 13-9) | |
| itemNum | Word — Number of item whose text style will be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItemFlag(newValue,itemNum)
Returns values for a specified item, such as whether it is disabled, underlined or highlighted
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| itemNum | Word — Number of item whose flag will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| itemFlag | Word — Values for flag (see Toolbox Ref Vol1, Table 13-9 in the section "SetMitemFlag") | |
| ← | SP |
None
extern pascal Word GetMItemFlag(itemNum)
Determines how many times all menu items should blink when selected
| Stack before call | ||
|---|---|---|
| previous contents | ||
| count | Word — Number of times any item should blink when selected | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItemBlink(count)
Adjusts screen resolution and redraws the current system menu bar
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void MenuNewRes()
Draws the current menu bar, along with any menu titles on the bar
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void DrawMenuBar()
Draws highlighted titles, pulls down menus, and handles user interaction when a mouse button is clicked on a menu bar (see FindWindow routine if using Window Manager).
| Stack before call | ||
|---|---|---|
| previous contents | ||
| taskRecPtr | Long — POINTER to a task record containing button-down point | |
| barHandle | Long — HANDLE to menu bar; 0 for system menu bar | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MenuSelect(taskRecPtr,barHandle)
Highlights or unhighlights the title of a specified menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| hiliteFlag | Word — BOOLEAN; FALSE to draw normally, TRUE to highlight title | |
| menuNum | Word — ID of menu | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void HiliteMenu(hiliteFlag,menuNum)
Allocates space for a menu list and its items
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| menuStringPtr | Long — POINTER to an array of menu lines and item lines | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuHandle | Long — HANDLE to menu; 0 if error | |
| ← | SP |
None
extern pascal CtlRecHndl NewMenu(menuStringPtr)
Frees the memory allocated by NewMenu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| menuHandle | Long — HANDLE to menu list to be discarded | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DisposeMenu(menuHandle)
Reinitializes the palettes needed for the colored Apple logo in system menu bar (changes SCB for lines 2 through 9 to the first color from color tables 1 through 6)
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void InitPalette()
Sets a specified menu item to display normally and allows it to be selected
| Stack before call | ||
|---|---|---|
| previous contents | ||
| itemNum | Word — Number of item to be enabled | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void EnableMItem(itemNum)
Sets specified menu item to display in dimmed characters & does not allow it to be selected
| Stack before call | ||
|---|---|---|
| previous contents | ||
| itemNum | Word — Number of item to be disabled | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DisableMItem(itemNum)
Sets specified menu item to display or to not display a check mark to the left of the item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| checkedFlag | Word — BOOLEAN; TRUE to check item; FALSE to uncheck item | |
| itemNum | Word — Number of item to be checked or unchecked | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CheckMItem(checkedFlag,itemNum)
Sets a specified menu item to display or to not display a specified character to the left of item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| mark | Word — Character to mark item with or 0 for no mark | |
| itemNum | Word — Number of item to be marked or unmarked | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItemMark(mark,itemNum)
Returns the current character that is displayed to the left of a specified menu item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| itemNum | Word — Number of item to be marked or unmarked | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| mark | Word — Character marking item; 0 if no mark | |
| ← | SP |
None
extern pascal Word GetMItemMark(itemNum)
Sets the text style for a specified menu item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| textStyle | Word — Text style (see Toolbox Ref Vol1, Figure 13-12) | |
| itemNum | Word — Number of item whose text style will be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItemStyle(textStyle,itemNum)
Returns the text style for a specified menu item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| itemNum | Word — Number of item whose text style will be returned | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| mark | Word — Text style (see Toolbox Ref Vol1, Figure 13-12 section "SetMItemStyle") | |
| ← | SP |
None
extern pascal TextStyle GetMItemStyle(itemNum)
Specifies a new menu number
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newMenuNum | Word — New menu number for the menu | |
| curMenuNum | Word — Current menu number whose ID will be changed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMenuID(newMenuNum,curMenuNum)
Specifies the ID number of a menu item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newItemNum | Word — New ID number to be assigned to the item | |
| curItemNum | Word — Current item whose ID will be changed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItemID(newItemNum,curItemNum)
Sets the current menu bar
| Stack before call | ||
|---|---|---|
| previous contents | ||
| barHandle | Long — HANDLE to new current bar; 0 for system menu bar | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMenuBar(barHandle)
Specifies the aname of a menu item by pointing to a Pascal-type string
| Stack before call | ||
|---|---|---|
| previous contents | ||
| strPtr | Long — POINTER to a Pascal-type string (length in first byte) | |
| itemNum | Word — Number of item whose name will be set | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItemName(strPtr,itemNum)
Returns a pointer to the control definition procedure for pop-up menus (called during Control Manager startup) - application should not call
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| defProcPtr | Long — Pointer to control procedure | |
| ← | SP |
None
extern pascal Pointer GetPopUpDefProc()
Draws highlighted titles and handles user interaction when the user clicks on a pop-up menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| selection | Word — Item ID of current menu selection | |
| currentLeft | Word — Global coordinate value of left edge of pop-up menu | |
| currentTop | Word — Global coordinate value of top of current selection | |
| flag | Word — Flag word for call | |
| menuHandle | Long — Menu Handle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| itemID | Word — Item ID of new selection (0 if none) | |
| ← | SP |
None
extern pascal Word PopUpMenuSelect(selection,currentLeft,currentTop,flag,menuHandle)
Allocates space for a menu list and its items
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| refDesc | Word — Defines type of reference in menuTRef | |
| menuTRef | Long — Reference to menu template | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuHandle | Long — HANDLE for new menu | |
| ← | SP |
None
extern pascal Long NewMenu2(refDesc,menuTRef)
Inserts an item into a menu after a specified menu item or at the top of the menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| refDesc | Word — Defines type of reference in menuItemTRef | |
| menuItemTRef | Long — Reference to menu item template | |
| insertAfter | Word — ID of item after which to insert this item | |
| menuNum | Word — ID of menu after which to insert this item | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InsertMItem2(refDesc,menuItemTRef,insertAfter,menuNum)
Specifies the title of a menu
| Stack before call | ||
|---|---|---|
| previous contents | ||
| refDesc | Word — Defines type of reference in titleRef | |
| titleRef | Long — Reference to title string of menu | |
| menuNum | Word — ID of menu to receive title | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMenuTitle2(refDesc,titleRef,menuNum)
Specifies the title of a menu item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| refDesc | Word — Defines type of reference in menuItemTRef | |
| menuItemTRef | Long — Reference to menu item template | |
| menuItemID | Word — ID of item to be changed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItem2(refDesc,menuItemTRef,menuItemID)
Specifies the name of a menu item
| Stack before call | ||
|---|---|---|
| previous contents | ||
| refDesc | Word — Defines type of reference in titleRef | |
| titleRef | Long — Reference to menu item title | |
| menuItemID | Word — ID of item to be changed | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItemName2(refDesc,titleRef,menuItemID)
Creates a menu bar using a menu bar template as its input specification
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| refDesc | Word — Defines type of reference in menuBarTRef | |
| menuBarTRef | Long — Reference to menu bar template | |
| windowPtr | Long — POINTER to window's GrafPort; NIL if system menu bar | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| menuBarHandle | Long — HANDLE for new menu bar | |
| ← | SP |
None
extern pascal Long NewMenuBar2(refDesc,menuBarTRef,windowPtr)
Returns pointer to the menu title (undocumented?)
Hides the system menu bar by adding the menu bar to the desktop region
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void HideMenuBar()
Reveals the system menu bar by subtracting the menu bar from the desktop region, setting visible, and updating SCBs
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void ShowMenuBar()
Set the ItemIconRef field in the itemStruct record for the menu item indicated
| Stack before call | ||
|---|---|---|
| previous contents | ||
| iconDesc | Word — Describes how icon is to be referenced | |
| iconRef | Long — Reference to icon | |
| itemID | Word — ID of menu item | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0F03 menuNoStruct Returned if bit 10 of itemFlag is not set
extern pascal void SetMItemIcon(iconDesc,iconRef,itemID)
Returns the reference to the icon associated with menu item indicated
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| itemID | Word — ID of menu item | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| iconRef | Long — Reference to icon | |
| ← | SP |
None
extern pascal Ref GetMItemIcon(itemID)
Sets the ItemTitleRef field of the item record to the reference for the itemStruct record passed
| Stack before call | ||
|---|---|---|
| previous contents | ||
| itemStructDesc | Word — Describes how itemStruct is to be referenced | |
| itemStructRef | Long — Reference to itemStruct | |
| itemID | Word — ID of menu item | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetMItemStruct(itemStructDesc,itemStructRef,itemID)
Returns the reference to the itemStruct record of the menu item specified
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| itemID | Word — ID of menu item | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| itemStructRef | Long — Reference to itemStruct | |
| ← | SP |
None
extern pascal Ref GetMItemStruct(itemID)
Removes the itemStruct record from the item record
| Stack before call | ||
|---|---|---|
| previous contents | ||
| itemID | Word — ID of menu item | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void RemoveMItemStruct(itemID)
Returns the itemFlag2 field for the itemStruct record associated with the menu item indicated
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| itemID | Word — ID of menu item | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| itemFlag | Word — itemFlag2 field from itemStruct | |
| ← | SP |
$0F03 menuNoStruct Returned if bit 10 of itemFlag is not set
extern pascal Word GetMItemFlag2(itemID)
Sets the itemFlag2 field for the itemStruct record of the indicated menu item to the value passed
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newValue | Word — New value for itemFlag2 | |
| itemID | Word — ID of menu item | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0F03 menuNoStruct Returned if bit 10 of itemFlag is not set
extern pascal void SetMItemFlag2(newValue,itemID)
Computes the default size of a specified menu item (undocumented?)
GetMItemBlink returns the current menu item blink setting, as set with SetMItemBlink
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| count | Word — Menu item blink setting | |
| ← | SP |
None
extern pascal Word GetMItemBlink()
Takes a GS/OS pathname and inserts one menu item into the specified menu for each segment of the pathname
| Stack before call | ||
|---|---|---|
| previous contents | ||
| flags | Word — Flags | |
| pathPtr | Long — POINTER to GS/OS input filename | |
| deviceNum | Word — Device number the path is on, if known | |
| menuID | Word — Menu ID of the menu to insert into | |
| afterID | Word — Menu item ID of the item to insert after | |
| startingID | Word — Menu item ID to use for the first item inserted | |
| resultPtr | Long — POINTER to the result buffer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal void InsertPathMItems(flags,pathPtr,deviceNum,menuID,afterID,startingID,resultPtr)
| Control Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| CtlBootInit | $0110 | Initializes the Control Manager; called only by Tool Locator (not application) |
| CtlStartUp | $0210 | Starts up the Control Manager for use by an application |
| CtlShutDown | $0310 | Shuts down the Control Manager |
| CtlVersion | $0410 | Returns the version number of the Control Manager |
| CtlReset | $0510 | Resets the Control Manager; called only on reset (not by application) |
| CtlStatus | $0610 | Indicates whether the Control Manager is active |
| NewControl | $0910 | Creates a control, adds it to beginning of specified window's control list, and returns handle to new control |
| DisposeControl | $0A10 | Deletes a specified control from its window's control list, releases its memory and any associated data structures. |
| KillControls | $0B10 | Disposes of all controls associated with a specified window |
| SetCtlTitle | $0C10 | Sets a specified control's title to a given string and redraws the control |
| GetCtlTitle | $0D10 | Returns value in specified control's ctlData field, so scrollbars = view and data size, for ctrls w/titles = ptr to title str, or custom. |
| HideControl | $0E10 | Makes a specified control invisible by filling the region the control occupies with the background pattern of the window's GrafPort. |
| ShowControl | $0F10 | Makes a specified control visible |
| DrawControls | $1010 | Draws all controls currently visible in a specified window |
| HiliteControl | $1110 | Changes the way a specified control is highlighted |
| CtlNewRes | $1210 | Reinitializes resolution and mode. Call after you have changed the video modes. |
| FindControl | $1310 | Reports which of window's controls, if any, the cursor was in when user pressed mouse button. |
| TestControl | $1410 | Tests which part of a specified control contains a specified point (if specified control is visible and active) |
| TrackControl | $1510 | Follows mouse movements and responds appropriately until mouse button is released |
| MoveControl | $1610 | Moves a specified control to a new location within its window |
| DragControl | $1710 | Pulls dotted outln of ctrl around screen, following mvments of mouse till button released |
| SetCtlIcons | $1810 | Replaces current icon font with a specified new font and returns the handle of the old font, or just returns the handle of the old font. |
| SetCtlValue | $1910 | Sets specified control's ctlValue field to a specified value & redraws control to reflect new setting |
| GetCtlValue | $1A10 | Returns a specified control's current ctlValue field |
| SetCtlParams | $1B10 | Sets new params in controls's definition procedure, which will set values & redraw control if necessary |
| GetCtlParams | $1C10 | Returns a specified control's additional parameters |
| DragRect | $1D10 | Pulls a dotted outline of a specified rectangle around the screen, following the mouse movements until the mouse button is released |
| GrowSize | $1E10 | Returns the height & width of size box control, using Control Manager's current icon font |
| GetCtlDPage | $1F10 | Returns the value of the Control Manager's direct page |
| SetCtlAction | $2010 | Sets a specified control's ctrlAction field to a new action |
| GetCtlAction | $2110 | Returns the current value of a specified control's ctlAction field |
| SetCtlRefCon | $2210 | Sets a specified control's ctlRefCon field to a new value |
| GetCtlRefCon | $2310 | Returns the current value of a specified control's ctlRefCon field |
| EraseControl | $2410 | Makes specified control invisible but doesn't add control's enclosing rectangle to window update region |
| DrawOneCtl | $2510 | Draws a specified control |
| FindTargetCtl | $2610 | Returns the handle of the target control within the control list for the active window |
| MakeNextCtlTarget | $2710 | Makes the next eligible control the target control |
| MakeThisCtlTarget | $2810 | Makes the specified control the target |
| SendEventToCtl | $2910 | Passes a specified extended task record to the appropriate control or controls |
| GetCtlID | $2A10 | Returns the ctlID field from the control record of a specified control |
| SetCtlID | $2B10 | Sets the ctlID field in the control record of a specified control |
| CallCtlDefProc | $2C10 | Calls a control's definition procedure with the specified inputs |
| NotifyCtls | $2D10 | Calls control definition procedures for extended controls in a specified window, sending a control message and parameter. |
| GetCtlMoreFlags | $2E10 | Gets the contents of the ctlMoreFlags field of the control record for a specified control |
| SetCtlMoreFlags | $2F10 | Sets the contents of the ctlMoreFlags field of the control record for a specified control |
| GetCtlHandleFromID | $3010 | Retrieves the control handle to the control record with a specified ctlID field value |
| NewControl2 | $3110 | Creates one or more new controls. |
| CMLoadResource | $3210 | This is an entry point to the internal Control Manager routine that loads resources. |
| CMReleaseResource | $3310 | This is an entry point to the internal Control Manager routine that releases resources |
| SetCtlParamPtr | $3410 | Sets the pointer to the current text substitution array for the Control Manager. |
| GetCtlParamPtr | $3510 | Retrieves the pointer to the current text substitution array for the Control Manager |
| FutzCtls | $3610 | Invalidates bound rects of a window's normal controls and tells other controls that window state has change (undocumented?) |
| InvalCtls | $3710 | Invalidates all rectangles for all controls in a specified window |
| CMUnloadSegment | $3810 | Unloads any dynamic segments that have been loaded in the course of using the tool (undocumented?) |
| FindRadioButton | $3910 | Returns a value indicating which radio button is selected in a given family |
| SetLETextByID | $3A10 | Sets the text of an Edit Line control to a string supplied by the caller |
| GetLETextByID | $3B10 | Returns the text of an Edit Line control into a buffer supplied by the caller |
| SetCtlValueByD | $3C10 | Sets the value of the control that has the specified control ID in the specified window |
| GetCtlValueByID | $3D10 | Returns the current value of the control that has the specified control ID in the specified window |
| InvalOneCtlByID | $3E10 | Invalidates a control's rectangle, just as if you called InvalRect on the control's rectangle |
| HiliteCtlByID | $3F10 | Changes the way a specified control is highlighted, just as if you called HiliteControl |
Initializes the Control Manager; called only by Tool Locator (not application)
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up the Control Manager for use by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — ID assigned to the application | |
| dPageAddr | Word — Bank $0 starting address for one page of direct-page space | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1001 wmNotStartedUp The Window Manager is not initialized
extern pascal void CtlStartUp(userID,dPageAddr)
Shuts down the Control Manager
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void CtlShutDown()
Returns the version number of the Control Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Control Manager | |
| ← | SP |
None
extern pascal Word CtlVersion()
Resets the Control Manager; called only on reset (not by application)
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the Control Manager is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Control Manager is active, FALSE if not | |
| ← | SP |
None
extern pascal Boolean CtlStatus()
Creates a control, adds it to beginning of specified window's control list, and returns handle to new control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theWindowPtr | Long — POINTER to window owner | |
| boundsRectPtr | Long — POINTER to RECT data structure defining enclosing rectangle | |
| titlePtr | Long — POINTER to title string (ctlData) | |
| flag | Word — Bit flag (see Toolbox Ref Vol1, Figure 4-26) | |
| value | Word — Control's starting value | |
| param1 | Word — Additional parameter (view size for scroll bars) | |
| param2 | Word — Additional parameter (data size for scroll bars) | |
| defProcPtr | Long — POINTER to definition procedure, or standard control value | |
| refCon | Long — Reserved for application use | |
| colorTablePtr | Long — POINTER to control's color table; NIL for default color table | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theControlHandle | Long — HANDLE to control; NIL = error | |
| ← | SP |
None
extern pascal CtlRecHndl NewControl(theWindowPtr,boundsRectPtr,titlePtr,flag,value,paraml,param2,defProcPtr,refCon,colorTablePtr
Deletes a specified control from its window's control list, releases its memory and any associated data structures.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DisposeControl(theControlHandle)
Disposes of all controls associated with a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — POINTER to window whose controls are to be disposed of | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void KillControls(theWindowPtr)
Sets a specified control's title to a given string and redraws the control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| titlePtr | Long — POINTER to control's ctlData field | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetCtlTitle(titlePtr,theControlHandle)
Returns value in specified control's ctlData field, so scrollbars = view and data size, for ctrls w/titles = ptr to title str, or custom.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlTitlePtr | Long — POINTER to control's ctlData field | |
| ← | SP |
None
extern pascal Pointer GetCtlTitle(theControlHandle)
Makes a specified control invisible by filling the region the control occupies with the background pattern of the window's GrafPort.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theControlHandle | Long — HANDLE to control to be hidden | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void HideControl(theControlHandle)
Makes a specified control visible
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theControlHandle | Long — HANDLE to control to be hidden | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void ShowControl(theControlHandle)
Draws all controls currently visible in a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theWindowPtr | Long — HANDLE to window whose controls are to be drawn | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DrawControls(theWindowPtr)
Changes the way a specified control is highlighted
| Stack before call | ||
|---|---|---|
| previous contents | ||
| hiliteState | Word — Type of highlighting: 0 = none, 1-253 = part code, 255 = inactive | |
| theControlHandle | Long — HANDLE to control to be highlighted | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void HiliteControl(hiliteState,theControlHandle)
Reinitializes resolution and mode. Call after you have changed the video modes.
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void CtlNewRes()
Reports which of window's controls, if any, the cursor was in when user pressed mouse button.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| foundCtlPtr | Long — POINTER to address where handle of found control will be stored | |
| pointX | Word — X coordinate to check, in global coordinates | |
| pointY | Word — Y coordinate to check, in global coordinates | |
| theWindowPtr | Long — POINTER to window to check | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| foundPart | Word — Part code of found part of control | |
| ← | SP |
None
extern pascal Word FindControl(foundCtlPtr,pointX,pointY,theWindowPtr)
Tests which part of a specified control contains a specified point (if specified control is visible and active)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| pointX | Word — X coordinate to check, in global coordinates | |
| pointY | Word — Y coordinate to check, in global coordinates | |
| theControlHandle | Long — HANDLE of control to be tested | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| partCode | Word — Part code of the POINT; 0 if not in visible, active control | |
| ← | SP |
None
extern pascal Word TestControl(pointX,pointY,theControlHandle)
Follows mouse movements and responds appropriately until mouse button is released
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| startX | Word — X coordinate, in global coordinates, of starting point | |
| startY | Word — Y coordinate, in global coordinates, of starting point | |
| actionProcPtr | Long — POINTER to routine; NIL, or negative (see Toolbox Ref Vol1 Chapter4 -"Additional Actions and the Action Procedure") | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| partCode | Word — Selected part when button was released | |
| ← | SP |
None
extern pascal Word TrackControl(startX,startY,actionProcPtr,theControlHandle)
Moves a specified control to a new location within its window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newX | Word — New X origin ofcontrol, in local coordinates | |
| newY | Word — New Y origin ofcontrol, in local coordinates | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void MoveControl(newX,newY,theControlHandle)
Pulls dotted outln of ctrl around screen, following mvments of mouse till button released
| Stack before call | ||
|---|---|---|
| previous contents | ||
| startX | Word — X coordinate of starting point in local coordinates | |
| startY | Word — Y coordinate of starting point in local coordinates | |
| limitRectPtr | Long — POINTER to bounds RECT data structure | |
| slopRectPtr | Long — POINTER to slop RECT data structure | |
| axis | Word — Movement constraint: 0=none, 1=horizontal, 2=vertical | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DragControl(startX,startY,limitRectPtr,slopRectPtr,axis,theControlHandle)
Replaces current icon font with a specified new font and returns the handle of the old font, or just returns the handle of the old font.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| newFontHandle | Long — HANDLE to new icon font; negative value to not set new font | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| oldFontHandle | Long — HANDLE to old icon font | |
| ← | SP |
None
extern pascal FontHndl SetCtlIcons(newFontHandle)
Sets specified control's ctlValue field to a specified value & redraws control to reflect new setting
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newValue | Word — New value for control | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetCtlValue(newValue,theControlHandle)
Returns a specified control's current ctlValue field
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| curValue | Word — Control's current value | |
| ← | SP |
None
extern pascal Word GetCtlValue(theControlHandle)
Sets new params in controls's definition procedure, which will set values & redraw control if necessary
| Stack before call | ||
|---|---|---|
| previous contents | ||
| param2 | Word — Additional control parameter; defined by control | |
| param1 | Word — Additional control parameter; defined by control | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal Word SetCtlParams(param2,param1,theControlHandle)
Returns a specified control's additional parameters
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| param1 | Word — Additional control parameter; defined by control | |
| param2 | Word — Additional control parameter; defined by control | |
| ← | SP |
None
extern pascal LongWord GetCtlParams(theControlHandle)
Pulls a dotted outline of a specified rectangle around the screen, following the mouse movements until the mouse button is released
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| actionProcPtr | Long — POINTER to routine; NIL for default | |
| dragPatternPtr | Long — POINTER to pattern to use for drag outline | |
| startX | Word — X coordinate of starting point in local coordinates | |
| startY | Word — Y coordinate of starting point in local coordinates | |
| dragRectPtr | Long — POINTER to RECT data structure of rectangle to be dragged | |
| limitRectPtr | Long — POINTER to bounds RECT data structure | |
| slopRectPtr | Long — POINTER to slop RECT data structure | |
| dragFlag | Word — Bit flag that customizes DragRect (see Toolbox Ref Vol1 Figure 4-25) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| moveDelta | Long — High word = amount X changed, low word = amount Y changed | |
| ← | SP |
$1001 wmNotStartedUp The Window Manager is not initialized
extern pascal Longword DragRect(actionProcPtr,dragPatternPtr,startX,startY,dragRectPtr,limitRectPtr,slopRectPtr,dragFlag)
Returns the height & width of size box control, using Control Manager's current icon font
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| sizeOfGrow | Long — High-order word is width, low-order word is height | |
| ← | SP |
None
extern pascal Longword GrowSize()
Returns the value of the Control Manager's direct page
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlDPage | Word — Bank $0 starting address of Control Manager's direct page | |
| ← | SP |
None
extern pascal Word GetCtlDPage()
Sets a specified control's ctrlAction field to a new action
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newActionPtr | Long — POINTER to custom control action procedure | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetCtlAction(newActionPtr,theControlHandle)
Returns the current value of a specified control's ctlAction field
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlActionValue | Long — Value in control's ctlActton field | |
| ← | SP |
None
extern pascal LongProcPtr GetCtlAction(theControlHandle)
Sets a specified control's ctlRefCon field to a new value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newRefCon | Long — Value to store in the control's ctlRefCon field | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetCtlRefCon(newRefCon,theControlHandle)
Returns the current value of a specified control's ctlRefCon field
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| theControlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlRefConValue | Long — Value in control's ctlRefCon field | |
| ← | SP |
None
extern pascal Longword GetCtlRefCon(theControlHandle)
Makes specified control invisible but doesn't add control's enclosing rectangle to window update region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theControlHandle | Long — HANDLE to control to be erased | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void EraseControl(theControlHandle)
Draws a specified control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| theControlHandle | Long — HANDLE to control to be drawn | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void DrawOneCtl(theControlHandle)
Returns the handle of the target control within the control list for the active window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlHandle | Long — Handle of target control; undefined if none or error | |
| ← | SP |
$1004 noCtlError No controls in the window
$1005 noExtendedCtlError No extended controls in the window
$1006 noCtlTargetError No extended control is currently the target control
$100C noFrontWindowError There is no front window
extern pascal Handle FindTargetCtl()
Makes the next eligible control the target control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlHandle | Long — Handle of target control; undefined if error | |
| ← | SP |
$1004 noCtlError No controls in the window
$1005 noExtendedCtlError No extended controls in the window
$100B noCtlToBeTargetError No control could be made the target control
extern pascal Handle MakeNextCtlTarget()
Makes the specified control the target
| Stack before call | ||
|---|---|---|
| previous contents | ||
| ctlToBeTarget | Long — Handle to control to be made the target | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1007 notExtendedCtlError The action is valid only for extended controls
$1008 canNotBeTargetError The specified control cannot be made the target control
extern pascal void MakeThisCtlTarget(ctlToBeTarget)
Passes a specified extended task record to the appropriate control or controls
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| targetOnlyFlag | Word — (Boolean) TRUE = send to target only; FALSE = all controls | |
| ctlWindowPtr | Long — Pointer to window to search; NIL for top window | |
| eTaskRecPtr | Long — Pointer to extended task record for event | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| result | Word — BOOLEAN; TRUE if event accepted; otherwise FALSE | |
| ← | SP |
$1005 noExtendedCtlError No extended controls in the window
$100C noFrontWindowError There is no front window
extern pascal Boolean SendEventToCtl(targetOnlyFlag,ctlWindowPtr,eTaskRecPtr)
Returns the ctlID field from the control record of a specified control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ctlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlID | Long — ctlID for specified control | |
| ← | SP |
$1004 noCtlError No controls in the window
$1007 notExtendedCtlError The action is valid only for extended controls
extern pascal Long GetCtlID(ctlHandle)
Sets the ctlID field in the control record of a specified control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newID | Long — New ctlID value for the control | |
| ctlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1004 noCtlError No controls in the window
$1007 notExtendedCtlError The action is valid only for extended controls
extern pascal void SetCtlID(newID,ctlHandle)
Calls a control's definition procedure with the specified inputs
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ctlHandle | Long — HANDLE of control to be called | |
| ctlMessage | Word — Control message to send to control definition procedure | |
| ctlParam | Long — Parameter to pass to control definition procedure | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| result | Long — Result value from control definition procedure | |
| ← | SP |
None
extern pascal Long CallCtlDefProc(ctlHandle,ctlMessage,ctlParam)
Calls control definition procedures for extended controls in a specified window, sending a control message and parameter.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| mask | Word — Bit mask to be compared with ctlMoreFlags | |
| message | Word — Control message to send to control definition procedures | |
| param | Long — Parameter to pass to control definition procedures | |
| window | Long — GrafPort of window whose control list is to be searched | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void NotifyCtls(mask,message,param,window)
Gets the contents of the ctlMoreFlags field of the control record for a specified control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ctlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlMoreFlags | Word — ctlMoreFlags for specified control | |
| ← | SP |
$1004 noCtlError No controls in the window
$1007 notExtendedCtlError The action is valid only for extended controls
extern pascal Word GetCtlMoreFlags(ctlHandle)
Sets the contents of the ctlMoreFlags field of the control record for a specified control
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newMoreFlags | Word — New ctlMoreFlags value for the control | |
| ctlHandle | Long — HANDLE to control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1004 noCtlError No controls in the window
$1007 notExtendedCtlError The action is valid only for extended controls
extern pascal void SetCtlMoreFlags(newMoreFlags,ctlHandle)
Retrieves the control handle to the control record with a specified ctlID field value
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ctlWindowPtr | Long — POINTER to window for control list search; NIL = top window | |
| ctlID | Long — ID value for desired control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlHandle | Long — HANDLE for specified control | |
| ← | SP |
$1004 noCtlError No controls in the window
$1005 noExtendedCtlError No extended controls in the window
$1009 noSuchIDError The specified control ID cannot be found
$100C noFrontWindowError There is no front window
extern pascal Long GetCtlHandleFromID(ctlWindowPtr,ctlID)
Creates one or more new controls.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ownerPtr | Long — POINTER to window for control(s) | |
| inputDesc | Word — Describes contents of inputRef | |
| inputRef | Long — Reference of a type defined by inputDesc | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ctlHandle | Long — Control handle (if single control created) or 0 | |
| ← | SP |
None
extern pascal Handle NewControl2(ownerPtr,inputDesc,inputRef)
This is an entry point to the internal Control Manager routine that loads resources.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| resourceType | Word — Type of resource to load | |
| resourceID | Long — ID of resource to load | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| resourceHandle | Long — Handle of loaded resource | |
| ← | SP |
None
extern pascal Handle CMLoadResource(resourceType,resourceID)
This is an entry point to the internal Control Manager routine that releases resources
| Stack before call | ||
|---|---|---|
| previous contents | ||
| resourceType | Word — Type of resource to load | |
| resourceID | Long — ID of resource to load | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CMReleaseResource(resourceType,resourceID)
Sets the pointer to the current text substitution array for the Control Manager.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| subArrayPtr | Long — New pointer to text substitution array | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SetCtlParamPtr(subArrayPtr)
Retrieves the pointer to the current text substitution array for the Control Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| subArrayPtr | Long — New pointer to text substitution array | |
| ← | SP |
None
extern pascal Pointer GetCtlParamPtr()
Invalidates bound rects of a window's normal controls and tells other controls that window state has change (undocumented?)
The stack is not affected by this call. There are no input or output parameters.
Call must not be made by an application.
Invalidates all rectangles for all controls in a specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| ctlWindowPtr | Long — POINTER to window for operation | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void InvalCtls(ctlWindowPtr)
Unloads any dynamic segments that have been loaded in the course of using the tool (undocumented?)
Returns a value indicating which radio button is selected in a given family
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| windPtr | Long — Window containing the radio buttons | |
| famNum | Word — Family number for the radio buttons to check | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| radioNum | Word — Value indicating selected radio button | |
| ← | SP |
None
extern pascal unsigned int FindRadioButton(windPtr,famNum)
Sets the text of an Edit Line control to a string supplied by the caller
| Stack before call | ||
|---|---|---|
| previous contents | ||
| windPtr | Long — Pointer to the window containing the control | |
| LECtlID | Long — Control ID for the LineEdit control | |
| textPtr | Long — Pointer to Pascal string | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1004 noCtlError No controls in the window
$1005 noExtendedCtlError No extended controls in the window
$1009 noSuchIDError The specified control ID cannot be found
$100C noFrontWindowError There is no front window
extern pascal void SetLETextByID(windPtr,LECtlID,textPtr)
Returns the text of an Edit Line control into a buffer supplied by the caller
| Stack before call | ||
|---|---|---|
| previous contents | ||
| windPtr | Long — Pointer to the window containing the control | |
| LECtlID | Long — Control ID for the LineEdit control | |
| textPtr | Long — POINTER to result buffer | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1004 noCtlError No controls in the window
$1005 noExtendedCtlError No extended controls in the window
$1009 noSuchIDError The specified control ID cannot be found
$100C noFrontWindowError There is no front window
extern pascal void GetLETextByID(windPtr,LECtlID,textPtr)
Sets the value of the control that has the specified control ID in the specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| newValue | Word — New value for control | |
| windPtr | Long — Window containing the control (NIL = front) | |
| ctlID | Long — Control ID of the control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1004 noCtlError No controls in the window
$1005 noExtendedCtlError No extended controls in the window
$1009 noSuchIDError The specified control ID cannot be found
$100C noFrontWindowError There is no front window
extern pascal void SetCtlValueByID(newValue,windPtr,ctlID)
Returns the current value of the control that has the specified control ID in the specified window
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| windPtr | Long — Window containing the control (NIL = front) | |
| ctlID | Long — Control ID of the control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theValue | Word — Current control value | |
| ← | SP |
Control Manager errors Returned unchanged
extern pascal void SetCtlValueByID(newValue,windPtr,ctlID)
Invalidates a control's rectangle, just as if you called InvalRect on the control's rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| windPtr | Long — Window containing the control (NIL = front) | |
| ctlID | Long — Control ID of the control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Control Manager errors Returned unchanged
extern pascal void InvalOneCtlByID(windPtr,ctlID)
Changes the way a specified control is highlighted, just as if you called HiliteControl
| Stack before call | ||
|---|---|---|
| previous contents | ||
| hiliteState | Word — New highlight value | |
| windPtr | Long — Window containing the control (NIL = front) | |
| ctlID | Long — Control ID of the control | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
Control Manager errors Returned unchanged
extern pascal void HiliteCtlByID(hiliteState,windPtr,ctlID)
| System Loader Calls | ||
|---|---|---|
| Routine | # | Description |
| LoaderInit | $0111 | Initializes System Loader Toolset; called only by the Tool Locator - not by application |
| LoaderStartUp | $0211 | Starts up System Loader - This function does nothing - Do not use |
| LoaderShutDown | $0311 | Shuts down System Loader - This function does nothing - Do not use |
| LoaderVersion | $0411 | Returns the version number of System Loader |
| LoaderReset | $0511 | Resets System Loader Toolset - This function does nothing - Do not use |
| LoaderStatus | $0611 | Indicates whether System Loader Toolset is active |
| InitialLoad | $0911 | Called by a controlling program (such as a shell or a switcher) to ask the System Loader to perform an initial load of a program |
| Restart | $0A11 | Asks the System Loader to resurrect a dormant application - one that has been shut down (by the User Shutdown function), but is still in memory. |
| LoadSegNum | $0B11 | Loads a load segment specified by load-file number, seg number, & user ID, into memory |
| UnloadSegNum | $0C11 | Unloads a specific load segment from memory |
| LoadSegName | $0D11 | Loads a named segment (by name) into memory, named by its load file's pathname & segment name) |
| UnloadSeg | $0E11 | Unloads the load segment containing the specified address |
| GetLoadSegInfo | $0F11 | Returns the Memory Segment Table entry corresponding to the specified (by #) load segment |
| GetUserID | $1011 | Returns the User ID associated with the specified pathname. Allows controlling propathname. Allows controlling program to determine whether it can restart an application or must perform an initial load. |
| LGetPathname | $1111 | Returns the pathname associated with the specified User ID. P16 uses this call to se application prefix (1/) for a program that is restarted from memory |
| UserShutdown | $1211 | Closes down an application that has just terminated |
Initializes System Loader Toolset; called only by the Tool Locator - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up System Loader - This function does nothing - Do not use
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Shuts down System Loader - This function does nothing - Do not use
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Returns the version number of System Loader
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of Tool Locator | |
| ← | SP |
None
extern pascal Word LoaderVersion()
Resets System Loader Toolset - This function does nothing - Do not use
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void LoaderReset()
Indicates whether System Loader Toolset is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if System Loader is active, FALSE if not | |
| ← | SP |
None
extern pascal Boolean LoaderStatus()
Called by a controlling program (such as a shell or a switcher) to ask the System Loader to perform an initial load of a program
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| longspace | Long — Space for result | |
| wordspace | Word — Space for result | |
| userID | Word — User ID consisting of TypeID and MainID fields which can also be zero (see documentation) | |
| pathPtr | Long — POINTER to pathname of file to be loaded | |
| specialMemoryFlag | Word — Special memory flag; if TRUE (nonzero), it will not load any static segments into special memory (banks $00 and $01) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| dirPageStackSize | Word — Stack size in the Direct Page | |
| dirPageStackAddr | Word — Stack address in the Direct Page | |
| startingAddress | Long — Address of the loaded file | |
| userID | Word — User ID that was passed in, or created by this call | |
| ← | SP |
$1104 The file is not a load file
$1105 System Loader is busy
$1109 Segment number out of sequence
$110A Illegal load record found
$110B Load segment is foreign
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Asks the System Loader to resurrect a dormant application - one that has been shut down (by the User Shutdown function), but is still in memory.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| longspace | Long — Space for result | |
| wordspace | Word — Space for result | |
| userID | Word — An existing, nonzero User ID must be specified (the Aux ID part is ignored). | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| dirPageStackSize | Word — Stack size in the Direct Page | |
| dirPageStackAddr | Word — Stack address in the Direct Page | |
| startingAddress | Long — Address of the loaded file | |
| userID | Word — User ID that was passed in, or created by this call | |
| ← | SP |
$1101 Entry not found
$1105 System Loader is busy
$1108 User ID error
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Loads a load segment specified by load-file number, seg number, & user ID, into memory
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| userID | Word — Caller's User ID | |
| loadFileNum | Word — The load-file number | |
| loadSegNum | Word — The load-segment number | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| segAddress | Long — Address of the segment | |
| ← | SP |
$1101 Entry not found
$1102 OMF version error
$1104 The file is not a load file
$1105 System Loader is busy
$1107 File version error
$1107 File version error
$1109 Segment number out of sequence
$110A Illegal load record found
$110B Load segment is foreign
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Unloads a specific load segment from memory
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — Caller's User ID | |
| loadFileNum | Word — The load-file number | |
| loadSegNum | Word — The load-segment number | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1101 Entry not found
$1105 System Loader is busy
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Loads a named segment (by name) into memory, named by its load file's pathname & segment name)
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| longspace | Long — Space for result | |
| userID | Word — User ID (if the segment should have a different User ID from the current one) | |
| loadFileName | Long — POINTER to pathname of file to be loaded | |
| loadSegName | Word — POINTER to segment name to be loaded | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| loadSegNum | Word — The load-segment number | |
| loadFileNum | Word — The load-file number | |
| userID | Word — User ID that was passed in, or created by this call | |
| segmentAddress | Long — Address of the loaded segment | |
| ← | SP |
$1101 Entry not found
$1104 The file is not a load file
$1105 System Loader is busy
$1107 File version error
$1109 Segment number out of sequence
$110A Illegal load record found
$110B Load segment is foreign
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Unloads the load segment containing the specified address
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| segAddress | Long — Any address in memory | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| loadSegNum | Word — The load-segment number | |
| loadFileNum | Word — The load-file number | |
| userID | Word — User ID of the found segment | |
| ← | SP |
$1101 Entry not found
$1105 System Loader is busy
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Returns the Memory Segment Table entry corresponding to the specified (by #) load segment
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID | |
| loadFileNum | Word — The load-file number | |
| loadSegNum | Word — The load-segment number | |
| bufferAddress | Long — Address of user buffer for results | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1101 Entry not found
$1105 System Loader is busy
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Returns the User ID associated with the specified pathname. Allows controlling propathname. Allows controlling program to determine whether it can restart an application or must perform an initial load.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| pathPtr | Long — POINTER to pathname | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID | |
| ← | SP |
$1101 Entry not found
$1105 System Loader is busy
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Returns the pathname associated with the specified User ID. P16 uses this call to se application prefix (1/) for a program that is restarted from memory
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| userID | Word — User ID | |
| loadFileNum | Word — The load-file number | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| pathPtr | Long — POINTER to pathname | |
| ← | SP |
$1101 Entry not found
$1105 System Loader is busy
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
Closes down an application that has just terminated
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| userID | Word — User ID | |
| quitFlag | Word — QUIT flag (correspondes to P16 flag word parameter for quit function) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| userID | Word — User ID | |
| ← | SP |
$1105 System Loader is busy
ProDOS 16 errors Returned unchanged
Memory Manager errors Returned unchanged
none
| QuickDraw Aux Calls | ||
|---|---|---|
| Routine | # | Description |
| QDAuxBootInit | $0112 | Initializes QuickDraw II Auxiliary; called only by the Tool Locator - not by application |
| QDAuxStartUp | $0212 | Starts up QuickDraw II Auxiliary for use by an application |
| QDAuxShutDown | $0312 | Shuts down QuickDraw II Auxiliary when an application quits |
| QDAuxVersion | $0412 | Returns the version number of QuickDraw II Auxiliary toolset |
| QDAuxReset | $0512 | Resets QuickDraw II Auxiliary; called only when the system is reset - not by applicaiton |
| QDAuxStatus | $0612 | Indicates whether QuickDraw II Auxiliary is active |
| CopyPixels | $0912 | Copies pixel image from 1 place to another, w/stretch or compress to make source fit dest |
| WaitCursor | $0A12 | Changes the cursor to a predefined cursor that looks like a watch |
| DrawIcon | $0B12 | Draws a specified icon in a specified mode at a specified location & clips to current visible region |
| SpecialRect | $0C12 | Frames and fills a rectangle in a single call, making separate calls to FrameRect and FillRect unnecessary. |
| SeedFill | $0D12 | Generates a mask from a specified source image and pattern by filling outward from a starting point |
| CalcMask | $0E12 | Generates a mask from a specified source image and pattern by filling inward from the boundary rectangle |
| GetSysIcon | $0F12 | Returns small icons representing files, devices, and other miscellaneous icons |
| PixelMap2Rgn | $1012 | Transforms a pixel map into a QuickDraw II region |
| IBeamCursor | $1312 | Sets the QuickDraw II cursor to an I-beam cursor |
| WhooshRect | $1412 | Animates a “zooming” effect from one rectangle to another |
| DrawStringWidth | $1512 | Draws a string in a specified horizontal width on a single line |
| UseColorTable | $1612 | Preserves Scanline Control Bytes (SCBs) and sets them to use a color table you specify |
| RestoreColorTable | $1712 | Undoes the effects of UseColorTable |
| OpenPicture | $B712 | Allocates memory for the recording of drawing commands into a picture definition, and returns picture handle. (see QuickDraw II OpenPicture call $B704) |
| PicComment | $B812 | Inserts a specified comment into the currently open picture. (see QuickDraw II PicComment call $B804) |
| DrawPicture | $BA12 | Takes drawing commands recorded in picture definition, maps them from picture frame into destination rect. (see QuickDraw II DrawPicture call $BA04) |
| KillPicture | $BB12 | Releases all memory occupied by a specifed picture. (see QuickDraw II KillPicture call $BB04) |
Initializes QuickDraw II Auxiliary; called only by the Tool Locator - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Starts up QuickDraw II Auxiliary for use by an application
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void QDAuxStartUp()
Shuts down QuickDraw II Auxiliary when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void QDAuxShutDown()
Returns the version number of QuickDraw II Auxiliary toolset
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the QuickDraw Auxiliary Set | |
| ← | SP |
None
extern pascal Word QDAuxVersion()
Resets QuickDraw II Auxiliary; called only when the system is reset - not by applicaiton
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether QuickDraw II Auxiliary is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if QuickDraw Aux toolset is active, FALSE if not | |
| ← | SP |
None
extern pascal Boolean QDAuxStatus()
Copies pixel image from 1 place to another, w/stretch or compress to make source fit dest
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcLocPtr | Long — POINTER to locInfo record of source rectangle | |
| destLocPtr | Long — POINTER to locInfo record of destination rectangle | |
| srcRect | Long — POINTER to RECT defining source rectangle | |
| destRect | Long — POINTER to RECT defining destination rectangle | |
| xferMode | Word — Pen mode | |
| maskRgn | Long — HANDLE to mask region | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void CopyPixels(srcLocPtr,destLocPtr,srcRect,destRect,xferMode,maskRgn)
Changes the cursor to a predefined cursor that looks like a watch
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void WaitCursor()
Draws a specified icon in a specified mode at a specified location & clips to current visible region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| iconPtr | Long — POINTER to icon record (see Toolbox Ref Vol2 Figure 17-1) | |
| displayMode | Word — HANDLE to mask region (see Toolbox Ref Vol2 Figure 17-2) | |
| xPos | Word — X coordinate of upper left corner of icon | |
| yPos | Word — Y coordinate of upper left corner of icon | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void Drawicon(iconPtr,displayMode,xPos,yPos)
Frames and fills a rectangle in a single call, making separate calls to FrameRect and FillRect unnecessary.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| rectPtr | Long — POINTER to rectangle to draw | |
| frameColor | Word — Color of rectangle frame | |
| fillColor | Word — Color of rectangle interior | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void SpecialRect(rectPtr,frameColor,fillColor)
Generates a mask from a specified source image and pattern by filling outward from a starting point
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcLocInfoPtr | Long — POINTER to source locInfo data record | |
| srcRect | Long — POINTER to source rectangle data record | |
| destLocInfoPtr | Long — POINTER to destination locInfo data record | |
| destRect | Long — POINTER to destination rectangle data record | |
| seedH | Word — Horizontal offset (pixel) to start fill point | |
| seedV | Word — Verical offset (pixel) to start fill point | |
| resMode | Word — Resolution mode | |
| patternPtr | Long — POINTER to fill pattern | |
| leakTblPtr | Long — POINTER to leak-through color table | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0201 memErr Unable to allocate memory
$1211 badRectSize The height or width is negative, the destination rect is not the same size as the source rect, or the source or destination rect is not within its boundary
$1212 destModeError The destMode portion of resMode is invalid
extern pascal void SeedFill(srcLocInfoPtr,srcRect,destLocInfoPtr,destRect,seedH,seedV,resMode,patternPtr,leakTblPtr)
Generates a mask from a specified source image and pattern by filling inward from the boundary rectangle
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcLocInfoPtr | Long — POINTER to source locInfo data record | |
| srcRect | Long — POINTER to source rectangle data record | |
| destLocInfoPtr | Long — POINTER to destination locInfo data record | |
| destRect | Long — POINTER to destination rectangle data record | |
| resMode | Word — Resolution mode | |
| patternPtr | Long — POINTER to fill pattern | |
| leakTblPtr | Long — POINTER to leak-through color table | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$0201 memErr Unable to allocate memory
$1211 badRectSize The height or width is negative, the destination rect is not the same size as the source rect, or the source or destination rect is not within its boundary
$1212 destModeError The destMode portion of resMode is invalid
extern pascal void CalcMask(srcLocIinfoPtr,srcRect,destLocInfoPtr,destRect,resMode,patternPtr,leakTblPtr)
Returns small icons representing files, devices, and other miscellaneous icons
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| flags | Word — What kind of icon to get | |
| value | Word — File type, deviceID, or index | |
| auxValue | Long — Auxiliary type of file or zero | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| iconPtr | Long — POINTER to resulting icon | |
| ← | SP |
$1230 badGetSysIconInput No icon is available for the given input
extern pascal IconPtr GetSysIcon(flags,value,auxValue)
Transforms a pixel map into a QuickDraw II region
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| srcLocInfo | Long — POINTER to a locInfo record for the pixel map | |
| bitsPerPixel | Word — Number of bits per pixel (either 2 or 4) | |
| colorsToInclude | Word — Bit flags indicating which colors to include | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| theRgn | Long — HANDLE to region created from the pixel map | |
| ← | SP |
$0433 rgnFull Region full
Memory Manager errors Returned unchanged
extern pascal RgnHandle PixelMap2Rgn(srcLocInfo,bitsPerPixel,colorsToInclude)
Sets the QuickDraw II cursor to an I-beam cursor
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void IBeamCursor()
Animates a “zooming” effect from one rectangle to another
| Stack before call | ||
|---|---|---|
| previous contents | ||
| flags | Long — Flags | |
| smallRect | Long — POINTER to first rectangle | |
| bigRect | Long — POINTER to second rectangle | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void WhooshRect(flags,smallRect,bigRect)
Draws a string in a specified horizontal width on a single line
| Stack before call | ||
|---|---|---|
| previous contents | ||
| flags | Word — Flags | |
| ref | Long — String reference | |
| width | Word — Width in pixels | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1231 badQDAuxValue Illegal input values
System Loader errors Returned unchanged
extern pascal void DrawStringWidth(flags,ref,width)
Preserves Scanline Control Bytes (SCBs) and sets them to use a color table you specify
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| tableNum | Word — Color table number (0..15) | |
| tablePtr | Long — Pointer to color table (NIL = standard) | |
| width | Word — Flags | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| colorInfo | Long — Value to pass to RestoreColorTable | |
| ← | SP |
NewHandle errors Returned unchanged
extern pascal Long UseColorTable(tableNum,tablePtr,flags)
Undoes the effects of UseColorTable
| Stack before call | ||
|---|---|---|
| previous contents | ||
| colorInfo | Long — Color information from UseColorTable | |
| flags | Word — Flags | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
DisposeHandle errors Returned unchanged
extern pascal void RestoreColorTable(colorInfo,flags)
Allocates memory for the recording of drawing commands into a picture definition, and returns picture handle. (see QuickDraw II OpenPicture call $B704)
Inserts a specified comment into the currently open picture. (see QuickDraw II PicComment call $B804)
Takes drawing commands recorded in picture definition, maps them from picture frame into destination rect. (see QuickDraw II DrawPicture call $BA04)
Releases all memory occupied by a specifed picture. (see QuickDraw II KillPicture call $BB04)
| Print Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| PMBootInit | $0113 | Initializes the Print Manager; called only by Tool Locator - not by application |
| PMStartUp | $0213 | Starts up the Print Manager for use by an application |
| PMShutDown | $0313 | Shuts down the Print Manager when an application quits |
| PMVersion | $0413 | Returns the version number of the Print Manager |
| PMReset | $0513 | Resets the Print Manager; called only when system reset - not by application |
| PMStatus | $0613 | Indicates whether the Print Manager is active |
| PrDefault | $0913 | Fills the fields of specified print record with default values for the appropriate printer. printRecordHandle may be a new or an existing print record. |
| PrValidate | $0A13 | Checks print record for compatibility w/current version # of Print Mgr & installed printer |
| PrStlDialog | $0B13 | Conducts a style dialog w/user to determine page dimens & other info needed for page setup |
| PrJobDialog | $0C13 | Conducts a job dialog w/user to determine print quality, range of pages to print, etc. |
| PrPixelMap | $0D13 | Prints all or part of a specified pixel map |
| PrOpenDoc | $0E13 | Initializes a GrafPort for use in printing a document, makes it the current port, and returns a pointer to the port. |
| PrCloseDoc | $0F13 | Closes the GrafPort being used for printing |
| PrOpenPage | $1013 | Begins a new page. Only printed if it falls within page range given in job subrecord. Must balance each PrOpenPage with a call to PrClosePage. |
| PrClosePage | $1113 | Ends the printing of the current page |
| PrPicFile | $1213 | Prints a spooled document. If spool printing is being used, your application should normally call PrPicFile after it calls the PrCloseDoc routine. |
| PrError | $1413 | Returns last printer error code left during printing loop by Print Manager routines (see Toolbox Ref Vol1, Figure 15-7). |
| PrSetError | $1513 | Stores a specified value into the global variable where the Print Manager keeps its printer error code. E.g. - can be used to abort a print by setting to prAbort. |
| PrChoosePrinter | $1613 | Conducts a Choose Printer dialog w/user to determine printer and port driver to use. |
| PrGetPrinterSpecs | $1813 | Returns information about the currently selected printer. |
| PrDriverVer | $2313 | Returns the version number of the currently installed printer driver |
| PrPortVer | $2413 | Returns the version number of the currently installed port driver |
| PrGetZoneName | $2513 | Returns the name string for the currently selected AppleTalk print zone |
| PrGetPrinterDvrName | $2813 | Returns the name string for the currently selected printer driver |
| PrGetPortDvrName | $2913 | Returns the name string for the currently selected port driver. |
| PrGetUserName | $2A13 | Returns the user name as entered in the Control Panel. |
| PrGetNetworkName | $2B13 | Returns the AppleTalk network name for the currently selected printer; otherwise NIL if non-networked printer. |
| PMUnloadDriver | $3413 | Unloads current port driver, printer driver, or both, depending on input parameter |
| PMLoadDriver | $3513 | Loads current printer driver, port driver, or both, depending on the input parameter |
| PrGetDocName | $3613 | Returns a pointer to the current document name string for your document |
| PrSetDocName | $3713 | Sets the document name for use with AppleTalk printers |
| PrGetPgOrientation | $3813 | Returns a value indicating the current page orientation for the specified document |
Initializes the Print Manager; called only by Tool Locator - not by application
Starts up the Print Manager for use by an application
| Stack before call | ||
|---|---|---|
| previous contents | ||
| userID | Word — ID number of the application | |
| dPageAddr | Word — Bank $0 starting address for 2 pages of direct-page space | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1301 missingDriver Specified driver not in DRIVERS subdirectory of SYSTEM subdirectory
System Loader errors Returned unchanged
Tool Locator errors Returned unchanged
Memory Manager errors Returned unchanged
extern pascal void PMStartUp(userID,dPageAddr)
Shuts down the Print Manager when an application quits
The stack is not affected by this call. There are no input or output parameters.
None
extern pascal void PMShutDown()
Returns the version number of the Print Manager
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the Print Manager | |
| ← | SP |
None
extern pascal Word PMVersion()
Resets the Print Manager; called only when system reset - not by application
The stack is not affected by this call. There are no input or output parameters.
None
Call must not be made by an application.
Indicates whether the Print Manager is active
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| activeFlag | Word — BOOLEAN; TRUE if Print Manager is active, FALSE if not | |
| ← | SP |
None
extern pascal Boolean PMStatus()
Fills the fields of specified print record with default values for the appropriate printer. printRecordHandle may be a new or an existing print record.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| printRecordHandle | Long — HANDLE to print record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1303 noPrintRecord No print record was specified
Memory Manager errors Returned unchanged
extern pascal void PrDefault(printRecordHandle)
Checks print record for compatibility w/current version # of Print Mgr & installed printer
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| printRecordHandle | Long — HANDLE to print record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| recAdjustFlag | Word — BOOLEAN; TRUE if record adjusted, FALSE if no change | |
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal Boolean PrValidate(printRecordHandle)
Conducts a style dialog w/user to determine page dimens & other info needed for page setup
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| printRecordHandle | Long — HANDLE to print record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| confirmFlag | Word — BOOLEAN; TRUE if user confirms dialog, FALSE if not | |
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal Boolean PrStlDialog(printRecordHandle)
Conducts a job dialog w/user to determine print quality, range of pages to print, etc.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| printRecordHandle | Long — HANDLE to print record | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| confirmFlag | Word — BOOLEAN; TRUE if user confirms dialog, FALSE if not | |
| ← | SP |
Memory Manager errors Returned unchanged
extern pascal Boolean PrJobDialog(printRecordHandle)
Prints all or part of a specified pixel map
| Stack before call | ||
|---|---|---|
| previous contents | ||
| srcLogPtr | Long — POINTER to source LocInfo containing POINTER to pixel map | |
| srcRectPtr | Long — POINTER to rectangle enclosing portion of pixel map to print | |
| colorFlag | Word — BOOLEAN; TRUE if printing in color, FALSE if in black and white | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1302 portNotOn The specified port is not selected in the Control Panel
$1304 badLaserPrep The version of LaserPrep in the drivers folder is not compatible with this version of the Print Manager
$1305 badLPFile The version of LaserPrep in the drivers folder is not compatible with this version of the Print Manager
$1306 papConnNotOpen Connection can’t be established with the LaserWriter
$1307 papReadWriteErr Read-write error on the LaserWriter
Memory Manager errors Returned unchanged
QuickDraw II errors Returned unchanged
extern pascal void PrPixelMap(srcLocPtr,srcRectPtr,colorFlag)
Initializes a GrafPort for use in printing a document, makes it the current port, and returns a pointer to the port.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| printRecordHandle | Long — HANDLE to print record | |
| printGrafPortPtr | Long — POINTER to GrafPort, if desired; NIL to allocate new GrafPort | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| printGrafPortPtr | Long — POINTER to GrafPort | |
| ← | SP |
$1302 portNotOn The specified port is not selected in the Control Panel
$1304 badLaserPrep The version of LaserPrep in the drivers folder is not compatible with this version of the Print Manager
$1305 badLPFile The version of LaserPrep in the drivers folder is not compatible with this version of the Print Manager
$1306 papConnNotOpen Connection can’t be established with the LaserWriter
$1307 papReadWriteErr Read-write error on the LaserWriter
Memory Manager errors Returned unchanged
ProDOS 16 errors Returned unchanged
extern pascal GrafPortPtr PrOpenDoc(printRecordHandle,printGrafPortPtr)
Closes the GrafPort being used for printing
| Stack before call | ||
|---|---|---|
| previous contents | ||
| printGrafPortPtr | Long — POINTER to GrafPort to be used for printing | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1302 portNotOn The specified port is not selected in the Control Panel
extern pascal void PrCloseDoc(printGrafPortPtr)
Begins a new page. Only printed if it falls within page range given in job subrecord. Must balance each PrOpenPage with a call to PrClosePage.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| printGrafPortPtr | Long — POINTER to GrafPort to be used for printing | |
| pageFramePtr | Long — POINTER to scaling rectangle; NIL for none | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1302 portNotOn The specified port is not selected in the Control Panel
Memory Manager errors Returned unchanged
extern pascal void PrOpenPage(printGrafPortPtr,pageFramePtr)
Ends the printing of the current page
| Stack before call | ||
|---|---|---|
| previous contents | ||
| printGrafPortPtr | Long — POINTER to GrafPort to be used for printing | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1302 portNotOn The specified port is not selected in the Control Panel
extern pascal void PrClosePage(printGrafPortPtr)
Prints a spooled document. If spool printing is being used, your application should normally call PrPicFile after it calls the PrCloseDoc routine.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| printRecordHandle | Long — HANDLE to print record | |
| printGrafPortPtr | Long — POINTER to GrafPort, if desired; NIL to allocate new GrafPort | |
| statusRecPtr | Long — POINTER to printer status record (see Toolbox Ref Vol1, Figure 15-13) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1302 portNotOn The specified port is not selected in the Control Panel
Memory Manager errors Returned unchanged
extern pascal void PrPicfile(printRecordHandle,printGrafPortPtr,statusRecPtr)
Returns last printer error code left during printing loop by Print Manager routines (see Toolbox Ref Vol1, Figure 15-7).
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| lastError | Word — Last printer error code left by Print Manager routine | |
| ← | SP |
None
extern pascal word PrError()
Stores a specified value into the global variable where the Print Manager keeps its printer error code. E.g. - can be used to abort a print by setting to prAbort.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| errorNumber | Word — Error number to be stored | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PrSetError(errorNumber)
Conducts a Choose Printer dialog w/user to determine printer and port driver to use.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| driverChangedFlag | Word — BOOLEAN; TRUE if driver changed, FALSE if no change | |
| ← | SP |
None
extern pascal Boolean PrChoosePrinter()
Returns information about the currently selected printer.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| characteristics | Word — Word defining printer characteristics | |
| printerType | Word — Word indicating the type of printer connected | |
| ← | SP |
None
extern pascal PrinterSpecs PrGetPrinterSpecs()
Returns the version number of the currently installed printer driver
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the printer driver | |
| ← | SP |
None
extern pascal Word PrDriverVer()
Returns the version number of the currently installed port driver
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| versionInfo | Word — Version number of the port driver | |
| ← | SP |
None
extern pascal Word PrPortVer()
Returns the name string for the currently selected AppleTalk print zone
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| zoneNamePtr | Long — POINTER to zone namestring (Pascal string) | |
| ← | SP |
None
extern pascal Pointer PrGetZoneName()
Returns the name string for the currently selected printer driver
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ptrDvrNamePtr | Long — POINTER to printer driver name string (Pascal string) | |
| ← | SP |
None
extern pascal Pointer PrGetPrinterDvrName()
Returns the name string for the currently selected port driver.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ptrDvrNamePtr | Long — POINTER to port driver name string (Pascal string) | |
| ← | SP |
None
extern pascal Pointer PrGetPortDvrName()
Returns the user name as entered in the Control Panel.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| userNamePtr | Long — POINTER to user name string (Pascal string) | |
| ← | SP |
None
extern pascal Pointer PrGetUserName()
Returns the AppleTalk network name for the currently selected printer; otherwise NIL if non-networked printer.
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| netNamePtr | Long — POINTER to network name string (Pascal string) | |
| ← | SP |
None
extern pascal Pointer PrGetNetworkName()
Unloads current port driver, printer driver, or both, depending on input parameter
| Stack before call | ||
|---|---|---|
| previous contents | ||
| whichDriver | Word — Printer driver to unload | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1309 badLoadParam The specified parameter is invalid
System Loader errors Returned unchanged
extern pascal void PMUnloadDriver(whichDriver)
Loads current printer driver, port driver, or both, depending on the input parameter
| Stack before call | ||
|---|---|---|
| previous contents | ||
| whichDriver | Word — Printer driver to load | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
$1309 badLoadParam The specified parameter is invalid
System Loader errors Returned unchanged
extern pascal void PMLoadDriver(whichDriver)
Returns a pointer to the current document name string for your document
| Stack before call | ||
|---|---|---|
| previous contents | ||
| longspace | Long — Space for result | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| docNamePtr | Long — POINTER to document name string (Pascal string) | |
| ← | SP |
None
extern pascal Pointer PrGetDocName()
Sets the document name for use with AppleTalk printers
| Stack before call | ||
|---|---|---|
| previous contents | ||
| docNamePtr | Long — POINTER to document name string (Pascal string) | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| ← | SP |
None
extern pascal void PrSetDocName()
Returns a value indicating the current page orientation for the specified document
| Stack before call | ||
|---|---|---|
| previous contents | ||
| wordspace | Word — Space for result | |
| prRecordHandle | Long — HANDLE to print record for document | |
| ← | SP |
| Stack after call | ||
|---|---|---|
| previous contents | ||
| orientation | Word — Pageorientation: 0 = portrait, 1 = landscape | |
| ← | SP |
None
extern pascal Word PrGetPgOrientation(prRecordHandle)
| Line Edit Calls | ||
|---|---|---|
| Routine | # | Description |
| LEBootInit | $0114 | Initializes the LineEdit Tool Set; called only by Tool Locator |
| LEStartUp | $0214 | Starts up the LineEdit Tool Set for use by an application |
| LEShutDown | $0314 | Shuts down the LineEdit Tool Set when an application quits |
| LEVersion | $0414 | Returns the version number of the LineEdit Tool Set |
| LEReset | $0514 | Resets the LineEdit Tool Set; called only when the system is reset |
| LEStatus | $0614 | Indicates whether the LineEdit Tool Set is active |
| LENew | $0914 | Allocates space for text, creates & inits edit record, & returns handle to new edit record |
| LEDispose | $0A14 | Releases the memory allocated for a specified edit record |
| LESetText | $0B14 | Incorporates a copy of the specified text into a specified edit record |
| LEIdle | $0C14 | Causes the caret at the insertion point (if any) in specified text to blink |
| LEClick | $0D14 | Controls placement & highlighting of selection range as determined by mouse events |
| LESetSelect | $0E14 | Sets the selection range of a specified edit record |
| LEActivate | $0F14 | Highlights the selection range or caret of a specified edit record |
| LEDeactivate | $1014 | Unhighlights the selection range or caret of a specified edit record |
| LEKey | $1114 | Replaces select range/caret in text of specified edit record w/specified char & leaves insert pnt |
| LECut | $1214 | Removes selection range from text of specified edit record & places it in LineEdit scrap |
| LECopy | $1314 | Copies selection range from text of a specified edit record to the LineEdit scrap |
| LEPaste | $1414 | Replaces selec range/caret in text of specified edit record w/contents of LineEdit scrap |
| LEDelete | $1514 | Removes selec range from text of specified edit record without placing it in LineEdit scrap |
| LEInsert | $1614 | Takes specified text & inserts it just before selection range/caret in text of specified edit record |
| LEUpdate | $1714 | Redraws the text of a specified edit record |
| LETextBox | $1814 | Draws specified text in a specified rectangle, justifying the text as specified |
| LEFromScrap | $1914 | Copies the desk scrap to the LineEdit scrap |
| LEToScrap | $1A14 | Copies the LineEdit scrap to the desk scrap |
| LEScrapHandle | $1B14 | Returns a handle to the LineEdit scrap |
| LEGetScrapLen | $1C14 | Returns the size of the LineEdit scrap in bytes |
| LESetScrapLen | $1D14 | Sets the size of the LineEdit scrap to a specified number of bytes |
| LESetHilite | $1E14 | Sets the leHiliteHook field of a psecified edit record to a specified address |
| LESetCaret | $1F14 | Sets the leCaretHook field of a specified edit record to a specified address |
| LETextBox2 | $2014 | Draws specified txt in specified rectangle, justify text as spec, w/word wrap, & handle embed chges |
| LESetJust | $2114 | Sets the style of justification for the text of a specified edit record |
| LEGetTextHand | $2214 | Returns a handle to the text of a specified edit record |
| LEGetTextLen | $2314 | Returns the length of the text of a specified edit record in bytes |
| GetLEDefProc | $2414 | Returns the address of the current LineEdit control definition procedure |
| LEClassifyKey | $2514 | Returns a word with bits indicating what categories a specified event falls into |
Initializes the LineEdit Tool Set; called only by Tool Locator
Starts up the LineEdit Tool Set for use by an application
Shuts down the LineEdit Tool Set when an application quits
Returns the version number of the LineEdit Tool Set
Resets the LineEdit Tool Set; called only when the system is reset
Indicates whether the LineEdit Tool Set is active
Allocates space for text, creates & inits edit record, & returns handle to new edit record
Releases the memory allocated for a specified edit record
Incorporates a copy of the specified text into a specified edit record
Causes the caret at the insertion point (if any) in specified text to blink
Controls placement & highlighting of selection range as determined by mouse events
Sets the selection range of a specified edit record
Highlights the selection range or caret of a specified edit record
Unhighlights the selection range or caret of a specified edit record
Replaces select range/caret in text of specified edit record w/specified char & leaves insert pnt
Removes selection range from text of specified edit record & places it in LineEdit scrap
Copies selection range from text of a specified edit record to the LineEdit scrap
Replaces selec range/caret in text of specified edit record w/contents of LineEdit scrap
Removes selec range from text of specified edit record without placing it in LineEdit scrap
Takes specified text & inserts it just before selection range/caret in text of specified edit record
Redraws the text of a specified edit record
Draws specified text in a specified rectangle, justifying the text as specified
Copies the desk scrap to the LineEdit scrap
Copies the LineEdit scrap to the desk scrap
Returns a handle to the LineEdit scrap
Returns the size of the LineEdit scrap in bytes
Sets the size of the LineEdit scrap to a specified number of bytes
Sets the leHiliteHook field of a psecified edit record to a specified address
Sets the leCaretHook field of a specified edit record to a specified address
Draws specified txt in specified rectangle, justify text as spec, w/word wrap, & handle embed chges
Sets the style of justification for the text of a specified edit record
Returns a handle to the text of a specified edit record
Returns the length of the text of a specified edit record in bytes
Returns the address of the current LineEdit control definition procedure
Returns a word with bits indicating what categories a specified event falls into
| Dialog Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| DialogBootInit | $0115 | Initializes the Dialog Manager; called only by Tool Locator (not application) |
| DialogStartUp | $0215 | Starts up the Dialog Manager for use by an application |
| DialogShutDown | $0315 | Shuts down the Dialog Manager |
| DialogVersion | $0415 | Returns the version number of the Dialog Manager |
| DialogReset | $0515 | Resets the Dialog Manager; called only on reset (not by application) |
| DialogStatus | $0615 | Indicates whether the Dialog Manager is active |
| ErrorSound | $0915 | Establishes the sound procedure for alerts |
| NewModalDialog | $0A15 | Creates a specified modal dialog & returns a pointer to the GrafPort of the new dialog |
| NewModelessDia | $0B15 | Creates a specified modeless dialog & returns a pointer to the GrafPort of the new dialog |
| CloseDialog | $0C15 | Removes a specified dialog window from the screen and deletes it from the window list |
| NewDItem | $0D15 | Adds a new item to the dialog's item list |
| RemoveDItem | $0E15 | Removes a specified item from a specified dialog and erases it from the screen |
| ModalDialog | $0F15 | If frontmost window is modal dialog box, then repeatedly gets events in dialog's window |
| IsDialogEvent | $1015 | Determines whether a specified event needs to be handled as part of modeless dialog |
| DialogSelect | $1115 | Handles an event as part of a specified modeless dialog |
| DlgCut | $1215 | Checks if specified dialog has any editLine items, if so applies LEcut proc to selected item |
| DlgCopy | $1315 | Checks if specified dialog has any editLine items, if so applies LEcopy proc to selected item |
| DlgPaste | $1415 | Checks if specified dialog has any editLine items, if so applies LEPaste proc to selected item |
| DlgDelete | $1515 | Checks if specified dialog has any editLine items, if so applies LEDelete proc to selected item |
| DrawDialog | $1615 | Draws the contents of a specified dialog box |
| Alert | $1715 | Invokes an alert defined by a specified alert template |
| StopAlert | $1815 | Invokes an alert defined by alert template & draws stop icon in upper-left corner of box |
| NoteAlert | $1915 | Invokes an alert defined by alert template & draws note icon in upper-left corner of box |
| CautionAlert | $1A15 | Invokes an alert defined by alert template & draws caution icon in uppr-left corner of box |
| ParamText | $1B15 | Specifies text for 1-4 special strings in statText, longStatText, & longStatText2 items |
| SetDAFont | $1C15 | Specifies the font for the dialog or alert window's GrafPort |
| GetControlDIte | $1E15 | Returns a handle to the control for a specified item |
| GetIText | $1F15 | Returns the text of a specified statText or editLine item in a psecified dialog box |
| SetIText | $2015 | Provides text for specified statText or editLine item in a specified dialog box & draws the item |
| SelectIText | $2115 | Sets selection range or insertion point for a specified editLine item in a specified dialog box |
| HideDItem | $2215 | Erases a specified item from a specified dialog |
| ShowDItem | $2315 | Makes visible a specified item from a specified dialog |
| FindDItem | $2415 | Returns the ID of the item located at a specified point in a specified dialog |
| UpdateDialog | $2515 | Redraws the part of a specified dialog that is in a specifed update region |
| GetDItemType | $2615 | Returns type of a specified item (buttonItem, radioItem, statText, etc.) |
| SetDItemType | $2715 | Changes a specified item to a new specified item type |
| GetDItemBox | $2815 | Returns the display rectangle of a specified item |
| SetDItemBox | $2915 | Changes the display rectangle of a specified item to a new display rectangle |
| GetFirstDItem | $2A15 | Returns the ID of the first item in a specified dialog |
| GetNextDItem | $2B15 | Returns the ID of the next item in a specified dialog after a specified item |
| ModalDialog2 | $2C15 | If frontmost wndow is modal, then handles events in window; returns code if emabled item |
| GetDItemValue | $2E15 | Returns the current value of a specified item |
| SetDItemValue | $2F15 | Sets the value of a specified item to a new desired value & redraws the item |
| GetNewModalDia | $3215 | Creates a modal dialog & returns a pointer to the port of the new dialog |
| GetNewDItem | $3315 | Adds a new item to a specified dialog's item list using a template |
| GetAlertStage | $3415 | Returns the stage of the last occurence of an alert as a number from 0 to 3 |
| ResetAlertStag | $3515 | Resets stage of last occurrence of alert so next occurence of same alert will be as first |
| DefaultFilter | $3615 | Calls standard default filter used by ModalDialog or Alert when no user filter is spec |
| GetDefButton | $3715 | Returns the ID of the default button item in a specified dialog |
| SetDefButton | $3815 | Sets the ID of the default button to a specified ID |
| DisableDItem | $3915 | Disables a specified item in a specified dialog |
| EnableDItem | $3A15 | Enables a specified item in a specified dialog |
Initializes the Dialog Manager; called only by Tool Locator (not application)
Starts up the Dialog Manager for use by an application
Shuts down the Dialog Manager
Returns the version number of the Dialog Manager
Resets the Dialog Manager; called only on reset (not by application)
Indicates whether the Dialog Manager is active
Establishes the sound procedure for alerts
Creates a specified modal dialog & returns a pointer to the GrafPort of the new dialog
Creates a specified modeless dialog & returns a pointer to the GrafPort of the new dialog
Removes a specified dialog window from the screen and deletes it from the window list
Adds a new item to the dialog's item list
Removes a specified item from a specified dialog and erases it from the screen
If frontmost window is modal dialog box, then repeatedly gets events in dialog's window
Determines whether a specified event needs to be handled as part of modeless dialog
Handles an event as part of a specified modeless dialog
Checks if specified dialog has any editLine items, if so applies LEcut proc to selected item
Checks if specified dialog has any editLine items, if so applies LEcopy proc to selected item
Checks if specified dialog has any editLine items, if so applies LEPaste proc to selected item
Checks if specified dialog has any editLine items, if so applies LEDelete proc to selected item
Draws the contents of a specified dialog box
Invokes an alert defined by a specified alert template
Invokes an alert defined by alert template & draws stop icon in upper-left corner of box
Invokes an alert defined by alert template & draws note icon in upper-left corner of box
Invokes an alert defined by alert template & draws caution icon in uppr-left corner of box
Specifies text for 1-4 special strings in statText, longStatText, & longStatText2 items
Specifies the font for the dialog or alert window's GrafPort
Returns a handle to the control for a specified item
Returns the text of a specified statText or editLine item in a psecified dialog box
Provides text for specified statText or editLine item in a specified dialog box & draws the item
Sets selection range or insertion point for a specified editLine item in a specified dialog box
Erases a specified item from a specified dialog
Makes visible a specified item from a specified dialog
Returns the ID of the item located at a specified point in a specified dialog
Redraws the part of a specified dialog that is in a specifed update region
Returns type of a specified item (buttonItem, radioItem, statText, etc.)
Changes a specified item to a new specified item type
Returns the display rectangle of a specified item
Changes the display rectangle of a specified item to a new display rectangle
Returns the ID of the first item in a specified dialog
Returns the ID of the next item in a specified dialog after a specified item
If frontmost wndow is modal, then handles events in window; returns code if emabled item
Returns the current value of a specified item
Sets the value of a specified item to a new desired value & redraws the item
Creates a modal dialog & returns a pointer to the port of the new dialog
Adds a new item to a specified dialog's item list using a template
Returns the stage of the last occurence of an alert as a number from 0 to 3
Resets stage of last occurrence of alert so next occurence of same alert will be as first
Calls standard default filter used by ModalDialog or Alert when no user filter is spec
Returns the ID of the default button item in a specified dialog
Sets the ID of the default button to a specified ID
Disables a specified item in a specified dialog
Enables a specified item in a specified dialog
| Scrap Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| ScrapBootInit | $0116 | Initializes the Scrap Manager; called only by Tool Locator (not application) |
| ScrapStartUp | $0216 | Starts up the Scrap Manager for use by an application |
| ScrapShutDown | $0316 | Shuts down the Scrap Manager |
| ScrapVersion | $0416 | Returns the version number of the Scrap Manager |
| ScrapReset | $0516 | Resets the Scrap Manager; called only on reset (not by application) |
| ScrapStatus | $0616 | Indicates whether the Scrap Manager is active |
| UnloadScrap | $0916 | Writes desk scrap from memory to the scrap file & releases the memory it occupied |
| LoadScrap | $0A16 | Reads the desk scrap from the scrap file into memory |
| ZeroScrap | $0B16 | Clears the contents of the scrap and increments the scrap count |
| PutScrap | $0C16 | Appends specified data to the scrap that has the same scrap type as the data |
| GetScrap | $0D16 | Copies scrap info of appropriate type to specified handle, setting handle to correct size |
| GetScrapHandle | $0E16 | Returns a copy of the handle for the scrap of a specified type |
| GetScrapSize | $0F16 | Returns the size of the specified scrap |
| GetScrapPath | $1016 | Returns a pointer to the pathname used for the Clipboard file |
| SetScrapPath | $1116 | Sets a pointer to the pathname used for the Clipboard file |
| GetScrapCount | $1216 | Returns the current scrap count |
| GetScrapState | $1316 | Returns a flag indicating the current state of the scrap |
| GetIndScrap | $1416 | This call is useful for utilities that want to read all scrap types |
| ShowClipboard | $1516 | Creates a System window that takes care of the clipboard display for you |
Initializes the Scrap Manager; called only by Tool Locator (not application)
Starts up the Scrap Manager for use by an application
Shuts down the Scrap Manager
Returns the version number of the Scrap Manager
Resets the Scrap Manager; called only on reset (not by application)
Indicates whether the Scrap Manager is active
Writes desk scrap from memory to the scrap file & releases the memory it occupied
Reads the desk scrap from the scrap file into memory
Clears the contents of the scrap and increments the scrap count
Appends specified data to the scrap that has the same scrap type as the data
Copies scrap info of appropriate type to specified handle, setting handle to correct size
Returns a copy of the handle for the scrap of a specified type
Returns the size of the specified scrap
Returns a pointer to the pathname used for the Clipboard file
Sets a pointer to the pathname used for the Clipboard file
Returns the current scrap count
Returns a flag indicating the current state of the scrap
This call is useful for utilities that want to read all scrap types
Creates a System window that takes care of the clipboard display for you
| Std File Ops Calls | ||
|---|---|---|
| Routine | # | Description |
| SFBootInit | $0117 | Initializes the Std File Ops Tool Set; called only by Tool Locator (not by application) |
| SFStartUp | $0217 | Starts up the Std File Ops Tool Set for use by an application |
| SFShutDown | $0317 | Shuts down the Standard File Operations Tool Set when application quits |
| SFVersion | $0417 | Returns the version number of the Standard File Operations Tool Set |
| SFReset | $0517 | Resets the Std File Ops Tool Set; called only on system reset - not by application |
| SFStatus | $0617 | Indicates whether the Std File Ops Tool Set is active |
| SFGetFile | $0917 | Displays the standard Open FIle dialog box & returns info about the file selected by user |
| SFPutFile | $0A17 | Displays standard Save File dialog box & returns info about the name of file to be saved |
| SFPGetFile | $0B17 | Displays custom Open File dialog box & returns info about file selected by user |
| SFPPutFile | $0C17 | Displays custom Save File dialog box & returns info about the name of file to be saved |
| SFAllCaps | $0D17 | Allows applicat. to decide if filenames will be displayed in all upper or upper/lowercase |
| SFGetFile2 | $0E17 | Displays the standard Open File dialog box and returns information about the file selected by the user |
| SFPutFile2 | $0F17 | Displays the standard Save File dialog box and returns the file specification entered by the user |
| SFPGetFile2 | $1017 | Displays a custom Open File dialog box and returns information about the file selected by the user |
| SFPPutFile2 | $1117 | Displays a custom Save File dialog box and returns information about the file specification entered by the user |
| SFShowinvisibl | $1217 | Controls the display of invisible files |
| SFReScan | $1317 | Forces the system to rebuild and redisplay the current list of files |
| SFMultiGet2 | $1417 | Displays the standard Open Multifile dialog box and returns information about the file or files selected by the user |
| SFPMultiGet2 | $1517 | Displays a custom Open Multifile dialog box and returns information about the file or files selected by the user |
Initializes the Std File Ops Tool Set; called only by Tool Locator (not by application)
Starts up the Std File Ops Tool Set for use by an application
Shuts down the Standard File Operations Tool Set when application quits
Returns the version number of the Standard File Operations Tool Set
Resets the Std File Ops Tool Set; called only on system reset - not by application
Indicates whether the Std File Ops Tool Set is active
Displays the standard Open FIle dialog box & returns info about the file selected by user
Displays standard Save File dialog box & returns info about the name of file to be saved
Displays custom Open File dialog box & returns info about file selected by user
Displays custom Save File dialog box & returns info about the name of file to be saved
Allows applicat. to decide if filenames will be displayed in all upper or upper/lowercase
Displays the standard Open File dialog box and returns information about the file selected by the user
Displays the standard Save File dialog box and returns the file specification entered by the user
Displays a custom Open File dialog box and returns information about the file selected by the user
Displays a custom Save File dialog box and returns information about the file specification entered by the user
Controls the display of invisible files
Forces the system to rebuild and redisplay the current list of files
Displays the standard Open Multifile dialog box and returns information about the file or files selected by the user
Displays a custom Open Multifile dialog box and returns information about the file or files selected by the user
| Note Synthesize Calls | ||
|---|---|---|
| Routine | # | Description |
| NSBootInit | $0119 | Initializes the Note Synthesizer; called only by Tool Locator (not application) |
| NSStartUp | $0219 | Starts up the Note Synthesizer for use by an application |
| NSShutDown | $0319 | Shuts down the Note Synthesizer |
| NSVersion | $0419 | Returns the version number of the Note Synthesizer |
| NSReset | $0519 | Resets the Note Synthesizer; called only on reset (not by application) |
| NSStatus | $0619 | Indicates whether the Note Synthesizer is active |
| AllocGen | $0919 | Requests allocation of a sound generator - returns a generator number from 0 to 13 |
| DeallocGen | $0A19 | Sets the named generator's allocation priority to zero |
| NoteOn | $0B19 | Initiates generation of a note on a specified generator |
| NoteOff | $0C19 | Switches the specified generator to release mode, which causes note being generated to die out |
| AllNotesOff | $0D19 | Turns off all Note Synthesizer generators & sets their priorities to zero |
| NSSetUpdateRate | $0E19 | Sets the Note Synthesizer's updateRate parameter |
| NSSetUserUpdate | $0F19 | Sets the user update routine |
Initializes the Note Synthesizer; called only by Tool Locator (not application)
Starts up the Note Synthesizer for use by an application
Shuts down the Note Synthesizer
Returns the version number of the Note Synthesizer
Resets the Note Synthesizer; called only on reset (not by application)
Indicates whether the Note Synthesizer is active
Requests allocation of a sound generator - returns a generator number from 0 to 13
Sets the named generator's allocation priority to zero
Initiates generation of a note on a specified generator
Switches the specified generator to release mode, which causes note being generated to die out
Turns off all Note Synthesizer generators & sets their priorities to zero
Sets the Note Synthesizer's updateRate parameter
Sets the user update routine
| Note Sequencer Calls | ||
|---|---|---|
| Routine | # | Description |
| SeqBootInit | $011A | Initializes the Note Sequencer; called only by Tool Locator (not application) |
| SeqStartUp | $021A | Starts up the Note Sequencer for use by an application |
| SeqShutDown | $031A | Shuts down the Note Sequencer |
| SeqVersion | $041A | Returns the version number of the Note Sequencer |
| SeqReset | $051A | Resets the Note Sequencer; called only on reset (not by application) |
| SeqStatus | $061A | Indicates whether the Note Sequencer is active |
| SetIncr | $091A | Sets the Note Sequencer's increment value - used for temp control of a sequence |
| ClearIncr | $0A1A | Sets NS's increment value to zero, halting current sequence, & returns previous inc value |
| GetTimer | $0B1A | Returns the value of the Note Sequencer's tick counter |
| GetLoc | $0C1A | Returns certain info about the sequence that is playing |
| SeqAllNotesOff | $0D1A | Switches off all notes that are playing but doesn't stop the sequence |
| SetTrkInfo | $0E1A | Assigns instruments in current instrument table to logical tracks, & determines priority |
| StartSeq | $0F1A | Starts interpretation of a series of seqItems stored at address specified by 'sequence' |
| StepSeq | $101A | Advances Note Sequencer to next seqItem in current sequence, executing current seqItems |
| StopSeq | $111A | Halts interpretation of a series of seqItems |
| SetInstTable | $121A | Sets the current instrument table to the one specified in instTable |
| StartInts | $131A | Enables interrupts - Restores normal functioning after call to StopInts |
| StopInts | $141A | Disables Note Synthesizer & Note Sequencer interrupts |
| StartSeqRel | $151A | This call differs from StartSeq in that it uses relative addressing from the beginning of the sequence |
Initializes the Note Sequencer; called only by Tool Locator (not application)
Starts up the Note Sequencer for use by an application
Shuts down the Note Sequencer
Returns the version number of the Note Sequencer
Resets the Note Sequencer; called only on reset (not by application)
Indicates whether the Note Sequencer is active
Sets the Note Sequencer's increment value - used for temp control of a sequence
Sets NS's increment value to zero, halting current sequence, & returns previous inc value
Returns the value of the Note Sequencer's tick counter
Returns certain info about the sequence that is playing
Switches off all notes that are playing but doesn't stop the sequence
Assigns instruments in current instrument table to logical tracks, & determines priority
Starts interpretation of a series of seqItems stored at address specified by 'sequence'
Advances Note Sequencer to next seqItem in current sequence, executing current seqItems
Halts interpretation of a series of seqItems
Sets the current instrument table to the one specified in instTable
Enables interrupts - Restores normal functioning after call to StopInts
Disables Note Synthesizer & Note Sequencer interrupts
This call differs from StartSeq in that it uses relative addressing from the beginning of the sequence
| Font Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| FMBootInit | $011B | Initializes the Font Manager; called only by Tool Locator (not application) |
| FMStartUp | $021B | Starts up the Font Manager for use by an application |
| FMShutDown | $031B | Shuts down the Font Manager |
| FMVersion | $041B | Returns the version number of the Font Manager |
| FMReset | $051B | Resets the Font Manager; called only on reset (not by application) |
| FMStatus | $061B | Indicates whether the Font Manager is active |
| CountFamilies | $091B | Returns total # of distinct font families currently available to FM that match given spec |
| FindFamily | $0A1B | Returns the number and name of a particular font family |
| GetFamInfo | $0B1B | Returns family name & characteristics of a font family with a specified family number |
| GetFamNum | $0C1B | Returns the family number corresponding to a specified font family name |
| AddFamily | $0D1B | Enables application to add a family number & name to Font Manager's list of known fonts |
| InstallFont | $0E1B | Finds specified font or best fit if specified font isn't available; loads or scales; makes current |
| SetPurgeStat | $0F1B | Makes a specified font in memory purgeable or unpurgeable |
| CountFonts | $101B | Returns number of fonts currently available to Font Manager that fit a specified description |
| FindFontStats | $111B | Returns the font ID and the characteristics of a particular font |
| LoadFont | $121B | Loads a specified font into memory (if not already there) & make it current & unpurgeable |
| LoadSysFont | $131B | Makes the system font the current font |
| AddFontVar | $141B | Enables application to add variation of preexisting font family to FM's available fonts |
| FixFontMenu | $151B | Appends the names of available font families to a specified menu |
| ChooseFont | $161B | Displays a dialog box enabling the user to select a new font, size, and style |
| ItemID2FamNum | $171B | Translates the menu item ID into a font family number |
| FMSetSysFont | $181B | Makes a specified font the system font |
| FMGetSysFID | $191B | Returns the font ID of the system font |
| FMGetCurFID | $1A1B | Returns the font ID of the current font |
| FamNum2ItemID | $1B1B | Translates a font family number into a menu item ID |
| InstallWithSta | $1C1B | Installs a font & returns info about that font |
Initializes the Font Manager; called only by Tool Locator (not application)
Starts up the Font Manager for use by an application
Shuts down the Font Manager
Returns the version number of the Font Manager
Resets the Font Manager; called only on reset (not by application)
Indicates whether the Font Manager is active
Returns total # of distinct font families currently available to FM that match given spec
Returns the number and name of a particular font family
Returns family name & characteristics of a font family with a specified family number
Returns the family number corresponding to a specified font family name
Enables application to add a family number & name to Font Manager's list of known fonts
Finds specified font or best fit if specified font isn't available; loads or scales; makes current
Makes a specified font in memory purgeable or unpurgeable
Returns number of fonts currently available to Font Manager that fit a specified description
Returns the font ID and the characteristics of a particular font
Loads a specified font into memory (if not already there) & make it current & unpurgeable
Makes the system font the current font
Enables application to add variation of preexisting font family to FM's available fonts
Appends the names of available font families to a specified menu
Displays a dialog box enabling the user to select a new font, size, and style
Translates the menu item ID into a font family number
Makes a specified font the system font
Returns the font ID of the system font
Returns the font ID of the current font
Translates a font family number into a menu item ID
Installs a font & returns info about that font
| List Manager Calls | ||
|---|---|---|
| Routine | # | Description |
| ListBootInit | $011C | Initializes the List Manager; called only by Tool Locater - not by application |
| ListStartup | $021C | Starts up the List Manager for use by an application |
| ListShutDown | $031C | Shuts down the List Manager when an application quits |
| ListVersion | $041C | Returns the version number of the List Manager |
| ListReset | $051C | Resets the List Manager; called only on system reset - not by application |
| ListStatus | $061C | Indicates whether the List Manager is active |
| CreateList | $091C | Creates a list control using a specified list record |
| SortList | $0A1C | Alphabetizes a specified list by rearranging the array of member records |
| NextMember | $0B1C | Searches specified list record, start w/specified member, & return ptr to member of nxt member found |
| DrawMember | $0C1C | Draws one or all members of a specified list |
| SelectMember | $0D1C | Select specified member, deselects other select members in list, scrolls list & put specified on top |
| GetListDefProc | $0E1C | Returns a pointer to the list control's definition procedure |
| ResetMember | $0F1C | Search specified list record, start w/first member, & returns ptr to member record, & deselects |
| NewList | $101C | Resets the list control according to a specified list record |
| DrawMember2 | $111C | Draws one or all members of a specified list |
| NextMember2 | $121C | Searches a specified list record, returns the item number corresponding to the next selected item |
| ResetMember2 | $131C | Searches a specified list control, returns the item number of the first selected member in the list |
| SelectMember2 | $141C | Selects a specified member, deselects any other selected members of the list, scrolls the list display |
| SortList2 | $151C | Alphabetizes a specified list by rearranging the array of member records |
| NewList2 | $161C | Resets the list control according to a specified list record |
| ListKey | $171C | Accepts keystrokes and jumps the selection around in the specified list appropriately |
| CompareStrings | $181C | CompareStrings compares two Pascal strings |
Initializes the List Manager; called only by Tool Locater - not by application
Starts up the List Manager for use by an application
Shuts down the List Manager when an application quits
Returns the version number of the List Manager
Resets the List Manager; called only on system reset - not by application
Indicates whether the List Manager is active
Creates a list control using a specified list record
Alphabetizes a specified list by rearranging the array of member records
Searches specified list record, start w/specified member, & return ptr to member of nxt member found
Draws one or all members of a specified list
Select specified member, deselects other select members in list, scrolls list & put specified on top
Returns a pointer to the list control's definition procedure
Search specified list record, start w/first member, & returns ptr to member record, & deselects
Resets the list control according to a specified list record
Draws one or all members of a specified list
Searches a specified list record, returns the item number corresponding to the next selected item
Searches a specified list control, returns the item number of the first selected member in the list
Selects a specified member, deselects any other selected members of the list, scrolls the list display
Alphabetizes a specified list by rearranging the array of member records
Resets the list control according to a specified list record
Accepts keystrokes and jumps the selection around in the specified list appropriately
CompareStrings compares two Pascal strings
| ACE Tool Set Calls | ||
|---|---|---|
| Routine | # | Description |
| ACEBootInit | $011D | Initializes the ACE Tool Set; called only by Tool Locator (not by application) |
| ACEStartUp | $021D | Starts up the ACE Tool Set for use by an application |
| ACEShutDown | $031D | Shuts down the ACE Tool Set when an application quits |
| ACEVersion | $041D | Returns the version number of the ACE Tool Set |
| ACEReset | $051D | Resets the ACE Tool Set; called only on reset - not by application |
| ACEStatus | $061D | Indicates whether the ACE Tool Set is active |
| ACEInfo | $071D | Returns certain information about currently installed version of the ACE tools |
| ACECompress | $091D | Compresses equivalent of NBlks of blocks of digital audio data & stores at specified location |
| ACEExpand | $0A1D | Decompresses a previously compressed Audio Sample, using specified method, & stores at specified loc |
| ACECompBegin | $0B1D | Prepares the ACE tools to compress a new audio sequence |
| ACEExpBegin | $0C1D | Prepares ACE to expand a new sequence |
| ACEGetExpState | $0D1D | Gets the first 16 bytes of the expansion buffer |
| ACESetExpState | $0E1D | Copies the first 16 bytes to the expansion buffer |
Initializes the ACE Tool Set; called only by Tool Locator (not by application)
Starts up the ACE Tool Set for use by an application
Shuts down the ACE Tool Set when an application quits
Returns the version number of the ACE Tool Set
Resets the ACE Tool Set; called only on reset - not by application
Indicates whether the ACE Tool Set is active
Returns certain information about currently installed version of the ACE tools
Compresses equivalent of NBlks of blocks of digital audio data & stores at specified location
Decompresses a previously compressed Audio Sample, using specified method, & stores at specified loc
Prepares the ACE tools to compress a new audio sequence
Prepares ACE to expand a new sequence
Gets the first 16 bytes of the expansion buffer
Copies the first 16 bytes to the expansion buffer
| ResourceManager Calls | ||
|---|---|---|
| Routine | # | Description |
| ResourceBootIn | $011E | Initializes the Resource Manager |
| ResourceStartUp | $021E | Notifies the Resource Manager that an application wishes to open and use its own resource files |
| ResourceShutDown | $031E | Notifies the Resource Manager that an application is finished using its own resource files |
| ResourceVersion | $041E | Retrieves the Resource Manager version number |
| ResourceReset | $051E | Resets the Resource Manager; issued only when the system is reset |
| ResourceStatus | $061E | Returns a flag indicating whether the Resource Manager is active |
| CreateResource | $091E | Initializes a resource fork with no resources |
| OpenResourceFile | $0A1E | Opens a specified resource file, making it the current file, and returns a unique file ID to the calling program |
| CloseResourceFile | $0B1E | Updates a specified resource file, frees any memory used by the resource map and resources and closes the file |
| AddResource | $0C1E | Adds a resource to the current resource file |
| UpdateResource | $0D1E | Transfers modifications made to resources in memory to the appropriate resource file |
| LoadResource | $0E1E | Loads a resource into memory and returns a handle to that location |
| RemoveResource | $0F1E | Deletes a resource from its resource file and releases any memory used by the resource |
| MarkResourceCh | $101E | Instructs the Resource Manager to write the specified resource to disk the next time its resource file is updated |
| SetCurResource | $111E | Makes a specified resource file the current file |
| GetCurResource | $121E | Returns the file ID of the current resource file |
| SetCurResource | $131E | Tells the Resource Manager that another application will now be issuing Resource Manager calls |
| GetCurResource | $141E | Returns the user ID for the application that is currently using the Resource Manager |
| HomeResourceFile | $151E | Returns the file ID of the resource file that contains a specified resource |
| WriteResource | $161E | Directs the Resource Manager to write a modified resource to its resource file |
| ReleaseResource | $171E | Sets the purge level of the memory used by a resource |
| DetachResource | $181E | Instructs the Resource Manager to dispose of its control blocks for a specified resource |
| UniqueResource | $191E | Returns a unique resource ID for a specified resource type |
| SetResourceID | $1A1E | Changes the ID of a resource to a new value |
| GetResourceAtt | $1B1E | Returns the attributes word for a specified resource |
| SetResourceAtt | $1C1E | Sets the attributes of a resource |
| GetResourceSiz | $1D1E | Returns the size of the specified resource |
| MatchResourceH | $1E1E | Returns the type and ID of a resource, given ahandle to that resource |
| GetOpenFileRef | $1F1E | Returns the GS/OS file reference number associated with the resource fork of an open resource file |
| CountTypes | $201E | Counts the number of different resource types in all resource files available to the calling program |
| GetIndType | $211E | Finds a resource type value by means of its index |
| CountResources | $221E | Counts the number of resources of a specified type in all resource files available to the calling program |
| GetIndResource | $231E | Finds a resource of a specified type by means of its index and returns the resource ID for that resource |
| SetResourceLoa | $241E | Controls Resource Manager access to the disk when resources are loaded |
| SetResourceFil | $251E | Sets the number of files the Resource Manager is to search during a search operation |
| GetMapHandle | $261E | Returns a handle to the resource map for a specified resource file |
| LoadAbsResourc | $271E | Loads a resource into a specified absolute memory location |
| ResourceConver | $281E | Installs or removes a converter routine from either the application or system converter list |
| LoadResource2 | $291E | It is like LoadResource expect that it returns information about the previous state of the returned handle |
| RMFindeNamedRe | $2A1E | Takes a resource type and a resource name and finds the resource ID of the corresponding resource |
| RMGetResourceN | $2B1E | Returns the Pascal string name of the specified resource |
| RMLoadNamedRes | $2C1E | Takes a resource type and a resource name and loads the corresponding resource |
| RMSetResourceN | $2D1E | Sets the name of the specified resource, first removing any existing name |
| OpenResourceFi | $2E1E | Starts the Resource Manager for you if it isn't already started under the specified user ID |
| CompactResourc | $2F1E | Consolidates all free blocks in an open resource file into a single free block at the end |
Initializes the Resource Manager
Notifies the Resource Manager that an application wishes to open and use its own resource files
Notifies the Resource Manager that an application is finished using its own resource files
Retrieves the Resource Manager version number
Resets the Resource Manager; issued only when the system is reset
Returns a flag indicating whether the Resource Manager is active
Initializes a resource fork with no resources
Opens a specified resource file, making it the current file, and returns a unique file ID to the calling program
Updates a specified resource file, frees any memory used by the resource map and resources and closes the file
Adds a resource to the current resource file
Transfers modifications made to resources in memory to the appropriate resource file
Loads a resource into memory and returns a handle to that location
Deletes a resource from its resource file and releases any memory used by the resource
Instructs the Resource Manager to write the specified resource to disk the next time its resource file is updated
Makes a specified resource file the current file
Returns the file ID of the current resource file
Tells the Resource Manager that another application will now be issuing Resource Manager calls
Returns the user ID for the application that is currently using the Resource Manager
Returns the file ID of the resource file that contains a specified resource
Directs the Resource Manager to write a modified resource to its resource file
Sets the purge level of the memory used by a resource
Instructs the Resource Manager to dispose of its control blocks for a specified resource
Returns a unique resource ID for a specified resource type
Changes the ID of a resource to a new value
Returns the attributes word for a specified resource
Sets the attributes of a resource
Returns the size of the specified resource
Returns the type and ID of a resource, given ahandle to that resource
Returns the GS/OS file reference number associated with the resource fork of an open resource file
Counts the number of different resource types in all resource files available to the calling program
Finds a resource type value by means of its index
Counts the number of resources of a specified type in all resource files available to the calling program
Finds a resource of a specified type by means of its index and returns the resource ID for that resource
Controls Resource Manager access to the disk when resources are loaded
Sets the number of files the Resource Manager is to search during a search operation
Returns a handle to the resource map for a specified resource file
Loads a resource into a specified absolute memory location
Installs or removes a converter routine from either the application or system converter list
It is like LoadResource expect that it returns information about the previous state of the returned handle
Takes a resource type and a resource name and finds the resource ID of the corresponding resource
Returns the Pascal string name of the specified resource
Takes a resource type and a resource name and loads the corresponding resource
Sets the name of the specified resource, first removing any existing name
Starts the Resource Manager for you if it isn't already started under the specified user ID
Consolidates all free blocks in an open resource file into a single free block at the end
| MIDI Tool Set Calls | ||
|---|---|---|
| Routine | # | Description |
| MIDIBootInit | $0120 | Initializes the MIDI Tool Set; called only by Tool Locator (not by application) |
| MIDIStartUp | $0220 | Starts up the MIDI Tool Set for use by an application |
| MIDIShutDown | $0320 | Shuts down the MIDI Tool Set when an application quits |
| MIDIVersion | $0420 | Returns the version number of the MIDI Tool Set |
| MIDIReset | $0520 | Resets the MIDI Tool Set; called only on reset - not by application |
| MIDIStatus | $0620 | Indicates whether the MIDI Tool Set is active |
| MIDIControl | $0920 | Performs 18 different control functions required by the MIDI Tool Set |
| MIDIDevice | $0A20 | Allows an application to select, load, & unload device drivers for use with the tools |
| MIDIClock | $0B20 | Controls operation of optional time-stamp clock - allows precise timing of events |
| MIDIInfo | $0C20 | Returns certain information about the state of the MIDI Tools |
| MIDIReadPacket | $0D20 | Returns length of a packet of MIDI data that was transferred from input buffer to array |
| MIDIWritePacke | $0E20 | Queues specified MIDI packet into output buffer - returns # of bytes written, if successful |
Initializes the MIDI Tool Set; called only by Tool Locator (not by application)
Starts up the MIDI Tool Set for use by an application
Shuts down the MIDI Tool Set when an application quits
Returns the version number of the MIDI Tool Set
Resets the MIDI Tool Set; called only on reset - not by application
Indicates whether the MIDI Tool Set is active
Performs 18 different control functions required by the MIDI Tool Set
Allows an application to select, load, & unload device drivers for use with the tools
Controls operation of optional time-stamp clock - allows precise timing of events
Returns certain information about the state of the MIDI Tools
Returns length of a packet of MIDI data that was transferred from input buffer to array
Queues specified MIDI packet into output buffer - returns # of bytes written, if successful
| Text Edit Tool Calls | ||
|---|---|---|
| Routine | # | Description |
| TEBootInit | $0122 | Initializes TextEdit; called only by the Tool Locator |
| TEStartUp | $0222 | Starts up the TextEdit Tool Set and prepares TextEdit for application use |
| TEShutDown | $0322 | Frees memory used by TextEdit, not including memory used by individual TextEdit records |
| TEVersion | $0422 | Retrieves the TextEdit version number |
| TEReset | $0522 | Resets TextEdit; called only when the system is reset |
| TEStatus | $0622 | Returns a flag indicating whether TextEdit is active |
| TENew | $0922 | Allocates a new TextEdit record in the current port and returns the TERecord defining that record |
| TEKill | $0A22 | Deallocates a TERecord and all associated memory |
| TESetText | $0B22 | Replaces the text in a TextEdit record, including style information, with supplied text and style data |
| TEGetText | $0C22 | Returns the text from a TextEdit record, including the style information associated with that text |
| TEGetTextInfo | $0D22 | Returns an information record, of variable size, describing a TextEdit record |
| TEIdle | $0E22 | Provides processor time so that TextEdit can cause the cursor to blink and can perform other background tasks |
| TEActivate | $0F22 | Makes the specified TextEdit record active-that is, makes that record the target of user keystrokes |
| TEDeactivate | $1022 | Deactivates a TextEdit record |
| TEClick | $1122 | Tracks the pointer within a TextEdit record, selecting all text that it passes over until the user releases the mouse button |
| TEUpdate | $1222 | Redraws the screen for a TextEdit record |
| TEPaintText | $1322 | Prints the text from a TextEdit record |
| TEKey | $1422 | Processes a keystroke for a TextEdit record |
| TEUndo | $1522 | This routine does nothing |
| TECut | $1622 | Copies the current selection from the active TextEdit record to the Clipboard, destroying its previous contents |
| TECopy | $1722 | Copies the current selection from the active TextEdit record to the Clipboard, destroying its previous contents |
| TEPaste | $1822 | Replaces the current selection with the contents of the Clipboard, including both text and style information |
| TEClear | $1922 | Clears the current selection in the active TextEdit record and redraws the screen |
| TEInsert | $1A22 | Inserts a block of text before the current selection in a TextEdit record and redraws the text screen |
| TEReplace | $1B22 | Replaces the current selection in a TextEdit record with a specified block of text and redraws the text screen |
| TEGetSelection | $1C22 | Returns information defining the current selection for a TextEdit record |
| TESetSelection | $1D22 | Sets the current selection for a TextEdit record |
| TEGetSelection | $1E22 | Returns all style information for the text in the current selection in a TextEdit record. |
| TEStyleChange | $1F22 | Changes the style information for the current selection in a TextEdit record |
| TEOffsetToPoin | $2022 | Converts a text byte offset into a pixel position expressed in the local coordinates of the GrafPort |
| TEPointToOffse | $2122 | Converts a pixel position into a text byte offset to the text for the record |
| TEGetDefProc | $2222 | Returns the address of the TextEdit control definition procedure |
| TEGetRuler | $2322 | Returns the ruler definition for a TextEdit record |
| TESetRuler | $2422 | Sets the ruler for a TextEdit record |
| TEScroll | $2522 | Causes the text in a TextEdit record to scroll |
| TEGetInternalP | $2622 | Returns a pointer to the low-level procedure routine for TextEdit |
| TEGetLastError | $2722 | Returns the last error code generated for a TextEdit record |
| TECompactRecor | $2822 | Compresses all the TextEdit data structures in a specified TextEdit record |
Initializes TextEdit; called only by the Tool Locator
Starts up the TextEdit Tool Set and prepares TextEdit for application use
Frees memory used by TextEdit, not including memory used by individual TextEdit records
Retrieves the TextEdit version number
Resets TextEdit; called only when the system is reset
Returns a flag indicating whether TextEdit is active
Allocates a new TextEdit record in the current port and returns the TERecord defining that record
Deallocates a TERecord and all associated memory
Replaces the text in a TextEdit record, including style information, with supplied text and style data
Returns the text from a TextEdit record, including the style information associated with that text
Returns an information record, of variable size, describing a TextEdit record
Provides processor time so that TextEdit can cause the cursor to blink and can perform other background tasks
Makes the specified TextEdit record active-that is, makes that record the target of user keystrokes
Deactivates a TextEdit record
Tracks the pointer within a TextEdit record, selecting all text that it passes over until the user releases the mouse button
Redraws the screen for a TextEdit record
Prints the text from a TextEdit record
Processes a keystroke for a TextEdit record
This routine does nothing
Copies the current selection from the active TextEdit record to the Clipboard, destroying its previous contents
Copies the current selection from the active TextEdit record to the Clipboard, destroying its previous contents
Replaces the current selection with the contents of the Clipboard, including both text and style information
Clears the current selection in the active TextEdit record and redraws the screen
Inserts a block of text before the current selection in a TextEdit record and redraws the text screen
Replaces the current selection in a TextEdit record with a specified block of text and redraws the text screen
Returns information defining the current selection for a TextEdit record
Sets the current selection for a TextEdit record
Returns all style information for the text in the current selection in a TextEdit record.
Changes the style information for the current selection in a TextEdit record
Converts a text byte offset into a pixel position expressed in the local coordinates of the GrafPort
Converts a pixel position into a text byte offset to the text for the record
Returns the address of the TextEdit control definition procedure
Returns the ruler definition for a TextEdit record
Sets the ruler for a TextEdit record
Causes the text in a TextEdit record to scroll
Returns a pointer to the low-level procedure routine for TextEdit
Returns the last error code generated for a TextEdit record
Compresses all the TextEdit data structures in a specified TextEdit record
| ProDOS 16 Calls | ||
|---|---|---|
| Routine | # | Description |
| CREATE | $0100 | Creates a standard file, extended file, or subdirectory file on a volume |
| DESTROY | $0200 | Deletes a specified standard, extended, or subdir file & updates file system to show deletion |
| CHANGE_PATH | $0400 | Changes a file's pathname to another pathname on the same volume, or renames a volume |
| SET_FILE_INFO | $0500 | Sets certain file attributes of existing block file & immediately modifies directory entry |
| GET_FILE_INFO | $0600 | Returns certain file attributes of existing block file |
| VOLUME | $0800 | Returns name of volume mounted in specified device along with other info about volume |
| SET_PREFIX | $0900 | Sets one of the number pathname prefixes to a specified value |
| GET_PREFIX | $0A00 | Returns current value of any one of the numbered prefixes |
| CLEAR_BACKUP_BI | $0B00 | Alters a file's state info to indicate file has been backed up & not altered since backup |
| OPEN | $1000 | Causes GS/OS to establish an access path to a file & allows subsequent reads & writes |
| NEWLINE | $1100 | Enables or disables the newline read mode for an open file & specified enable mask & character |
| READ | $1200 | Attempts to transfer # of bytes requested, starting at current mark, into file buffer |
| WRITE | $1300 | Attempts to transfer # bytes specified from applications buffer to the specified file, at mark |
| CLOSE | $1400 | Closes access path to specified file, releasing all resources & buffered data for file |
| FLUSH | $1500 | Writes to volume all file state info that's buffered in mem but not yet written to volume |
| SET_MARK | $1600 | Sets the file mark to a specified value (position where next byte will be accessed) |
| GET_MARK | $1700 | Returns the current file mark for the specified file |
| SET_EOF | $1800 | Sets logical size of open file to specified value which may be larger or smaller than current |
| GET_EOF | $1900 | Returns current logical size of a specified file |
| SET_LEVEL | $1A00 | Sets current value of the system file level |
| GET_LEVEL | $1B00 | Returns current value of system file level |
| GET_DIR_ENTRY | $1C00 | Returns info about a directory entry in the volume directory or a subdirectory |
| GET_DEV_NUMBER | $2000 | Returns device number of a device identifed by device name or volume name |
| GET_LAST_DEV | $2100 | Returns the device number of the last accessed device (use with caution) |
| READ_BLOCK | $2200 | Reads one 512-byte block of information from disk specified by device number |
| WRITE_BLOCK | $2300 | Writes one 512-byte block of information to disk specified by device number |
| FORMAT | $2400 | Puts up dialog box that allows user to physically format a volume & chose file system |
| ERASE_DISK | $2500 | Puts up dialog box that allows user to erase a specified volume (does not physically format) |
| GET_NAME | $2700 | Returns the filename (not complete pathname) of currently running application program |
| GET_BOOT_VOL | $2800 | Returns volume name of volume from wich the file GS/OS was last loaded & executed (*/) |
| QUIT | $2900 | Terminates the running application, closes all open files, then launches next application |
| GET_VERSION | $2A00 | Returns the version number of the GS/OS operating system |
| D_INFO | $2C00 | Returns general information about a device attached to the system (devNum & devName) |
| ALLOC_INTERRUPT | $3100 | Places address of an interrupt handler into GS/OS interrupt vector table |
| DEALLOC_INTERRU | $3200 | Removes a specified interrupt handler from the interrupt vector table |
Creates a standard file, extended file, or subdirectory file on a volume
Deletes a specified standard, extended, or subdir file & updates file system to show deletion
Changes a file's pathname to another pathname on the same volume, or renames a volume
Sets certain file attributes of existing block file & immediately modifies directory entry
Returns certain file attributes of existing block file
Returns name of volume mounted in specified device along with other info about volume
Sets one of the number pathname prefixes to a specified value
Returns current value of any one of the numbered prefixes
Alters a file's state info to indicate file has been backed up & not altered since backup
Causes GS/OS to establish an access path to a file & allows subsequent reads & writes
Enables or disables the newline read mode for an open file & specified enable mask & character
Attempts to transfer # of bytes requested, starting at current mark, into file buffer
Attempts to transfer # bytes specified from applications buffer to the specified file, at mark
Closes access path to specified file, releasing all resources & buffered data for file
Writes to volume all file state info that's buffered in mem but not yet written to volume
Sets the file mark to a specified value (position where next byte will be accessed)
Returns the current file mark for the specified file
Sets logical size of open file to specified value which may be larger or smaller than current
Returns current logical size of a specified file
Sets current value of the system file level
Returns current value of system file level
Returns info about a directory entry in the volume directory or a subdirectory
Returns device number of a device identifed by device name or volume name
Returns the device number of the last accessed device (use with caution)
Reads one 512-byte block of information from disk specified by device number
Writes one 512-byte block of information to disk specified by device number
Puts up dialog box that allows user to physically format a volume & chose file system
Puts up dialog box that allows user to erase a specified volume (does not physically format)
Returns the filename (not complete pathname) of currently running application program
Returns volume name of volume from wich the file GS/OS was last loaded & executed (*/)
Terminates the running application, closes all open files, then launches next application
Returns the version number of the GS/OS operating system
Returns general information about a device attached to the system (devNum & devName)
Places address of an interrupt handler into GS/OS interrupt vector table
Removes a specified interrupt handler from the interrupt vector table
| GS/OS Calls | ||
|---|---|---|
| Routine | # | Description |
| CreateGS | $0120 | Creates a standard file, extended file, or subdirectory file on a volume |
| DestroyGS | $0220 | Deletes a specified standard, extended, or subdir file & updates file system to show deletion |
| OSShutdownGS | $0320 | Allows application to shut down OS in prep for power down or cold reboot of machine |
| Change_PathGS | $0420 | Changes a file's pathname to another pathname on the same volume, or change name of volume |
| Set_File_InfoGS | $0520 | Sets certain file attributes of existing block file & immediately modifies directory entry |
| Get_File_InfoGS | $0620 | Returns certain file attributes of existing block file |
| JudgeNameGS | $0720 | Allows the caller to verify the syntax of a file name, directory name or volume name |
| VolumeGS | $0820 | Returns name of volume mounted in specified device along with other info about volume |
| Set_PrefixGS | $0920 | Sets one of the number pathname prefixes to a specified value |
| Get_PrefixGS | $0A20 | Returns current value of any one of the numbered prefixes |
| Clear_BackupGS | $0B20 | Sets file's state info to indicate that file has been backed up & not altered since backup |
| Set_Sys_PrefsGS | $0C20 | Sets value of current global system preferences - values affect behavior of sys calls |
| NullGS | $0D20 | Executes any pending events in Scheduler & GS/OS event queue - flushes queues |
| Expand_PathGS | $0E20 | Converts input pathname into full pathname with ':' as separators, optionally changin case |
| Get_Sys_PrefsGS | $0F20 | Returns value of current global system preferences - values affect behavior of sys calls |
| OpenGS | $1020 | Causes GS/OS to establish an access path to a file & allows subsequent reads & writes |
| NewLineGS | $1120 | Enables or disables newline read mode for an open file, & specified enable mask & character |
| ReadGS | $1220 | Attempts to transfer # of bytes requested, starting at current mark, into file buffer |
| WriteGS | $1320 | Attempts to transfer # bytes specified from applications buffer to the specified file, at mark |
| CloseGS | $1420 | Closes access path to specified file, releasing all resources & buffered data for file |
| FlushGS | $1520 | Writes to volume all file state info that's buffered in mem but not yet written to volume |
| Set_MarkGS | $1620 | Sets the file mark to a specified value (position where next byte will be accessed) |
| Get_MarkGS | $1720 | Returns the current file mark for the specified file |
| Set_EOFGS | $1820 | Sets logical size of open file to specified value which may be larger or smaller than current |
| Get_EOFGS | $1920 | Returns current logical size of a specified file |
| Set_LevelGS | $1A20 | Sets current value of the system file level |
| Get_LevelGS | $1B20 | Returns the current value of the system file level |
| Get_Dir_EntryGS | $1C20 | Returns info about a directory entry in the volume directory or a subdirectory |
| Begin_SessionGS | $1D20 | Tells GS/OS to begin deferring block writes to disk - block cache until EndSession |
| End_SessionGS | $1E20 | Flushes any deferred block writes occuring during write-deferral session & resume norm |
| Session_StatusG | $1F20 | Returns a value that tells if a write-deferral session is in progress |
| Get_Dev_NumberG | $2020 | Returns device number of a device identifed by device name or volume name |
| Get_Last_DevGS | $2120 | Returns the device number of the last accessed device (use with caution) |
| FormatGS | $2420 | Puts up dialog box that allows user to physically format a volume & chose file system |
| Erase_DiskGS | $2520 | Puts up dialog box that allows user to erase a specified volume (does not physically format) |
| ResetCacheGS | $2620 | Provides a way to resize the GS/OS cache and be able to use the resized cache immediately |
| Get_NameGS | $2720 | Returns the filename (not complete pathname) of currently running application program |
| Get_Boot_VolGS | $2820 | Returns volume name of volume from wich the file GS/OS was last loaded & executed (*/) |
| QuitGS | $2920 | Terminates the running application, closes all open files, then launches next application |
| Get_VersionGS | $2A20 | Returns the version number of the GS/OS operating system |
| Get_FST_InfoGS | $2B20 | Returns general information about a specified File System Translator |
| D_InfoGS | $2C20 | Returns general information about a device attached to the system |
| D_StatusGS | $2D20 | Returns status information about a specified device |
| D_ControlGS | $2E20 | Sends control info to a specified device |
| D_ReadGS | $2F20 | Performs a device-level read on a specified device |
| D_WriteGS | $3020 | Performs a device-level write to a specified device |
| Bind_IntGS | $3120 | Places address of an interrupt handler into GS/OS's interrupt vector table |
| Unbind_IntGS | $3220 | Removes a specified interrupt handler from the interrupt vector table |
| FSTSpecificGS | $3320 | Call that can be defined individually for any file system translator |
| AddNotifyProcGS | $3420 | Adds a notification queue to the notification queue |
| DelNotifyProcGS | $3520 | Removes a notification procedure from the notification queue |
| D_RenameGS | $3620 | Replaces a device name as specificed in a device information block |
| GetRefInfoGS | $3920 | Returns the access attributes and full pathname for an open file when the reference number is given as input |
| SetStdRefNumGS | $3A20 | Allows the caller to explicitly set the reference number associated with one of the standard I/O channels |
Creates a standard file, extended file, or subdirectory file on a volume
Deletes a specified standard, extended, or subdir file & updates file system to show deletion
Allows application to shut down OS in prep for power down or cold reboot of machine
Changes a file's pathname to another pathname on the same volume, or change name of volume
Sets certain file attributes of existing block file & immediately modifies directory entry
Returns certain file attributes of existing block file
Allows the caller to verify the syntax of a file name, directory name or volume name
Returns name of volume mounted in specified device along with other info about volume
Sets one of the number pathname prefixes to a specified value
Returns current value of any one of the numbered prefixes
Sets file's state info to indicate that file has been backed up & not altered since backup
Sets value of current global system preferences - values affect behavior of sys calls
Executes any pending events in Scheduler & GS/OS event queue - flushes queues
Converts input pathname into full pathname with ':' as separators, optionally changin case
Returns value of current global system preferences - values affect behavior of sys calls
Causes GS/OS to establish an access path to a file & allows subsequent reads & writes
Enables or disables newline read mode for an open file, & specified enable mask & character
Attempts to transfer # of bytes requested, starting at current mark, into file buffer
Attempts to transfer # bytes specified from applications buffer to the specified file, at mark
Closes access path to specified file, releasing all resources & buffered data for file
Writes to volume all file state info that's buffered in mem but not yet written to volume
Sets the file mark to a specified value (position where next byte will be accessed)
Returns the current file mark for the specified file
Sets logical size of open file to specified value which may be larger or smaller than current
Returns current logical size of a specified file
Sets current value of the system file level
Returns the current value of the system file level
Returns info about a directory entry in the volume directory or a subdirectory
Tells GS/OS to begin deferring block writes to disk - block cache until EndSession
Flushes any deferred block writes occuring during write-deferral session & resume norm
Returns a value that tells if a write-deferral session is in progress
Returns device number of a device identifed by device name or volume name
Returns the device number of the last accessed device (use with caution)
Puts up dialog box that allows user to physically format a volume & chose file system
Puts up dialog box that allows user to erase a specified volume (does not physically format)
Provides a way to resize the GS/OS cache and be able to use the resized cache immediately
Returns the filename (not complete pathname) of currently running application program
Returns volume name of volume from wich the file GS/OS was last loaded & executed (*/)
Terminates the running application, closes all open files, then launches next application
Returns the version number of the GS/OS operating system
Returns general information about a specified File System Translator
Returns general information about a device attached to the system
Returns status information about a specified device
Sends control info to a specified device
Performs a device-level read on a specified device
Performs a device-level write to a specified device
Places address of an interrupt handler into GS/OS's interrupt vector table
Removes a specified interrupt handler from the interrupt vector table
Call that can be defined individually for any file system translator
Adds a notification queue to the notification queue
Removes a notification procedure from the notification queue
Replaces a device name as specificed in a device information block
Returns the access attributes and full pathname for an open file when the reference number is given as input
Allows the caller to explicitly set the reference number associated with one of the standard I/O channels