The FooDoo Lounge

Finder 10.3 Dictionary

™ and © 1983-2003 Apple Computer Inc., All rights reserved.

Index

  1. Standard Suite
  2. Finder Basics
  3. Finder items
  4. Containers and folders
  5. Files
  6. Window classes
  7. Legacy suite
  8. Type Definitions

Standard Suite: Common terms that most applications should support

Events:

close: Close an object

close reference -- the object to close

count: Return the number of elements of a particular class within an object

count reference -- the object whose elements are to be counted

each type class -- the class of the elements to be counted

Result: integer -- the number of elements

data size: Return the size in bytes of an object

data size reference -- the object whose data size is to be returned

[as type class] -- the data type for which the size is calculated

Result: integer -- the size of the object in bytes

delete: Move an item from its container to the trash

delete reference -- the item to delete

Result: reference -- to the item that was just deleted

duplicate: Duplicate one or more object(s)

duplicate reference -- the object(s) to duplicate

[to location reference] -- the new location for the object(s)

[replacing boolean] -- Specifies whether or not to replace items in the destination that have the same name as items being duplicated

[routing suppressed boolean] -- Specifies whether or not to autoroute items (default is false). Only applies when copying to the system folder.

Result: reference -- to the duplicated object(s)

exists: Verify if an object exists

exists reference -- the object in question

Result: boolean -- true if it exists, false if not

make: Make a new element

make

new type class -- the class of the new element

at location reference -- the location at which to insert the element

[to reference] -- when creating an alias file, the original item to create an alias to or when creating a file viewer window, the target of the window

[with properties record] -- the initial values for the properties of the element

Result: reference -- to the new object(s)

move: Move object(s) to a new location

move reference -- the object(s) to move

to location reference -- the new location for the object(s)

[replacing boolean] -- Specifies whether or not to replace items in the destination that have the same name as items being moved

[positioned at list] -- Gives a list (in local window coordinates) of positions for the destination items

[routing suppressed boolean] -- Specifies whether or not to autoroute items (default is false). Only applies when moving to the system folder.

Result: reference -- to the object(s) after they have been moved

open: Open the specified object(s)

open reference -- list of objects to open

[using reference] -- the application file to open the object with

[with properties record] -- the initial values for the properties, to be included with the open command sent to the application that opens the direct object

print: Print the specified object(s)

print reference -- list of objects to print

[with properties record] -- optional properties to be included with the print command sent to the application that prints the direct object

quit: Quit the Finder

quit

select: Select the specified object(s)

select reference -- the object to select

Finder Basics: Commonly-used Finder commands and object classes

Classes:

Class application: The Finder

Elements:

item by numeric index, before/after another element, by name, as a range of elements, satisfying a test

container by numeric index, by name

disk by numeric index, by name, by ID

folder by numeric index, by name, by ID

file by numeric index, by name

alias file by numeric index, by name

application file by numeric index, by name, by ID

document file by numeric index, by name

internet location file by numeric index, by name

clipping by numeric index, by name

package by numeric index, by name

window by numeric index, by name

Finder window by numeric index, by ID

clipping window by numeric index, by name

Properties:

clipboard reference [r/o] -- (NOT AVAILABLE YET) the Finder’s clipboard window

name international text [r/o] -- the Finder’s name

visible boolean -- Is the Finder’s layer visible?

frontmost boolean -- Is the Finder the frontmost process?

selection reference -- the selection in the frontmost Finder window

insertion location reference [r/o] -- the container in which a new folder would appear if “New Folder” was selected

product version Unicode text [r/o] -- the version of the System software running on this computer

version Unicode text [r/o] -- the version of the Finder

startup disk disk [r/o] -- the startup disk

desktop desktop-object [r/o] -- the desktop

trash trash-object [r/o] -- the trash

home folder [r/o] -- the home directory

Finder preferences preferences [r/o] -- (NOT AVAILABLE YET) Various preferences that apply to the Finder as a whole

Events:

copy: (NOT AVAILABLE YET) Copy the selected items to the clipboard (the Finder must be the front application)

copy

sort: (NOT AVAILABLE YET) Return the specified object(s) in a sorted list

sort reference -- a list of finder objects to sort

by property -- the property to sort the items by (name, index, date, etc.)

[Result: reference] -- the sorted items in their new order

Finder items: Commands used with file system items, and basic item definition

Classes:

Class item: An item

Plural form:

items

Properties:

name Unicode text -- the name of the item

displayed name Unicode text [r/o] -- the user-visible name of the item

name extension Unicode text [r/o] -- the name extension of the item (such as “txt”)

extension hidden boolean -- Is the item's extension hidden from the user?

index integer [r/o] -- the index in the front-to-back ordering within its container

container reference [r/o] -- the container of the item

disk reference [r/o] -- the disk on which the item is stored

position point -- the position of the item within its parent window (can only be set for an item in a window viewed as icons or buttons)

bounds bounding rectangle -- the bounding rectangle of the item (can only be set for an item in a window viewed as icons or buttons)

label index integer -- the label of the item

locked boolean -- Is the file locked?

kind Unicode text [r/o] -- the kind of the item

description Unicode text [r/o] -- a description of the item

comment Unicode text -- the comment of the item, displayed in the “Get Info” window

size double integer [r/o] -- the logical size of the item

physical size double integer [r/o] -- the actual space used by the item on disk

creation date date [r/o] -- the date on which the item was created

modification date date -- the date on which the item was last modified

icon icon family -- the icon bitmap of the item

URL Unicode text [r/o] -- the URL of the item

owner Unicode text -- the user that owns the container

group Unicode text -- the user or group that has special access to the container

owner privileges read only/read write/write only/none

group privileges read only/read write/write only/none

everyones privileges read only/read write/write only/none

information window reference [r/o] -- the information window for the item

properties record -- every property of an item

class type class [r/o] -- the class of the item

Events:

add to favorites: (NOT AVAILABLE YET) Add the items to the user’s Favorites

add to favorites reference -- the items to add to the collection of Favorites

clean up: (NOT AVAILABLE YET) Arrange items in window nicely (only applies to open windows in icon view that are not kept arranged)

clean up reference -- the window to clean up

[by property] -- the order in which to clean up the objects (name, index, date, etc.)

eject: Eject the specified disk(s)

eject reference -- the disk(s) to eject

empty: Empty the trash

empty reference -- “empty” and “empty trash” both do the same thing

erase: (NOT AVAILABLE) Erase the specified disk(s)

erase reference -- the items to erase

reveal: Bring the specified object(s) into view

reveal reference -- the object to be made visible

update: Update the display of the specified object(s) to match their on-disk representation

update reference -- the item to update

[necessity boolean] -- only update if necessary (i.e. a finder window is open). default is false

[registering applications boolean] -- register applications. default is true

Containers and folders: Classes that can contain other file system items

Classes:

Class container: An item that contains other items

Plural form:

containers

Elements:

item by numeric index, by name

container by numeric index, by name

folder by numeric index, by name, by ID

file by numeric index, by name

alias file by numeric index, by name

application file by numeric index, by name, by ID

document file by numeric index, by name

internet location file by numeric index, by name

clipping by numeric index, by name

package by numeric index, by name

Properties:

<Inheritance> item [r/o] -- inherits some of its properties from the item class

entire contents reference [r/o] -- the entire contents of the container, including the contents of its children

expandable boolean [r/o] -- (NOT AVAILABLE YET) Is the container capable of being expanded as an outline?

expanded boolean -- (NOT AVAILABLE YET) Is the container opened as an outline? (can only be set for containers viewed as lists)

completely expanded boolean -- (NOT AVAILABLE YET) Are the container and all of its children opened as outlines? (can only be set for containers viewed as lists)

container window reference [r/o] -- the container window for this folder

Class desktop-object: Desktop-object is the class of the “desktop” object

Elements:

item by numeric index, by name

container by numeric index, by name

disk by numeric index, by name

folder by numeric index, by name, by ID

file by numeric index, by name

alias file by numeric index, by name

application file by numeric index, by name, by ID

document file by numeric index, by name

internet location file by numeric index, by name

clipping by numeric index, by name

package by numeric index, by name

Properties:

<Inheritance> container [r/o] -- inherits some of its properties from the container class (NOTE: some container properties are not valid for the desktop)

Class disk: A disk

Plural form:

disks

Elements:

item by numeric index, by name

container by numeric index, by name

folder by numeric index, by name, by ID

file by numeric index, by name

alias file by numeric index, by name

application file by numeric index, by name, by ID

document file by numeric index, by name

internet location file by numeric index, by name

clipping by numeric index, by name

package by numeric index, by name

Properties:

<Inheritance> container [r/o] -- inherits some of its properties from the container class

capacity double integer [r/o] -- the total number of bytes (free or used) on the disk

free space double integer [r/o] -- the number of free bytes left on the disk

ejectable boolean [r/o] -- Can the media be ejected (floppies, CD's, and so on)?

local volume boolean [r/o] -- Is the media a local volume (as opposed to a file server)?

startup boolean [r/o] -- Is this disk the boot disk?

format Mac OS format/Mac OS Extended format/UFS format/NFS format/audio format/ProDOS format/MS-DOS format/NTFS format/ISO 9660 format/High Sierra format/QuickTake format/Apple Photo format/AppleShare format/UDF format/WebDAV format/FTP format/... [r/o] -- the filesystem format of this disk

journaling enabled boolean [r/o] -- Does this disk do file system journaling?

ignore privileges boolean -- Ignore permissions on this disk?

Class folder: A folder

Plural form:

folders

Elements:

item by numeric index, by name

container by numeric index, by name

folder by numeric index, by name, by ID

file by numeric index, by name

alias file by numeric index, by name

application file by numeric index, by name, by ID

document file by numeric index, by name

internet location file by numeric index, by name

clipping by numeric index, by name

package by numeric index, by name

Properties:

<Inheritance> container [r/o] -- inherits some of its properties from the container class

Class trash-object: Trash-object is the class of the “trash” object

Elements:

item by numeric index, by name

container by numeric index, by name

folder by numeric index, by name, by ID

file by numeric index, by name

alias file by numeric index, by name

application file by numeric index, by name, by ID

document file by numeric index, by name

internet location file by numeric index, by name

clipping by numeric index, by name

package by numeric index, by name

Properties:

<Inheritance> container [r/o] -- inherits some of its properties from the container class

warns before emptying boolean -- Display a dialog when emptying the trash?

Files: Classes representing files

Classes:

Class alias file: An alias file (created with “Make Alias”)

Plural form:

alias files

Properties:

<Inheritance> file [r/o] -- inherits some of its properties from the file class

original item reference -- the original item pointed to by the alias

Class application file: An application's file on disk

Plural form:

application files

Properties:

<Inheritance> file [r/o] -- inherits some of its properties from the file class

suggested size integer [r/o] -- the memory size with which the developer recommends the application be launched

minimum size integer -- the smallest memory size with which the application can be launched

preferred size integer -- the memory size with which the application will be launched

accepts high level events boolean [r/o] -- Is the application high-level event aware? (OBSOLETE: always returns true)

has scripting terminology boolean [r/o] -- Does the process have a scripting terminology, i.e., can it be scripted?

opens in Classic boolean -- Should the application launch in the Classic environment?

Class clipping: A clipping

Plural form:

clippings

Properties:

<Inheritance> file [r/o] -- inherits some of its properties from the file class

clipping window reference [r/o] -- (NOT AVAILABLE YET) the clipping window for this clipping

Class document file: A document file

Plural form:

document files

Properties:

<Inheritance> file [r/o] -- inherits some of its properties from the file class

Class file: A file

Plural form:

files

Properties:

<Inheritance> item [r/o] -- inherits some of its properties from the item class

file type type class -- the OSType identifying the type of data contained in the item

creator type type class -- the OSType identifying the application that created the item

stationery boolean -- Is the file a stationery pad?

product version Unicode text [r/o] -- the version of the product (visible at the top of the “Get Info” window)

version Unicode text [r/o] -- the version of the file (visible at the bottom of the “Get Info” window)

Class internet location file: An file containing an internet location

Plural form:

internet location files

Properties:

<Inheritance> file [r/o] -- inherits some of its properties from the file class

location Unicode text [r/o] -- the internet location

Class package: A package

Plural form:

packages

Properties:

<Inheritance> item [r/o] -- inherits some of its properties from the item class

Window classes: Classes representing windows

Classes:

Class Finder window: A file viewer window

Plural form:

Finder windows

Properties:

<Inheritance> window [r/o] -- inherits some of its properties from the window class

target reference -- the container at which this file viewer is targeted

current view icon view/list view/column view -- the current view for the container window

icon view options icon view options [r/o] -- the icon view options for the container window

list view options list view options [r/o] -- the list view options for the container window

toolbar visible boolean -- Is the window's toolbar visible?

Class clipping window: The window containing a clipping

Plural form:

clipping windows

Properties:

<Inheritance> window [r/o] -- inherits some of its properties from the window class

Class information window: An inspector window (opened by “Show Info”)

Properties:

<Inheritance> window [r/o] -- inherits some of its properties from the window class

item reference [r/o] -- the item from which this window was opened

current panel General Information panel/Sharing panel/Memory panel/Preview panel/Application panel/Languages panel/Plugins panel/Name & Extension panel/Comments panel/Content Index panel -- the current panel in the information window

Class preferences window: (NOT AVAILABLE YET) The Finder Preferences window

Properties:

<Inheritance> window [r/o] -- inherits some of its properties from the window class

current panel 'pple' -- The current panel in the Finder preferences window

Class window: A window

Plural form:

windows

Properties:

id unsigned integer [r/o] -- the unique id for this window

position point -- the upper left position of the window

bounds bounding rectangle -- the boundary rectangle for the window

titled boolean [r/o] -- Does the window have a title bar?

name Unicode text [r/o] -- the name of the window

index integer -- the number of the window in the front-to-back layer ordering

closeable boolean [r/o] -- Does the window have a close box?

floating boolean [r/o] -- Does the window have a title bar?

modal boolean [r/o] -- Is the window modal?

resizable boolean [r/o] -- Is the window resizable?

zoomable boolean [r/o] -- Is the window zoomable?

zoomed boolean -- Is the window zoomed?

zoomed full size boolean -- Is the window zoomed to the full size of the screen? (can only be set, not read)

visible boolean [r/o] -- Is the window visible (always true for open Finder windows)?

collapsed boolean -- Is the window collapsed

properties record -- every property of a window

Legacy suite: Operations formerly handled by the Finder, but now automatically delegated to other applications

Classes:

Class application: The Finder

Properties:

desktop picture file -- the desktop picture of the main monitor

Class application process: A process launched from an application file

Plural form:

application processes

Properties:

<Inheritance> process [r/o] -- inherits some of its properties from the process class

application file application file [r/o] -- the application file from which this process was launched

Class desk accessory process: A process launched from a desk accessory file

Plural form:

desk accessory processes

Properties:

<Inheritance> process [r/o] -- inherits some of its properties from the process class

desk accessory file reference [r/o] -- the desk accessory file from which this process was launched

Class process: A process running on this computer

Plural form:

processes

Properties:

name international text [r/o] -- the name of the process

visible boolean -- Is the process' layer visible?

frontmost boolean -- Is the process the frontmost process?

file reference [r/o] -- the file from which the process was launched

file type type class [r/o] -- the OSType of the file type of the process

creator type type class [r/o] -- the OSType of the creator of the process (the signature)

accepts high level events boolean [r/o] -- Is the process high-level event aware (accepts open application, open document, print document, and quit)?

accepts remote events boolean [r/o] -- Does the process accept remote events?

has scripting terminology boolean [r/o] -- Does the process have a scripting terminology, i.e., can it be scripted?

total partition size integer [r/o] -- the size of the partition with which the process was launched

partition space used integer [r/o] -- the number of bytes currently used in the process' partition

Events:

restart: Restart the computer

restart

shut down: Shut Down the computer

shut down

sleep: Put the computer to sleep

sleep

Type Definitions: Definitions of records used in scripting the Finder

Classes:

Class alias list: A list of aliases. Use ‘as alias list’ when a list of aliases is needed (instead of a list of file system item references).

Class column: a column of a list view

Plural form:

columns

Properties:

index integer -- the index in the front-to-back ordering within its container

name name column/modification date column/creation date column/size column/kind column/label column/version column/comment column [r/o] -- the column name

sort direction normal/reversed -- The direction in which the window is sorted

width small integer -- the width of this column

visible boolean -- is this column visible

Class icon family: (NOT AVAILABLE YET) A family of icons

Properties:

large monochrome icon and mask 'ICN#' [r/o] -- the large black-and-white icon and the mask for large icons

large 8 bit mask 'l8mk' [r/o] -- the large 8-bit mask for large 32-bit icons

large 32 bit icon 'il32' [r/o] -- the large 32-bit color icon

large 8 bit icon 'icl8' [r/o] -- the large 8-bit color icon

large 4 bit icon 'icl4' [r/o] -- the large 4-bit color icon

small monochrome icon and mask 'ics#' [r/o] -- the small black-and-white icon and the mask for small icons

small 8 bit mask 's8mk' [r/o] -- the small 8-bit mask for small 32-bit icons

small 32 bit icon 'is32' [r/o] -- the small 32-bit color icon

small 8 bit icon 'ics8' [r/o] -- the small 8-bit color icon

small 4 bit icon 'ics4' [r/o] -- the small 4-bit color icon

Class icon view options: the icon view options

Properties:

arrangement not arranged/snap to grid/arranged by name/arranged by modification date/arranged by creation date/arranged by size/arranged by kind/arranged by label -- the property by which to keep icons arranged

icon size small integer -- the size of icons displayed in the icon view

Class label: (NOT AVAILABLE YET) A Finder label (name and color)

Properties:

name Unicode text -- the name associated with the label

index integer -- the index in the front-to-back ordering within its container

color RGB color -- the color associated with the label

Class list view options: the list view options

Elements:

column by numeric index, before/after another element, as a range of elements, satisfying a test

Properties:

calculates folder sizes boolean -- Are folder sizes calculated and displayed in the window?

icon size small icon/large icon -- the size of icons displayed in the list view

sort column column -- the column that the list view is sorted on

uses relative dates boolean -- Are relative dates (e.g., today, yesterday) shown in the list view?

Class preferences: (NOT AVAILABLE, SUBJECT TO CHANGE) The Finder Preferences

Elements:

label by numeric index, by name

Properties:

window preferences window [r/o] -- the window that would open if Finder preferences was opened

button view arrangement not arranged/snap to grid/arranged by name/arranged by modification date/arranged by creation date/arranged by size/arranged by kind/arranged by label -- the method of arrangement of icons in default Finder button view windows

button view icon size integer -- the size of icons displayed in Finder button view windows.

spatial view arrangement not arranged/snap to grid/arranged by name/arranged by modification date/arranged by creation date/arranged by size/arranged by kind/arranged by label -- the method of arrangement of icons in default Finder spatial view windows

spatial view icon size integer -- the size of icons displayed in Finder spatial view windows.

calculates folder sizes boolean -- Are folder sizes calculated and displayed in Finder list view windows?

list view icon size integer -- the size of icons displayed in Finder list view windows.

shows comments boolean -- Are comments displayed in default Finder list view windows?

shows creation date boolean -- Are creation dates displayed in default Finder list view windows?

shows kind boolean -- Are document kinds displayed in default Finder list view windows?

shows label boolean -- Are labels displayed in default Finder list view windows?

shows modification date boolean -- Are modification dates displayed in default Finder list view windows?

shows size boolean -- Are file sizes displayed in default Finder list view windows?

shows version boolean -- Are file versions displayed in default Finder list view windows?

uses relative dates boolean -- Are relative dates (e.g., today, yesterday) shown in Finder list view windows?

uses simple menus boolean -- Use simplified Finder menus?

uses wide grid boolean -- Space icons on a wide grid?

spring open folders boolean -- Spring open folders after the specified delay?

delay before springing small integer -- the delay before springing open a container in ticks (1/60th of a second) (12 is shortest delay, 60 is longest delay)

view font integer -- the id of the font used in Finder views.

view font size integer -- the size of the font used in Finder views

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/Finder_1030_asDict.html
|| created: 8-Aug-04, 4:10 PM; updated: 8-Aug-04, 4:10 PM
|| size: 108544 bytes