LNS Home
Script Debugger
Download & Buy
x Explore
x Edit
x Run & Debug
x Deploy
What's New In 4.5
bullet Documentation
bullet Blog Posts
My SD Story
Software Updates
 
4.0.9 Update
3.0.9 Update
bullet 2.0.5 Update
x Free Downloads
 
XML Tools
XSLT Tools
x Property List Tools
x List & Record Tools
Register Your Copy of Script Debugger
Join the Script Debugger Mailing List
x AppleScript/ Scripting Links
Products
x Script Debugger 4.5
Site Contents
bullet Mark’s Blog
Product Registration
Bug Reporting
x Freeware
Contacting Us

SD4 Headling


image

Types of Entities Shown in the Dictionary Browser

image

This is a list of the various types of entities shown in the browser at the top of the dictionary display, as well as in results from searching the dictionary (in the dictionary window or through the Look Up Definition inspector).

image
Suite
A suite (image) is an artificial grouping of entities created by the developer of the application’s scripting model. A suite can contain any other type of entity (except another suite), and in most dictionaries, every dictionary entry is part of some suite. At the same time, in Script Debugger’s display of the dictionary, all dictionary entries are also accessible, starting in the first column, without using the Suites entry.

So, in the above illustration, we could have started with the Commands entry in the first column to see the pair command listed in the second column and in the info pane.

Command
A command is a verb, something that you tell an application or one of its objects to do. The icon distinguishes between a function (image), which returns a result, and a plain command (image), which does not. Command parameters are marked in a search result by image.
Event
An event (image) is a message sent by an application to your code. Your code can receive this message through an event handler. For example, Folder Actions are implemented through events. If you want something to happen when files are added to a folder, you must implement a handler called adding folder items to, so that System Events can call it by sending the corresponding event to your script.

Dictionaries do not always distinguish events from commands, so Script Debugger will sometimes report events as commands. For example, most of the “commands” listed in the AppleScript Studio dictionary are really events, but Script Debugger has no way to know this.

Class
A class (image) is a datatype. A class can have attributes — properties (image) and elements. Most of what you do in scripting an application involves working with properties and elements. You get and set the values of properties, and you manipulate elements in various ways (asking for particular elements or lists of elements, creating new elements, deleting elements, and so forth).
Record
A record (image) is a sort of lightweight class, typically used only in communicating data between an application and your script. Script Debugger distinguishes records from classes only when the target application has an sdef-based dictionary (because only an sdef-based dictionary can draw such a distinction).
Type
A type (image) is a built-in datatype, such as boolean or string. It is not always obvious what the distinction is between a Type and a Class. In some contexts, the difference is that a Class can have attributes (properties and elements), but some dictionaries fail to draw this distinction consistently.
Enumeration
An enumeration (image) is a datatype whose value is always one of a predefined list of constants (image). For example, the saving parameter of the close command is either the constant yes or the constant no or the constant ask. An enumeration’s constants are called its enumerators.

In the dictionary info pane, each enumeration is listed, with its enumerators, on a page of its own. A value type is shown as a hyperlink with the enumeration name. Click this link to see the enumeration’s own page, listing its enumerator values. For example, the saving parameter of the close command is listed as the saving enumeration. Click that to see the saving enumeration on its own page, where the enumerators yes, no, and ask are listed.

Scripting Addition
This category appears only in the Scripting Additions dictionary display. Script Debugger collects the dictionaries of all installed scripting additions into a single dictionary, so this category lets you browse an individual scripting addition. Individual scripting additions are marked as to their location, namely the ScriptingAdditions folder in the Library at the system (image), computer (image), user (image), or network (image) level.
Summary of Symbols
image # in a folder Enumeration
image # in a circle Constant (Enumerator)
image C in a circle Class
image C in a hexagon Command
image E in a hexagon Event
image F in a hexagon Function (Command with result)
image P in a square Parameter
image Pr in a square Property
image R in a circle Record
image S in a folder Suite
image T in a circle Type
image ! in a triangle PowerPC-only*
image Mac OS X-style X System**
image iMac display Computer**
image Person silhouette User**
image Network globe Network**

* The PowerPC-only icon appears when Script Debugger is running natively on an Intel-based machine and a scripting addition is PowerPC only. It alerts you to the fact that Intel-native AppleScript environments, including Script Debugger, will not load this scripting addition. (But a Carbon applet, or any application that executes AppleScript scripts and is not a universal binary and therefore runs under Rosetta, will load such a scripting addition.)

** Scripting Addition icons reflect the location of the Library/ScriptingAdditions folder containing the marked scripting addition file: /System, top level, the user’s home folder, or the network, respectively.



Explore | Edit | Run & Debug | Deploy | What's New In 4.5 | My SD Story


Copyright © 1998-2009 Late Night Software Ltd. - All Rights Reserved.