Doc/mac/libmacostools.tex

   1 \section{\module{macostools} ---
   2          Convenience routines for file manipulation}
   3
   4 \declaremodule{standard}{macostools}
   5   \platform{Mac}
   6 \modulesynopsis{Convenience routines for file manipulation.}
   7
   8
   9 This module contains some convenience routines for file-manipulation
  10 on the Macintosh. All file parameters can be specified as
  11 pathnames, \class{FSRef} or \class{FSSpec} objects.  This module
  12 expects a filesystem which supports forked files, so it should not
  13 be used on UFS partitions.
  14
  15 The \module{macostools} module defines the following functions:
  16
  17
  18 \begin{funcdesc}{copy}{src, dst\optional{, createpath\optional{, copytimes}}}
  19 Copy file \var{src} to \var{dst}.  If \var{createpath} is non-zero
  20 the folders leading to \var{dst} are created if necessary.
  21 The method copies data and
  22 resource fork and some finder information (creator, type, flags) and
  23 optionally the creation, modification and backup times (default is to
  24 copy them). Custom icons, comments and icon position are not copied.
  25 \end{funcdesc}
  26
  27 \begin{funcdesc}{copytree}{src, dst}
  28 Recursively copy a file tree from \var{src} to \var{dst}, creating
  29 folders as needed. \var{src} and \var{dst} should be specified as
  30 pathnames.
  31 \end{funcdesc}
  32
  33 \begin{funcdesc}{mkalias}{src, dst}
  34 Create a finder alias \var{dst} pointing to \var{src}.
  35 \end{funcdesc}
  36
  37 \begin{funcdesc}{touched}{dst}
  38 Tell the finder that some bits of finder-information such as creator
  39 or type for file \var{dst} has changed. The file can be specified by
  40 pathname or fsspec. This call should tell the finder to redraw the
  41 files icon.
  42 \end{funcdesc}
  43
  44 \begin{datadesc}{BUFSIZ}
  45 The buffer size for \code{copy}, default 1 megabyte.
  46 \end{datadesc}
  47
  48 Note that the process of creating finder aliases is not specified in
  49 the Apple documentation. Hence, aliases created with \function{mkalias()}
  50 could conceivably have incompatible behaviour in some cases.
  51
  52
  53 \section{\module{findertools} ---
  54          The \program{finder}'s Apple Events interface}
  55
  56 \declaremodule{standard}{findertools}
  57   \platform{Mac}
  58 \modulesynopsis{Wrappers around the \program{finder}'s Apple Events interface.}
  59
  60
  61 This module contains routines that give Python programs access to some
  62 functionality provided by the finder. They are implemented as wrappers
  63 around the AppleEvent\index{AppleEvents} interface to the finder.
  64
  65 All file and folder parameters can be specified either as full
  66 pathnames, or as \class{FSRef} or \class{FSSpec} objects.
  67
  68 The \module{findertools} module defines the following functions:
  69
  70
  71 \begin{funcdesc}{launch}{file}
  72 Tell the finder to launch \var{file}. What launching means depends on the file:
  73 applications are started, folders are opened and documents are opened
  74 in the correct application.
  75 \end{funcdesc}
  76
  77 \begin{funcdesc}{Print}{file}
  78 Tell the finder to print a file. The behaviour is identical to selecting the file and using
  79 the print command in the finder's file menu.
  80 \end{funcdesc}
  81
  82 \begin{funcdesc}{copy}{file, destdir}
  83 Tell the finder to copy a file or folder \var{file} to folder
  84 \var{destdir}. The function returns an \class{Alias} object pointing to
  85 the new file.
  86 \end{funcdesc}
  87
  88 \begin{funcdesc}{move}{file, destdir}
  89 Tell the finder to move a file or folder \var{file} to folder
  90 \var{destdir}. The function returns an \class{Alias} object pointing to
  91 the new file.
  92 \end{funcdesc}
  93
  94 \begin{funcdesc}{sleep}{}
  95 Tell the finder to put the Macintosh to sleep, if your machine
  96 supports it.
  97 \end{funcdesc}
  98
  99 \begin{funcdesc}{restart}{}
 100 Tell the finder to perform an orderly restart of the machine.
 101 \end{funcdesc}
 102
 103 \begin{funcdesc}{shutdown}{}
 104 Tell the finder to perform an orderly shutdown of the machine.
 105 \end{funcdesc}