CodeWarrior
index
/System/Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/plat-mac/lib-scriptpackages/CodeWarrior/__init__.py
Module Docs

Package generated from /Volumes/Sap/Applications (Mac OS 9)/Metrowerks CodeWarrior 7.0/Metrowerks CodeWarrior/CodeWarrior IDE 4.2.5

 
Package Contents
       
CodeWarrior_suite
Metrowerks_Shell_Suite
Required
Standard_Suite

 
Classes
       
CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events
CodeWarrior(CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events, CodeWarrior.Standard_Suite.Standard_Suite_Events, CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events, CodeWarrior.Required.Required_Events, aetools.TalkTo)
CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events
CodeWarrior(CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events, CodeWarrior.Standard_Suite.Standard_Suite_Events, CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events, CodeWarrior.Required.Required_Events, aetools.TalkTo)
CodeWarrior.Required.Required_Events(StdSuites.Required_Suite.Required_Suite_Events)
CodeWarrior(CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events, CodeWarrior.Standard_Suite.Standard_Suite_Events, CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events, CodeWarrior.Required.Required_Events, aetools.TalkTo)
CodeWarrior.Standard_Suite.Standard_Suite_Events(StdSuites.Standard_Suite.Standard_Suite_Events)
CodeWarrior(CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events, CodeWarrior.Standard_Suite.Standard_Suite_Events, CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events, CodeWarrior.Required.Required_Events, aetools.TalkTo)
aetools.TalkTo
CodeWarrior(CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events, CodeWarrior.Standard_Suite.Standard_Suite_Events, CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events, CodeWarrior.Required.Required_Events, aetools.TalkTo)

 
class CodeWarrior(CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events, CodeWarrior.Standard_Suite.Standard_Suite_Events, CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events, CodeWarrior.Required.Required_Events, aetools.TalkTo)
    
Method resolution order:
CodeWarrior
CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events
CodeWarrior.Standard_Suite.Standard_Suite_Events
StdSuites.Standard_Suite.Standard_Suite_Events
_builtinSuites.builtin_Suite.builtin_Suite_Events
CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events
CodeWarrior.Required.Required_Events
StdSuites.Required_Suite.Required_Suite_Events
aetools.TalkTo

Methods inherited from CodeWarrior.CodeWarrior_suite.CodeWarrior_suite_Events:
add(self, _object, _attributes={}, **_arguments)
add: add elements to a project or target
Required argument: an AE object reference
Keyword argument new: the class of the new element or elements to add
Keyword argument with_data: the initial data for the element or elements
Keyword argument to_targets: the targets to which the new element or elements will be added
Keyword argument to_group: the group to which the new element or elements will be added
Keyword argument _attributes: AppleEvent attribute dictionary
build(self, _no_object=None, _attributes={}, **_arguments)
build: build a project or target (equivalent of the Make menu command)
Keyword argument _attributes: AppleEvent attribute dictionary
check(self, _object=None, _attributes={}, **_arguments)
check: check the syntax of a file in a project or target
Required argument: the file or files to be checked
Keyword argument _attributes: AppleEvent attribute dictionary
compile_file(self, _object=None, _attributes={}, **_arguments)
compile file: compile a file in a project or target
Required argument: the file or files to be compiled
Keyword argument _attributes: AppleEvent attribute dictionary
disassemble_file(self, _object=None, _attributes={}, **_arguments)
disassemble file: disassemble a file in a project or target
Required argument: the file or files to be disassembled
Keyword argument _attributes: AppleEvent attribute dictionary
export(self, _no_object=None, _attributes={}, **_arguments)
export: Export the project file as an XML file
Keyword argument in_: the XML file in which to export the project
Keyword argument _attributes: AppleEvent attribute dictionary
remove_object_code(self, _no_object=None, _attributes={}, **_arguments)
remove object code: remove object code from a project or target
Keyword argument _attributes: AppleEvent attribute dictionary
remove_target_files(self, _object, _attributes={}, **_arguments)
remove target files: remove files from a target
Required argument: an AE object reference
Keyword argument _attributes: AppleEvent attribute dictionary
run_target(self, _no_object=None, _attributes={}, **_arguments)
run target: run a project or target
Keyword argument _attributes: AppleEvent attribute dictionary
touch_file(self, _object=None, _attributes={}, **_arguments)
touch file: touch a file in a project or target for compilation
Required argument: the file or files to be touched
Keyword argument _attributes: AppleEvent attribute dictionary
update(self, _no_object=None, _attributes={}, **_arguments)
update: bring a project or target up to date
Keyword argument _attributes: AppleEvent attribute dictionary

Methods inherited from CodeWarrior.Standard_Suite.Standard_Suite_Events:
close(self, _object, _attributes={}, **_arguments)
close: close an object
Required argument: the object to close
Keyword argument saving: specifies whether or not changes should be saved before closing
Keyword argument saving_in: the file in which to save the object
Keyword argument _attributes: AppleEvent attribute dictionary
count(self, _object, _attributes={}, **_arguments)
count: return the number of elements of a particular class within an object
Required argument: the object whose elements are to be counted
Keyword argument each: the class of the elements to be counted. Keyword 'each' is optional in AppleScript
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: the number of elements
get(self, _object, _attributes={}, **_arguments)
get: get the data for an object
Required argument: the object whose data is to be returned
Keyword argument as: the desired types for the data, in order of preference
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: The data from the object
make(self, _no_object=None, _attributes={}, **_arguments)
make: make a new element
Keyword argument new: the class of the new element—keyword 'new' is optional in AppleScript
Keyword argument as: the desired types for the data, in order of preference
Keyword argument at: the location at which to insert the element
Keyword argument with_data: the initial data for the element
Keyword argument with_properties: the initial values for the properties of the element
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: to the new object(s)
select(self, _object=None, _attributes={}, **_arguments)
select: select the specified object
Required argument: the object to select
Keyword argument _attributes: AppleEvent attribute dictionary
set(self, _object, _attributes={}, **_arguments)
set: set an object's data
Required argument: the object to change
Keyword argument to: the new value
Keyword argument _attributes: AppleEvent attribute dictionary

Methods inherited from StdSuites.Standard_Suite.Standard_Suite_Events:
class_info(self, _object=None, _attributes={}, **_arguments)
class info: (optional) Get information about an object class
Required argument: the object class about which information is requested
Keyword argument in_: the human language and script system in which to return information
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: a record containing the object’s properties and elements
data_size(self, _object, _attributes={}, **_arguments)
data size: (optional) Return the size in bytes of an object
Required argument: the object whose data size is to be returned
Keyword argument as: the data type for which the size is calculated
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: the size of the object in bytes
delete(self, _object, _attributes={}, **_arguments)
delete: Delete an object from its container. Note this does not work on script variables, only on elements of application classes.
Required argument: the element to delete
Keyword argument _attributes: AppleEvent attribute dictionary
duplicate(self, _object, _attributes={}, **_arguments)
duplicate: Duplicate one or more objects
Required argument: the object(s) to duplicate
Keyword argument to: the new location for the object(s)
Keyword argument with_properties: the initial values for properties of the new object that are to be different from the original
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: to the duplicated object(s)
event_info(self, _object, _attributes={}, **_arguments)
event info: (optional) Get information about the Apple events in a suite
Required argument: the event class of the Apple events for which to return information
Keyword argument in_: the human language and script system in which to return information
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: a record containing the events and their parameters
exists(self, _object, _attributes={}, **_arguments)
exists: Verify if an object exists
Required argument: the object in question
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: true if it exists, false if not
handleBreakpoint(self, _object, _attributes={}, **_arguments)
handleBreakpoint: return true to stop at a breakpoint
Required argument: the call frame of the breakpoint
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: true to stop, false if not
move(self, _object, _attributes={}, **_arguments)
move: Move object(s) to a new location
Required argument: the object(s) to move
Keyword argument to: the new location for the object(s)
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: to the object(s) after they have been moved
open(self, _object, _attributes={}, **_arguments)
open: Open the specified object(s)
Required argument: list of objects to open
Keyword argument _attributes: AppleEvent attribute dictionary
print_(self, _object, _attributes={}, **_arguments)
print: Print the specified object(s)
Required argument: list of objects to print
Keyword argument _attributes: AppleEvent attribute dictionary
quit(self, _no_object=None, _attributes={}, **_arguments)
quit: Quit an application
Keyword argument saving: specifies whether to save currently open documents
Keyword argument _attributes: AppleEvent attribute dictionary
reopen(self, _no_object=None, _attributes={}, **_arguments)
reopen: Reactivate a running application.  Some applications will open a new untitled window if no window is open.
Keyword argument _attributes: AppleEvent attribute dictionary
run(self, _no_object=None, _attributes={}, **_arguments)
run: Run an application.  Most applications will open an empty, untitled window.
Keyword argument _attributes: AppleEvent attribute dictionary
save(self, _object, _attributes={}, **_arguments)
save: Save an object
Required argument: the object to save, usually a document or window
Keyword argument in_: the file or alias in which to save the object
Keyword argument as: the file type of the document in which to save the data
Keyword argument _attributes: AppleEvent attribute dictionary
suite_info(self, _object, _attributes={}, **_arguments)
suite info: (optional) Get information about event suite(s)
Required argument: the suite for which to return information
Keyword argument in_: the human language and script system in which to return information
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: a record containing the suites and their versions

Methods inherited from CodeWarrior.Metrowerks_Shell_Suite.Metrowerks_Shell_Suite_Events:
Add_Files(self, _object, _attributes={}, **_arguments)
Add Files: Add the specified file(s) to the current project
Required argument: List of files to add
Keyword argument To_Segment: Segment number into which to add the file(s)
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Error code for each file added
Check_Syntax(self, _object, _attributes={}, **_arguments)
Check Syntax: Check the syntax of the specified file(s)
Required argument: List of files to check the syntax of
Keyword argument ExternalEditor: Should the contents of the message window be returned to the caller?
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Errors for each file whose syntax was checked
Close_Project(self, _no_object=None, _attributes={}, **_arguments)
Close Project: Close the current project
Keyword argument _attributes: AppleEvent attribute dictionary
Close_Window(self, _object, _attributes={}, **_arguments)
Close Window: Close the windows showing the specified files
Required argument: The files to close
Keyword argument Saving: Whether to save changes to each file before closing its window
Keyword argument _attributes: AppleEvent attribute dictionary
Compile(self, _object, _attributes={}, **_arguments)
Compile: Compile the specified file(s)
Required argument: List of files to compile
Keyword argument ExternalEditor: Should the contents of the message window be returned to the caller?
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Errors for each file compiled
Create_Project(self, _object, _attributes={}, **_arguments)
Create Project: Create a new project file
Required argument: New project file specifier
Keyword argument from_stationery: undocumented, typecode 'alis'
Keyword argument _attributes: AppleEvent attribute dictionary
Get_Definition(self, _object, _attributes={}, **_arguments)
Get Definition: Returns the location(s) of a globally scoped function or data object.
Required argument: undocumented, typecode 'TEXT'
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: undocumented, typecode 'FDef'
Get_Open_Documents(self, _no_object=None, _attributes={}, **_arguments)
Get Open Documents: Returns the list of open documents
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: The list of documents
Get_Preferences(self, _no_object=None, _attributes={}, **_arguments)
Get Preferences: Get the preferences for the current project
Keyword argument of: Names of requested preferences
Keyword argument from_panel: Name of the preference panel
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: The requested preferences
Get_Project_File(self, _object, _attributes={}, **_arguments)
Get Project File: Returns a description of a file in the project window.
Required argument: The index of the file within its segment.
Keyword argument Segment: The segment containing the file.
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: undocumented, typecode 'SrcF'
Get_Project_Specifier(self, _no_object=None, _attributes={}, **_arguments)
Get Project Specifier: Return the File Specifier for the current project
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: File Specifier for the current project
Get_Segments(self, _no_object=None, _attributes={}, **_arguments)
Get Segments: Returns a description of each segment in the project.
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: undocumented, typecode 'Seg '
Get_member_function_names(self, _object, _attributes={}, **_arguments)
Get member function names: Returns a list containing the names of all the member functions of a class object
Required argument: must be a class object
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: undocumented, typecode 'list'
Get_nonsimple_classes(self, _no_object=None, _attributes={}, **_arguments)
Get nonsimple classes: Returns an alphabetical list of classes with member functions, bases classes, or subclasses
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: undocumented, typecode 'list'
Goto_Function(self, _object, _attributes={}, **_arguments)
Goto Function: Goto Specified Function Name
Required argument: undocumented, typecode 'TEXT'
Keyword argument _attributes: AppleEvent attribute dictionary
Goto_Line(self, _object, _attributes={}, **_arguments)
Goto Line: Goto Specified Line Number
Required argument: The requested source file line number
Keyword argument _attributes: AppleEvent attribute dictionary
Is_In_Project(self, _object, _attributes={}, **_arguments)
Is In Project: Whether or not the specified file(s) is in the current project
Required argument: List of files to check for project membership
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Result code for each file
Make_Project(self, _no_object=None, _attributes={}, **_arguments)
Make Project: Make the current project
Keyword argument ExternalEditor: Should the contents of the message window be returned to the caller?
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Errors that occurred while making the project
Open_browser(self, _object, _attributes={}, **_arguments)
Open browser: Display a class, member function, or data member object in a single class browser window
Required argument: an AE object reference
Keyword argument _attributes: AppleEvent attribute dictionary
Precompile(self, _object, _attributes={}, **_arguments)
Precompile: Precompile the specified file to the specified destination file
Required argument: File to precompile
Keyword argument Saving_As: Destination file for precompiled header
Keyword argument ExternalEditor: Should the contents of the message window be returned to the caller?
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Errors for the precompiled file
Preprocess(self, _object, _attributes={}, **_arguments)
Preprocess: Preprocesses the specified file(s)
Required argument: undocumented, typecode 'alis'
Keyword argument ExternalEditor: undocumented, typecode 'bool'
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Errors for each preprocessed file
Remove_Binaries(self, _no_object=None, _attributes={}, **_arguments)
Remove Binaries: Remove the binary object code from the current project
Keyword argument _attributes: AppleEvent attribute dictionary
Remove_Files(self, _object, _attributes={}, **_arguments)
Remove Files: Remove the specified file(s) from the current project
Required argument: List of files to remove
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Error code for each file removed
Reset_File_Paths(self, _no_object=None, _attributes={}, **_arguments)
Reset File Paths: Resets access paths for all files belonging to open project.
Keyword argument _attributes: AppleEvent attribute dictionary
Run_Project(self, _no_object=None, _attributes={}, **_arguments)
Run Project: Run the current project
Keyword argument ExternalEditor: Should the contents of the message window be returned to the caller?
Keyword argument SourceDebugger: Run the application under the control of the source-level debugger
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Errors that occurred when running the project
Save_Error_Window_As(self, _object, _attributes={}, **_arguments)
Save Error Window As: Saves the Errors & Warnings window as a text file
Required argument: Destination file for Save Message Window As
Keyword argument _attributes: AppleEvent attribute dictionary
Set_Current_Target(self, _object=None, _attributes={}, **_arguments)
Set Current Target: Set the current target of a project
Required argument: Name of target
Keyword argument _attributes: AppleEvent attribute dictionary
Set_Default_Project(self, _object, _attributes={}, **_arguments)
Set Default Project: Set the default project
Required argument: Name of project
Keyword argument _attributes: AppleEvent attribute dictionary
Set_Modification_Date(self, _object, _attributes={}, **_arguments)
Set Modification Date: Changes the internal modification date of the specified file(s)
Required argument: List of files
Keyword argument to: undocumented, typecode 'ldt '
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Error code for each modified file
Set_Preferences(self, _no_object=None, _attributes={}, **_arguments)
Set Preferences: Set the preferences for the current project
Keyword argument of_panel: Name of the preference panel
Keyword argument to: Preferences settings
Keyword argument _attributes: AppleEvent attribute dictionary
Set_Project_File(self, _object, _attributes={}, **_arguments)
Set Project File: Changes the settings for a given file in the project.
Required argument: The name of the file
Keyword argument to: The new settings for the file
Keyword argument _attributes: AppleEvent attribute dictionary
Set_Segment(self, _object, _attributes={}, **_arguments)
Set Segment: Changes the name and attributes of a segment.
Required argument: The segment to change
Keyword argument to: The new name and attributes for the segment.
Keyword argument _attributes: AppleEvent attribute dictionary
Touch(self, _object, _attributes={}, **_arguments)
Touch: Force recompilation of the specified file(s)
Required argument: List of files to compile
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Error code for each file touched
Update_Project(self, _no_object=None, _attributes={}, **_arguments)
Update Project: Update the current project
Keyword argument ExternalEditor: Should the contents of the message window be returned to the caller?
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Errors that occurred while updating the project

Methods inherited from aetools.TalkTo:
__getattr__(self, name)
__init__(self, signature=None, start=0, timeout=0)
Create a communication channel with a particular application.
 
Addressing the application is done by specifying either a
4-byte signature, an AEDesc or an object that will __aepack__
to an AEDesc.
activate(self)
Send 'activate' command
newevent(self, code, subcode, parameters={}, attributes={})
Create a complete structure for an apple event
send(self, code, subcode, parameters={}, attributes={})
Send an appleevent given code/subcode/pars/attrs and unpack the reply
sendevent(self, event)
Send a pre-created appleevent, await the reply and unpack it
start(self)
Deprecated, used _start()

 
Functions
       
getbaseclasses(v)

 
Data
        Error = 'aetools.Error'
clipboard = Property('pcli')
frontmost = Property('pisf')
name = Property('pnam')
selection = Property('sele')
user_interaction = Property('inte')
version = Property('vers')