Home | Software | Tools | Routines | Info | Dictionaries

Address Book 3.0.1 Dictionary

Copyright © 2002 Apple Computer, Inc. All rights reserved.

Index

1. Standard Suite
   • Classes:
     1. application
     2. color
     3. document
     4. item
     5. window
   • Events:
     1. close
     2. count
     3. delete
     4. duplicate
     5. exists
     6. get
     7. make
     8. move
     9. open
     10. print
     11. quit
     12. save
     13. set
2. Text Suite
   • Classes:
     1. attachment
     2. attribute run
     3. character
     4. paragraph
     5. text
     6. word
3. Address Book Script Suite
   • Classes:
     1. AIM Handle
     2. ICQ handle
     3. Jabber handle
     4. MSN handle
     5. Yahoo handle
     6. address
     7. application
     8. contact info
     9. email
     10. entry
     11. group
     12. person
     13. phone
   • Events:
     1. add
     2. remove
     3. save addressbook

Standard Suite: Common classes and commands for most applications.

Classes:

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

Plural form:

applications

Elements:

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

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

Properties:

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

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

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

version Unicode text [r/o] -- The version 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.

path Unicode text -- The document's path.

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

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.

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

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

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

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

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

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

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

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

zoomed boolean -- Whether the window is currently zoomed.

visible boolean -- Whether the window is currently visible.

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

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

miniaturized boolean -- Whether the window is currently miniaturized.

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

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 in Unicode text] -- The file in which to save the object.

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

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

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

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

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

[with properties record] -- The initial values for properties of 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 a list of alias -- list of objects

print: Print an object.

print a list of alias -- list of objects

quit: Quit an application.

quit reference -- the object for the command

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

save: Save an object.

save reference -- the object for the command

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

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

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:

attribute run 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

paragraph 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

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:

attribute run 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

paragraph 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

Properties:

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

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

color color -- The color of the first character.

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

Class character: This subdivides the text into characters.

Plural form:

characters

Elements:

attribute run 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

paragraph 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

Properties:

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

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

color color -- The color of the first character.

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

Class paragraph: This subdivides the text into paragraphs.

Plural form:

paragraphs

Elements:

attribute run 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

paragraph 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

Properties:

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

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

color color -- The color of the first character.

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

Class text: Rich (styled) text

Elements:

attribute run 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

paragraph 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

Properties:

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

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

color color -- The color of the first character.

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

Class word: This subdivides the text into words.

Plural form:

words

Elements:

attribute run 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

paragraph 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

Properties:

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

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

color color -- The color of the first character.

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

Address Book Script Suite: commands and classes for Address Book scripting.

Classes:

Class AIM Handle: User name for America Online (AOL) messaging.

Plural form:

AIM handles

Properties:

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

Class ICQ handle: User name for ICQ messaging.

Plural form:

ICQ handles

Properties:

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

Class Jabber handle: User name for Jabber messaging.

Plural form:

Jabber handles

Properties:

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

Class MSN handle: User name for Microsoft Network (MSN).

Plural form:

MSN handles

Properties:

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

Class Yahoo handle: User name for Yahoo messaging.

Plural form:

Yahoo handles

Properties:

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

Class address: Address for the given record.

Plural form:

addresses

Properties:

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

state Unicode text -- State, Province, or Region part of the address.

label Unicode text -- Label.

zip Unicode text -- Zip or postal code of the address.

city Unicode text -- City part of the address.

country code Unicode text -- Country code part of the address (should be a two character iso country code).

country Unicode text -- Country part of the address.

id Unicode text -- unique identifier for this address.

street Unicode text -- Street part of the address, multiple lines separated by carriage returns.

Class application: Users address book database

Elements:

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

person 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

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

Properties:

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

unsaved boolean [r/o] -- Does the Address Book have any unsaved changes?

Class contact info: Container object in the database, holds a key and a value

Properties:

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

id Unicode text [r/o] -- unique identifier for this entry, this is persistant, and stays with the record.

label Unicode text -- Label is the label associated with value like "work", "home", etc.

value Unicode text -- Value.

Class email: Email address for a person.

Plural form:

emails

Properties:

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

Class entry: A entry in the address book database

Plural form:

entries

Properties:

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

id Unicode text [r/o] -- unique identifier for this record, this is persistant, and stays with the record.

modification date date [r/o] -- when the contact was last modified.

creation date date [r/o] -- when the contact was creation.

Class group: A Group Record in the address book database

Plural form:

groups

Elements:

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

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

Properties:

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

name Unicode text -- The name of this group.

Class person: A Person Record in the address book database.

Plural form:

people

Elements:

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

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

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

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

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

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

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

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

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

Properties:

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

birth date date -- The Birth date of this person.

organization Unicode text -- Organization that the person works for.

job title Unicode text -- The Job title of this person.

title Unicode text -- The title of this person.

home page Unicode text -- The Home page of this person.

nickname Unicode text -- The Nickname of this person.

phonetic first name Unicode text -- The Phonetic Version of the First name of this person.

note Unicode text -- Notes for this person.

first name Unicode text -- The First name of this person.

name Unicode text [r/o] -- First/Last name of the person, uses the preference setting in Address Book.

maiden name Unicode text -- The Maiden name of this person.

middle name Unicode text -- The Middle name of this person.

suffix Unicode text -- The Suffix of this person.

last name Unicode text -- The Last name of this person.

phonetic last name Unicode text -- The Phonetic Version of the Last name of this person.

Class phone: Phone number for a person.

Plural form:

phones

Properties:

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

Events:

add: Add a child object.

add reference -- the object for the command

to reference -- where to add this child to.

remove: Remove a child object.

remove reference -- the object for the command

from reference -- where to remove this child from.

save addressbook: Save all the current Address Book.

save addressbook reference -- the object for the command

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/AddressBook_301_asDict.html
|| created: 5-Aug-04, 2:28 PM; updated: 11-Aug-03, 4:42 PM
|| size: 69139 bytes