The FooDoo Lounge

Script Editor 2.0 Dictionary

© Copyright 1997-2003. Apple Computer Inc., all rights reserved.

Index

  1. Standard Suite
  2. Text Suite
  3. Script Editor Suite

Standard Suite: Common classes and commands for most applications.

Classes:

Class application: An application's top level scripting object.

Plural form:

applications

Elements:

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

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

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

version Unicode text [r/o] -- The version of the application.

frontmost boolean [r/o] -- Is this the frontmost (active) application?

name Unicode text [r/o] -- The name of the application.

Class color: A color.

Plural form:

colors

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

Class document: A document.

Plural form:

documents

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

modified boolean [r/o] -- Has the document been modified since the last save?

path Unicode text -- The document's path.

name Unicode text -- The document's name.

Class item: A scriptable object.

Plural form:

items

Properties:

class type class [r/o] -- The class of the object.

properties record -- All of the object's properties.

Class window: A window.

Plural form:

windows

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

zoomed boolean -- Whether the window is currently zoomed.

miniaturized boolean -- Whether the window is currently miniaturized.

name Unicode text -- The full title of the window.

floating boolean [r/o] -- Whether the window floats.

modal boolean [r/o] -- Whether the window is the application's current modal window.

miniaturizable boolean [r/o] -- Whether the window can be miniaturized.

visible boolean -- Whether the window is currently visible.

closeable boolean [r/o] -- Whether the window has a close box.

resizable boolean [r/o] -- Whether the window can be resized.

zoomable boolean [r/o] -- Whether the window can be zoomed.

id integer [r/o] -- The unique identifier of the window.

bounds bounding rectangle -- The bounding rectangle of the window.

titled boolean [r/o] -- Whether the window has a title bar.

index integer -- The index of the window in the back-to-front window ordering.

document document [r/o] -- The document whose contents are being displayed in the window.

Events:

close: Close an object.

close reference -- the object for the command

[saving yes/no/ask] -- Specifies whether changes should be saved before closing.

[saving in alias] -- The file in which to save the object.

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

count reference -- the object for the command

[each type class] -- The class of objects to be counted.

Result: integer -- the reply for the command

delete: Delete an object.

delete reference -- the object for the command

duplicate: Copy object(s) and put the copies at a new location.

duplicate reference -- the object for the command

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

[with properties record] -- Properties to be set in the new duplicated object(s).

exists: Verify if an object exists.

exists reference -- the object for the command

Result: boolean -- the reply for the command

get: Get the data for an object.

get reference -- the object for the command

Result: anything -- the reply for the command

make: Make a new object.

make

[with properties record] -- The initial values for properties of the object.

new type class -- The class of the new object.

[with data anything] -- The initial data for the object.

[at location reference] -- The location at which to insert the object.

Result: reference -- the reply for the command

move: Move object(s) to a new location.

move reference -- the object for the command

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

open: Open an object.

open alias -- The file(s) to be opened.

print: Print an object.

print alias -- The file(s) or document(s) to be printed.

quit: Quit an application.

quit reference -- the object for the command

[saving yes/no/ask] -- Specifies whether changes should be saved before quitting.

save: Save an object.

save reference -- the object for the command

[as Unicode text] -- The file type in which to save the data.

[in alias] -- The file in which to save the object.

set: Set an object's data.

set reference -- the object for the command

to anything -- The new value.

Text Suite: A set of basic classes for text processing.

Classes:

Class attachment: Represents an inline text attachment. This class is used mainly for make commands.

Elements:

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

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

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

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

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

Properties:

<Inheritance> text [r/o] -- All of the properties of the superclass.

file name Unicode text -- The path to the file for the attachment

Class attribute run: This subdivides the text into chunks that all have the same attributes.

Plural form:

attribute runs

Elements:

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

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

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

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

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

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class character: This subdivides the text into characters.

Plural form:

characters

Elements:

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

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

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

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

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

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class paragraph: This subdivides the text into paragraphs.

Plural form:

paragraphs

Elements:

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

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

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

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

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

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class text: Rich (styled) text

Elements:

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

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

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

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

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

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class word: This subdivides the text into words.

Plural form:

words

Elements:

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

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

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

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

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

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Script Editor Suite: Classes and Commands for working with the Script Editor

Classes:

Class application: Script Editor's top level scripting object.

Plural form:

applications

Elements:

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

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

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

Properties:

<Inheritance> application [r/o] -- All of the properties of the superclass.

selection selection-object -- The current selection.

Class document: A script document.

Plural form:

documents

Elements:

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

Properties:

<Inheritance> document [r/o] -- All of the properties of the superclass.

contents text -- The contents of the document.

selection selection-object -- The current selection.

text text -- The text of the document.

description text -- The description of the document.

language language -- The scripting language.

Class insertion point: An insertion point between to objects.

Plural form:

insertion points

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

contents item -- The contents of the insertion point.

Class language: A scripting language.

Plural form:

languages

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

supports recording boolean [r/o] -- Is the language recordable?

supports compiling boolean [r/o] -- Is the language compilable?

description Unicode text [r/o] -- The description

name Unicode text [r/o] -- The name of the language.

id Unicode text [r/o] -- The unique id of the language.

Class selection-object: A way to refer to the state of the current selection.

Properties:

<Inheritance> item [r/o] -- All of the properties of the superclass.

contents item -- The contents of the selection.

character range point [r/o] -- The range of characters in the selection.

Class text: Rich (styled) text

Plural form:

text

Elements:

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

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

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

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

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

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

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

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

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

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

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

Properties:

<Inheritance> text [r/o] -- All of the properties of the superclass.

size integer -- The size in points of the first character.

font Unicode text -- The name of the font of the first character.

color color -- The color of the first character.

Class window: A window.

Properties:

<Inheritance> window [r/o] -- All of the properties of the superclass.

name Unicode text -- The full title of the window.

Events:

check syntax: Check the syntax of a document.

check syntax reference -- the object for the command

compile: Compile the script of a document.

compile reference -- the object for the command

Result: boolean -- the reply for the command

execute: Execute the document.

execute reference -- the object for the command

save: Save an object.

save reference -- the object for the command

[run only boolean] -- Should the script be saved as Run-Only? If it is, you will not be able to edit the contents of the script again. The default is not to save as run only. (Applies to all script types except for "text").

[stay open boolean] -- Should the application remain open after it is launched? The default is not to stay open. (Only applies to scripts saved as "application" or "application bundle").

[as Unicode text] -- The file type in which to save the data. Use one of the following strings: "script", "application", "script bundle", "application bundle", "text".

[in alias] -- The file in which to save the object.

[startup screen boolean] -- Show the startup screen? The default is not to show the startup screen. (Only applies to scripts saved as "application" or "application bundle").

 

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