The FooDoo Lounge

Palm Desktop 4.1 Dictionary

Copyright 2002 Palm, Inc. or its subsidiaries and their licensors. All rights reserved.

Index

  1. Standard Suite
  2. Earlier Terms
  3. Palm Desktop Basics
  4. Address Book
  5. Date Book
  6. Memos
  7. Views
  8. Obsolete Terms

Standard Suite: Common terms that most applications should support

Classes:

Class file: a file on a disk or server

Plural form:

files

Class item: A scriptable object

Plural form:

items

Properties:

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

properties record -- property that allows getting/setting multiple properties

Class window: A window

Plural form:

windows

Properties:

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

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

index integer [r/o] -- the number of the window in the front-to-back layer ordering

id integer [r/o] -- an id that identifies the window

position point -- the upper left position of the window

bounds bounding rectangle [r/o] -- the boundary rectangle for the window

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

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

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 [r/o] -- Is the window zoomed?

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

frontmost boolean -- Is this the frontmost window?

Events:

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

delete: Delete an object from its container

delete reference -- the element to delete

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

[with data anything] -- the initial data for the element; some items, such as categories and labels, can be created with string data for the name

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

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

open: Open the specified object(s)

open reference -- list of objects to open

quit: Quit Palm Desktop

quit

reopen: Reactivate Palm Desktop

reopen

run: Sent to an application when it is opened

run

Earlier Terms: Terms that have been renamed from earlier versions of Palm Desktop. These are included to ease transition to the new terms and may be removed in a future version.

Classes:

Class address: Address and other information about a person or contact

Properties:

primary address address info -- earlier term for ‘address one’

secondary address address info -- earlier term for ‘address two’

phone 1 phone info -- earlier term for ‘phone one’

phone 2 phone info -- earlier term for ‘phone two’

phone 3 phone info -- earlier term for ‘phone three’

phone 4 phone info -- earlier term for ‘phone four’

custom 1 custom field info -- earlier term for ‘custom one’

custom 2 custom field info -- earlier term for ‘custom two’

custom 3 custom field info -- earlier term for ‘custom three’

custom 4 custom field info -- earlier term for ‘custom four’

custom 5 custom field info -- earlier term for ‘custom five’

custom 6 custom field info -- earlier term for ‘custom six’

custom 7 custom field info -- earlier term for ‘custom seven’

custom 8 custom field info -- earlier term for ‘custom eight’

custom 9 custom field info -- earlier term for ‘custom nine’

custom 10 custom field info -- earlier term for ‘custom ten’

custom 11 custom field info -- earlier term for ‘custom eleven’

custom 12 custom field info -- earlier term for ‘custom twelve’

Class address info: Earlier term for ‘postal address’

Properties:

address label reference -- earlier term for ‘label’

mailing label international text [r/o] -- earlier term for ‘formatted address’

Class attachment: An item or file that is attached to another item

Properties:

generic title international text [r/o] -- earlier term for ‘name’

Class memo: A memo

Properties:

body international text -- earlier term for ‘contents’

date modified date -- earlier term for ‘modification date’

Class phone info: Earlier term for ‘phone number’

Properties:

phone label reference -- earlier term for ‘label’

full phone international text [r/o] -- earlier term for ‘full formatted number’

Class special field info: Earlier term for ‘special info’

Properties:

button field international text [r/o] -- earlier term for ‘button field text’

Palm Desktop Basics: Basic commands and object classes

Classes:

Class application: The Palm Desktop application

Elements:

calendar day by name, as a range of elements, satisfying a test, by ID

address by name, by numeric index, as a range of elements, satisfying a test, by ID

memo by name, by numeric index, as a range of elements, satisfying a test, by ID

to do by name, by numeric index, as a range of elements, satisfying a test, by ID

event by name, by numeric index, as a range of elements, satisfying a test, by ID

category by name, by numeric index, as a range of elements, satisfying a test, by ID

phone number label by name, by numeric index, as a range of elements, satisfying a test, by ID

postal address label by name, by numeric index, as a range of elements, satisfying a test, by ID

window by name, by numeric index, as a range of elements, satisfying a test, by ID

Properties:

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

name international text [r/o] -- the application name

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

selection a list of reference [r/o] -- the selection visible to the user

version international text [r/o] -- the version of the application

current event reference [r/o] -- the event scheduled right now or nothing if no event is scheduled

Class attachment: An entry or a file that is attached to another entry.

Plural form:

attachments

Properties:

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

Class category: A descriptive category for an item (e.g., “Business”, “Friends/Family”)

Plural form:

categories

Properties:

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

name international text -- the name of the item

id integer [r/o] -- an id that identifies the category

color index integer -- the category color index (the specific RGB color depends on the application Decor preference)

Class entry: A data entry, e.g., an address, to do, or memo

Plural form:

entries

Elements:

attachment by name, by numeric index, as a range of elements, satisfying a test, by ID

Properties:

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

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

id integer [r/o] -- an id that identifies the item

primary category category -- the primary category of the item

secondary category category -- the secondary category of the item

private boolean -- Is the item private? (Private items are not accessible from AppleScript if hidden in the application.)

Events:

attach: Attach an entry to other entries and files

attach reference -- the entry to attach

to reference -- list of the entries and files to attach

show: Show an entry or a calendar day

show reference -- the entry or calendar day to show

[date book daily/weekly/monthly] -- the date book view in which to show a calendar day

Address Book: Classes representing address book items

Classes:

Class address: Address and other information about a person or contact

Plural form:

addresses

Elements:

attachment by name, by numeric index, as a range of elements, satisfying a test, by ID

Properties:

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

first name international text -- the first (given) name of the address book item

first name yomi international text -- the first (given) name yomi of the address book item (Japanese version of Palm Desktop only); NOTE: This is currently stored in custom nine

last name international text -- the last (sur) name of the address book item

last name yomi international text -- the last (sur) name yomi of the address book item (Japanese version of Palm Desktop only); NOTE: This is currently stored in custom ten

prefix international text -- the name prefix of the address book item

suffix international text -- the name suffix of the address book item

title international text -- the title of the address book item

company international text -- the company name of the address book item

company yomi international text -- the company yomi of the address book item (Japanese version of Palm Desktop only); NOTE: This is currently stored in custom eleven

division international text -- the division name of the address book item

full name international text [r/o] -- the full (formal) name of the address book item (e.g., “Mr. John Doe Jr.”)

full informal name international text [r/o] -- the full, informal name of the address book item (e.g., “John Doe”)

salutation name international text [r/o] -- the name used for (formal) salutations of the address book item (e.g., “Mr. Doe”)

salutation informal name international text [r/o] -- the name used for informal salutations of the address book item (e.g., “John”)

address one postal address -- the first postal address of the address book item

address two postal address -- the second postal address of the address book item

phone one phone number -- the first phone number of the address book item

phone two phone number -- the second phone number of the address book item

phone three phone number -- the third phone number of the address book item

phone four phone number -- the fourth phone number of the address book item

custom one custom field info -- the first custom field of the address book item

custom two custom field info -- the second custom field of the address book item

custom three custom field info -- the third custom field of the address book item

custom four custom field info -- the fourth custom field of the address book item

custom five custom field info -- the fifth custom field of the address book item

custom six custom field info -- the sixth custom field of the address book item

custom seven custom field info -- the seventh custom field of the address book item

custom eight custom field info -- the eigth custom field of the address book item

custom nine custom field info -- the ninth custom field of the address book item

custom ten custom field info -- the tenth custom field of the address book item

custom eleven custom field info -- the eleventh custom field of the address book item

custom twelve custom field info -- the twelfth custom field of the address book item (not displayed in the application)

birthday date or text -- the birthday of the address book item; when no year is specified, the value is a string with the month and day (e.g., “October 13”)

comments international text -- the comment text of the address book item

modification date date [r/o] -- the date and time the address book item was last modified

marked boolean -- Is the address book item marked?

special special info [r/o] -- the special information of the address book item (used by scripts attached to address card buttons)

Class custom field info: A record containing custom field information for an address book item

Properties:

field title international text -- the title of the custom field

field text international text -- the value of the custom field

Class phone number: A record containing phone number information for an address book item

Properties:

label reference -- the descriptive label of the phone number; this can be a reference to a phone number label, a unique string for this phone number, or ‘missing value’

formatted number international text -- the phone number (without extension) formatted as specified in application preferences

raw number international text -- the phone number (without extension) without any formatting

extension international text -- the phone number extension

full formatted number international text [r/o] -- the full formatted phone number with extension

dial string international text [r/o] -- the string used for dialing the phone number (raw number with prefixes for outside line, long distance, etc., as specified in application preferences)

in menu boolean -- Is the phone number displayed in the Instant Palm Desktop menu?

Class phone number label: A descriptive label for a phone number (e.g., “Home”, “Fax”)

Plural form:

phone number labels

Properties:

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

name international text -- the name of the item

id integer [r/o] -- an id that identifies the label

Class postal address: A record containing postal (street) address information for an address book item

Properties:

label reference -- the descriptive label of the address; this can be a reference to a postal address label, a unique string for this postal address, or ‘missing value’

street address one international text -- the street address (line one)

street address two international text -- the street address (line two)

city international text -- the city of the address

state international text -- the state of the address

zip international text -- the zip code of the address

country international text -- the country of the address

formatted address international text [r/o] -- the address formatted as set in application preferences

Class postal address label: A descriptive label for a postal address (e.g., “Work”, “Home”)

Plural form:

postal address labels

Properties:

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

name international text -- the name of the item

id integer [r/o] -- an id that identifies the label

Class special info: Miscellaneous information used by scripts attached to address book item buttons (only valid while running an attached script)

Properties:

button field text international text [r/o] -- the field text of the custom field to which the script is attached

personalize boolean [r/o] -- Personalize the letter template contents? (used by scripts attached to the letter attachment button)

template file [r/o] -- the file containing the letter template (used by scripts attached to the letter attachment button)

save to fsspec file specification [r/o] -- the file to save the new attached letter in, as a file specification (used by scripts attached to the letter attachment button)

save to filename international text [r/o] -- the file to save the new attached letter in, as a string (used by scripts attached to the letter attachment button)

save to alias alias [r/o] -- the file to save the new attached letter in, as an alias (used by scripts attached to the letter attachment button)

Date Book: Classes representing date book items

Classes:

Class calendar day: A calendar day, containing events and to dos on a particular date

Plural form:

calendar days

Elements:

event by name, by numeric index, as a range of elements, satisfying a test, by ID

to do by name, by numeric index, as a range of elements, satisfying a test, by ID

Properties:

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

name international text [r/o] -- the name of the day (a date string)

id date [r/o] -- a date that identifies the day

Class event: An appointment or event that occurs at a particular date and time

Plural form:

events

Elements:

attachment by name, by numeric index, as a range of elements, satisfying a test, by ID

event occurrence by ID

Properties:

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

title international text -- the title of the event

start time date -- the start date and time of the event; setting the start time changes the end time to keep the same duration

end time date -- the end date and time of the event; must be on the same date as the start time

duration seconds -- the duration of the event in seconds

all day event boolean -- Is this an all day event?

alarm seconds -- the alarm time in seconds before the event start, or ‘missing value’ if there is no alarm

Class event occurrence: An occurrence of a recurring event on a particular date

Plural form:

event occurrences

Elements:

attachment by name, by numeric index, as a range of elements, satisfying a test, by ID

Properties:

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

event reference [r/o] -- the event of which this is an occurrence

Class to do: A task to do by a due date or until completed

Plural form:

to dos

Elements:

attachment by name, by numeric index, as a range of elements, satisfying a test, by ID

to do occurrence by ID

Properties:

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

title international text -- the title of the to do item

due date date -- the due date of the task, or ‘missing value’ if there is no due date

reminder integer -- the number of days before the due date to display a reminder of the uncompleted task, or ‘missing value’ if there is no reminder

completed boolean -- Has the task been completed? Setting this to true will set ‘completion date’ to the current date.

completion date date -- the date the task was completed, or ‘missing value’ if the task has not been completed; setting this will also update ‘completed’

priority highest/high/medium/low/lowest -- the priority of the to do item

carry over boolean -- Display the item on today’s list of to dos until completed, even when past the due date?

Class to do occurrence: An occurrence of a recurring to do on a particular date

Plural form:

to do occurrences

Elements:

attachment by name, by numeric index, as a range of elements, satisfying a test, by ID

Properties:

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

to do reference [r/o] -- the to do of which this is an occurrence

Events:

find available time: Return the earliest available time with no events scheduled

find available time

[after date] -- the date and time to start searching; a calendar day or a date may be given (default is the current date and time)

[duration seconds] -- the required duration in seconds (default is one minute)

[all hours boolean] -- Search all hours? (Default is to search only work hours as set in application preferences.)

Result: date -- the date and time, or ‘missing value’ if no time is available

Memos: Classes representing text memos

Classes:

Class memo: A memo

Plural form:

memos

Elements:

attachment by name, by numeric index, as a range of elements, satisfying a test, by ID

Properties:

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

title international text -- the title of the memo

contents international text -- the contents (body text) of the memo

creation date date -- the date and time the memo was created

modification date date -- the date and time the memo was last modified

Views: Commands and classes for selecting which items are shown in windows

Classes:

Class address view: A view for an address list window

Plural form:

address views

Properties:

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

first name restriction text restriction -- the view restriction on first names

nickname restriction text restriction -- the view restriction on nicknames

last name restriction text restriction -- the view restriction on last names

prefix restriction text restriction -- the view restriction on name prefixes

suffix restriction text restriction -- the view restriction on name suffixes

title restriction text restriction -- the view restriction on titles

company restriction text restriction -- the view restriction on company names

division restriction text restriction -- the view restriction on division names

street restriction text restriction -- the view restriction on street addresses

city restriction text restriction -- the view restriction on cities

state restriction text restriction -- the view restriction on states

zip restriction text restriction -- the view restriction on zip codes

country restriction text restriction -- the view restriction on countries

phone restriction text restriction -- the view restriction on phone numbers

extension restriction text restriction -- the view restriction on phone number extensions

custom one restriction text restriction -- the view restriction on custom field text

custom two restriction text restriction -- the view restriction on custom field text

custom three restriction text restriction -- the view restriction on custom field text

custom four restriction text restriction -- the view restriction on custom field text

custom five restriction text restriction -- the view restriction on custom field text

custom six restriction text restriction -- the view restriction on custom field text

custom seven restriction text restriction -- the view restriction on custom field text

custom eight restriction text restriction -- the view restriction on custom field text

custom nine restriction text restriction -- the view restriction on custom field text

custom ten restriction text restriction -- the view restriction on custom field text

custom eleven restriction text restriction -- the view restriction on custom field text

custom twelve restriction text restriction -- the view restriction on custom field text

comments restriction text restriction -- the view restriction on comments

birthday restriction date restriction -- the view restriction on birthdays

modification date restriction date restriction -- the view restriction on modification dates

Class date restriction: A record containing a date restriction for a view

Properties:

from the beginning of all time/today/tomorrow/yesterday/this week/next week/last week/this month/next month/last month/this year/next year/last year/one week from today [r/o] -- restrict the view to items on or after this date or time

to the end of all time/today/tomorrow/yesterday/this week/next week/last week/this month/next month/last month/this year/next year/last year/one week from today [r/o] -- restrict the view to items before or on this date or time

exclude completed boolean -- restrict the view to uncompleted to do items (only for to do views)

exclude undated boolean -- restrict the view to to do items without due dates (only for to do views)

Class memo view: A view for a memo list window

Plural form:

memo views

Properties:

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

memo title restriction text restriction -- the view restriction on memo titles

contents restriction text restriction -- the view restriction on memo contents

creation date restriction date restriction [r/o] -- the view restriction on memo creation dates

modification date restriction date restriction [r/o] -- the view restriction on memo modification dates

Class text restriction: A record containing a text restriction for a view

Properties:

comparison text contains/text starts with/text ends with/text is/text is not/text doesn’t contain/text is empty/text is not empty [r/o] -- the comparison used to restrict the view to items matching ‘text one’, ‘text two’, and ‘text three’

text one international text -- restrict the view to items matching this text

text two international text -- restrict the view to items matching this text

text three international text -- restrict the view to items matching this text

Class to do view: A view for a to do list window

Plural form:

to do views

Properties:

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

to do title restriction text restriction -- the view restriction on to do item titles

priority restriction a list of highest/high/medium/low/lowest -- the view restriction on to do item priorities

due date restriction date restriction -- the view restriction on to do item due dates

Class view: Properties common to all view classes; to set the view for a window, create a view with ‘make’ and the view will be set in the appropriate list window

Plural form:

views

Properties:

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

name international text -- the name of the view

save sort boolean -- Is the sorting order saved with the view?

save window positions boolean -- Are the list window position and size saved with the view?

category restriction a list of list [r/o] -- the view restriction on categories (a list of one or more categories)

Events:

show all in: Show all items in a window (sets the window’s view to “All”)

show all in reference -- the window in which to show all items

Obsolete Terms: Terms from earlier versions that should no longer be used. These are included to ease transition to the new terms and may be removed in a future version. Some have been changed to read-only or support for them has been removed altogether.

Classes:

Class address: An address book item

Properties:

name info OBSOLETE name info OBSOLETE [r/o] -- the name information of the address book item; obsolete, its properties are now direct properties of address

all fields OBSOLETE record [r/o] -- a record containing all fields of the address book item; obsolete, use ‘properties’ instead

Class attachment: An item or file that is attached to another item

Properties:

generic title OBSOLETE international text [r/o] -- the descriptive title of the attached object; obsolete, use ‘name’ or construct a descriptive name from other properties instead

Class category: A category

Properties:

title international text -- the title of the category; obsolete, use ‘name’ instead

Class event: A date book event

Properties:

date OBSOLETE anything [r/o] -- the date of the event (at midnight); obsolete, use ‘start time’ instead

start time OBSOLETE anything [r/o] -- the start time of the event (on Jan 1, 1904); obsolete, use ‘start time’ instead

end time OBSOLETE anything [r/o] -- the end time of the event (on Jan 1, 1904); obsolete, use ‘end time’ instead

duration OBSOLETE small integer [r/o] -- the duration of the event in minutes; obsolete, use ‘duration’ instead

alarm OBSOLETE boolean [r/o] -- Does the event have an alarm?; obsolete, compare ‘alarm’ to ‘missing value’ instead

alarm time OBSOLETE integer [r/o] -- the alarm time in minutes before the event start; obsolete, use ‘alarm’ instead

all fields OBSOLETE record [r/o] -- a record containing all fields of the event; obsolete, use ‘properties’ instead

Class memo: A memo

Properties:

body OBSOLETE international text -- the body text of the memo; obsolete, use ‘contents’ instead

creation time OBSOLETE anything [r/o] -- the time the memo was created (on Jan 1, 1904); obsolete, use ‘creation date’ instead

creation date OBSOLETE anything [r/o] -- the date the memo was created (at midnight); obsolete, use ‘creation date’ instead

all fields OBSOLETE record [r/o] -- a record containing all fields of the memo; obsolete, use ‘properties’ instead

Class name info OBSOLETE: Name information of an address book item; obsolete, its properties are now direct properties of address

Class object OBSOLETE: A record containing properties of an item id; instead of using a record with information private to the application, opaque ids are now used

Properties:

object class OBSOLETE constant [r/o] -- the class of the object; NOTE: This is a value private to Palm Desktop, not an AppleScript class

object number OBSOLETE small integer [r/o] -- the number of the object within its class

object instance OBSOLETE small integer [r/o] -- the recurring instance of the object (uniquely identifies a particular instance of a recurring item)

Class phone number: A record containing phone number information for an address book item

Properties:

phone label OBSOLETE reference -- the descriptive label of the phone number; obsolete, use ‘label’ instead

Class phone number label: A descriptive phone number label

Properties:

title international text -- the title of the label; obsolete, use ‘name’ instead

Class postal address: A record containing postal (street) address information for an address book item

Properties:

address label OBSOLETE reference -- the descriptive label of the address; obsolete, use ‘label’ instead

street OBSOLETE international text [r/o] -- the entire street address of the address, including all lines of the address; obsolete, use ‘street address one’ and ‘street address two’ instead

Class postal address label: A descriptive address label

Properties:

title international text -- the title of the label; obsolete, use ‘name’ instead

Class to do: A to do item

Properties:

all fields OBSOLETE record [r/o] -- a record containing all fields of the to do item; obsolete, use ‘properties’ instead

Class view info OBSOLETE: Properties common to all view classes; obsolete, use the properties inherited from class ‘view’ instead

Properties:

view title OBSOLETE international text [r/o] -- the name of the view; obsolete, use ‘name’ instead

Events:

attach: Attach any two items

attach reference -- the first object to attach

to OBSOLETE reference -- the object or file to attach; obsolete, use ‘to’ instead

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

count reference -- the object in which the items are to be counted

[on OBSOLETE reference] -- the day on which to count events or to dos; obsolete, use a reference with ‘...of calendar day...’ instead

Result: integer -- the number of elements

export OBSOLETE: Export items to a text file; obsolete, get item properties and convert them to the desired format instead

export OBSOLETE type class -- the class of items to export (address, to do, or memo)

in file specification -- the file in which to save the exported items

locate address OBSOLETE: Open a Find dialog to locate an address book entry; obsolete, use ‘every...whose...’ to select address book entries instead

locate address OBSOLETE

Result: reference -- to the found address

show: Show an item

show reference -- the item to show

[in OBSOLETE reference] -- the window in which to show the item; obsolete, use ‘date book’ instead

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/PalmDesktop_41_asDict.html
|| created: 4-Aug-03, 9:48 PM; updated: 4-Aug-03, 2:48 PM
|| size: 128253 bytes