The FooDoo Lounge

OmniOutliner 2.1.1 Dictionary

Copyright © 2000-2002 The Omni Group. All rights reserved.

Index

  1. Standard Suite
  2. Text Suite
  3. Extended Text Suite
  4. OmniOutliner 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.

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:

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

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.

underlined boolean -- Is the first character underlined?

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

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

superscript integer -- The superscript level of the text.

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

text Unicode text -- The actual text content.

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

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.

underlined boolean -- Is the first character underlined?

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

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

superscript integer -- The superscript level of the text.

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

text Unicode text -- The actual text content.

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

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.

underlined boolean -- Is the first character underlined?

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

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

superscript integer -- The superscript level of the text.

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

text Unicode text -- The actual text content.

color color -- The color of the first character.

Class text: Rich (styled) text

Plural form:

texts

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

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.

underlined boolean -- Is the first character underlined?

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

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

superscript integer -- The superscript level of the text.

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

text Unicode text -- The actual text content.

color color -- The color of the first character.

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

Plural form:

text attachments

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

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

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.

underlined boolean -- Is the first character underlined?

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

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

superscript integer -- The superscript level of the text.

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

text Unicode text -- The actual text content.

color color -- The color of the first character.

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

OmniOutliner Suite: OmniOutliner specific classes and events.

Classes:

Class application:

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

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.

Class cell: The intersection of an item and a column. One value.

Plural form:

cells

Properties:

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

column column [r/o] -- Column that this cell is in

row row [r/o] -- Row that this cell is in

text text -- Text of this cell

value item -- Value of this cell

Class child: For a document, the top level rows. For a row, the rows one level below this one.

Plural form:

children

Elements:

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

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

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

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

note text -- Contents of the note column.

topic text -- Contents of the outline column.

has subtopics boolean [r/o] -- Whether the row has any subtopics.

expanded boolean -- Whether the row's subtopics are visible.

hidden boolean -- Whether this row is hidden because one of its supertopics is not expanded.

level integer -- How 'deep' this item is. Top-level rows are level 1, subtopics of those rows are level 2, and so on.

state none/checked/indeterminate/unchecked -- The state of the check box for this row.

Class column: An outline column.

Plural form:

columns

Properties:

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

background color color -- The background color of the column

title Unicode text -- The title of the column.

width integer -- The width of the column in pixels.

Class document: An OmniOutliner document.

Plural form:

documents

Elements:

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

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

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

gutter color color -- The gutter color of the document. The gutter is the region of the outline on the left-hand side where items are indented.

background color color -- The background color of the document.

root row -- The invisible root item of the document. The children of the root are the level 1 items.

alternate color color -- The background color of every other row

Class parent: The rows that this row is contained by, from the top level on down.

Plural form:

parents

Elements:

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

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

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

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

note text -- Contents of the note column.

topic text -- Contents of the outline column.

has subtopics boolean [r/o] -- Whether the row has any subtopics.

expanded boolean -- Whether the row's subtopics are visible.

hidden boolean -- Whether this row is hidden because one of its supertopics is not expanded.

level integer -- How 'deep' this item is. Top-level rows are level 1, subtopics of those rows are level 2, and so on.

state none/checked/indeterminate/unchecked -- The state of the check box for this row.

Class row: An outline row.

Plural form:

rows

Elements:

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

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

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

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

note text -- Contents of the note column.

topic text -- Contents of the outline column.

has subtopics boolean [r/o] -- Whether the row has any subtopics.

expanded boolean -- Whether the row's subtopics are visible.

hidden boolean -- Whether this row is hidden because one of its supertopics is not expanded.

level integer -- How 'deep' this item is. Top-level rows are level 1, subtopics of those rows are level 2, and so on.

state none/checked/indeterminate/unchecked -- The state of the check box for this row.

Events:

group: Increase the outline level of a list of items by creating a new parent item for them and moving them right one step.

group reference -- the object for the command

Result: row -- the reply for the command

hoist: Hide all outline items except for this one's children.

hoist reference -- the object for the command

ungroup: Decrease the outline level of all children of an item, moving them left one step.

ungroup reference -- the object for the command

unhoist: Show items hidden in the last Hoist operation on an outline.

unhoist reference -- the object for the command

[unhoisting all boolean] -- Reverse just the last Hoist operation on the outline, or show items hidden by all previous Hoist operations.

 

|| url: http://www.foodoo.sunreal.com.au/info/dictionaries/OmniOutliner_211_asDict.html
|| created: 23-Aug-04, 4:00 PM; updated: 23-Aug-04, 4:02 PM
|| size: 96861 bytes