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

Package generated from /Volumes/Sap/Applications (Mac OS 9)/Netscape Communicator‚ĄĘ Folder/Netscape Communicator‚ĄĘ

 
Package Contents
       
Mozilla_suite
PowerPlant
Required_suite
Standard_Suite
Standard_URL_suite
Text
WorldWideWeb_suite

 
Classes
       
Netscape.Mozilla_suite.Mozilla_suite_Events
Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)
Netscape.PowerPlant.PowerPlant_Events
Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)
Netscape.Required_suite.Required_suite_Events(StdSuites.Required_Suite.Required_Suite_Events)
Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)
Netscape.Standard_Suite.Standard_Suite_Events(StdSuites.Standard_Suite.Standard_Suite_Events)
Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)
Netscape.Standard_URL_suite.Standard_URL_suite_Events
Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)
Netscape.Text.Text_Events(StdSuites.Text_Suite.Text_Suite_Events)
Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)
Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events
Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)
aetools.TalkTo
Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)

 
class Netscape(Netscape.Standard_Suite.Standard_Suite_Events, Netscape.Standard_URL_suite.Standard_URL_suite_Events, Netscape.Mozilla_suite.Mozilla_suite_Events, Netscape.Text.Text_Events, Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events, Netscape.PowerPlant.PowerPlant_Events, Netscape.Required_suite.Required_suite_Events, aetools.TalkTo)
    
Method resolution order:
Netscape
Netscape.Standard_Suite.Standard_Suite_Events
StdSuites.Standard_Suite.Standard_Suite_Events
_builtinSuites.builtin_Suite.builtin_Suite_Events
Netscape.Standard_URL_suite.Standard_URL_suite_Events
Netscape.Mozilla_suite.Mozilla_suite_Events
Netscape.Text.Text_Events
StdSuites.Text_Suite.Text_Suite_Events
Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events
Netscape.PowerPlant.PowerPlant_Events
Netscape.Required_suite.Required_suite_Events
StdSuites.Required_Suite.Required_Suite_Events
aetools.TalkTo

Methods inherited from Netscape.Standard_Suite.Standard_Suite_Events:
close(self, _object, _attributes={}, **_arguments)
close: Close an object
Required argument: the objects to close
Keyword argument _attributes: AppleEvent attribute dictionary
data_size(self, _object, _attributes={}, **_arguments)
data size: Return the size in bytes of an object
Required argument: the object whose data size is to be returned
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: the size of the object in bytes
get(self, _object, _attributes={}, **_arguments)
get: Get the data for an object
Required argument: the object whose data is to be returned
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: The data from the object
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
count(self, _object, _attributes={}, **_arguments)
count: Return the number of elements of an object
Required argument: the object whose elements are to be counted
Keyword argument each: if specified, restricts counting to objects of this class
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: the number of elements
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
make(self, _no_object=None, _attributes={}, **_arguments)
make: Make a new element
Keyword argument new: the class of the new element
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)
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
select(self, _object, _attributes={}, **_arguments)
select: Make a selection
Required argument: the object to select
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 Netscape.Standard_URL_suite.Standard_URL_suite_Events:
GetURL(self, _object, _attributes={}, **_arguments)
GetURL: Loads the URL (optionally to disk)
Required argument: The url
Keyword argument to: file the URL should be loaded into
Keyword argument inside: Window the URL should be loaded to
Keyword argument from_: Referrer, to be sent with the HTTP request
Keyword argument _attributes: AppleEvent attribute dictionary

Methods inherited from Netscape.Mozilla_suite.Mozilla_suite_Events:
Get_Import_Data(self, _no_object=None, _attributes={}, **_arguments)
Get Import Data: Returns a structure containing information that is of use to an external module in importing data from an external mail application into Communicator.
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: vRefNum and dirID of profile folder (2+4 bytes), vRefNum and DirID of the local mail folder (2+4 bytes), window type of front window (0 if none, ‘Brwz’ browser, ‘Addr’ addressbook, ‘Mesg’ messenger, etc., 4 bytes)
Get_Profile_Name(self, _no_object=None, _attributes={}, **_arguments)
Get Profile Name: Get the current User Profile
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Name of the current profile, like “Joe Bloggs”. This is the name of the profile folder in the Netscape Users folder.
Get_workingURL(self, _no_object=None, _attributes={}, **_arguments)
Get workingURL: Get the path to the running application in URL format.  This will allow a script to construct a relative URL
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Will return text of the from “FILE://foo/applicationname”
Go(self, _object, _attributes={}, **_arguments)
Go: navigate a window: back, forward, again(reload), home)
Required argument: window
Keyword argument direction: undocumented, typecode 'dire'
Keyword argument _attributes: AppleEvent attribute dictionary
Handle_command(self, _object, _attributes={}, **_arguments)
Handle command: Handle a command
Required argument: The command to handle
Keyword argument _attributes: AppleEvent attribute dictionary
Open_Address_Book(self, _no_object=None, _attributes={}, **_arguments)
Open Address Book: Opens the address book
Keyword argument _attributes: AppleEvent attribute dictionary
Open_Component(self, _object, _attributes={}, **_arguments)
Open Component: Open a Communicator component
Required argument: The component to open
Keyword argument _attributes: AppleEvent attribute dictionary
Open_Profile_Manager(self, _no_object=None, _attributes={}, **_arguments)
Open Profile Manager: Open the user profile manager (obsolete)
Keyword argument _attributes: AppleEvent attribute dictionary
Open_bookmark(self, _object=None, _attributes={}, **_arguments)
Open bookmark: Reads in a bookmark file
Required argument: If not available, reloads the current bookmark file
Keyword argument _attributes: AppleEvent attribute dictionary
Read_help_file(self, _object, _attributes={}, **_arguments)
Read help file: Reads in the help file (file should be in the help file format)
Required argument: undocumented, typecode 'alis'
Keyword argument with_index: Index to the help file. Defaults to  ‘DEFAULT’)
Keyword argument search_text: Optional text to search for
Keyword argument _attributes: AppleEvent attribute dictionary

Methods inherited from Netscape.WorldWideWeb_suite.WorldWideWeb_suite_Events:
OpenURL(self, _object, _attributes={}, **_arguments)
OpenURL: Opens a URL. Allows for more options than GetURL event
Required argument: URL
Keyword argument to: file destination
Keyword argument toWindow: window iD
Keyword argument flags: Binary: any combination of 1, 2 and 4 is allowed: 1 and 2 mean force reload the document. 4 is ignored
Keyword argument post_data: Form posting data
Keyword argument post_type: MIME type of the posting data. Defaults to application/x-www-form-urlencoded
Keyword argument progressApp: Application that will display progress
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: ID of the loading window
ShowFile(self, _object, _attributes={}, **_arguments)
ShowFile: Similar to OpenDocuments, except that it specifies the parent URL, and MIME type of the file
Required argument: File to open
Keyword argument MIME_type: MIME type
Keyword argument Window_ID: Window to open the file in
Keyword argument URL: Use this as a base URL
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Window ID of the loaded window. 0 means ShowFile failed, FFFFFFF means that data was not appropriate type to display in the browser.
cancel_progress(self, _object=None, _attributes={}, **_arguments)
cancel progress: Interrupts the download of the document in the given window
Required argument: progress ID, obtained from the progress app
Keyword argument in_window: window ID of the progress to cancel
Keyword argument _attributes: AppleEvent attribute dictionary
find_URL(self, _object, _attributes={}, **_arguments)
find URL: If the file was downloaded by Netscape, you can call FindURL to find out the URL used to download the file.
Required argument: File spec
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: The URL
get_window_info(self, _object=None, _attributes={}, **_arguments)
get window info: Returns the information about the window as a list. Currently the list contains the window title and the URL. You can get the same information using standard Apple Event GetProperty.
Required argument: window ID
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: undocumented, typecode 'list'
list_windows(self, _no_object=None, _attributes={}, **_arguments)
list windows: Lists the IDs of all the hypertext windows
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: List of unique IDs of all the hypertext windows
parse_anchor(self, _object, _attributes={}, **_arguments)
parse anchor: Resolves the relative URL
Required argument: Main URL
Keyword argument relative_to: Relative URL
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: Parsed  URL
register_URL_echo(self, _object=None, _attributes={}, **_arguments)
register URL echo: Registers the “echo” application. Each download from now on will be echoed to this application.
Required argument: Application signature
Keyword argument _attributes: AppleEvent attribute dictionary
register_protocol(self, _object=None, _attributes={}, **_arguments)
register protocol: Registers application as a “handler” for this protocol with a given prefix. The handler will receive “OpenURL”, or if that fails, “GetURL” event.
Required argument: Application sig
Keyword argument for_protocol: protocol prefix: “finger:”, “file”,
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: TRUE if registration has been successful
register_viewer(self, _object, _attributes={}, **_arguments)
register viewer: Registers an application as a ‘special’ viewer for this MIME type. The application will be launched with ViewDoc events
Required argument: Application sig
Keyword argument MIME_type: MIME type viewer is registering for
Keyword argument with_file_type: Mac file type for the downloaded files
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: TRUE if registration has been successful
register_window_close(self, _object=None, _attributes={}, **_arguments)
register window close: Netscape will notify registered application when this window closes
Required argument: Application signature
Keyword argument for_window: window ID
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: true if successful
unregister_URL_echo(self, _object, _attributes={}, **_arguments)
unregister URL echo: cancels URL echo
Required argument: application signature
Keyword argument _attributes: AppleEvent attribute dictionary
unregister_protocol(self, _object=None, _attributes={}, **_arguments)
unregister protocol: reverses the effects of “register protocol”
Required argument: Application sig.
Keyword argument for_protocol: protocol prefix. If none, unregister for all protocols
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: TRUE if successful
unregister_viewer(self, _object, _attributes={}, **_arguments)
unregister viewer: Revert to the old way of handling this MIME type
Required argument: Application sig
Keyword argument MIME_type: MIME type to be unregistered
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: TRUE if the event was successful
unregister_window_close(self, _object=None, _attributes={}, **_arguments)
unregister window close: Undo for register window close
Required argument: Application signature
Keyword argument for_window: window ID
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: true if successful
webActivate(self, _object=None, _attributes={}, **_arguments)
webActivate: Makes Netscape the frontmost application, and selects a given window. This event is here for suite completeness/ cross-platform compatibility only, you should use standard AppleEvents instead.
Required argument: window to bring to front
Keyword argument _attributes: AppleEvent attribute dictionary

Methods inherited from Netscape.PowerPlant.PowerPlant_Events:
SwitchTellTarget(self, _no_object=None, _attributes={}, **_arguments)
SwitchTellTarget: Makes an object the “focus” of AppleEvents
Keyword argument to: reference to new focus of AppleEvents
Keyword argument _attributes: AppleEvent attribute dictionary

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'
alert_application = Property('ALAP')
clipboard = Property('pcli')
frontmost = Property('pisf')
kiosk_mode = Property('KOSK')
name = Property('pnam')
selection = Property('sele')
version = Property('vers')