cpython/Mac/Lib/lib-scriptpackages/Finder/Finder_items.py

333 lines
9.5 KiB
Python
Raw Normal View History

2000-08-20 16:29:03 -03:00
"""Suite Finder items: Commands used with file system items, and basic item definition
Level 1, version 1
Generated from Macintosh HD:Systeemmap:Finder
AETE/AEUT resource version 0/144, language 0, script 0
"""
import aetools
import MacOS
_code = 'fndr'
class Finder_items_Events:
def add_to_favorites(self, _object, _attributes={}, **_arguments):
"""add to favorites: Add the items to the Favorites menu in the Apple Menu and in Open and Save dialogs
Required argument: the items to add to the collection of Favorites
Keyword argument _attributes: AppleEvent attribute dictionary
"""
_code = 'fndr'
_subcode = 'ffav'
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_clean_up = {
'by' : 'by ',
}
def clean_up(self, _object, _attributes={}, **_arguments):
"""clean up: Arrange items in window nicely (only applies to open windows in icon or button views that are not kept arranged)
Required argument: the window to clean up
Keyword argument by: the order in which to clean up the objects (name, index, date, etc.)
Keyword argument _attributes: AppleEvent attribute dictionary
"""
_code = 'fndr'
_subcode = 'fclu'
aetools.keysubst(_arguments, self._argmap_clean_up)
_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 eject(self, _object=None, _attributes={}, **_arguments):
"""eject: Eject the specified disk(s), or every ejectable disk if no parameter is specified
Required argument: the items to eject
Keyword argument _attributes: AppleEvent attribute dictionary
"""
_code = 'fndr'
_subcode = 'ejct'
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 empty(self, _object=None, _attributes={}, **_arguments):
"""empty: Empty the trash
Required argument: <EFBFBD>empty<EFBFBD> and <EFBFBD>empty trash<EFBFBD> both do the same thing
Keyword argument _attributes: AppleEvent attribute dictionary
"""
_code = 'fndr'
_subcode = 'empt'
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 erase(self, _object, _attributes={}, **_arguments):
"""erase: Erase the specified disk(s)
Required argument: the items to erase
Keyword argument _attributes: AppleEvent attribute dictionary
"""
_code = 'fndr'
_subcode = 'fera'
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 put_away(self, _object, _attributes={}, **_arguments):
"""put away: Put away the specified object(s)
Required argument: the items to put away
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: the object put away in its put-away location
"""
_code = 'fndr'
_subcode = 'ptwy'
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 reveal(self, _object, _attributes={}, **_arguments):
"""reveal: Bring the specified object(s) into view
Required argument: the object to be made visible
Keyword argument _attributes: AppleEvent attribute dictionary
"""
_code = 'misc'
_subcode = 'mvis'
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 update(self, _object, _attributes={}, **_arguments):
"""update: Update the display of the specified object(s) to match their on-disk representation
Required argument: the item to update
Keyword argument _attributes: AppleEvent attribute dictionary
"""
_code = 'fndr'
_subcode = 'fupd'
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['----']
class item(aetools.ComponentItem):
"""item - An item """
want = 'cobj'
class name(aetools.NProperty):
"""name - the name of the item """
which = 'pnam'
want = 'itxt'
class index(aetools.NProperty):
"""index - the index in the front-to-back ordering within its container """
which = 'pidx'
want = 'long'
class id(aetools.NProperty):
"""id - an id that identifies the item """
which = 'ID '
want = 'long'
class container(aetools.NProperty):
"""container - the container of the item """
which = 'ctnr'
want = 'obj '
class disk(aetools.NProperty):
"""disk - the disk on which the item is stored """
which = 'cdis'
want = 'obj '
class folder(aetools.NProperty):
"""folder - the folder in which the item is stored """
which = 'asdr'
want = 'obj '
class position(aetools.NProperty):
"""position - the position of the item within its parent window (can only be set for an item in a window viewed as icons or buttons) """
which = 'posn'
want = 'QDpt'
class bounds(aetools.NProperty):
"""bounds - the bounding rectangle of the item (can only be set for an item in a window viewed as icons or buttons) """
which = 'pbnd'
want = 'qdrt'
class label_index(aetools.NProperty):
"""label index - the label of the item """
which = 'labi'
want = 'long'
class kind(aetools.NProperty):
"""kind - the kind of the item """
which = 'kind'
want = 'itxt'
class description(aetools.NProperty):
"""description - a description of the item """
which = 'dscr'
want = 'itxt'
class comment(aetools.NProperty):
"""comment - the comment of the item, displayed in the <20>Get Info<66> window """
which = 'comt'
want = 'itxt'
class size(aetools.NProperty):
"""size - the logical size of the item """
which = 'ptsz'
want = 'long'
class physical_size(aetools.NProperty):
"""physical size - the actual space used by the item on disk """
which = 'phys'
want = 'long'
class creation_date(aetools.NProperty):
"""creation date - the date on which the item was created """
which = 'ascd'
want = 'ldt '
class modification_date(aetools.NProperty):
"""modification date - the date on which the item was last modified """
which = 'asmo'
want = 'ldt '
class icon(aetools.NProperty):
"""icon - the icon bitmap of the item """
which = 'iimg'
want = 'ifam'
class selected(aetools.NProperty):
"""selected - Is the item selected? """
which = 'issl'
want = 'bool'
class content_space(aetools.NProperty):
"""content space - the window that would open if the item was opened """
which = 'dwnd'
want = 'obj '
class window(aetools.NProperty):
"""window - the window that would open if the item was opened """
which = 'cwin'
want = 'obj '
class information_window(aetools.NProperty):
"""information window - the information window for the item """
which = 'iwnd'
want = 'obj '
items = item
item._propdict = {
'name' : name,
'index' : index,
'id' : id,
'container' : container,
'disk' : disk,
'folder' : folder,
'position' : position,
'bounds' : bounds,
'label_index' : label_index,
'kind' : kind,
'description' : description,
'comment' : comment,
'size' : size,
'physical_size' : physical_size,
'creation_date' : creation_date,
'modification_date' : modification_date,
'icon' : icon,
'selected' : selected,
'content_space' : content_space,
'window' : window,
'information_window' : information_window,
}
item._elemdict = {
}
#
# Indices of types declared in this module
#
_classdeclarations = {
'cobj' : item,
}
_propdeclarations = {
'iwnd' : information_window,
'cdis' : disk,
'asmo' : modification_date,
'ascd' : creation_date,
'pnam' : name,
'labi' : label_index,
'ID ' : id,
'iimg' : icon,
'pidx' : index,
'dwnd' : content_space,
'cwin' : window,
'comt' : comment,
'dscr' : description,
'asdr' : folder,
'issl' : selected,
'pbnd' : bounds,
'ctnr' : container,
'phys' : physical_size,
'ptsz' : size,
'kind' : kind,
'posn' : position,
}
_compdeclarations = {
}
_enumdeclarations = {
}