©1994-2000 AKUA interactive media AG. All rights reserved.
window peek integer [r/o] -- A pointer to the window in memory. Do NOT change or create this!
screen location point [r/o] -- The location of the window (in case you wish to save/restore it)
window dimensions point [r/o] -- The size of the window
canceled boolean [r/o] -- If Apple-’.’ was held down, this is set to TRUE.
aev suite id string [r/o]
aev id string [r/o]
aev direct parameter anything [r/o]
aev parameters anything [r/o] -- Any other parameters in form of «class PmID»:param
trigger key Menu Shortcut Rec -- If the trigger is activated by a keyboard combo
trigger year small integer -- The year to trigger in.
trigger month small integer -- The month to fire.
trigger day small integer -- The day to trigger.
trigger weekdays string -- The weekdays
trigger hour small integer
trigger minute small integer
trigger period small integer -- How many seconds between repetitions?
trigger repeat small integer -- How many times to repeat this trigger. -1 for infinite.
trigger idle integer -- Trigger fires after this many seconds of idle time has gone by.
trigger last date [r/o] -- The last time trigger was fired
trigger next date [r/o] -- The next time trigger will fire
Akua Sweets Version file specification -- The file (instead of Akua Sweets) from which to get the version.
[as type class] -- “as text” for the long version string or “as string” for the short string
[packaging boolean] -- Get the package version instead of the item version?
Result: string -- The short version string - or value if requested.
I will not idle string -- An optional extra creator type to check for.
Result: boolean -- Won’t you get an idle and quit message?
Thread Complete anything -- The result of the thread (if it returned one).
named string -- The name of the Thread that completed
tagged anything -- The tag if you spawned with one - else the name again.
Thread Run 'targ' -- The application you should target any interface commands to - since you may not (will probably not) be running in its context.
automate alerts after integer -- The number of seconds after which alerts are automatically “OK”’d.
[preferring button small integer] -- Prefer this button when trying to first dismiss a dialog.
[pointer jumping boolean] -- Move the mouse to the default button?
[vertical bars boolean] -- Position the timer bars vertically?
[opposite bars boolean] -- Position time bars on the opposite side (right or bottom) of dialogs.
[movables boolean] -- Handle movable modals as well as modals.
[shortcuts boolean] -- Enable keyboard shortcuts (letters activate button with letter closest to start).
[log boolean] -- Used to disable the default logging of alert text.
[persistent log boolean] -- Log to the “Alertia Log” file?
Result: a list of string -- The accumulated alert text.
display info Progress Window Rec -- The info window returned from a previous call to display info.
[message string] -- The message(s) to display.
[at line small integer] -- The line at which to display the message.
[at column small integer] -- The column in which to display the message.
[using state Draw State Rec] -- The style you wish to use for this primitive (it sticks for future primitives until changed).
[a change of style boolean] -- Normally a style is only recorded when a line is first entered. Setting this parameter to TRUE overrides the stored style with the given parameters.
[static state boolean] -- Override the default time based static state (influences updating mechanism) for this line. The default state is based on the frequency of updates. Set this to true when updating a line repeatedly and then not for a long time after.
[located at point] -- The global location of the window - can be restored from previous r field. {-1,-1} for default, {-2,-2} to keep window invisible.
[with dimensions point] -- The size in w/h. If not provided, the maximum width of any of the strings will be used
[with borders point] -- Set the x,y borders (between cells and between edge of window and cells). Default is 2,2.
[fixed dimensions boolean] -- Fix the dimensions? - as opposed to letting them adjust to string widths and line numbers.
[removing cells a list of point] -- A list of cells to remove from the spreadsheet. Use a 0 as a cell parameter to indicate the whole line/column. Use a negative number to indicate that the cell should be completely emptied (i.e. take up no more space). Use {0,0} to cut below & right.
[returning cells a list of point] -- A list of cells to return from the spreadsheet. Use a 0 as a cell parameter to indicate the whole line/column. {0,0} to return the whole sheet.
[tasking boolean] -- Without tasking goes faster than with, but windows can not be moved.
[flotation boolean] -- Float the window above all others (use NewCServiceWindow instead of NewCWindow).
[disposal boolean] -- When you use “with disposal” - NEVER use the object returned again! The window will be deleted.
[a close box boolean] -- Create / Remove the close box by using with/without this parameter.
[a zoom box boolean] -- Create / Remove the zoom box by using with/without this parameter.
[a grow box boolean] -- Create / Remove the grow box by using with/without this parameter.
[as small integer] -- The kind of window you wish to convert it to (be careful and know what you are doing).
Result: Draw Window Rec -- The info window for future display info calls
display progress Progress Window Rec -- The progress window - leave blank if creating - or optionally just give the title of the window again.
[subtitled string] -- Usually the name of what you are doing the title to. When initially created, if this is present, the window is movable modal, else just modal.
[labeled string] -- This text appears under the subtitle (or title if subtitle is absent at creation).
[maximum integer] -- The right end of the progress bar has this value.
[value integer] -- The current value of the progress bar. Use 0 to just increment the current value by 1.
[located at point] -- The global position of the window - can be restored from previous globalLoc field.
[alternate color boolean] -- Use the alternate fill colour
[tasking boolean] -- Without tasking goes faster than with, but windows can not be dragged.
[flotation boolean] -- Float the window above all others (use NewCServiceWindow instead of NewCWindow).
[disposal boolean] -- When you use “with death” - NEVER use the object returned again! The window will be deleted.
Result: Progress Window Rec -- A progress window - don’t mess with it or you may crash!
mutter string -- Say what?
[as anything] -- You may request “as sound” to speak into a new sound resource or “as text” to get the text as phonemes.
[Result: anything] -- Nothing, text or a sound depending on your ‘as’
pause for integer -- The amount of ticks to pause or 0 to just inquire current tick count or seconds count if seconds timing is selected.
[break on key boolean] -- Exit pause if a key is pressed.
[break on button boolean] -- Exit pause if mouse button is pressed.
[seconds timing boolean] -- The amount of seconds to wait.
[eating breaks boolean] -- Uses GetNextEvent instead of EventAvail to get break events. Default is TRUE.
Result: real -- The tick counter or seconds counter if specified.
spawn file specification -- The event to send or script file to run. You can’t ‘spawn beep 2’. You can spawn a Raw AE Rec
[thread script] -- AppleScript has a problem giving scripts as direct objects, thus this is an alternate to the first parameter.
[for alias] -- An alias to the application or its creator type or process number. Default is the current “tell” application.
[at Trigger Rec] -- The record describing when and how often the event should be sent - or the amount of seconds to delay before sending the event or an absolute date/time. Defaults to 2 minutes.
[autolaunch boolean] -- Don't launch the app just to send this event. (By default, it will be launched in the background, if you specify this as true, then it will be launched in the foreground).
[from alias] -- (path to me) or your process number to receive the reply event - if you are telling someone else to do this.
[as string] -- The name of the thread to schedule. The “Thread Complete” event will be sent with this name when the action is complete.
[tagged anything] -- Will be passed to “Thread Complete” if you provide it.
Result: a list of Trigger Rec -- A list containing the current trigger table. See “Thread Complete” for the queued response from a spawned child.
the idled time
[as type class] -- Request “as list” to get a more detailed accounting.
Result: integer -- The number of seconds since the user has neither moved the mouse, typed a key - or the mac was busy for more than 2 seconds.
transcend string -- The eight letter suite/eventID combo to create an event with.
[to anything] -- The application (name, file, alias, process number) to send the event to.
[using data record] -- The data to send with the event
menu bar boolean [r/o] -- Should the menu bar be drawn?
one screen boolean [r/o] -- Should screens other than #1 be disabled?
menu mode menus are active/menu bar area usable/menu bar drops down/menu bar drops with modifiers/menu bar deactivated/menu bar is mute/dragging impossible [r/o] -- The “area mode” for Bartender.
bartender settings Tender is the night -- The new settings for Bartender.
Result: Tender is the night -- The current settings (before application of new settings if any).
pen size point -- The size of the pen.
transfer mode small integer -- The drawing mode of graphics borders & lines and text.
text font small integer -- The font of drawn text as a number or the name of the font.
text size small integer -- The size of text drawn.
text face small integer -- The face of the drawn text.
justification left/right/center/flush top left/flush top center/flush top right/flush center left/flush dead center/flush center right/flush bottom left/flush bottom center/flush bottom right [r/o]
pen color string -- The color of the pen in HTML 6-byte format (e.g. "BEAFED").
pen pattern string -- 16-character hex equivalent of a 8x8 bitmap (B&W) pattern.
bg color string -- The color of the background in HTML 24-bit format.
bg pattern string -- See pen pattern
window peek integer [r/o] -- A pointer to the window in memory. Do NOT change or create this!
screen location point [r/o] -- The location of the window (in case you wish to save/restore it)
window dimensions point [r/o] -- The size of the window
canceled boolean [r/o] -- If Apple-’.’ was held down, this is set to TRUE.
user selection bounding rectangle [r/o] -- The selection chosen by the user.
name string [r/o] -- The name of the driver of the monitor
bounds bounding rectangle -- The global coordinates of the monitor.
id small integer [r/o]
bit depth small integer -- The depth of the monitor.
monitor is main boolean [r/o] -- The monitor is the main monitor.
picture bounds bounding rectangle -- The bounds of the picture.
picture size integer [r/o] -- The total data length of the picture.
picture colors integer [r/o] -- An adjusted value for “image colors” - if there are “direct pixel maps” (16/32-bit) in the picture, this will be 2^15 or 2^32 accordingly.
image colors integer [r/o] -- Number of unique colors in the color table portion of the image. This may be inacurate if direct pixel maps are in the image.
image color table a list of RGB color [r/o] -- Color table for optimal CLUT-based drawing.
picture resolution point [r/o] -- Horizontal, Vertical DPI of picture.
image grayscale boolean [r/o] -- Is the image greyscale?
image depth small integer [r/o] -- The deepest pixel encountered in the compressed pixmaps.
image pixmap depth small integer [r/o] -- The deepest pixel encountered in the (compressed) pixmaps.
picture source box bounding rectangle [r/o] -- The rectangle at the given DPI.
picture text count integer [r/o] -- The number of text objects in the picture.
picture line count integer [r/o] -- The number of vector lines in the picture.
picture rect count integer [r/o] -- The number of vector rects in the picture.
picture rounded rect count integer [r/o] -- The number of vector rounded rectangles in the picture.
picture oval count integer [r/o] -- The number of ovals in the picture.
picture arc count integer [r/o] -- The number of arcs drawn in the picture.
picture polygon count integer [r/o] -- The number of polygons drawn in the picture.
picture region count integer [r/o] -- The number of drawn regions.
picture image count integer [r/o] -- The number of images (Pixel Maps).
picture bits count integer [r/o] -- The number of bit maps in the picture (B&W Images).
picture comment count integer [r/o] -- The number of comments.
picture compressed count integer [r/o]
picture compression string [r/o] -- The last compression encountered in compressed pixmaps.
picture compressed quality small integer [r/o] -- The quality of the last encountered compressed pixmap in %.
picture fonts a list of string [r/o] -- A list of the names of the fonts encountered while parsing the picture.
blue box image picture -- The image to blue box.
[using key color RGB color] -- The color to key out (default is white).
[vector regions boolean] -- Use the shapes (if the input picture is created with a "drawing" application, this may produce better results and uses less RAM). Default FALSE.
Result: picture -- The modified (clipped/keyed) image. If you passed a proxy in, nothing is returned.
capture picture
[from Draw Window Rec] -- The drawing window from which you wish to take - if blank, then the screen. If {window peek:0} then the front window as pixels. If (window peek:-1} then the front window with border. Can also be name of a draw or info window.
[pixel conversion boolean] -- Grab the r as pixels instead of vectors (screen source is always pixels).
[at small integer] -- The depth of the offscreen world when grabbing pixels. (32 + x = x bit grey).
[in bounding rectangle] -- The rectangle (or region) you wish to grab (default whole window).
[dithering boolean] -- Dither when going to a lesser depth?
[proxy return boolean] -- Default FALSE - use proxy data to save memory
Result: Proxy Data -- The resulting picture - or Proxy Data if requested.
capture region
[from Draw Window Rec] -- The drawing window from which you wish to take the region - if blank, then the screen.
[pixel conversion boolean] -- Grab the region from non-white pixels instead of vectors (screen source is always pixels).
[in bounding rectangle] -- Clip region to this box.
[using key color RGB color] -- The key color to use when "as pixels" is true. Defaults to white.
[proxy return boolean] -- Default FALSE - use proxy data to save memory
Result: Region Handle -- The region captured.
display drawing Draw Window Rec -- The drawing window (if any) to work with - or the title of an existing drawing window - or a new title to create a new window.
[located at point] -- The location of the window in global coordinates. Use {-1, -1} for default location or {-2,-2} to keep window invisible.
[with dimensions point] -- The size of the window to be created - if present, override picture size.
[starting with picture] -- The picture to begin with - if no dimensions are specified, the window will fit the size of this picture if available.
[flotation boolean] -- Float the window above all others (use NewCServiceWindow instead of NewCWindow).
[disposal boolean] -- Dispose of the drawing window
[a close box boolean] -- Create / Remove the close box by using with/without this parameter.
[a zoom box boolean] -- Create / Remove the zoom box by using with/without this parameter.
[a grow box boolean] -- Create / Remove the grow box by using with/without this parameter.
[as small integer] -- The kind of window you wish to convert it to (be careful and know what you are doing).
Result: Draw Window Rec -- The draw window
display setup a list of Monitor Information Rec -- The [modified] record returned from a previous call.
Result: a list of Monitor Information Rec -- A list of rectangles showing the global display bounds.
extract color
[from string] -- The name of a window.
[in picture] -- The picture (or image file) to extract the pixel from.
[at bounding rectangle] -- The point (or rectangle range) to extract a color from.
Result: RGB color -- The color
print picture picture -- The picture to print.
[in bounding rectangle] -- The bounds you wish to print in.
[with printer config Printer Configuration Rec] -- The printer to use. (Current printer IS restored after print job is finished).
[tiling on the page boolean] -- Tile the picture as many times as fit on the page.
[scaling to page boolean] -- Scale the picture to the maximum proportions that fit on the page.
[multipage begin/iterate/finish] -- Use to start a multipage (and/or multi-image) document, do on same page or finish a multipage document respectively
[on Multipage Document] -- The port (in multipage documents, this should be passed in after the first call returns it).
Result: Multipage Document -- When printing a multipage document, this is returned and must be passed back in
quickdraw a point/a line/a polygon/a box/a rounded box/an oval/an arc/a string/a text box/a picture/a region -- The object to draw
[into Draw Window Rec] -- The Draw Window (or its name) to draw into. If left off, then the first draw window found.
[in bounding rectangle] -- The parameters for the object. See the “Draw Object” enumeration to get the appropriate parameters.
[filling it with nothing/with the pen/by erasing it/by inverting it/with the pattern] -- Fill the object (if pertinent).
[at point] -- The offset to draw at
[with scale point] -- Scale the picture (x,y). Positive values zoom in, negative values zoom out. For Arcs, this is the start angle and end angle of the arc.
[with clip bounding rectangle] -- The region or rectangle you wish to limit any drawing to.
[using data anything] -- The picture, text, pattern or point list or whatever is necessary for the object.
[using state Draw State Rec] -- The style you wish to use for this primitive (it sticks for future primitives until changed).
[recording boolean] -- Default is TRUE, this parameter allows you to draw without becoming part of the picture (faster).
[refresh boolean] -- Refresh the recording - removing some extraneous style information (useful after a lot of vector drawing).
[a clear slate boolean] -- Clear the slate before drawing this object (remove all others).
rotate image picture -- The image to rotate.
[by small integer] -- T
[around point] -- The point around which to rotate the image (relative to the image). Defaults to the center.
[at small integer] -- The DPI to render the image with. Default is 72
[using key color RGB color] -- The color to key out (default is white).
[transparency boolean] -- Should the key color be made transparent (by masking it out with a region)?
Result: picture -- The image after rotation. Unless you passed a proxy in.
scale image picture -- The picture object, proxy or file to scale.
[to bounding rectangle] -- The box to place the image in. Can also be a point, where {0,0} is assumed to be the top left.
[expansion boolean] -- Default TRUE, without expansion, the image will remain at the upper left, its size unchanged, while the frame is changed.
[at small integer] -- The DPI to render the image with. Default is 72
[Result: picture] -- You only get the picture if you provided one. Otherwise, the file (or proxy) will have been modified.
store image picture -- The picture to store (can be type picture, a file with an image or a proxy data for a picture).
[in alias] -- The file to store the image in - leave out to use File Selector.
[as string] -- Defaults to Q. E.g. “JPEG”, “BMPf”, “8BPS”, “qtif”, “TPIC”, “TIFF”, “.SGI”, “PNGf”...
[with percent quality small integer] -- Percent quality from 1 to 100% where applicable (e.g. JPEG) - defaults to 75%.
[overwriting boolean] -- Replace existing file (default is false)?
[appending boolean] -- Add the image to the current picture file by extending it with the new image and adjusting its bounds to include it?
[Result: a list of string] -- A list of {type, name, MIME type} if no parameters specified.
the image from alias -- The image file from which you wish to pull a picture.
[in bounding rectangle] -- The box you wish to scale/clip the image to.
[from bounding rectangle] -- The source bounds of the picture you wish to get.
[as bounding rectangle] -- If you set this parameter, then a lower resolution image can be gotten (e.g. to load a 20MB image into a 128x128 thumb).
[proxy return boolean] -- Default FALSE - use proxy data to save memory
Result: Proxy Data -- A proxy for the picture loaded from the file.
the image type in alias -- The file you wish to check.
Result: string -- A four character ID specifying the kind of file we will convert from - or empty for no import possible through QuickTime.
the matrix made by offsetting/by rotating/by scaling/by skewing/by the identity -- What to do
Result: 'mtrx' -- The result
the picture info for picture -- The picture or picture file in question.
[optimized clut boolean] -- Return the parameter "image color table" in the info record? Default FALSE.
[fonts used boolean] -- Return a list of the fonts encountered in the Picture. Default FALSE.
[black and white boolean] -- Include black & white in color table and image depth (for optimal Mac drawing) - default FALSE.
Result: Picture Info Rec -- Picture info
the region made by the offset/by the mapping/by the union/by the intersection/by the xor/by the difference -- What to do
of region Region Handle -- Region operand 1
[with region Region Handle] -- The second operand region (can be blank if you just want to offset)
[at point] -- An offset applied to the resulting region (or only operand 1 if no operand 2 is provided).
[in bounding rectangle] -- Map the region into this box.
Result: Region Handle -- The resulting region.
thumbnail image
[in file specification] -- The file you wish to get the thumbnail from (or store the thumbnail in - if you provide one).
[from picture] -- The image to save into the file as its thumbnail - or the picture to create a thumbnail for if you don’t provide a file.
[proxy return boolean] -- Default FALSE - use proxy data to save memory
[Result: Proxy Data] -- A proxy for the Picture thumbnail of the file (if not setting the thumbnail with “using”). If no file, but a “using”, then of the picture in “using”
alias zone string [r/o] -- The zone (if any) of the server that holds the volume that holds the file that the alias references.
alias server string [r/o] -- The server that holds the file that the alias references.
alias volume string [r/o] -- The name of the volume on which the file resides that the alias references.
alias folder string [r/o] -- The folder (if any) that holds the file that the alias references.
name string [r/o] -- The name of the file referenced by the alias.
alias identifier string [r/o] -- The ID of the alias. Only used by some applications.
ARA number string [r/o] -- The telephone number of the remote machine (if any).
ARA user string [r/o] -- The user for the RA connection.
ARA password string [r/o] -- The password for the RA user.
vol ref small integer [r/o] -- The volume reference # of the volume on which the file resides.
folder ref integer [r/o] -- The reference # of the folder in which the item resides.
file type string -- The file’s type (or class).
file creator string -- The file’s creator (or order).
finder flags small integer -- Finder flags (isAlias, isStationery etc.)
finder location point -- The info.fdLocation field (Position of Icon / Folder Window)
catalog flags small integer [r/o] -- A conglomerate of the catalog flags (bitwise). Includes “catalog locked state” etc.
creation date date -- T
modification date date -- Modification date of file system object
archival date date -- Date of last backup
kind nothing/a folder/a file/an alias [r/o] -- The kind of object
name string [r/o] -- The name of the file
<Inheritance> Folder Info Rec [r/o] -- The basic information.
shared status boolean -- Can item be shared over a network (multiply launched)?
initted status boolean -- Has the bundle been recorded?
custom icon status boolean -- Does the item have a custom icon?
stationery status boolean -- Is the item stationery?
locked name status boolean -- Is the name locked?
bundle status boolean [r/o] -- For files, indicates that icons for specific files are stored. For folders in MacOS 9 and later, this indicates the “package” status of the folder.
invisible status boolean -- Is the item invisible to normal viewing?
label number small integer -- The label number chosen for the file (0 to 7).
item spec alias [r/o]
parent spec alias [r/o]
vol name string [r/o] -- The name of the volume upon which the item resides.
desktop comment string -- The desktop comment for the file (if explicitly requested).
short version string [r/o] -- the version string for the file (from the Finder’s ‘Get Info’ box)
long version string [r/o] -- the long version string for the file (from the Finder’s ‘Get Info’ box)
vol ref small integer [r/o] -- The reference number of the volume (changes between mounts).
folder ref integer [r/o] -- The reference # of the folder in which the item resides.
name string [r/o] -- The name of the item
<Inheritance> Catalog Info Rec [r/o] -- The setable information.
catalog busy state boolean [r/o] -- If true, the file is open on this machine.
catalog locked state boolean -- Is the file locked?
catalog protected state boolean -- Is the file AppleShare protected?
data fork length integer [r/o] -- Length of the data fork of this file.
resource fork length integer [r/o] -- Length of the resource fork.
fsi server info1 integer
fsi server info2 integer
fsi server info3 integer
fsi server info4 integer
fsi server data 'tdta' [r/o]
<Inheritance> Catalog Info Rec [r/o] -- The setable information.
number of items within integer [r/o] -- The number of items inside (if a folder).
finder window box bounding rectangle -- The folder’s window bounds when opened
finder view setting small integer -- The arbitrary view setting.
finder view columns a list of Finder Column -- This is a list of the columns viewable in the finder for a given folder - ONLY RETURNED with “extended info”. You may rearrange the order and change the width or visible properties. WARNING - moving the name out of first position may make Finder display b
finder window scroll point -- The scroll setting of the window of the folder when open.
AkuaCopy alias -- File to copy
to alias -- This may be an alias to a folder itself or a file within that folder.
[overwriting boolean] -- Overwrite existing destination file?
[resuming boolean] -- Resume a broken copy?
[alias resolution boolean] -- Resolve source file if it is an alias file? Default is FALSE.
[faster operation boolean] -- Take over the machine for the copy!
[progress display boolean] -- Show a progress window? Default TRUE.
[located at point] -- The global location of the window - can be restored from previous "screen location" of return record.
Result: point -- The location of the progress window at the end of the operation.
a new alias for file specification -- The file or folder to make the new alias for.
[from file specification] -- The file/folder to make the alias relative to.
[in file specification] -- A place to store the new alias (a new or existing alias file).
Result: alias -- The alias.
a new file
[in alias] -- The folder to contain the new file. Optional - will use temp folder on volume with most free writable space if not given.
[named string] -- The file's name. Optional - will use a time/date stamp if not given.
[of type string] -- The four-character type (default is "TEXT")
[with creator string] -- A 4-character creator ID (default is "ttxt" for SimpleText).
[overwriting boolean] -- I
[resource fork boolean] -- Create a resource file?
[temporary status boolean] -- Create the file in the Temporary folder of the volume referenced by "in".
[with prompt string] -- Show a file selector and let user choose where it should go (like “Choose file”).
[navigation services boolean] -- Default is TRUE them if available
Result: file specification -- The file created.
alias info from alias -- The alias from which the information should be extracted. (see also - load alias from)
Result: Alias Info Rec -- The alias information stored in the alias.
apply catalog info Catalog Info Rec -- The file/folder info (from basic or extended info for).
to file specification -- The file to which the (modified) catalog info should be applied.
basic info for alias -- File / Folder / List of files & folders (as alias, file, text or whatever).
Result: Catalog Info Rec -- The FInfo & Lengths for the file - the stuff you need for a copy
close fork small integer -- The reference from “the open fork of”
[flushing boolean] -- Flush the disk’s cache after closing the file.
collate a list of file specification -- The file (or folder, or list of files & folders) to act on.
[by renaming it to string] -- The new name of the file.
[by moving it to file specification] -- Move the file to the same place as this file (or to this folder)
[deletion boolean] -- Delete the file.
[the trasher boolean] -- Move the file/folder to the trash.
Result: alias -- The resulting file system object.
display selector
[from file specification] -- The starting point for this (or the next) file selection - only in the Application told to do this.
[of type a list of list] -- restrict the files shown to only these file types (up to 4 for traditional)
[with prompt string] -- Show a file selector and let user choose where it should go (like “Choose file”, except our Nav Services is growable).
[for type class] -- What you want to choose: file/folder/volume
[multiple choices boolean] -- Allow multiple items to be selected
[navigation services boolean] -- Default is TRUE (i.e. use them if available)
[invisibles boolean] -- Should invisible files be included (default FALSE).
[Result: alias] -- The object(s) chosen if a prompt is provided.
extended info for alias -- File / Folder / List of files & folders
[server attributes boolean] -- Include server attributes?
[desktop comment boolean] -- Include desktop comment?
Result: Extended Info Rec -- An extended info record.
load alias from alias -- An alias to the alias file.
[resolving aliases boolean] -- Default is FALSE - if this parameter is set, the alias is followed one link. You give an alias, an alias is loaded from the alias file it describes. That alias is resolved once to find the file it points to.
[following aliases boolean] -- Return the non-alias file/folder? Default FALSE. This will resolve all the way to the original item - if possible.
[ever using dialogs boolean] -- Set this to FALSE to avoid a user/password dialog from ever appearing. Server aliases will fail if volumes are not mounted.
Result: alias -- The alias stored in the file.
open fork from alias -- The file to open a fork of.
[write access boolean] -- Open with write access?
[resource fork boolean] -- Read the resource fork (as a data fork)
[named string] -- Create a new file with this name - if you give a folder as the direct parameter.
[extended by string] -- Create a new file by adding this extension to the name
[of type string] -- The file type to create file with if nonexistant.
[with creator string] -- The application who should own the file (if new).
[overwriting boolean] -- If the file already exists, you will get a “duplicate file name” error unless you provide this parameter which will erase the file if it exists.
Result: small integer -- The reference (> 0 for successful open fork)
read data from small integer -- File, Alias or Fork reference from “open fork from”
[at integer] -- The s into the file from which to read
[for integer] -- T
[as type class] -- Return the data as this type (instead of d) - do not fake it, or you may crash!
[from integer] -- The line number to read (from a text file).
[resource fork boolean] -- Read from the resource fork (as a data fork)
Result: anything -- The chunk of data read from the file as ‘tdta’ or text.
resolve chain alias -- Alias File Alias
[as user name string] -- The User will be entered into the “Name” field of the “L” dialog. (Use “” for the User to login as “Guest”).
[with password string] -- The Password will be entered into the “Password” field of the “L” dialog.
[with volume password string] -- Volume password for NT servers. Untested since we don’t have an NT server.
[from file specification] -- Resolve the alias relative to this file.
[ever using dialogs boolean] -- Set this to FALSE to avoid a user/password dialog from ever appearing. Server aliases will fail if volumes are not mounted. Only for MacOS 8.5 or newer.
Result: alias -- The resulting file - may be the same as the original if the original was not an alias file.
size fork small integer -- The reference from “open fork from”
[to integer] -- The new length of the fork (leave out or use -1 to inquire).
[reservation boolean] -- Only reserve the space, don't extend the logical length of the fork. (Allocate)
Result: integer -- The length of the fork if no parameter
the kind of entry in alias -- Parent folder alias
named string -- Name of object to check for
[creation boolean] -- Set this to TRUE to have a folder created if no object exists with this name.
Result: nothing/a folder/a file/an alias -- Kind of object found (or created if specified)
write data to small integer -- Alias, File, or Fork Reference from “open fork from”
from anything -- The data to write - from read b from.
[at integer] -- The b
[to integer] -- The line number to replace or create (in a text file)
[of type string] -- The file type to create file with if non-existant.
[with creator string] -- The application who should own the file (if new).
[overwriting boolean] -- When “at 0” is also used, this overwrites the fork only - otherwise the entire file is replaced.
[resource fork boolean] -- Write to the resource fork (as a data fork) - KNOW WHAT YOU ARE DOING!
Result: integer -- Length of file after write was done.
view property -- What is displayed
size small integer -- The width of the column
index small integer [r/o] -- The order index of this item. I.e. #1 is first from left to right, #2 is second...
visible boolean -- Is the column shown?
fsi owner ID integer -- Owner ID of the folder.
fsi group ID integer -- U&G Group
fsi user rights string -- “R” for “Read”, “W” for “Write”, “S” for “Search”, “B” for “Blank”, “O” for Owner.
fsi everyone rights string -- Ditto
fsi group rights string -- Ditto
fsi owner rights string -- Ditto
fsi deny modes small integer [r/o] -- Things denied
fsi path rights small integer [r/o] -- Rights inherited.
vol ref small integer [r/o] -- The reference number of the volume (changes between mounts).
name string [r/o] -- The name of the volume.
kind HFS volume/HFS plus volume/AFP volume/FAT Volume/Unknown File System [r/o] -- The kind of this volume.
creation date date [r/o] -- The date the volume was initialized.
modification date date [r/o] -- The last time the volume was modified.
archival date date [r/o] -- The last date the volume was archived.
vol attributes small integer [r/o] -- The attribute bits of the volume.
vol device kind standard disk volume/tape volume/printer volume/processor volume/worm volume/cd volume/floppy disk volume/scanner volume/image volume/removable disk volume [r/o] -- The kind of device the volume resides on.
vol mount attributes integer [r/o] -- Mount attributes for the volume.
vol speed integer [r/o] -- The relative speed of the volume (smaller is better).
vol block size integer [r/o] -- The size of an allocation block on the volume (the size of the smallest file).
vol total blocks integer [r/o] -- The total number of blocks on the volume.
vol free blocks integer [r/o] -- The number of free blocks on the volume.
vol total bytes double integer [r/o] -- Total bytes on volume
vol free bytes double integer [r/o] -- Total free bytes on volume.
vol drive number small integer [r/o] -- The info flags together.
vol read only boolean [r/o] -- Is the volume read only?
vol busy boolean [r/o] -- Does the volume have files open?
vol removable boolean [r/o] -- Is the volume removable (i.e. Jaz, Zip, Floppy, CD, Syquest).
vol ejectable boolean [r/o] -- Not sure at the moment what the difference is between “Ejectable” and “Removable”
vol is server boolean [r/o] -- Does the volume support server attributes (like protected from extended info).
vol driver ref small integer [r/o] -- The reference number of the driver of the volume.
vol driver name string [r/o] -- The name of the driver of the volume.
vol alias alias [r/o] -- An alias to the volume's root directory.
a new folder in file specification -- The folder in which to make the new folder.
named string -- Create the new folder with this name.
Result: alias -- The folder created.
apply catalog info Catalog Info Rec -- The file/folder info (from basic or extended info for).
to file specification -- The file to which the (modified) catalog info should be applied.
default startup disk a list of small integer -- A list of parameters defining the startup device.
Result: a list of small integer -- A list of 4 parameters defining the startup device. I would suggest only using something you've gotten before... {Device, Partition, Slot, Rsrc} or {Rsvd, Rsvd, ScsiRef1, ScsiRef2}
disk volume info
[for file specification] -- Anything on the volume whose info should be returned.
[volume ref small integer] -- The volume reference number (start at -1 and go down). Use > 0 for fixed drive numbers (these do not change between restarts).
[volume index small integer] -- The volume index - you can start at 1 and count up until you get an error.
[volume named string] -- The name of the volume. Returns "Duplicate File Name" if there are two volumes with the same name.
Result: Volume Info Rec -- The information record(s)
expel file specification -- Any object on the volume
[volume ref small integer] -- The volume reference number - start at -1. ( > 0 will cause a mount of the drive of that "drive number").
[volume index small integer] -- The volume index - you can start at 1 and count up until you get an error.
[volume named string] -- The name of the volume. Returns "Duplicate File Name" if there are two volumes with the same name.
[physically ejecting it boolean] -- Default is true, setting it to false will keep the disk in the drive.
[unmounting it boolean] -- Remove the desktop icon? (Default is true).
the entries in file specification -- The folder to list.
[from point] -- The start and count to return (if memory is low, maybe you want to get 20 at a time in a loop). E.g. from {1,20}, then from {21, 20}, {41,20} etc. Negation does NOT apply. Use a negative {-1, 20} for a random entry. {-1, 0} for any random entry.
[whose types are in a list of string] -- The four letter types that the items must match (use “fold” for folders).
[whose creators are in a list of string] -- The four letter application ID that the items must have.
[whose labels are in a list of small integer] -- A list of labels to match. No label is 0.
[that were created after date] -- Creation date is on or after this date
[that were created before date] -- Ditto for before
[that were modified after date] -- Items whose modification date is on or after this date.
[that were modified before date] -- Ditto for before
[that were archived after date] -- Items who backed up on or after this date.
[that were archived before date] -- Ditto for before
[whose names match string] -- A regular expression (see “collect lines”) restricting names.
[whose kinds are nothing/a folder/a file/an alias] -- Only return items if they are this kind (a file, an alias, a folder).
[visibility boolean] -- Limit results to only those items whose visibility is as specified. (As opposed to including both with the "invisibles" option.)
[resolving aliases boolean] -- Default is TRUE - this determines whether or not alias files should be listed instead of the entries they refer to. Only available for “as file” or “as alias”.
[following aliases boolean] -- Follow aliases to folders into them when going deep. Default FALSE.
[ever using dialogs boolean] -- Set this to FALSE to avoid a user/password dialog from ever appearing. Server aliases will fail if volumes are not mounted.
[invisibles boolean] -- Should invisible files be included (default FALSE).
[busy files boolean] -- Include busy files? Default is TRUE.
[locked files boolean] -- Include locked files (default TRUE).
[to a depth of small integer] -- Follow subfolders up to this many levels deep. Default is 0, -1 uses the maximum.
[as type class] -- The kind of items returned. Default is string. You can optionally request alias or file items.
[negation boolean] -- Return the opposite (the items that don't match). Does NOT apply to the “from” range.
[tasking boolean] -- Without tasking goes faster than with, but windows can not be moved. Default FALSE.
[for script] -- Instead of returning them, process each item with this script.
Result: a list of string -- A list of the names of items that match the query.
the files in use
[on alias] -- The volume (or anything on the volume) you wish to restrict the list to.
[on volume ref small integer] -- The volume reference number - start at -1. ( > 0 will cause a mount of the drive of that "drive number").
[on volume index small integer] -- The volume index - you can start at 1 and count up until you get an error.
[on volume named string] -- The name of the volume. Returns "Duplicate File Name" if there are two volumes with the same name.
Result: a list of file specification -- A list of the matching files.
verify path string -- The path string.
[to string] -- The four character identifier of a folder (e.g. path to) on the startup volume (or the “in” volume if given). Special code “/tmp” for temp items folder on disk with most space available.
[in alias] -- The file/folder from which to start a path if its first character is a ":" (or not a "/" in unix mode).
[unix delimiters boolean] -- (Default false) The path is Unix-Style ("/MyDIsk/MyFold1/etc/") instead of Mac-Style ("MyDisk:MyFold1:etc:").
Result: alias -- An alias to the lowest folder in the hierarchy.
HTT rows integer [r/o]
HTT columns integer [r/o]
HTT '????' [r/o]
add table row/column/cell -- What to add
[at point] -- The coordinates of the cell (if appropriate).
[using data string] -- The data to add in the cell (if appropriate).
[to HTML Table Rec] -- The table to modify. Leave empty to create a new table with coordinates in "at". E.g set newTbl to (add table cell at {3, 10})
Result: HTML Table Rec -- The changed table.
compile ML a list of string -- The parsed ML list.
[unix line breaks boolean] -- Use unix line feeds to break lines.
[mac line breaks boolean] -- Use "return" to break lines. (Use unix and mac for DOS LF/CR line breaks).
Result: string -- The new HTML text.
compile table HTML Table Rec -- The table to compile.
[into a list of string] -- The parsed ML into which to compile the table.
compile tag a list of string -- The parsed ML list.
Result: string -- The new HTML tag.
compile tag val a list of string -- A 2-item list (see parse tag val).
parse ML string -- The HTML text to parse.
Result: a list of string -- List of {"<A", "H", "</HTML>"…
parse table string -- The NAME tag of the table you wish to parse.
Result: HTML Table Rec -- The table.
parse tag string -- The HTML text to parse.
Result: a list of string -- List of {"<A", "HREF=url"} etc. (1 list for each tag)
parse tag val string -- The "Tag=Val" item.
[tag item boolean] -- Return {tag, value} as a list.
Result: anything -- May return an integer (if all digits) or a string or a list if "with tag item" is specified.
resolve SRC tag string -- The "SRC=../../x/myFile.jpg" tag.
[relative to file file specification] -- The file to start the search from (i.e. the HTML source file from which the tag comes). If the path starts with "/", then this is ignored.
Result: file specification -- The file found.
name string [r/o] -- I hope I’m not walking on toes with this element...
collapse on double boolean [r/o] -- WindowShade on title-double-click?
desktop picture files a list of alias -- Optional desktop picture(s) - always a list of pictures for each monitor.
desktop picture alignment a list of integer -- How to align picture (arbitrary constant from alignment menu in Appearance CP).
theme hilite color RGB color -- Nuff said.
theme large system font string -- ditto
theme desktop pattern name string -- …
theme desktop pattern Pixel Pattern -- …
theme scroll options small integer -- I’m guessing.
theme shade options small integer -- Guessing again.
theme smooth fonts boolean -- obvious
theme smooth size small integer -- Smallest font size to smooth
theme small system font string -- …
theme sounds mask integer -- 32-bits, flags indicating which actions are given sounds (-1 for all).
theme sounds boolean -- Sounds on/off.
theme soundscape string -- The “sound theme” used.
theme base file name string -- On which base theme is this theme based :)
kind button control/scroll control/custom control [r/o] -- The kind of the control.
name string -- The name of the control
enabled boolean -- Active?
control value small integer -- Current value.
control minimum small integer -- The minimum value
control maximum small integer -- Hmmm
bounds bounding rectangle -- The bounds in local coordinates
owner integer [r/o] -- The window the control resides in.
bounds bounding rectangle -- The bounds of the item
name string -- The name/title of the item
kind 'FmEn' [r/o] -- The kind of element
kind button down event/button up event/key down event [r/o] -- The kind of event (only if sent to you).
conglomerate integer [r/o] -- A mix of all the values (to see if something has changed).
pointer location point -- Global coordinates of the pointer.
modifier keys string
transient keys string
button down boolean
caps locked boolean
raw keys down string [r/o] -- The keys currently down ignoring shift, option & caps lock.
window under mouse string [r/o] -- The window (if any) under the mouse
window coordinates point [r/o] -- The location of the mouse relative to the above window’s top-left.
window part under mouse small integer [r/o]
<Inheritance> Menu Shortcut Rec -- Individual Transient Modifier Keys
name string [r/o] -- The name of the menu item.
menu item mark boolean [r/o] -- Is the item marked? If not, this is an empty string.
menu item icon Icon Suite [r/o] -- The item’s icon or 0 if none.
keys down string [r/o] -- The non-modifier keys currently down
command key bit boolean [r/o]
option key bit boolean [r/o]
control key bit boolean [r/o]
shift key bit boolean [r/o]
fn key bit boolean [r/o] -- Only on some funky powerbooks.
Menu Selection a list of string -- A list containing {MenuTitle, MenuItemHit, InputStateAtHit, {itemNum, menuID}}.
Window Action a list of string -- A {window title, action, object} pair to indicate which action was activated. If class of action is string, then it was a window part like “Close” or “Zoom” - or a “Key” - or a “Drag”
click on control Control Rec -- The control (or name of the control) to click on.
[of string] -- The title of the window the control resides in - if you pass a Control Rec from “the controls of window”, this is not necessary.
[at point] -- Offset the click by this coordinate.
Result: Control Rec -- The resulting control.
edit menu string -- The title of the menu to modify
[adding a list of string] -- Items to add to the menu
[at string] -- The name/number of the item after which to add the items.
[removing a list of string] -- The item(s) to remove from the menu (don’t remove items from apps or the items below may no longer work - disable them instead).
[setting the state of a list of string] -- The items to disable/enable - use “without enabling” or “with enabling” in addition to this parameter.
[enabling boolean] -- Enable the state (with enabling) or disable (without enabling).
[setting the mark of a list of string] -- Set the mark of the item(s) - use the “to” parameter to choose which mark.
[renaming string] -- The name or number of the item to rename. Use 0 or “*” for the title of the menu.
[to string] -- The name to change the item to - or the mark to use when marking. Leave off for unmarking (or use “”), use “*” for a checkmark, “^” for a diamond.
[shortcutting string] -- The name/number of the item to add a shortcut to.
[by Menu Shortcut Rec] -- The Keyboard equivalent for the “shortcut item”.
[removal boolean] -- Remove the p
[disposal boolean] -- Dispose of the menu (clear from RAM) - IT BETTER BE YOURS!
[depending on boolean] -- Set the mark to the first character if TRUE, else second character - or if only one character mark, then clear if FALSE - else set.
[controlled by script] -- Send events generated by the menu (item) to this process or script. If editing another app, you must use (frontmost process with currency) or (path to me) or a scripts object’s name or a compiled script file here.
Result: point -- The number of the menu & the number of the last item touched - or {0,0} if item(s) not found.
input state Input State Rec -- The input you wish to post as if user input (if any). Use a Rect instead of a point as the location (with button:down) to drag a box (or double click if the top-left and bottom-right are the same). Use button:false to click at the location given (instead
[background check boolean] -- Defaults to TRUE, this ignores modifier keys when in the background.
Result: Input State Rec -- The current state of affairs.
insert menu string -- The title of the menu to insert. An “Icon Suite” (or a picture that will be coerced) can be used instead to have an icon as the title.
[with items string] -- The menu items (return or semi-colon separated) to add to menu. Use /X in the text of an item to add a command key X. Use "®XXXX" for a resource menu (e.g. ®FONT" for a fonts menu).
[controlled by script] -- Send events generated by the menu to this process or script. If inserting in another app, you must use (frontmost process with currency) or (path to me) or a script object’s name or a compiled script file here.
[total control boolean] -- Send all menu selections (except System Menus and Apple Menu > 1) to the controlling process.
[system menus boolean] -- Add the menu to the right in all applications.
[expression evaluation boolean] -- Ignore formatting parse (e.g. if you got your items from file names or something where you don’t know what the text may contain and don’t want “/X” to be Cmd-X or “<B” to indicate bold etc.)
[Result: small integer] -- The menu number of the created menu.
puppet menu a list of string -- The {title, item} of the menu to pull. EIther or both may be numbers if you wish to have the script work internationally.
reposition window string -- The name of the window to move. You can also pass a number here for the index of the window from front to back (e.g. 1 is front window). Use -1 for ALL windows (e.g. collapsing).
[to point] -- The location you want to move it to (or pass a rectangle to resize as well).
[activation boolean] -- Activate the window (bringing it to the front and highlighting it)?
[a close box boolean] -- Create / Remove the close box by using with/without this parameter.
[a zoom box boolean] -- Create / Remove the zoom box by using with/without this parameter.
[a grow box boolean] -- Create / Remove the grow box by using with/without this parameter.
[collapsing boolean] -- Collapse (or expand) a window (under Appearance Manager, not System 7).
[as small integer] -- The kind of window you wish to convert it to (be careful and know what you are doing).
[titled string] -- A new name for the window (if any).
Result: bounding rectangle -- The new bounds of the window.
set menu bar visibility to boolean -- TRUE to show it, FALSE to hide it.
Result: boolean -- What to restore the state to when done.
the active menus
[named string] -- Only if the title of the menu is this.
[numbered small integer] -- Only if the ID of the menu is this.
[item names boolean] -- Include the items with each title?
[numbers boolean] -- Include the ID of the menus and the index with each item?
[hierarchal menus boolean] -- Include hierarchal menus?
[system menus boolean] -- A
[item status boolean] -- Return the item status?
Result: a list of string -- A list of the menus currently in the menu bar.