The FooDoo Lounge

OmniWeb 4.2.1 Dictionary

Copyright © 1994-2003 The Omni Group. All rights reserved.

Index

  1. Standard Suite
  2. Text Suite
  3. Extended Text Suite
  4. OmniWeb compatibility commands
  5. OmniWeb suite

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.

Extended Text Suite: Extended functionality for text.

Classes:

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

Plural form:

attribute runs

Elements:

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

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

Properties:

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

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

alignment justified/right/center/left -- Alignment of the text.

underlined boolean -- Is the first character underlined?

baseline offset small real -- Number of pixels shifted above or below the normal baseline.

color color -- The color of the first character.

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

superscript integer -- The superscript level of the text.

text Unicode text -- The actual text content.

Class character: This subdivides the text into characters.

Plural form:

characters

Elements:

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

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

Properties:

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

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

alignment justified/right/center/left -- Alignment of the text.

underlined boolean -- Is the first character underlined?

baseline offset small real -- Number of pixels shifted above or below the normal baseline.

color color -- The color of the first character.

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

superscript integer -- The superscript level of the text.

text Unicode text -- The actual text content.

Class paragraph: This subdivides the text into paragraphs.

Plural form:

paragraphs

Elements:

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

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

Properties:

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

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

alignment justified/right/center/left -- Alignment of the text.

underlined boolean -- Is the first character underlined?

baseline offset small real -- Number of pixels shifted above or below the normal baseline.

color color -- The color of the first character.

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

superscript integer -- The superscript level of the text.

text Unicode text -- The actual text content.

Class text: Rich (styled) text

Plural form:

texts

Elements:

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

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

Properties:

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

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

alignment justified/right/center/left -- Alignment of the text.

underlined boolean -- Is the first character underlined?

baseline offset small real -- Number of pixels shifted above or below the normal baseline.

color color -- The color of the first character.

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

superscript integer -- The superscript level of the text.

text Unicode text -- The actual text content.

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

Plural form:

text attachments

Elements:

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

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

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 word: This subdivides the text into words.

Plural form:

words

Elements:

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

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

Properties:

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

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

alignment justified/right/center/left -- Alignment of the text.

underlined boolean -- Is the first character underlined?

baseline offset small real -- Number of pixels shifted above or below the normal baseline.

color color -- The color of the first character.

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

superscript integer -- The superscript level of the text.

text Unicode text -- The actual text content.

Events:

bold: Bold some text

bold reference -- the object for the command

italicize: Italicize some text

italicize reference -- the object for the command

unbold: Unbold some text

unbold reference -- the object for the command

underline: Underline some text

underline reference -- the object for the command

unitalicize: Unitalicize some text

unitalicize reference -- the object for the command

ununderline: Ununderline some text

ununderline reference -- the object for the command

OmniWeb compatibility commands: AppleScript commands supported for compatibility with other applications.

Events:

GetWindowInfo: Given a window's numeric ID, returns a list containing its current URL and title string.

GetWindowInfo reference -- the object for the command

Result: list -- the reply for the command

ListWindows: Returns a list of the numeric IDs of all open browser windows.

ListWindows reference -- the object for the command

Result: list -- the reply for the command

OpenURL: Causes the web browser to display a specified URL.

OpenURL reference -- the object for the command

[to anything] -- The file to which to save the retrieved data

[toWindow integer] -- The numeric ID of the window to use.

[MIME Type Unicode text] -- The MIME Content-Type of the FormData.

[FormData anything] -- Data to use for a POST transaction.

Result: integer -- the reply for the command

ParseAnchor: Parses a URL (possibly relative to a base URL) and returns the resulting URL as a string.

ParseAnchor reference -- the object for the command

[withURL Unicode text] -- The base URL with respect to which to interpret a relative URL.

Result: string -- the reply for the command

OmniWeb suite: AppleScript commands and classes specific to OmniWeb.

Classes:

Class application: OmniWeb's top-level object.

Plural form:

applications

Elements:

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

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

fullVersion Unicode text [r/o] -- The complete version string for this instance of OmniWeb.

personal bookmarks bookmarks document [r/o] -- The default bookmarks document.

favorites bookmark [r/o] -- The bookmark item whose contents are displayed in the Favorites bar.

Class bookmark: A bookmark or shortcut item.

Plural form:

bookmarks

Elements:

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

effect follow in window/view as bookmarks/view as source/open new window -- the behavior of this bookmark when activated

is new boolean -- whether this page has been updated since it was last viewed.

note Unicode text -- the annotation text of this bookmark item.

is reachable boolean -- whether this page could be retrieved last time it was checked.

check interval integer -- how often this bookmark is automatically checked for changes, in seconds.

last checked date date [r/o] -- the date on which this bookmark was last retrieved.

address Unicode text -- the location to which this bookmark refers (a URL).

label Unicode text -- the label text of this bookmark item.

Class bookmarks document: A document containing a set of bookmarks.

Elements:

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

Properties:

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

is read only boolean [r/o] -- can the bookmarks in this document be modified?

address Unicode text [r/o] -- the URL at which these bookmarks are stored.

Class browser: A web browser window.

Plural form:

browsers

Properties:

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

has favorites boolean -- whether the browser window displays the favorites shelf

address Unicode text -- the URL currently being displayed in this browser.

shows address boolean -- whether the browser window always displays the address (URL) field

is busy boolean -- whether the browser is currently working on its display.

has toolbar boolean -- whether the browser window has a toolbar

Events:

GetURL: The Netscape way of displaying a URL in a window.

GetURL reference -- the object for the command

[to anything] -- Location to which the URL's contents should be written, as either a file or a POSIX path

check: Tells a bookmark to check for updates of its resource.

check reference -- the object for the command

[including children boolean] -- Cause all of the bookmark's children to check for updates as well.

do script: Execute the text as a script.

do script reference -- the object for the command

[language Unicode text] -- The language or language version of the script (defaults to JavaScript)

[window browser] -- The window in which to execute the script

flush cache: Flush all cached content.

flush cache reference -- the object for the command

reload: Reload the contents of this browser from the server.

reload reference -- the object for the command

stop: Stop a browser.

stop reference -- the object for the command

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/OmniWeb_421_asDict.html
|| created: 11-Aug-03, 2:49 PM; updated: 11-Aug-03, 2:49 PM
|| size: 91518 bytes