Doc/mac/libscrap.tex

   1 \section{\module{Carbon.Scrap} --- Scrap Manager}
   2 \declaremodule{standard}{Carbon.Scrap}
   3   \platform{Mac}
   4 \modulesynopsis{The Scrap Manager provides basic services for
   5                 implementing cut \&\ paste and clipboard operations.}
   6
   7
   8 This module is only fully available on MacOS9 and earlier under
   9 classic PPC MacPython.  Very limited functionality is available under
  10 Carbon MacPython.
  11
  12 The Scrap\index{Scrap Manager} Manager supports the simplest form of
  13 cut \&\ paste operations on the Macintosh.  It can be use for both
  14 inter- and intra-application clipboard operations.
  15
  16 The \module{Scrap} module provides low-level access to the functions
  17 of the Scrap Manager.  It contains the following functions:
  18
  19
  20 \begin{funcdesc}{InfoScrap}{}
  21   Return current information about the scrap.  The information is
  22   encoded as a tuple containing the fields \code{(\var{size},
  23   \var{handle}, \var{count}, \var{state}, \var{path})}.
  24
  25   \begin{tableii}{l|l}{var}{Field}{Meaning}
  26     \lineii{size}{Size of the scrap in bytes.}
  27     \lineii{handle}{Resource object representing the scrap.}
  28     \lineii{count}{Serial number of the scrap contents.}
  29     \lineii{state}{Integer; positive if in memory, \code{0} if on
  30                    disk, negative if uninitialized.}
  31     \lineii{path}{Filename of the scrap when stored on disk.}
  32   \end{tableii}
  33 \end{funcdesc}
  34
  35
  36
  37 \begin{seealso}
  38   \seetitle[http://developer.apple.com/documentation/mac/MoreToolbox/MoreToolbox-109.html]
  39            {Scrap Manager}{Apple's documentation for the Scrap Manager
  40             gives a lot of useful information about using the Scrap
  41             Manager in applications.}
  42 \end{seealso}