<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"mac.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"mac.html" title='Macintosh Library Modules'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"module-EasyDialogs.html" />
<link rel=
"prev" href=
"module-macostools.html" />
<link rel=
"parent" href=
"macpython-modules.html" />
<link rel=
"next" href=
"module-EasyDialogs.html" />
<meta name='aesop' content='information'
/>
<title>2.6 findertools -- The finder's Apple Events interface
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"2.5 macostools "
href=
"module-macostools.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"2. MacPython Modules"
href=
"macpython-modules.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"2.7 EasyDialogs "
href=
"module-EasyDialogs.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Macintosh Library Modules
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-macostools.html">2.5 macostools
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"macpython-modules.html">2. MacPython Modules
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-EasyDialogs.html">2.7 EasyDialogs
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION004600000000000000000">
2.6 <tt class=
"module">findertools
</tt> --
The
<b class=
"program">finder
</b>'s Apple Events interface
</A>
<A NAME=
"module-findertools"></A>
<p class=
"availability">Availability:
<span
class=
"platform">Macintosh
</span>.
</p>
This module contains routines that give Python programs access to some
functionality provided by the finder. They are implemented as wrappers
around the AppleEvent
<a id='l2h-
79' xml:id='l2h-
79'
></a> interface to the finder.
All file and folder parameters can be specified either as full
pathnames, or as
<tt class=
"class">FSRef
</tt> or
<tt class=
"class">FSSpec
</tt> objects.
The
<tt class=
"module">findertools
</tt> module defines the following functions:
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
72' xml:id='l2h-
72'
class=
"function">launch
</tt></b>(
</nobr></td>
<td><var>file
</var>)
</td></tr></table></dt>
Tell the finder to launch
<var>file
</var>. What launching means depends on the file:
applications are started, folders are opened and documents are opened
in the correct application.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
73' xml:id='l2h-
73'
class=
"function">Print
</tt></b>(
</nobr></td>
<td><var>file
</var>)
</td></tr></table></dt>
Tell the finder to print a file. The behaviour is identical to selecting the file and using
the print command in the finder's file menu.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
74' xml:id='l2h-
74'
class=
"function">copy
</tt></b>(
</nobr></td>
<td><var>file, destdir
</var>)
</td></tr></table></dt>
Tell the finder to copy a file or folder
<var>file
</var> to folder
<var>destdir
</var>. The function returns an
<tt class=
"class">Alias
</tt> object pointing to
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
75' xml:id='l2h-
75'
class=
"function">move
</tt></b>(
</nobr></td>
<td><var>file, destdir
</var>)
</td></tr></table></dt>
Tell the finder to move a file or folder
<var>file
</var> to folder
<var>destdir
</var>. The function returns an
<tt class=
"class">Alias
</tt> object pointing to
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
76' xml:id='l2h-
76'
class=
"function">sleep
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Tell the finder to put the Macintosh to sleep, if your machine
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
77' xml:id='l2h-
77'
class=
"function">restart
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Tell the finder to perform an orderly restart of the machine.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
78' xml:id='l2h-
78'
class=
"function">shutdown
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Tell the finder to perform an orderly shutdown of the machine.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"2.5 macostools "
href=
"module-macostools.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"2. MacPython Modules"
href=
"macpython-modules.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"2.7 EasyDialogs "
href=
"module-EasyDialogs.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Macintosh Library Modules
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-macostools.html">2.5 macostools
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"macpython-modules.html">2. MacPython Modules
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"module-EasyDialogs.html">2.7 EasyDialogs
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.