MacPython / i Term / TerminologyΒΆ
Legacy Wiki Page
This page was migrated from the old MoinMoin-based wiki. Information may be outdated or no longer applicable. For current documentation, see python.org.
(iTerm.app terminology, generated from /Applications/iTerm.app)
Suites |
|
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.
Children:
terminal character paragraph i_term_application color document attribute_run window word session text
Properties:
class_ (r/o) Type β The class of the object.
properties AERecord β All of the objectβs properties.\
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:
color β A color.
Parent:
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:
characters β index | relative | range | test
attribute_runs β index | relative | range | test
attachment β index | relative | range | test
words β index | relative | range | test
paragraphs β index | relative | range | test\
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:
characters β index | relative | range | test
attribute_runs β index | relative | range | test
attachment β index | relative | range | test
words β index | relative | range | test
paragraphs β index | relative | range | test\
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:
characters β index | relative | range | test
attribute_runs β index | relative | range | test
attachment β index | relative | range | test
words β index | relative | range | test
paragraphs β index | relative | range | test\
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:
characters β index | relative | range | test
attribute_runs β index | relative | range | test
attachment β index | relative | range | test
words β index | relative | range | test
paragraphs β index | relative | range | test\
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:
characters β index | relative | range | test
attribute_runs β index | relative | range | test
attachment β index | relative | range | test
words β index | relative | range | test
paragraphs β index | relative | range | test\
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\
[contents_of_file=UnicodeText] β File to be written
[text=UnicodeText] β Text to be written
Result: None
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\