The FooDoo Lounge

iCal 1.5.1 Dictionary

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

Index

  1. Standard Suite
  2. Text Suite
  3. iCal 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.

iCal suite: iCal specific classes.

Classes:

Class application: This class represents iCal.

Plural form:

applications

Elements:

calendar 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

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.

progression small real -- Set this value to augment the progress bar. Don't read it (obsolete, will be removed in next release)

allow cancel boolean -- Tell to not allow user cancel of an import (obsolete, will be removed in next release)

Class attendee: This class represents an attendee

Plural form:

attendees

Properties:

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

email Unicode text -- e-mail of the attendee

participation status declined/unknown/accepted [r/o] -- The invitation status for the attendee

display name Unicode text -- The first and last name of the attendee

Class calendar: This class represents a calendar

Plural form:

calendars

Elements:

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

todo 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.

tint Unicode text [r/o] -- The calendar color

title Unicode text -- This is the calendar title.

writable boolean [r/o] -- If this calendar is writable

key Unicode text [r/o] -- An unique calendar key

description Unicode text [r/o] -- This is the calendar description.

Class display alarm: This class represents a message alarm

Plural form:

display alarms

Properties:

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

trigger interval integer -- The interval in minutes between the event and the alarm: (positive for alarm that trigger after the event date or negative for alarms that trigger before)

Class event: This class represents an event

Plural form:

events

Elements:

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

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

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

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

mail alarm 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.

uid Unicode text [r/o] -- An unique event key

location Unicode text -- The event location

url Unicode text -- The URL associated to the event

end date date -- The event end date, if defined

sequence integer -- The event version

recurrence Unicode text -- The iCAL string describing the event recurrence, if defined

summary Unicode text -- The event summary

start date date -- The event start date

excluded dates date -- A recurring event excluded dates

stamp date date [r/o] -- The event last stamp date

allday event boolean -- True if the event is an all-day event

description Unicode text -- This is the event description.

status none/confirmed/tentative/cancelled -- The event status

Class mail alarm: This class represents a mail alarm

Plural form:

mail alarms

Properties:

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

trigger interval integer -- The interval in minutes between the event and the alarm: (positive for alarm that trigger after the event date or negative for alarms that trigger before)

Class open file alarm: This class represents an 'open file' alarm

Plural form:

open file alarms

Properties:

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

trigger interval integer -- The interval in minutes between the event and the alarm: (positive for alarm that trigger after the event date or negative for alarms that trigger before)

filepath Unicode text -- The (POSIX) path to be opened by the alarm

Class sound alarm: This class represents a sound alarm

Plural form:

sound alarms

Properties:

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

trigger interval integer -- The interval in minutes between the event and the alarm: (positive for alarm that trigger after the event date or negative for alarms that trigger before)

sound name Unicode text -- The system sound name to be used for the alarm

Class todo: This class represents an todo

Plural form:

todos

Properties:

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

priority integer -- The todo priority

due date date -- The todo due date

uid Unicode text [r/o] -- An unique todo key

sequence integer -- The todo version

url Unicode text -- The URL associated to the todo

summary Unicode text -- The todo summary

stamp date date [r/o] -- The todo last stamp date

completion date date -- The todo completion date

Events:

GetURL: Open a webcal: or http: for a remote calendar

GetURL reference -- the object for the command

breathe now: Tell the progress panel to update its UI (obsolete, will be removed in next release)

breathe now reference -- the object for the command

create calendar: Creates a new calendar (obsolete, will be removed in next release)

create calendar reference -- the object for the command

[with name Unicode text] -- the calendar new name

dismiss progress: Dismiss the progress dialog (obsolete, will be removed in next release)

dismiss progress reference -- the object for the command

reload calendars: Tell the application to reload all calendar files contents

reload calendars reference -- the object for the command

reschedule: Reschedules an event to a different start date

reschedule reference -- the object for the command

to date -- the event new start date

should cancel: Return true when the user clicked on the cancel button (obsolete, will be removed in next release)

should cancel reference -- the object for the command

Result: boolean -- the reply for the command

show: Show the event or to-do in the calendar window

show reference -- the object for the command

show progress: Show the progress dialog (obsolete, will be removed in next release)

show progress reference -- the object for the command

[with message Unicode text] -- Give the message to display

switch view: Show calendar on the given view

switch view reference -- the object for the command

to day view/week view/month view -- the calendar view to be displayed

view calendar: Show calendar on the given date

view calendar reference -- the object for the command

at date -- the date to be displayed

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/iCal_151_asDict.html
|| created: 16-Aug-04, 8:15 PM; updated: 16-Aug-04, 8:15 PM
|| size: 74591 bytes