py-cvs-rel2_1 (Rev 1.2) merge

[python/dscho.git] / Mac / Lib / lib-scriptpackages / StdSuites / Standard_Suite.py

"""Suite Standard Suite: Common terms for most applications
Level 1, version 1

Generated from Macintosh HD:Systeemmap:Extensies:AppleScript
AETE/AEUT resource version 1/0, language 0, script 0
"""

import aetools
import MacOS

_code = 'core'

class Standard_Suite_Events:

        def open(self, _object, _attributes={}, **_arguments):
                """open: Open the specified object(s)
                Required argument: list of objects to open
                Keyword argument _attributes: AppleEvent attribute dictionary
                """
                _code = 'aevt'
                _subcode = 'odoc'

                if _arguments: raise TypeError, 'No optional args expected'
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        def 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
                """
                _code = 'aevt'
                _subcode = 'oapp'

                if _arguments: raise TypeError, 'No optional args expected'
                if _no_object != None: raise TypeError, 'No direct arg expected'


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        def 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
                """
                _code = 'aevt'
                _subcode = 'rapp'

                if _arguments: raise TypeError, 'No optional args expected'
                if _no_object != None: raise TypeError, 'No direct arg expected'


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        def _print(self, _object, _attributes={}, **_arguments):
                """print: Print the specified object(s)
                Required argument: list of objects to print
                Keyword argument _attributes: AppleEvent attribute dictionary
                """
                _code = 'aevt'
                _subcode = 'pdoc'

                if _arguments: raise TypeError, 'No optional args expected'
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_quit = {
                'saving' : 'savo',
        }

        def 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
                """
                _code = 'aevt'
                _subcode = 'quit'

                aetools.keysubst(_arguments, self._argmap_quit)
                if _no_object != None: raise TypeError, 'No direct arg expected'

                aetools.enumsubst(_arguments, 'savo', _Enum_savo)

                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_close = {
                'saving' : 'savo',
                'saving_in' : 'kfil',
        }

        def close(self, _object, _attributes={}, **_arguments):
                """close: Close an object
                Required argument: the object to close
                Keyword argument saving: specifies whether changes should be saved before closing
                Keyword argument saving_in: the file in which to save the object
                Keyword argument _attributes: AppleEvent attribute dictionary
                """
                _code = 'core'
                _subcode = 'clos'

                aetools.keysubst(_arguments, self._argmap_close)
                _arguments['----'] = _object

                aetools.enumsubst(_arguments, 'savo', _Enum_savo)

                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_count = {
                'each' : 'kocl',
        }

        def 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
                """
                _code = 'core'
                _subcode = 'cnte'

                aetools.keysubst(_arguments, self._argmap_count)
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        def 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
                """
                _code = 'core'
                _subcode = 'delo'

                if _arguments: raise TypeError, 'No optional args expected'
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_duplicate = {
                'to' : 'insh',
                'with_properties' : 'prdt',
        }

        def 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)
                """
                _code = 'core'
                _subcode = 'clon'

                aetools.keysubst(_arguments, self._argmap_duplicate)
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        def 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
                """
                _code = 'core'
                _subcode = 'doex'

                if _arguments: raise TypeError, 'No optional args expected'
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_make = {
                'new' : 'kocl',
                'at' : 'insh',
                'with_data' : 'data',
                'with_properties' : 'prdt',
        }

        def 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)
                """
                _code = 'core'
                _subcode = 'crel'

                aetools.keysubst(_arguments, self._argmap_make)
                if _no_object != None: raise TypeError, 'No direct arg expected'


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_move = {
                'to' : 'insh',
        }

        def 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
                """
                _code = 'core'
                _subcode = 'move'

                aetools.keysubst(_arguments, self._argmap_move)
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_save = {
                '_in' : 'kfil',
                'as' : 'fltp',
        }

        def 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 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
                """
                _code = 'core'
                _subcode = 'save'

                aetools.keysubst(_arguments, self._argmap_save)
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        def select(self, _object, _attributes={}, **_arguments):
                """select: Make a selection
                Required argument: the object to select
                Keyword argument _attributes: AppleEvent attribute dictionary
                """
                _code = 'misc'
                _subcode = 'slct'

                if _arguments: raise TypeError, 'No optional args expected'
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_data_size = {
                'as' : 'rtyp',
        }

        def 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
                """
                _code = 'core'
                _subcode = 'dsiz'

                aetools.keysubst(_arguments, self._argmap_data_size)
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_suite_info = {
                '_in' : 'wrcd',
        }

        def 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
                """
                _code = 'core'
                _subcode = 'gtsi'

                aetools.keysubst(_arguments, self._argmap_suite_info)
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_event_info = {
                '_in' : 'wrcd',
        }

        def 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
                """
                _code = 'core'
                _subcode = 'gtei'

                aetools.keysubst(_arguments, self._argmap_event_info)
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']

        _argmap_class_info = {
                '_in' : 'wrcd',
        }

        def 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
                """
                _code = 'core'
                _subcode = 'qobj'

                aetools.keysubst(_arguments, self._argmap_class_info)
                _arguments['----'] = _object


                _reply, _arguments, _attributes = self.send(_code, _subcode,
                                _arguments, _attributes)
                if _arguments.has_key('errn'):
                        raise aetools.Error, aetools.decodeerror(_arguments)
                # XXXX Optionally decode result
                if _arguments.has_key('----'):
                        return _arguments['----']


class application(aetools.ComponentItem):
        """application - An application program """
        want = 'capp'
class name(aetools.NProperty):
        """name - the name of the application """
        which = 'pnam'
        want = 'itxt'
class frontmost(aetools.NProperty):
        """frontmost - Is this the frontmost application? """
        which = 'pisf'
        want = 'bool'
class selection(aetools.NProperty):
        """selection - the selection visible to the user.  Use the •selectÕ command to set a new selection; use •contents of selectionÕ to get or change information in the document. """
        which = 'sele'
        want = 'csel'
class clipboard(aetools.NProperty):
        """clipboard - the contents of the clipboard for this application """
        which = 'pcli'
        want = '****'
class version(aetools.NProperty):
        """version - the version of the application """
        which = 'vers'
        want = 'vers'

applications = application

class document(aetools.ComponentItem):
        """document - A document of a scriptable application """
        want = 'docu'
class modified(aetools.NProperty):
        """modified - Has the document been modified since the last save? """
        which = 'imod'
        want = 'bool'

documents = document

class file(aetools.ComponentItem):
        """file - a file on a disk or server (or a file yet to be created) """
        want = 'file'
class stationery(aetools.NProperty):
        """stationery - Is the file a stationery file? """
        which = 'pspd'
        want = 'bool'

files = file

class alias(aetools.ComponentItem):
        """alias - a file on a disk or server.  The file must exist when you check the syntax of your script. """
        want = 'alis'

aliases = alias

class selection_2d_object(aetools.ComponentItem):
        """selection-object - A way to refer to the state of the current of the selection.  Use the •selectÕ command to make a new selection. """
        want = 'csel'
class contents(aetools.NProperty):
        """contents - the information currently selected.  Use •contents of selectionÕ to get or change information in a document. """
        which = 'pcnt'
        want = '****'

class window(aetools.ComponentItem):
        """window - A window """
        want = 'cwin'
class bounds(aetools.NProperty):
        """bounds - the boundary rectangle for the window """
        which = 'pbnd'
        want = 'qdrt'
class closeable(aetools.NProperty):
        """closeable - Does the window have a close box? """
        which = 'hclb'
        want = 'bool'
class titled(aetools.NProperty):
        """titled - Does the window have a title bar? """
        which = 'ptit'
        want = 'bool'
class index(aetools.NProperty):
        """index - the number of the window """
        which = 'pidx'
        want = 'long'
class floating(aetools.NProperty):
        """floating - Does the window float? """
        which = 'isfl'
        want = 'bool'
class modal(aetools.NProperty):
        """modal - Is the window modal? """
        which = 'pmod'
        want = 'bool'
class resizable(aetools.NProperty):
        """resizable - Is the window resizable? """
        which = 'prsz'
        want = 'bool'
class zoomable(aetools.NProperty):
        """zoomable - Is the window zoomable? """
        which = 'iszm'
        want = 'bool'
class zoomed(aetools.NProperty):
        """zoomed - Is the window zoomed? """
        which = 'pzum'
        want = 'bool'
class visible(aetools.NProperty):
        """visible - Is the window visible? """
        which = 'pvis'
        want = 'bool'

windows = window

class insertion_point(aetools.ComponentItem):
        """insertion point - An insertion location between two objects """
        want = 'cins'

insertion_points = insertion_point
application._propdict = {
        'name' : name,
        'frontmost' : frontmost,
        'selection' : selection,
        'clipboard' : clipboard,
        'version' : version,
}
application._elemdict = {
}
document._propdict = {
        'modified' : modified,
}
document._elemdict = {
}
file._propdict = {
        'stationery' : stationery,
}
file._elemdict = {
}
alias._propdict = {
}
alias._elemdict = {
}
selection_2d_object._propdict = {
        'contents' : contents,
}
selection_2d_object._elemdict = {
}
window._propdict = {
        'bounds' : bounds,
        'closeable' : closeable,
        'titled' : titled,
        'index' : index,
        'floating' : floating,
        'modal' : modal,
        'resizable' : resizable,
        'zoomable' : zoomable,
        'zoomed' : zoomed,
        'visible' : visible,
}
window._elemdict = {
}
insertion_point._propdict = {
}
insertion_point._elemdict = {
}
class starts_with(aetools.NComparison):
        """starts with - Starts with """
class contains(aetools.NComparison):
        """contains - Contains """
class ends_with(aetools.NComparison):
        """ends with - Ends with """
class _3d_(aetools.NComparison):
        """= - Equal """
class _3e_(aetools.NComparison):
        """> - Greater than """
class _b3_(aetools.NComparison):
        """³ - Greater than or equal to """
class _3c_(aetools.NComparison):
        """< - Less than """
class _b2_(aetools.NComparison):
        """² - Less than or equal to """
_Enum_savo = {
        'yes' : 'yes ', # Save objects now
        'no' : 'no  ',  # Do not save objects
        'ask' : 'ask ', # Ask the user whether to save
}

_Enum_kfrm = {
        'index' : 'indx',       # keyform designating indexed access
        'named' : 'name',       # keyform designating named access
        'id' : 'ID  ',  # keyform designating access by unique identifier
}

_Enum_styl = {
        'plain' : 'plan',       # Plain
        'bold' : 'bold',        # Bold
        'italic' : 'ital',      # Italic
        'outline' : 'outl',     # Outline
        'shadow' : 'shad',      # Shadow
        'underline' : 'undl',   # Underline
        'superscript' : 'spsc', # Superscript
        'subscript' : 'sbsc',   # Subscript
        'strikethrough' : 'strk',       # Strikethrough
        'small_caps' : 'smcp',  # Small caps
        'all_caps' : 'alcp',    # All capital letters
        'all_lowercase' : 'lowc',       # Lowercase
        'condensed' : 'cond',   # Condensed
        'expanded' : 'pexp',    # Expanded
        'hidden' : 'hidn',      # Hidden
}


#
# Indices of types declared in this module
#
_classdeclarations = {
        'docu' : document,
        'cins' : insertion_point,
        'capp' : application,
        'alis' : alias,
        'csel' : selection_2d_object,
        'file' : file,
        'cwin' : window,
}

_propdeclarations = {
        'ptit' : titled,
        'pidx' : index,
        'pnam' : name,
        'pzum' : zoomed,
        'pcnt' : contents,
        'pcli' : clipboard,
        'hclb' : closeable,
        'iszm' : zoomable,
        'isfl' : floating,
        'pspd' : stationery,
        'pisf' : frontmost,
        'sele' : selection,
        'pbnd' : bounds,
        'imod' : modified,
        'pvis' : visible,
        'pmod' : modal,
        'vers' : version,
        'prsz' : resizable,
}

_compdeclarations = {
        '>   ' : _3e_,
        'bgwt' : starts_with,
        '>=  ' : _b3_,
        '=   ' : _3d_,
        '<=  ' : _b2_,
        'cont' : contains,
        'ends' : ends_with,
        '<   ' : _3c_,
}

_enumdeclarations = {
        'styl' : _Enum_styl,
        'savo' : _Enum_savo,
        'kfrm' : _Enum_kfrm,
}