Differences between revisions 2 and 3
Revision 2 as of 2007-02-14 03:28:40
Size: 14753
Comment: subpage
Revision 3 as of 2008-11-15 14:00:57
Size: 14953
Editor: localhost
Comment: converted to 1.6 markup
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
|| '''Suites''' || [#suite_Standard_Suite Standard Suite] [#suite_Text_Suite Text Suite] [#suite_iTerm_Suite iTerm Suite] ||
|| '''Commands''' || [#command_close close] [#command_count count] [#command_delete delete] [#command_duplicate duplicate] [#command_exec_ exec_] [#command_exists exists] [#command_get get] [#command_launch launch] [#command_make make] [#command_move move] [#command_open open] [#command_print_ print_] [#command_quit quit] [#command_save save] [#command_select select] [#command_set set] [#command_terminate terminate] [#command_write write] ||
|| '''Classes''' || [#class_attachment attachment] [#class_attribute_run attribute_run] [#class_character character] [#class_color color] [#class_document document] [#class_i_term_application i_term_application] [#class_item item] [#class_paragraph paragraph] [#class_session session] [#class_terminal terminal] [#class_text text] [#class_window window] [#class_word word] ||


[[Anchor(suite_Standard_Suite)]]
|| '''Suites''' || [[#suite_Standard_Suite|Standard Suite]] [[#suite_Text_Suite|Text Suite]] [[#suite_iTerm_Suite|iTerm Suite]] ||
|| '''Commands''' || [[#command_close|close]] [[#command_count|count]] [[#command_delete|delete]] [[#command_duplicate|duplicate]] [[#command_exec_|exec_]] [[#command_exists|exists]] [[#command_get|get]] [[#command_launch|launch]] [[#command_make|make]] [[#command_move|move]] [[#command_open|open]] [[#command_print_|print_]] [[#command_quit|quit]] [[#command_save|save]] [[#command_select|select]] [[#command_set|set]] [[#command_terminate|terminate]] [[#command_write|write]] ||
|| '''Classes''' || [[#class_attachment|attachment]] [[#class_attribute_run|attribute_run]] [[#class_character|character]] [[#class_color|color]] [[#class_document|document]] [[#class_i_term_application|i_term_application]] [[#class_item|item]] [[#class_paragraph|paragraph]] [[#class_session|session]] [[#class_terminal|terminal]] [[#class_text|text]] [[#class_window|window]] [[#class_word|word]] ||


<<Anchor(suite_Standard_Suite)>>
Line 18: Line 18:
 [[Anchor(command_get)]]'''reference.get()''' -- Get the data for an object.[[BR]]  <<Anchor(command_get)>>'''reference.get()''' -- Get the data for an object.<<BR>>
Line 21: Line 21:
 [[Anchor(command_save)]]'''reference.save(...)''' -- Save an object.[[BR]]
  ['''as'''=''Unicode
Text''] -- The file type in which to save the data.[[BR]]
  ['''in_'''=''Alias''] -- The file in which to save the object.[[BR]]
  Result: ''None''

 [[Anchor(command_set)]]'''reference.set(...)''' -- Set an object's data.[[BR]]
  '''to'''=''Anything'' -- The new value.[[BR]]
  Result: ''None''

 [[Anchor(command_print_)]]'''application.print_(...)''' -- Print an object.[[BR]]
  [''
Alias''] -- The file(s) or document(s) to be printed.[[BR]]
  Result: ''None''

 [[Anchor(command_duplicate)]]
'''reference.duplicate(...)''' -- Copy object(s) and put the copies at a new location.[[BR]]
  '''to'''=''InsertionLoc'' -- The location for the new object(s).[[BR]]
  ['''with_properties'''=''AERecord''] -- Properties to be set in the new duplicated object(s).[[BR]]
  Result: ''None''

 [[Anchor(command_exists)]]'''reference.exists()''' -- Verify if an object exists.[[BR]]
 <<Anchor(command_save)>>'''reference.save(...)''' -- Save an object.<<BR>>
  
['''as'''=''UnicodeText''] -- The file type in which to save the data.<<BR>>
  ['''in_'''=''Alias''] -- The file in which to save the object.<<BR>>
  Result: ''None''

 <<Anchor(command_set)>>'''reference.set(...)''' -- Set an object's data.<<BR>>
  '''to'''=''Anything'' -- The new value.<<BR>>
  Result: ''None''

 <<Anchor(command_print_)>>'''application.print_(...)''' -- Print an object.<<BR>>
  
[''Alias''] -- The file(s) or document(s) to be printed.<<BR>>
  Result: ''None''

 <<
Anchor(command_duplicate)>>'''reference.duplicate(...)''' -- Copy object(s) and put the copies at a new location.<<BR>>
  '''to'''=''InsertionLoc'' -- The location for the new object(s).<<BR>>
  ['''with_properties'''=''AERecord''] -- Properties to be set in the new duplicated object(s).<<BR>>
  Result: ''None''

 <<Anchor(command_exists)>>'''reference.exists()''' -- Verify if an object exists.<<BR>>
Line 42: Line 42:
 [[Anchor(command_delete)]]'''reference.delete()''' -- Delete an object.[[BR]]
  Result: ''None''

 [[Anchor(command_make)]]'''application.make(...)''' -- Make a new object.[[BR]]
  ['''with_properties'''=''AERecord''] -- The initial values for properties of the object.[[BR]]
  '''new'''=''Type'' -- The class of the new object.[[BR]]
  ['''with_data'''=''Anything'']
-- The initial data for the object.[[BR]]
  ['''at'''=''InsertionLoc''] -- The location at which to insert the object.[[BR]]
 <<Anchor(command_delete)>>'''reference.delete()''' -- Delete an object.<<BR>>
  Result: ''None''

 <<Anchor(command_make)>>'''application.make(...)''' -- Make a new object.<<BR>>
  ['''with_properties'''=''AERecord''] -- The initial values for properties of the object.<<BR>>
  '''new'''=''Type'' -- The class of the new object.<<BR>>
  
['''with_data'''=''Anything''] -- The initial data for the object.<<BR>>
  
['''at'''=''InsertionLoc''] -- The location at which to insert the object.<<BR>>
Line 52: Line 52:
 [[Anchor(command_open)]]'''application.open(...)''' -- Open an object.[[BR]]
  [''Alias''] -- The file(s) to be opened.[[BR]]

  Result: ''None''

 [[Anchor(command_close)]]'''reference.close(...)''' -- Close an object.[[BR]]
  ['''saving'''=''k.yes | k.no | k.ask''] -- Specifies whether changes should be saved before closing.[[BR]]

  ['''saving_in'''=''Alias''] -- The file in which to save the object.[[BR]]
  Result: ''None''

 [[Anchor(command_count)]]'''reference.count(...)''' -- Return the number of elements of a particular class within an object.[[BR]]
  ['''each'''=''Type''] -- The class of objects to be counted.[[BR]]
 <<Anchor(command_open)>>'''application.open(...)''' -- Open an object.<<BR>>
  [''Alias''
] -- The file(s) to be opened.<<BR>>
  Result: ''None''

 <<Anchor(command_close)>>'''reference.close(...)''' -- Close an object.<<BR>>
  ['''saving'''=''k.yes | k.no | k.ask''
] -- Specifies whether changes should be saved before closing.<<BR>>
  ['''saving_in'''=''Alias''] -- The file in which to save the object.<<BR>>
  Result: ''None''

 <<Anchor(command_count)>>'''reference.count(...)''' -- Return the number of elements of a particular class within an object.<<BR>>
  ['''each'''=''Type''] -- The class of objects to be counted.<<BR>>
Line 65: Line 65:
 [[Anchor(command_move)]]'''reference.move(...)''' -- Move object(s) to a new location.[[BR]]
  '''to'''=''InsertionLoc'' -- The new location for the object(s).[[BR]]
  Result: ''None''

 [[Anchor(command_quit)]]'''reference.quit(...)''' -- Quit an application.[[BR]]
  ['''saving'''=''k.yes | k.no | k.ask''] -- Specifies whether changes should be saved before quitting.[[BR]]
 <<Anchor(command_move)>>'''reference.move(...)''' -- Move object(s) to a new location.<<BR>>
  '''to'''=''InsertionLoc'' -- The new location for the object(s).<<BR>>
  Result: ''None''

 <<Anchor(command_quit)>>'''reference.quit(...)''' -- Quit an application.<<BR>>
  ['''saving'''=''k.yes | k.no | k.ask''] -- Specifies whether changes should be saved before quitting.<<BR>>
Line 76: Line 76:
 [[Anchor(class_document)]]'''document''' -- A document.
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   

   '''modified''' (r/o) ''Boolean'' -- Has the document been modified since the last save?[[BR]]
   '''path''' ''UnicodeText'' -- The document's path.[[BR]]
   '''name''' ''UnicodeText'' -- The document's name.[[BR]]
   
  
 
 [[
Anchor(class_item)]]'''item''' -- A scriptable object.
 <<Anchor(class_document)>>'''document''' -- A document.
  Parent:
   ''
[[#class_item|item]]''       
  Properties:
   
   '''modified''' (r/o) ''Boolean'' -- Has the document been modified since the last save?<<BR>>
   '''path''' ''UnicodeText'' -- The document's path.<<BR>>
   '''name''' ''UnicodeText'' -- The document's name.<<BR>>
   
  
 
 <<
Anchor(class_item)>>'''item''' -- A scriptable object.
Line 92: Line 92:
   ''[#class_terminal terminal]'' ''[#class_character character]'' ''[#class_paragraph paragraph]'' ''[#class_i_term_application i_term_application]'' ''[#class_color color]'' ''[#class_document document]'' ''[#class_attribute_run attribute_run]'' ''[#class_window window]'' ''[#class_word word]'' ''[#class_session session]'' ''[#class_text text]''
  
  Properties:
   
   '''class_''' (r/o) ''Type'' -- The class of the object.[[BR]]
   '''properties''' ''AERecord'' -- All of the object's properties.[[BR]]
   
  
 
 [[
Anchor(class_window)]]'''window''' -- A window.
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   
   '''zoomed''' ''Boolean'' -- Whether the window is currently zoomed.[[BR]]
   '''miniaturized''' ''Boolean'' -- Whether the window is currently miniaturized.[[BR]]
   '''name''' ''UnicodeText'' -- The full title of the window.[[BR]]
   '''floating''' (r/o) ''Boolean'' -- Whether the window floats.[[BR]]
   '''modal''' (r/o) ''Boolean'' -- Whether the window is the application's current modal window.[[BR]]
   '''miniaturizable''' (r/o) ''Boolean'' -- Whether the window can be miniaturized.[[BR]]
   '''visible''' ''Boolean'' -- Whether the window is currently visible.[[BR]]
   '''closeable''' (r/o) ''Boolean'' -- Whether the window has a close box.[[BR]]
   '''resizable''' (r/o) ''Boolean'' -- Whether the window can be resized.[[BR]]
   '''zoomable''' (r/o) ''Boolean'' -- Whether the window can be zoomed.[[BR]]
   '''id''' (r/o) ''SInt32'' -- The unique identifier of the window.[[BR]]
   '''bounds''' ''QDRectangle'' -- The bounding rectangle of the window.[[BR]]
   '''titled''' (r/o) ''Boolean'' -- Whether the window has a title bar.[[BR]]
   '''index''' ''SInt32'' -- The index of the window in the back-to-front window ordering.[[BR]]
   '''document''' (r/o) ''[#class_document k.document]'' -- The document whose contents are being displayed in the window.[[BR]]
   
  
 
 [[
Anchor(class_i_term_application)]]'''i_term_application''' -- Main application class
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   
   '''version''' (r/o) ''UnicodeText'' -- The version of the application.[[BR]]
   '''frontmost''' (r/o) ''Boolean'' -- Is this the frontmost (active) application?[[BR]]
   '''name''' (r/o) ''UnicodeText'' -- The name of the application.[[BR]]
   '''current_terminal''' ''[#class_terminal k.terminal]'' -- currently active terminal[[BR]]
   
  Elements:
   
   '''[#class_terminal terminals]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_window windows]''' -- '' name | index | relative | range | test | id''[[BR]]
   '''
[#class_document documents]''' -- '' name | index | relative | range | test''[[BR]]
   
 
 [[
Anchor(class_color)]]'''color''' -- A color.
  Parent:
   ''[#class_item item]''
  
  
  
  
 


[[
Anchor(suite_Text_Suite)]]
   ''[[#class_terminal|terminal]]'' ''[[#class_character|character]]'' ''[[#class_paragraph|paragraph]]'' ''[[#class_i_term_application|i_term_application]]'' ''[[#class_color|color]]'' ''[[#class_document|document]]'' ''[[#class_attribute_run|attribute_run]]'' ''[[#class_window|window]]'' ''[[#class_word|word]]'' ''[[#class_session|session]]'' ''[[#class_text|text]]''
  
  Properties:
   
   '''class_''' (r/o) ''Type'' -- The class of the object.<<BR>>
   '''properties''' ''AERecord'' -- All of the object's properties.<<BR>>
   
  
 
 <<
Anchor(class_window)>>'''window''' -- A window.
  Parent:
   ''[[#class_item|item]]''
  
  
  Properties:
   
   '''zoomed''' ''Boolean'' -- Whether the window is currently zoomed.<<BR>>
   '''miniaturized''' ''Boolean'' -- Whether the window is currently miniaturized.<<BR>>
   '''name''' ''UnicodeText'' -- The full title of the window.<<BR>>
   '''floating''' (r/o) ''Boolean'' -- Whether the window floats.<<BR>>
   '''modal''' (r/o) ''Boolean'' -- Whether the window is the application's current modal window.<<BR>>
   '''miniaturizable''' (r/o) ''Boolean'' -- Whether the window can be miniaturized.<<BR>>
   '''visible''' ''Boolean'' -- Whether the window is currently visible.<<BR>>
   '''closeable''' (r/o) ''Boolean'' -- Whether the window has a close box.<<BR>>
   '''resizable''' (r/o) ''Boolean'' -- Whether the window can be resized.<<BR>>
   '''zoomable''' (r/o) ''Boolean'' -- Whether the window can be zoomed.<<BR>>
   '''id''' (r/o) ''SInt32'' -- The unique identifier of the window.<<BR>>
   '''bounds''' ''QDRectangle'' -- The bounding rectangle of the window.<<BR>>
   '''titled''' (r/o) ''Boolean'' -- Whether the window has a title bar.<<BR>>
   '''index''' ''SInt32'' -- The index of the window in the back-to-front window ordering.<<BR>>
   '''document''' (r/o) ''[[#class_document|k.document]]'' -- The document whose contents are being displayed in the window.<<BR>>
   
  
 
 <<
Anchor(class_i_term_application)>>'''i_term_application''' -- Main application class
  Parent:
   ''[[#class_item|item]]''
  
  
  Properties:
   
   '''version''' (r/o) ''UnicodeText'' -- The version of the application.<<BR>>
   '''frontmost''' (r/o) ''Boolean'' -- Is this the frontmost (active) application?<<BR>>
   '''name''' (r/o) ''UnicodeText'' -- The name of the application.<<BR>>
   '''current_terminal''' ''[[#class_terminal|k.terminal]]'' -- currently active terminal<<BR>>
   
  Elements:
   
   '''[[#class_terminal|terminals]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_window|windows]]''' -- '' name | index | relative | range | test | id''<<BR>>
   '''[
[#class_document|documents]]''' -- '' name | index | relative | range | test''<<BR>>
   
 
 <<
Anchor(class_color)>>'''color''' -- A color.
  Parent:
   ''[[#class_item|item]]''
  
  
  
  
 


<<
Anchor(suite_Text_Suite)>>
Line 162: Line 162:
 [[Anchor(class_attachment)]]'''attachment''' -- Represents an inline text attachment. This class is used mainly for make commands.
  Parent:
   ''[#class_text text]''
  
  
  Properties:
   
   '''file_name''' ''UnicodeText'' -- The path to the file for the attachment[[BR]]
   
  
 
 [[Anchor(class_text)]]'''text''' -- Rich (styled) text
  Parent:
   ''[#class_item item]''
 <<Anchor(class_attachment)>>'''attachment''' -- Represents an inline text attachment. This class is used mainly for make commands.
  Parent:
   ''[[#class_text|text]]''
  
  
  Properties:
   
   '''file_name''' ''UnicodeText'' -- The path to the file for the attachment<<BR>>
   
  
 
 <<Anchor(class_text)>>'''text''' -- Rich (styled) text
  Parent:
   ''[[#class_item|item]]''
Line 178: Line 178:
   ''[#class_attachment attachment]''
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.[[BR]]
   '''font''' ''UnicodeText'' -- The name of the font of the first character.[[BR]]
   '''color''' ''
[#class_color k.color]'' -- The color of the first character.[[BR]]
   
  Elements:
   
   '''[#class_character characters]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attribute_run attribute_runs]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attachment attachment]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_word words]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_paragraph paragraphs]''' -- '' index | relative | range | test''[[BR]]
   
 
 [[
Anchor(class_attribute_run)]]'''attribute_run''' -- This subdivides the text into chunks that all have the same attributes.
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.[[BR]]
   '''font''' ''UnicodeText'' -- The name of the font of the first character.[[BR]]
   '''color''' ''
[#class_color k.color]'' -- The color of the first character.[[BR]]
   
  Elements:
   
   '''[#class_character characters]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attribute_run attribute_runs]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attachment attachment]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_word words]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_paragraph paragraphs]''' -- '' index | relative | range | test''[[BR]]
   
 
 [[
Anchor(class_character)]]'''character''' -- This subdivides the text into characters.
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.[[BR]]
   '''font''' ''UnicodeText'' -- The name of the font of the first character.[[BR]]
   '''color''' ''
[#class_color k.color]'' -- The color of the first character.[[BR]]
   
  Elements:
   
   '''[#class_character characters]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attribute_run attribute_runs]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attachment attachment]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_word words]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_paragraph paragraphs]''' -- '' index | relative | range | test''[[BR]]
   
 
 [[
Anchor(class_word)]]'''word''' -- This subdivides the text into words.
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.[[BR]]
   '''font''' ''UnicodeText'' -- The name of the font of the first character.[[BR]]
   '''color''' ''
[#class_color k.color]'' -- The color of the first character.[[BR]]
   
  Elements:
   
   '''[#class_character characters]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attribute_run attribute_runs]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attachment attachment]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_word words]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_paragraph paragraphs]''' -- '' index | relative | range | test''[[BR]]
   
 
 [[
Anchor(class_paragraph)]]'''paragraph''' -- This subdivides the text into paragraphs.
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.[[BR]]
   '''font''' ''UnicodeText'' -- The name of the font of the first character.[[BR]]
   '''color''' ''
[#class_color k.color]'' -- The color of the first character.[[BR]]
   
  Elements:
   
   '''[#class_character characters]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attribute_run attribute_runs]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_attachment attachment]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_word words]''' -- '' index | relative | range | test''[[BR]]
   '''
[#class_paragraph paragraphs]''' -- '' index | relative | range | test''[[BR]]
   
 


[[
Anchor(suite_iTerm_Suite)]]
   ''[[#class_attachment|attachment]]''
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.<<BR>>
   '''font''' ''UnicodeText'' -- The name of the font of the first character.<<BR>>
   '''color''' ''[
[#class_color|k.color]]'' -- The color of the first character.<<BR>>
   
  Elements:
   
   '''[[#class_character|characters]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attribute_run|attribute_runs]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attachment|attachment]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_word|words]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_paragraph|paragraphs]]''' -- '' index | relative | range | test''<<BR>>
   
 
 <<
Anchor(class_attribute_run)>>'''attribute_run''' -- This subdivides the text into chunks that all have the same attributes.
  Parent:
   ''[[#class_item|item]]''
  
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.<<BR>>
   '''font''' ''UnicodeText'' -- The name of the font of the first character.<<BR>>
   '''color''' ''[
[#class_color|k.color]]'' -- The color of the first character.<<BR>>
   
  Elements:
   
   '''[[#class_character|characters]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attribute_run|attribute_runs]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attachment|attachment]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_word|words]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_paragraph|paragraphs]]''' -- '' index | relative | range | test''<<BR>>
   
 
 <<
Anchor(class_character)>>'''character''' -- This subdivides the text into characters.
  Parent:
   ''[[#class_item|item]]''
  
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.<<BR>>
   '''font''' ''UnicodeText'' -- The name of the font of the first character.<<BR>>
   '''color''' ''[
[#class_color|k.color]]'' -- The color of the first character.<<BR>>
   
  Elements:
   
   '''[[#class_character|characters]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attribute_run|attribute_runs]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attachment|attachment]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_word|words]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_paragraph|paragraphs]]''' -- '' index | relative | range | test''<<BR>>
   
 
 <<
Anchor(class_word)>>'''word''' -- This subdivides the text into words.
  Parent:
   ''[[#class_item|item]]''
  
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.<<BR>>
   '''font''' ''UnicodeText'' -- The name of the font of the first character.<<BR>>
   '''color''' ''[
[#class_color|k.color]]'' -- The color of the first character.<<BR>>
   
  Elements:
   
   '''[[#class_character|characters]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attribute_run|attribute_runs]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attachment|attachment]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_word|words]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_paragraph|paragraphs]]''' -- '' index | relative | range | test''<<BR>>
   
 
 <<
Anchor(class_paragraph)>>'''paragraph''' -- This subdivides the text into paragraphs.
  Parent:
   ''[[#class_item|item]]''
  
  
  Properties:
   
   '''size''' ''SInt32'' -- The size in points of the first character.<<BR>>
   '''font''' ''UnicodeText'' -- The name of the font of the first character.<<BR>>
   '''color''' ''[
[#class_color|k.color]]'' -- The color of the first character.<<BR>>
   
  Elements:
   
   '''[[#class_character|characters]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attribute_run|attribute_runs]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_attachment|attachment]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_word|words]]''' -- '' index | relative | range | test''<<BR>>
   '''[
[#class_paragraph|paragraphs]]''' -- '' index | relative | range | test''<<BR>>
   
 


<<
Anchor(suite_iTerm_Suite)>>
Line 283: Line 283:
 [[Anchor(command_launch)]]'''reference.launch(...)''' -- Launches a default or saved session[[BR]]
  '''session'''=''UnicodeText'' -- Name of session to be launched[[BR]]
  Result: ''None''

 [[Anchor(command_terminate)]]'''reference.terminate()''' -- Terminates a session[[BR]]
  Result: ''None''

 [[Anchor(command_exec_)]]'''reference.exec_(...)''' -- Executes a command in a session[[BR]]
  '''command'''=''UnicodeText'' -- Command executed in a session[[BR]]
  Result: ''None''

 [[Anchor(command_write)]]'''reference.write(...)''' -- Writes text or file contents into a session[[BR]]
  ['''contents
_of_file'''=''UnicodeText''] -- File to be written[[BR]]
  ['''text'''=''UnicodeText''] -- Text to be written[[BR]]
  Result: ''None''

 [[Anchor(command_select)]]'''reference.select()''' -- Selects a specified session[[BR]]
 <<Anchor(command_launch)>>'''reference.launch(...)''' -- Launches a default or saved session<<BR>>
  '''session'''=''UnicodeText'' -- Name of session to be launched<<BR>>
  Result: ''None''

 <<Anchor(command_terminate)>>'''reference.terminate()''' -- Terminates a session<<BR>>
  Result: ''None''

 <<Anchor(command_exec_)>>'''reference.exec_(...)''' -- Executes a command in a session<<BR>>
  '''command'''=''UnicodeText'' -- Command executed in a session<<BR>>
  Result: ''None''

 <<Anchor(command_write)>>'''reference.write(...)''' -- Writes text or file contents into a session<<BR>>
  ['''contents_of_file'''=''UnicodeText''
] -- File to be written<<BR>>
  ['''text'''=''UnicodeText''
] -- Text to be written<<BR>>
  Result: ''None''

 <<Anchor(command
_select)>>'''reference.select()''' -- Selects a specified session<<BR>>
Line 305: Line 305:
 [[Anchor(class_terminal)]]'''terminal''' -- A pseudo terminal
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   
   '''number_of_columns''' ''SInt32'' -- Number of columns[[BR]]
   '''number_of_rows''' ''SInt32'' -- Number of rows[[BR]]
   '''current_session''' ''
[#class_session k.session]'' -- current session in the terminal[[BR]]
   
  Elements:
   
   '''[#class_session sessions]''' -- '' name | index | relative | range | test | id''[[BR]]
   
 
 [[
Anchor(class_session)]]'''session''' -- A terminal session
  Parent:
   ''[#class_item item]''
  
  
  Properties:
   
   '''background_color''' ''[#class_color k.color]'' -- Background color[[BR]]
   '''transparency''' ''ShortFloat'' -- Transparency (0-1)[[BR]]
   '''bold_color''' ''[#class_color k.color]'' -- Bold color[[BR]]
   '''background_image_path''' ''UnicodeText'' -- Path to background image[[BR]]
   '''name''' ''UnicodeText'' -- Name of this session[[BR]]
   '''foreground_color''' ''[#class_color k.color]'' -- Foreground color[[BR]]
   '''id''' (r/o) ''UnicodeText'' -- id of session; set to tty name[[BR]]
   '''selection_color''' ''
[#class_color k.color]'' -- Selection color[[BR]]
   '''tty''' (r/o) ''UnicodeText'' -- tty device of session[[BR]]
   '''contents''' (r/o) ''[#class_text k.text]'' -- text of the session[[BR]]
   '''number''' ''SInt32'' -- index of session[[BR]]
 <<Anchor(class_terminal)>>'''terminal''' -- A pseudo terminal
  Parent:
   ''[[#class_item|item]]''
  
  
  Properties:
   
   '''number_of_columns''' ''SInt32'' -- Number of columns<<BR>>
   '''number_of_rows''' ''SInt32'' -- Number of rows<<BR>>
   '''current_session''' ''[
[#class_session|k.session]]'' -- current session in the terminal<<BR>>
   
  Elements:
   
   '''[[#class_session|sessions]]''' -- '' name | index | relative | range | test | id''<<BR>>
   
 
 <<
Anchor(class_session)>>'''session''' -- A terminal session
  Parent:
   ''[[#class_item|item]]''
  
  
  Properties:
   
   '''background_color''' ''[[#class_color|k.color]]'' -- Background color<<BR>>
   '''transparency''' ''ShortFloat'' -- Transparency (0-1)<<BR>>
   '''bold_color''' ''[[#class_color|k.color]]'' -- Bold color<<BR>>
   '''background_image_path''' ''UnicodeText'' -- Path to background image<<BR>>
   '''name''' ''UnicodeText'' -- Name of this session<<BR>>
   '''foreground_color''' ''[[#class_color|k.color]]'' -- Foreground color<<BR>>
   '''id''' (r/o) ''UnicodeText'' -- id of session; set to tty name<<BR>>
   '''selection_color''' ''[
[#class_color|k.color]]'' -- Selection color<<BR>>
   '''tty''' (r/o) ''UnicodeText'' -- tty device of session<<BR>>
   '''contents''' (r/o) ''[[#class_text|k.text]]'' -- text of the session<<BR>>
   '''number''' ''SInt32'' -- index of session<<BR>>

(iTerm.app terminology, generated from /Applications/iTerm.app)

Suites

Standard Suite Text Suite iTerm Suite

Commands

close count delete duplicate exec_ exists get launch make move open print_ quit save select set terminate write

Classes

attachment attribute_run character color document i_term_application item paragraph session terminal text window word

Standard Suite

Common classes and commands for most applications.

Commands

  • reference.get() -- Get the data for an object.

    • Result: Anything -- the reply for the command

    reference.save(...) -- Save an object.

    • [as=UnicodeText] -- The file type in which to save the data.
      [in_=Alias] -- The file in which to save the object.
      Result: None

    reference.set(...) -- Set an object's data.

    • to=Anything -- The new value.
      Result: None

    application.print_(...) -- Print an object.

    • [Alias] -- The file(s) or document(s) to be printed.
      Result: None

    reference.duplicate(...) -- Copy object(s) and put the copies at a new location.

    • to=InsertionLoc -- The location for the new object(s).
      [with_properties=AERecord] -- Properties to be set in the new duplicated object(s).
      Result: None

    reference.exists() -- Verify if an object exists.

    • Result: Boolean -- the reply for the command

    reference.delete() -- Delete an object.

    • Result: None

    application.make(...) -- Make a new object.

    • [with_properties=AERecord] -- The initial values for properties of the object.
      new=Type -- The class of the new object.
      [with_data=Anything] -- The initial data for the object.
      [at=InsertionLoc] -- The location at which to insert the object.
      Result: ObjectSpecifier -- the reply for the command

    application.open(...) -- Open an object.

    • [Alias] -- The file(s) to be opened.
      Result: None

    reference.close(...) -- Close an object.

    • [saving=k.yes | k.no | k.ask] -- Specifies whether changes should be saved before closing.
      [saving_in=Alias] -- The file in which to save the object.
      Result: None

    reference.count(...) -- Return the number of elements of a particular class within an object.

    • [each=Type] -- The class of objects to be counted.
      Result: SInt32 -- the reply for the command

    reference.move(...) -- Move object(s) to a new location.

    • to=InsertionLoc -- The new location for the object(s).
      Result: None

    reference.quit(...) -- Quit an application.

    • [saving=k.yes | k.no | k.ask] -- Specifies whether changes should be saved before quitting.
      Result: None

Classes

  • document -- A document.

    • Parent: Properties:
      • modified (r/o) Boolean -- Has the document been modified since the last save?
        path UnicodeText -- The document's path.
        name UnicodeText -- The document's name.

    item -- A scriptable object.

    window -- A window.

    • Parent: Properties:
      • zoomed Boolean -- Whether the window is currently zoomed.
        miniaturized Boolean -- Whether the window is currently miniaturized.
        name UnicodeText -- The full title of the window.
        floating (r/o) Boolean -- Whether the window floats.
        modal (r/o) Boolean -- Whether the window is the application's current modal window.
        miniaturizable (r/o) Boolean -- Whether the window can be miniaturized.
        visible Boolean -- Whether the window is currently visible.
        closeable (r/o) Boolean -- Whether the window has a close box.
        resizable (r/o) Boolean -- Whether the window can be resized.
        zoomable (r/o) Boolean -- Whether the window can be zoomed.
        id (r/o) SInt32 -- The unique identifier of the window.
        bounds QDRectangle -- The bounding rectangle of the window.
        titled (r/o) Boolean -- Whether the window has a title bar.
        index SInt32 -- The index of the window in the back-to-front window ordering.
        document (r/o) k.document -- The document whose contents are being displayed in the window.

    i_term_application -- Main application class

    • Parent: Properties:
      • version (r/o) UnicodeText -- The version of the application.
        frontmost (r/o) Boolean -- Is this the frontmost (active) application?
        name (r/o) UnicodeText -- The name of the application.
        current_terminal k.terminal -- currently active terminal

      Elements:
      • terminals -- index | relative | range | test
        windows -- name | index | relative | range | test | id
        documents -- name | index | relative | range | test

    color -- A color.

Text Suite

A set of basic classes for text processing.

Classes

  • attachment -- Represents an inline text attachment. This class is used mainly for make commands.

    • Parent: Properties:
      • file_name UnicodeText -- The path to the file for the attachment

    text -- Rich (styled) text

    • Parent: Children: Properties:
      • size SInt32 -- The size in points of the first character.
        font UnicodeText -- The name of the font of the first character.
        color k.color -- The color of the first character.

      Elements:

    attribute_run -- This subdivides the text into chunks that all have the same attributes.

    • Parent: Properties:
      • size SInt32 -- The size in points of the first character.
        font UnicodeText -- The name of the font of the first character.
        color k.color -- The color of the first character.

      Elements:

    character -- This subdivides the text into characters.

    • Parent: Properties:
      • size SInt32 -- The size in points of the first character.
        font UnicodeText -- The name of the font of the first character.
        color k.color -- The color of the first character.

      Elements:

    word -- This subdivides the text into words.

    • Parent: Properties:
      • size SInt32 -- The size in points of the first character.
        font UnicodeText -- The name of the font of the first character.
        color k.color -- The color of the first character.

      Elements:

    paragraph -- This subdivides the text into paragraphs.

    • Parent: Properties:
      • size SInt32 -- The size in points of the first character.
        font UnicodeText -- The name of the font of the first character.
        color k.color -- The color of the first character.

      Elements:

iTerm Suite

Scripting interface for iTerm.app

Commands

  • reference.launch(...) -- Launches a default or saved session

    • session=UnicodeText -- Name of session to be launched
      Result: None

    reference.terminate() -- Terminates a session

    • Result: None

    reference.exec_(...) -- Executes a command in a session

    • command=UnicodeText -- Command executed in a session
      Result: None

    reference.write(...) -- Writes text or file contents into a session

    reference.select() -- Selects a specified session

    • Result: None

Classes

  • terminal -- A pseudo terminal

    • Parent: Properties:
      • number_of_columns SInt32 -- Number of columns
        number_of_rows SInt32 -- Number of rows
        current_session k.session -- current session in the terminal

      Elements:
      • sessions -- name | index | relative | range | test | id

    session -- A terminal session

    • Parent: Properties:
      • background_color k.color -- Background color
        transparency ShortFloat -- Transparency (0-1)
        bold_color k.color -- Bold color
        background_image_path UnicodeText -- Path to background image
        name UnicodeText -- Name of this session
        foreground_color k.color -- Foreground color
        id (r/o) UnicodeText -- id of session; set to tty name
        selection_color k.color -- Selection color
        tty (r/o) UnicodeText -- tty device of session
        contents (r/o) k.text -- text of the session
        number SInt32 -- index of session

MacPython/iTerm/Terminology (last edited 2008-11-15 14:00:57 by localhost)

Unable to edit the page? See the FrontPage for instructions.