Home | Software | Tools | Routines | Info | Dictionaries

Standard Additions (OS7.5.x) Dictionary

Copyright Apple Computer, Inc. 1991-1994. All rights reserved.

Index

These suites are all separate files under System 7.x and OS 8.1

1. AGStart
   • Events:
     1. AGStart
2. Beep
   • Events:
     1. beep
3. Choose Application
   • Events:
     1. choose application
4. Choose File
   • Events:
     1. choose file
     2. choose folder
5. Current Date
   • Events:
     1. current date
6. Display Dialog
   • Classes:
     1. reply
   • Events:
     1. display dialog
7. Encode URL
   • Events:
     1. Encode URL
8. File Commands
   • Classes:
     1. file info
   • Events:
     1. info for
     2. list disks
     3. list folder
     4. path to
9. Load Script
   • Events:
     1. load script
10. Monitor Depth
    • Events:
      1. monitor depth
      2. max monitor depth
      3. set monitor depth
      4. min monitor depth
11. New File
    • Events:
      1. new file
12. Numerics
    • Events:
      1. round
      2. random number
13. Read/Write Commands
    • Events:
      1. open for access
      2. close access
      3. get eof
      4. set eof
      5. read
      6. write
14. Run Script
    • Events:
      1. run script
15. Set Volume
    • Events:
      1. set volume
16. Store Script
    • Events:
      1. store script
17. String Commands
    • Events:
      1. ASCII character
      2. ASCII number
      3. offset
18. Time to GMT
    • Events:
      1. time to GMT

AGStart

Events:

AGStart: Start Apple Guide in the background so that it can accept Apple events. This command is ignored if Apple Guide is already started.

AGStart

Beep

Events:

beep: Beep 1 or more times.

beep integer -- number of times to beep

Choose Application

Events:

choose application: Displays list of active applications.

choose application

[application label string] -- used as prompt for application list

[with prompt string] -- optional descriptive text

Result: application -- application chosen

Choose File

Events:

choose file: Choose a file from a list.

choose file

[with prompt string] -- optional user prompt

[of type list] -- list of file types to display (up to 4)

Result: alias -- chosen file

choose folder: Choose a folder from a list.

choose folder

[with prompt string] -- optional user prompt

Result: alias -- chosen folder

Current Date

Events:

current date: Return the current date and time.

current date

Result: anything -- date object

Display Dialog

Events:

display dialog: Display a dialog.

display dialog anything -- title of dialog

[default answer anything] -- default editable text

[buttons list] -- list of up to three buttons

[default button anything] -- name or number of default button

[with icon anything] -- name or id of the icon to display

[with icon stop/note/caution] -- display one of these system icons

Result: reply -- record containing the button hit and text entered (if any)

Classes:

Class reply:

Properties:

button returned reply [r/o] -- name of button chosen

text returned reply [r/o] -- text entered (if any)

Encode URL

Events:

Encode URL: Encode a string using the %xx encodings used in URLs

Encode URL anything -- text to be encoded

Result: 'char' -- Encoded URL string

File Commands

Events:

info for: Gets information for a file or folder.

info for file specification -- Target file or folder.

Result: file info -- Information for file or folder specified.

list disks: Returns a list of currently mounted disks.

list disks

Result: list -- List of mounted disks.

list folder: List the contents of the specified folder.

list folder file specification -- path or alias to specified folder

[invisibles boolean] -- list invisible files? (default is true)

Result: list -- list of items in specified folder

path to: Returns full path name to the folder or application specified.

path to apple menu/apple menu items/apple menu items folder/control panels/control panels folder/desktop/extensions/extensions folder/fonts/fonts folder/preferences/preferences folder/printmonitor/printmonitor documents/trash/startup items/startup items folder/.. -- The folder or application to return.

[as type class]

Result: anything -- Path name to folder or application specified.

Classes:

Class file info:

Properties:

name string [r/o]

creation date date [r/o]

modification date date [r/o]

icon position point [r/o]

visible boolean [r/o]

size integer [r/o]

folder boolean [r/o]

folder window bounding rectangle [r/o] -- Used with folders only.

locked boolean [r/o] -- Used with files only.

file creator string [r/o] -- Used with files only.

file type string [r/o] -- Used with files only.

short version string [r/o] -- Used with files only.

long version string [r/o] -- Used with files only.

default application alias [r/o] -- Used with non-application files only.

alias boolean [r/o] -- Is this file an alias?

Load Script

Events:

load script: Creates script object from compiled script file.

load script alias -- script file to load

Result: anything -- returns script object or error code

Monitor Depth

Events:

monitor depth: e.g. copy monitor depth to x

monitor depth

Result: anything -- Current Monitor Depth

max monitor depth: e.g. copy max monitor depth to x

max monitor depth

Result: anything -- Maximum Monitor Depth

set monitor depth: e.g. set monitor depth 8

set monitor depth anything -- Desired bit depth for the monitor

[Result: anything] -- The reply is not required

min monitor depth: e.g. copy min monitor depth to x

min monitor depth

Result: anything -- Minimum Monitor Depth

New File

Events:

new file: This command displays the standard putfile dialog. It returns a file specification that can be used to create a new file. The 'new file' command does not create a file.

new file

[with prompt string] -- prompt to use

[default name string] -- default file name

Result: file specification -- File specification for file to create.

Numerics

Events:

round: Round number to integer.

round extended real -- number to round

[rounding up/down/toward zero/to nearest] -- specify rounding direction,
default is rounding to nearest

Result: integer -- rounded value

random number: Generate a random number.

random number anything -- number to randomize (If included, random number from 0 to this value.
If no number specified, then a value between 0 and 1 is returned.)

[from anything] -- from value

[to anything] -- to value

[with seed anything]

Result: anything -- random number returned

Read/Write Commands

Events:

open for access:

open for access alias -- File to open.

[write permission boolean] -- If true, the file wll be opened with read/write access.
If false, the file will be opened with read access only.

Result: small integer -- Reply contains error or file reference number.

close access: Close the file which was opened for access.

close access anything -- Reference number or file to close.

[Result: integer] -- Error code if any.

get eof: Get end of file for specified file.

get eof anything -- Reference number or file to return eof information for.

Result: integer -- End of file for specified file.

set eof: Set end of file for specified file.

set eof anything -- Reference number or file to set eof for.

to anything -- New value for end of file.

[Result: integer] -- Error number, if any.

read: Read from file.

read anything -- reference number or file to read

using delimiters list -- Delimiters to use. May use 1 or 2 delimiters.

using delimiter anything -- Delimiters to use. May use 1 or 2 delimiters.

[as anything] -- read this data in this form

[for integer] -- read for this number of bytes

[before string] -- Read to this delimiter excluding it. A delimiter is a single character.

[until string] -- Read to this delimiter including it. A delimiter is a single character.

[to integer] -- read from current mark to this byte

[from integer] -- read from this byte

Result: anything -- data returned or error

write: write to file

write anything -- Data to write.

[for integer] -- number of bytes to write

[starting at integer] -- start writing at this offset from beginning of file

to anything -- reference number or file to write to

[as type class] -- write data in this form

[Result: integer] -- Returns error, if any.

Run Script

Events:

run script: Run a specified script or script file.

run script script -- script or script file to execute

[with parameters list] -- list of parameters

[in string] -- scripting component to use, default is current scripting component

Result: anything -- result of running script

Set Volume

Events:

set volume: Set the sound volume from 0 through 7.

set volume anything -- sound volume level

Store Script

Events:

store script: Stores script object in file specified.

store script script -- script object to store

in alias -- path to file to store in

[replacing ask/yes/no] -- control display of save as dialog

Result: integer -- error returned from storing (if any)

String Commands

Events:

ASCII character: Converts a number to its ASCII equivalent.

ASCII character small integer -- ASCII code of specified character.

Result: string -- The character.

ASCII number: Returns the ASCII number of a character.

ASCII number string -- The character.

Result: small integer -- Number of specified character.

offset: Find position of text in target block of text.

offset

of string -- Text to find offset of.

in string -- Target text to find offset in.

Result: integer -- Position in text or 0 if not found.

Time to GMT

Events:

time to GMT: delta to gmt in seconds

time to GMT

Result: integer

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/Std_Addns_110_asDict.html
|| created: 4-Aug-03, 9:48 PM; updated: 4-Aug-03, 2:48 PM
|| size: 48557 bytes