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

Package generated from /System/Library/CoreServices/Finder.app

 
Package Contents
       
Containers_and_folders
Enumerations
Files
Finder_Basics
Finder_items
Legacy_suite
Standard_Suite
Type_Definitions
Window_classes

 
Classes
       
Finder.Containers_and_folders.Containers_and_folders_Events
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
Finder.Enumerations.Enumerations_Events(StdSuites.Type_Names_Suite.Type_Names_Suite_Events)
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
Finder.Files.Files_Events
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
Finder.Finder_Basics.Finder_Basics_Events
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
Finder.Finder_items.Finder_items_Events
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
Finder.Legacy_suite.Legacy_suite_Events
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
Finder.Standard_Suite.Standard_Suite_Events(StdSuites.Standard_Suite.Standard_Suite_Events)
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
Finder.Type_Definitions.Type_Definitions_Events
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
Finder.Window_classes.Window_classes_Events
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
aetools.TalkTo
Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)

 
class Finder(Finder.Standard_Suite.Standard_Suite_Events, Finder.Legacy_suite.Legacy_suite_Events, Finder.Containers_and_folders.Containers_and_folders_Events, Finder.Files.Files_Events, Finder.Finder_Basics.Finder_Basics_Events, Finder.Finder_items.Finder_items_Events, Finder.Window_classes.Window_classes_Events, Finder.Type_Definitions.Type_Definitions_Events, Finder.Enumerations.Enumerations_Events, aetools.TalkTo)
    
Method resolution order:
Finder
Finder.Standard_Suite.Standard_Suite_Events
StdSuites.Standard_Suite.Standard_Suite_Events
_builtinSuites.builtin_Suite.builtin_Suite_Events
Finder.Legacy_suite.Legacy_suite_Events
Finder.Containers_and_folders.Containers_and_folders_Events
Finder.Files.Files_Events
Finder.Finder_Basics.Finder_Basics_Events
Finder.Finder_items.Finder_items_Events
Finder.Window_classes.Window_classes_Events
Finder.Type_Definitions.Type_Definitions_Events
Finder.Enumerations.Enumerations_Events
StdSuites.Type_Names_Suite.Type_Names_Suite_Events
aetools.TalkTo

Methods inherited from Finder.Standard_Suite.Standard_Suite_Events:
close(self, _object, _attributes={}, **_arguments)
close: Close an object
Required argument: the object to close
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 argument _attributes: AppleEvent attribute dictionary
Returns: the number of elements
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 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: Move an item from its container to the trash
Required argument: the item to delete
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: to the item that was just deleted
duplicate(self, _object, _attributes={}, **_arguments)
duplicate: Duplicate one or more object(s)
Required argument: the object(s) to duplicate
Keyword argument to: the new location for the object(s)
Keyword argument replacing: Specifies whether or not to replace items in the destination that have the same name as items being duplicated
Keyword argument routing_suppressed: Specifies whether or not to autoroute items (default is false). Only applies when copying to the system folder.
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: to the duplicated object(s)
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
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 to: when creating an alias file, the original item to create an alias to or when creating a file viewer window, the target of the window
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 replacing: Specifies whether or not to replace items in the destination that have the same name as items being moved
Keyword argument positioned_at: Gives a list (in local window coordinates) of positions for the destination items
Keyword argument routing_suppressed: Specifies whether or not to autoroute items (default is false). Only applies when moving to the system folder.
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 using: the application file to open the object with
Keyword argument with_properties: the initial values for the properties, to be included with the open command sent to the application that opens the direct object
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 with_properties: optional properties to be included with the print command sent to the application that prints the direct object
Keyword argument _attributes: AppleEvent attribute dictionary
quit(self, _no_object=None, _attributes={}, **_arguments)
quit: Quit the Finder
Keyword argument _attributes: AppleEvent attribute dictionary
select(self, _object, _attributes={}, **_arguments)
select: Select the specified object(s)
Required argument: the object to select
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
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
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
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 Finder.Legacy_suite.Legacy_suite_Events:
restart(self, _no_object=None, _attributes={}, **_arguments)
restart: Restart the computer
Keyword argument _attributes: AppleEvent attribute dictionary
shut_down(self, _no_object=None, _attributes={}, **_arguments)
shut down: Shut Down the computer
Keyword argument _attributes: AppleEvent attribute dictionary
sleep(self, _no_object=None, _attributes={}, **_arguments)
sleep: Put the computer to sleep
Keyword argument _attributes: AppleEvent attribute dictionary

Methods inherited from Finder.Finder_Basics.Finder_Basics_Events:
copy(self, _no_object=None, _attributes={}, **_arguments)
copy: (NOT AVAILABLE YET) Copy the selected items to the clipboard (the Finder must be the front application)
Keyword argument _attributes: AppleEvent attribute dictionary
sort(self, _object, _attributes={}, **_arguments)
sort: (NOT AVAILABLE YET) Return the specified object(s) in a sorted list
Required argument: a list of finder objects to sort
Keyword argument by: the property to sort the items by (name, index, date, etc.)
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: the sorted items in their new order

Methods inherited from Finder.Finder_items.Finder_items_Events:
add_to_favorites(self, _object, _attributes={}, **_arguments)
add to favorites: (NOT AVAILABLE YET) Add the items to the user’s Favorites
Required argument: the items to add to the collection of Favorites
Keyword argument _attributes: AppleEvent attribute dictionary
clean_up(self, _object, _attributes={}, **_arguments)
clean up: (NOT AVAILABLE YET) Arrange items in window nicely (only applies to open windows in icon view 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
eject(self, _object=None, _attributes={}, **_arguments)
eject: Eject the specified disk(s)
Required argument: the disk(s) to eject
Keyword argument _attributes: AppleEvent attribute dictionary
empty(self, _object=None, _attributes={}, **_arguments)
empty: Empty the trash
Required argument: “empty” and “empty trash” both do the same thing
Keyword argument _attributes: AppleEvent attribute dictionary
erase(self, _object, _attributes={}, **_arguments)
erase: (NOT AVAILABLE) Erase the specified disk(s)
Required argument: the items to erase
Keyword argument _attributes: AppleEvent attribute dictionary
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
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 necessity: only update if necessary (i.e. a finder window is open).  default is false
Keyword argument registering_applications: register applications. default is true
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
get = _get(self, _object, asfile=None, _attributes={})
_get: get data from an object
Required argument: the object
Keyword argument _attributes: AppleEvent attribute dictionary
Returns: the data
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
set = _set(self, _object, _attributes={}, **_arguments)
set: Set an object's data.
Required argument: the object for the command
Keyword argument to: The new value.
Keyword argument _attributes: AppleEvent attribute dictionary
start(self)
Deprecated, used _start()

 
Functions
       
getbaseclasses(v)

 
Data
        Error = 'aetools.Error'
Finder_preferences = Property('pfrp')
clipboard = Property('pcli')
desktop = Property('desk')
desktop_picture = Property('dpic')
frontmost = Property('pisf')
home = Property('home')
insertion_location = Property('pins')
name = Property('pnam')
product_version = Property('ver2')
selection = Property('sele')
startup_disk = Property('sdsk')
trash = Property('trsh')
visible = Property('pvis')